Skip to main content

Interface: ILoadModuleOptions

Defined in: src/types/runtime.ts:198

Options for loading a module-federated miniapp component (e.g., ToolbarIcon, Sidebar) without going through the full miniapp lifecycle.

Properties​

containerConfig?​

optional containerConfig?: IContainerConfig

Defined in: src/types/runtime.ts:210

Optional container config override — when omitted, runtime's containerConfig is used

containerId​

containerId: string

Defined in: src/types/runtime.ts:204

DOM container ID passed through to the container config

miniapp​

miniapp: object

Defined in: src/types/runtime.ts:200

The miniapp whose module to load

appVersion​

appVersion: string

categoryTags​

categoryTags: string[]

changeLog​

changeLog: string

createdBy​

createdBy: object

createdBy.displayName​

displayName: string

createdBy.id​

id: string

createdBy.photo​

photo: string

createdOn​

createdOn: string

description​

description: string

experience​

experience: "Edit" | "Create" | "Landing"

extensions​

extensions: object[]

iconUrl​

iconUrl: string

id​

id: string

isModuleFederated​

isModuleFederated: boolean

isPublic​

isPublic: boolean

isTrusted​

isTrusted: boolean

layout?​

optional layout?: string

name​

name: string

owners​

owners: object[]

packageId​

packageId: string

permissions​

permissions: "View"[]

platforms​

platforms: ("android" | "apple" | "website")[]

platformVersion​

platformVersion: string

productBundle​

productBundle: string

routes?​

optional routes?: object[]

state​

state: "Draft" | "Published"

systemTags​

systemTags: string[]

tags​

tags: string[]

updatedBy​

updatedBy: object

updatedBy.displayName​

displayName: string

updatedBy.id​

id: string

updatedBy.photo​

photo: string

updatedOn​

updatedOn: string

workspaceIds​

workspaceIds: string[]

moduleName​

moduleName: ExposedModuleNames

Defined in: src/types/runtime.ts:202

Which exposed module to load from the miniapp's module federation manifest

moduleProps​

moduleProps: unknown

Defined in: src/types/runtime.ts:206

Props forwarded to the loaded module component

sid​

sid: string

Defined in: src/types/runtime.ts:208

Session ID to associate with this module load