Interface AsukaModuleDefinition

Public custom module definition used by registerModule.

interface AsukaModuleDefinition {
    action?: ((context: AsukaModuleContext) => void | Promise<void>);
    displayMode?: ModuleDisplayMode;
    group?: string;
    icon?: string;
    id: string;
    isAvailable?: boolean;
    keepMounted?: boolean;
    label?: string;
    licenseFeature?: string;
    loader?: AsukaModuleLoader;
    mountTarget?: string;
    render?: AsukaModuleComponent;
    requiredCapabilities?: string[];
    requiresView?: boolean;
    supportedEngines?: AsukaRenderEngineKind[];
    title?: string;
}

Properties

action? displayMode? group? icon? id isAvailable? keepMounted? label? licenseFeature? loader? mountTarget? render? requiredCapabilities? requiresView? supportedEngines? title?

Properties

Optionalaction

action?: ((context: AsukaModuleContext) => void | Promise<void>)

Optional action-only module triggered without opening a UI container.

OptionaldisplayMode

displayMode?: ModuleDisplayMode

Preferred display mode.

Optionalgroup

group?: string

Optional grouping used by higher-level UIs.

Optionalicon

icon?: string

Icon name or serialized icon token.

id

id: string

Stable module id used by layout blocks and runtime APIs.

OptionalisAvailable

isAvailable?: boolean

Whether the module is currently available.

OptionalkeepMounted

keepMounted?: boolean

Keep the module mounted when it closes so internal state is preserved.

Optionallabel

label?: string

Human-readable sidebar/menu label.

OptionallicenseFeature

licenseFeature?: string

Optional premium gate evaluated against the current runtime license.

Optionalloader

loader?: AsukaModuleLoader

Lazy loader used to resolve the module implementation on demand.

OptionalmountTarget

mountTarget?: string

DOM selector or element id used as a mount target override.

Optionalrender

render?: AsukaModuleComponent

Module render function.

OptionalrequiredCapabilities

requiredCapabilities?: string[]

Optional high-level engine capabilities required by this module.

OptionalrequiresView

requiresView?: boolean

Whether this module needs at least one view/canvas to be usable. Defaults to true except for view-independent core modules.

OptionalsupportedEngines

supportedEngines?: AsukaRenderEngineKind[]

Rendering engines supported by this module. Defaults to ['fabric'] when omitted.

Optionaltitle

title?: string

Optional overlay title override.

Settings

Member Visibility

On This Page

Properties