Skip to content

spatial-monorepo


spatial-monorepo / ui/src / EmbedWidgetProps

Interface: EmbedWidgetProps

Defined in: packages/ui/src/EmbedWidget.tsx:53

Properties

onMessage?

optional onMessage?: (msg) => void

Defined in: packages/ui/src/EmbedWidget.tsx:66

Called when an IFrameEvent message arrives on window (iframe → host). Receives typed IFrameEvent objects only — untyped messages are ignored.

Parameters

msg

IFrameEvent

Returns

void


onResize?

optional onResize?: (size) => void

Defined in: packages/ui/src/EmbedWidget.tsx:71

Called when the widget container is resized via ResizeObserver. Receives the new bounding size.

Parameters

size
height

number

width

number

Returns

void


showFloorSwitcher?

optional showFloorSwitcher?: boolean

Defined in: packages/ui/src/EmbedWidget.tsx:59

Show the floor switcher control. Default: true.


optional showLogo?: boolean

Defined in: packages/ui/src/EmbedWidget.tsx:61

Show the DigiNest logo watermark. Default: true.


src

src: string

Defined in: packages/ui/src/EmbedWidget.tsx:55

IMDF archive URL passed as the src identifier for the embedded map.


theme?

optional theme?: Partial`<Theme>`

Defined in: packages/ui/src/EmbedWidget.tsx:57

Partial theme overrides merged with the default SpatialProvider theme.


trustedOrigins?

optional trustedOrigins?: string[]

Defined in: packages/ui/src/EmbedWidget.tsx:73

Trusted origins for the IFrameMessagingPlugin. Default: ['*'].

Released under commercial licensing.