Options
All
  • Public
  • Public/Protected
  • All
Menu

@feature-hub/react

Package Version Website API

A library for building a Feature Hub integrator with React.

Installation

Using Yarn

yarn add @feature-hub/react

Using NPM

npm install @feature-hub/react

Copyright (c) 2018-2019 SinnerSchrader Deutschland GmbH. Released under the terms of the MIT License.

Index

Type aliases

FeatureApp

A Feature App that can be rendered by the FeatureAppLoader or FeatureAppContainer must be either a ReactFeatureApp (recommended) or a DomFeatureApp.

FeatureHubContextConsumerValue

FeatureHubContextConsumerValue: SomeRequired<FeatureHubContextProviderValue, "logger">

Variables

Const FeatureHubContextProvider

FeatureHubContextProvider: ProviderExoticComponent<ProviderProps<FeatureHubContextProviderValue>> = FeatureHubContext.Provider

The integrator must render a FeatureHubContextProvider to provide the FeatureAppManager singleton instance, as well as the Async SSR Manager Feature Service (optionally), to Feature Hub context consumers, e.g. the FeatureAppLoader or FeatureAppContainer.

Functions

FeatureAppContainer

  • FeatureAppContainer<TFeatureApp, TFeatureServices, TConfig>(props: FeatureAppContainerProps<TFeatureApp, TFeatureServices, TConfig>): Element
  • The FeatureAppContainer component allows the integrator to bundle Feature Apps instead of loading them from a remote location. It can also be used by a Feature App to render another Feature App as a child.

    When a Feature App throws an error while rendering or, in the case of a ReactFeatureApp, throws an error in a lifecycle method, the FeatureAppContainer renders null. On the server, however, rendering errors are not caught and must therefore be handled by the integrator.

    Type parameters

    Parameters

    Returns Element

FeatureAppLoader

  • The FeatureAppLoader component allows the integrator to load Feature Apps from a remote location. It can also be used by a Feature App to render another Feature App as a child.

    When a Feature App throws an error while rendering or, in the case of a ReactFeatureApp, throws an error in a lifecycle method, the FeatureAppLoader renders null. On the server, however, rendering errors are not caught and must therefore be handled by the integrator.

    Type parameters

    • TConfig

    Parameters

    Returns Element

Const FeatureHubContextConsumer

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc