Skip to main content

GuestProps<AppObjects, AppEvents>

Extends​

  • InitOptions<AppObjects, AppEvents>

Type Parameters​

AppObjects​

AppObjects extends ScriptingObjects = Partial<ScriptingObjectTypes>

AppEvents​

AppEvents extends EventListeners = Events

Properties​

containerId​

containerId: string;

DOM element ID where the guest app should render. Defaults to DEFAULT_CONTAINER_ID and can be overridden by the host via module parameters or the MountOptions passed to mount().

history​

history: History;

Overrides​

InitOptions.history

homeRoute?​

optional homeRoute?: string;

Inherited from​

InitOptions.homeRoute

host?​

optional host?: 
  | IMicroAppHost<Partial<ScriptingObjectTypes>, Events>
  | IMicroFEHost<AppObjects, AppEvents>
| SSFGuest<AppObjects, AppEvents>;

Inherited from​

InitOptions.host

hostBreakpoint?​

optional hostBreakpoint?: keyof BreakPoints;

Inherited from​

InitOptions.hostBreakpoint

hostName?​

optional hostName?: string;

Inherited from​

InitOptions.hostName

hostUrl?​

optional hostUrl?: string;

Inherited from​

InitOptions.hostUrl

hostViewportSize?​

optional hostViewportSize?: ViewportSize;

Inherited from​

InitOptions.hostViewportSize

initialRoute?​

optional initialRoute?: To;

Inherited from​

InitOptions.initialRoute

manifestPath?​

optional manifestPath?: string;

Inherited from​

InitOptions.manifestPath

prevState​

prevState: JSONValue;

Overrides​

InitOptions.prevState

theme​

theme: DefaultTheme;

Overrides​

InitOptions.theme