FeatureAppLoaderProps | @feature-hub

Type parameters

TConfig

Hierarchy

FeatureAppLoaderProps

Index

Properties

Optional baseUrl

baseUrl: undefined | string

The absolute or relative base URL of the Feature App's assets and/or BFF.

Optional beforeCreate

beforeCreate: undefined | function

A callback that is called before the Feature App is created.

Optional children

children: undefined | function

A children function can be provided to customize rendering of the Feature App and provide Error or Loading UIs.

Optional config

config: TConfig

A config object that is passed to the Feature App's create method.

Optional css

css: Css[]

A list of stylesheets to be added to the document. If baseUrl is specified, it will be prepended, unless Css.href is an absolute URL.

Optional done

done: undefined | function

A callback that is passed to the Feature App's create method. A short-lived Feature App can call this function when it has completed its task. The Integrator (or parent Feature App) can then decide to e.g. unmount the Feature App.

featureAppId

featureAppId: string

The Feature App ID is used to identify the Feature App instance. Multiple Feature App Loaders with the same featureAppId will render the same Feature app instance. The ID is also used as a consumer ID for dependent Feature Services. To render multiple instances of the same kind of Feature App, different IDs must be used.

Optional onError

onError: undefined | function

Optional renderError

renderError: undefined | function

deprecated: Use the children render function instead to render an error.

Optional serverSrc

serverSrc: undefined | string

The URL of the Feature App's server module bundle. If baseUrl is specified, it will be prepended, unless serverSrc is an absolute URL. Either baseUrl or serverSrc must be an absolute URL.

src

src: string

The URL of the Feature App's client module bundle. If baseUrl is specified, it will be prepended, unless src is an absolute URL.

Generated using TypeDoc