Skip to content

SurfaceHostOptions

Options for surfaceHost — the same provider/surface/mount as EmbedSurfaceOptions, minus the per-call params.

mount: HTMLElement;

Host element the nested surface iframe is mounted into (inline in your UI).

EmbedSurfaceOptions.mount


optional onError?: (error) => void;

Called if the embed is denied or torn down before first ready (the otherwise-easy-to-miss handle.ready rejection).

PlatformError

void


providerId: string;

The app that provides the surface (e.g. "billing").

EmbedSurfaceOptions.providerId


surfaceName: string;

The provider’s declared surface name (e.g. "invoice-list").

EmbedSurfaceOptions.surfaceName