createPageExtension()

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

Helper for creating extensions for a routable React page component.

Signature:

function createPageExtension<TConfig extends {
    path: string;
}, TInputs extends AnyExtensionInputMap>(options: ({
    defaultPath: string;
} | {
    configSchema: PortableSchema<TConfig>;
}) & {
    namespace?: string;
    name?: string;
    attachTo?: {
        id: string;
        input: string;
    };
    disabled?: boolean;
    inputs?: TInputs;
    routeRef?: RouteRef;
    loader: (options: {
        config: TConfig;
        inputs: Expand<ResolvedExtensionInputs<TInputs>>;
    }) => Promise<JSX.Element>;
}): ExtensionDefinition<TConfig>;

Parameters

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

Returns:

ExtensionDefinition<TConfig>

Parameters​

Parameters