Skip to main content

Interface: ILoadOptions

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

Options passed to IRuntime.load to control how a miniapp is mounted, what permissions it receives, and which lifecycle callbacks fire.

Properties​

containerId?​

optional containerId?: string

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

Container ID to mount the miniapp into

optional disableDeeplinks?: boolean

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

Disable deep linking for this miniapp

initiateBootstrap?​

optional initiateBootstrap?: boolean

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

Whether to initiate bootstrap immediately

permissions?​

optional permissions?: Partial<MiniappPermissions>

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

Permissions for this miniapp

standalone?​

optional standalone?: boolean

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

Whether this is a standalone miniapp (not part of sidebar)

touchpoint?​

optional touchpoint?: string

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

Touchpoint identifier for analytics

Methods​

onClose()?​

optional onClose(params?): void | Promise<void>

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

Called when the miniapp signals close

Parameters​

params?​

unknown

Returns​

void | Promise<void>

onReady()?​

optional onReady(): void

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

Called when the miniapp signals it's ready

Returns​

void