Interface: MutkaModule

Defined in: module-registry/module-registry.types.ts:175

Properties

actions

actions: MutkaAction[];

Defined in: module-registry/module-registry.types.ts:187

Actions this module contributes.

declarativePanels?

optional declarativePanels?: DeclarativePanelContribution[];

Defined in: module-registry/module-registry.types.ts:195

Declarative side-pane panels filled from a UINode tree (sandbox-friendly).

description?

optional description?: string;

Defined in: module-registry/module-registry.types.ts:183

One-sentence description.

id

id: string;

Defined in: module-registry/module-registry.types.ts:177

Unique module ID. Follows the "author.name" convention.

moduleManagerButtons?

optional moduleManagerButtons?: ModuleManagerButtonContribution[];

Defined in: module-registry/module-registry.types.ts:199

Buttons this module adds to the Modules overlay (Browse tab).

name

name: string;

Defined in: module-registry/module-registry.types.ts:179

Display name.

onMount?

optional onMount?: () => void | (() => void) | () => void[];

Defined in: module-registry/module-registry.types.ts:203

Called once after registration. Return unsub fn(s) to run on unregister.

Returns

void | (() => void) | () => void[]

onUnmount?

optional onUnmount?: () => void;

Defined in: module-registry/module-registry.types.ts:205

Called once before unregistration, for non-EventBus cleanup (timers, etc.).

Returns

void

openHandlers?

optional openHandlers?: MutkaOpenHandler[];

Defined in: module-registry/module-registry.types.ts:189

Open handlers this module contributes (optional).

permissions?

optional permissions?: readonly ModulePermission[];

Defined in: module-registry/module-registry.types.ts:185

Permissions this module declared - enforced by the capability gateway.

runUIEvent?

optional runUIEvent?: (handlerId, value) => void;

Defined in: module-registry/module-registry.types.ts:201

Dispatch a UI-event (button/list/form interaction) into this module's runtime.

Parameters

Returns

void

settingsSections?

optional settingsSections?: SettingsSectionContribution[];

Defined in: module-registry/module-registry.types.ts:197

Declarative settings sections filled from a UINode tree (sandbox-friendly).

sidebarItems?

optional sidebarItems?: SidebarItem[];

Defined in: module-registry/module-registry.types.ts:191

Declarative left-sidebar entries this module contributes (optional).

sidebarPanels?

optional sidebarPanels?: MutkaSidebarPanel[];

Defined in: module-registry/module-registry.types.ts:193

Sidebar panels this module contributes as React components (core UI only).

version

version: string;

Defined in: module-registry/module-registry.types.ts:181

SemVer string, e.g. "1.0.0".