createSwappableComponent()

Home > @backstage/frontend-plugin-api > createSwappableComponent

Creates a SwappableComponent that can be used to render the component, optionally overridden by the app.

Signature:

function createSwappableComponent<TInnerComponentProps extends {}, TExternalComponentProps extends {} = TInnerComponentProps>(options: CreateSwappableComponentOptions<TInnerComponentProps, TExternalComponentProps>): {
    (props: TExternalComponentProps): JSX.Element | null;
    ref: SwappableComponentRef<TInnerComponentProps, TExternalComponentProps>;
};

Parameters

Parameter	Type	Description
options	CreateSwappableComponentOptions<TInnerComponentProps, TExternalComponentProps>

**Returns:**

{ (props: TExternalComponentProps): JSX.Element | null; ref: SwappableComponentRef<TInnerComponentProps, TExternalComponentProps>; }