Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • CustomFeatureAppRenderingParams

Index

Properties

Optional error

error: Error

The Error can be used to render a custom error UI. If there is an error, the Feature App will stop rendering and featureAppNode is undefined.

Optional featureAppNode

featureAppNode: React.ReactNode

The Feature App node is a rendered React node, that can be inserted into the react tree.

Caution! If featureAppNode is defined it has to be rendered, even when loading=true. A Feature App might depend on being rendered before resolving its loading promise.

Caution! The Feature App node should always be rendered into the same position of the tree. Otherwise React can re-mount the Feature App, which is resource-expensive and can break DOM Feature Apps.

loading

loading: boolean

The loading boolean indicates if the Feature App is still loading, and can be used to render a custom loading UI.

Caution! If featureAppNode is defined it has to be rendered, even when loading=true. A Feature App might depend on being rendered before resolving its loading promise.

To not show the Feature App in favour of a loading UI, it must be hidden visually (e.g. via display: none;).

Legend

  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Type alias with type parameter
  • Interface
  • Interface with type parameter
  • Property
  • Class
  • Class with type parameter

Generated using TypeDoc