@interopio/browser API Reference

Configuration for opening an app in an <iframe> element.

Properties (5)

Property Type Default Required Description
appName⚓︎ string x

Name of the app as specified in its definition.
channelId⚓︎ string x x

Name of the io.Connect Channel which the app instance will join.
container⚓︎ HTMLElement document.body x

The HTML element to which the newly created <iframe> will be appended as a child element.
context⚓︎ any x x

Starting context for the app instance.
iframeConfig⚓︎ { className?: string; styles?: Partial<CSSStyleDeclaration>; } x x

Initial configuration that will be applied to the <iframe> element on creation. Passing CSS classes and styles before opening the app instance in an <iframe> element may help avoid undesirable visual flickering that may be caused by manipulating the <iframe> element after creation.