Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AppLifecycleFnProps<RegProps>

Describes all properties that are passed by ILC & single-spa to the application lifecycle Fns

Type parameters

  • RegProps

Hierarchy

Index

Properties

appId

appId: string

Unique application ID, if same app will be rendered twice on a page - it will get different IDs

deprecated

use appSdk.appId instead

appSdk

appSdk: IIlcAppSdk

Isomorphic API that can be used during SSR & CSR. Documentation

domElementGetter

domElementGetter: () => HTMLElement

Returns ref to HTMLElement that should be used as container to render app's content

Type declaration

    • (): HTMLElement
    • Returns HTMLElement

errorHandler

errorHandler: ErrorHandler

App MUST use it to propagate all unhandled errors. Usually it's used in app's adapter.

getCurrentBasePath

getCurrentBasePath: () => string

Base path that is relative to the matched route.

So for reqUrl = /a/b/c?d=1 & matched route /a/* base path will be /a/. While for reqUrl = /a/b/c?d=1 & matched route /a/b/c base path will be /a/b/c.

Type declaration

    • (): string
    • Returns string

getCurrentPathProps

getCurrentPathProps: () => RegProps

Returns Props that were defined for current path

Type declaration

    • (): RegProps
    • Returns RegProps

mountParcel

mountParcel: MountParcel

Each application is provided a mountParcel function. The main advantage to using an applications mountParcel function is that parcels mounted via an applications mountParcel will be automatically unmounted when the application is unmounted.

name

name: string

Unique application ID, if same app will be rendered twice on a page - it will get different IDs

Generated using TypeDoc