Interface AsukaModulesApi

Runtime helpers used to override module presentation.

interface AsukaModulesApi {
    clearDisplayMode: ((id: string) => void);
    clearMountTarget: ((id: string) => void);
    getDisplayMode: ((id: string) => null | ModuleDisplayMode);
    getMountTarget: ((id: string) => null | string);
    setDisplayMode: ((id: string, mode: ModuleDisplayMode) => void);
    setMountTarget: ((id: string, target: null | string) => void);
}

Properties

clearDisplayMode: ((id: string) => void)

Clear the runtime display mode override of a module.

clearMountTarget: ((id: string) => void)

Remove the runtime mount target override of a module.

getDisplayMode: ((id: string) => null | ModuleDisplayMode)

Return the effective runtime display mode override, if any.

getMountTarget: ((id: string) => null | string)

Return the effective runtime mount target override, if any.

setDisplayMode: ((id: string, mode: ModuleDisplayMode) => void)

Override the display mode of a module at runtime.

setMountTarget: ((id: string, target: null | string) => void)

Force a module to mount into a specific DOM target.