Backstage
    Preparing search index...

    Interface OverridableFrontendPlugin<TRoutes, TExternalRoutes, TExtensionMap>

    A variant of the FrontendPlugin interface that can also be used to install overrides for the plugin.

    interface OverridableFrontendPlugin<
        TRoutes extends
            { [name in string]: RouteRef
            | SubRouteRef } = { [name in string]: RouteRef | SubRouteRef },
        TExternalRoutes extends
            { [name in string]: ExternalRouteRef } = {
            [name in string]: ExternalRouteRef
        },
        TExtensionMap extends
            { [id in string]: ExtensionDefinition } = {
            [id in string]: ExtensionDefinition
        },
    > {
        $$type: "@backstage/FrontendPlugin";
        externalRoutes: TExternalRoutes;
        icon?: IconElement;
        id: string;
        pluginId: string;
        routes: TRoutes;
        title?: string;
        getExtension<TId extends string | number | symbol>(
            id: TId,
        ): OverridableExtensionDefinition<TExtensionMap[TId]["T"]>;
        info(): Promise<FrontendPluginInfo>;
        withOverrides(
            options: {
                extensions?: ExtensionDefinition<ExtensionDefinitionParameters>[];
                icon?: IconElement;
                info?: FrontendPluginInfoOptions;
                title?: string;
            },
        ): OverridableFrontendPlugin<TRoutes, TExternalRoutes, TExtensionMap>;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    $$type externalRoutes icon? id pluginId routes title?

    Methods

    getExtension info withOverrides

    Properties

    $$type: "@backstage/FrontendPlugin"
    externalRoutes: TExternalRoutes
    icon?: IconElement

    The display icon of the plugin, used in page headers and navigation.

    id: string

    Deprecated alias for pluginId.

    Use pluginId instead.

    pluginId: string

    The plugin ID.

    routes: TRoutes
    title?: string

    The display title of the plugin, used in page headers and navigation. Falls back to the plugin ID if not provided.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods