createAppRootElementExtension()

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

Creates an extension that renders a React element at the app root, outside of the app layout. This is useful for example for shared popups and similar.

Signature:

function createAppRootElementExtension<TConfig extends {}, TInputs extends AnyExtensionInputMap>(options: {
    namespace?: string;
    name?: string;
    attachTo?: {
        id: string;
        input: string;
    };
    configSchema?: PortableSchema<TConfig>;
    disabled?: boolean;
    inputs?: TInputs;
    element: JSX.Element | ((options: {
        inputs: Expand<ResolvedExtensionInputs<TInputs>>;
        config: TConfig;
    }) => JSX.Element);
}): ExtensionDefinition<TConfig>;

Parameters

Parameter	Type	Description
options	{ namespace?: string; name?: string; attachTo?: { id: string; input: string; }; configSchema?: PortableSchema<TConfig>; disabled?: boolean; inputs?: TInputs; element: JSX.Element \| ((options: { inputs: Expand<ResolvedExtensionInputs<TInputs>>; config: TConfig; }) => JSX.Element); }

Returns:

ExtensionDefinition<TConfig>

Parameters​

Parameters