Interface FrontendPlugin<TRoutes, TExternalRoutes>

interface FrontendPlugin<
    TRoutes extends
        { [name in string]: RouteRef
        | SubRouteRef } = { [name in string]: RouteRef | SubRouteRef },
    TExternalRoutes extends
        { [name in string]: ExternalRouteRef } = {
        [name in string]: ExternalRouteRef
    },
> {
    $$type: "@backstage/FrontendPlugin";
    externalRoutes: TExternalRoutes;
    icon?: IconElement;
    id: string;
    pluginId: string;
    routes: TRoutes;
    title?: string;
    info(): Promise<FrontendPluginInfo>;
}

Type Parameters

TRoutes extends { [name in string]: RouteRef | SubRouteRef } = { [name in string]: RouteRef | SubRouteRef }
TExternalRoutes extends { [name in string]: ExternalRouteRef } = { [name in string]: ExternalRouteRef }

Hierarchy (View Summary)

FrontendPlugin
- OverridableFrontendPlugin

Index

Properties

$$type externalRoutes icon? id pluginId routes title?

Methods

Properties

`Readonly`$$type

$$type: "@backstage/FrontendPlugin"

`Readonly`externalRoutes

externalRoutes: TExternalRoutes

`Optional` `Readonly`icon

icon?: IconElement

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

`Readonly`id

id: string

Deprecated alias for pluginId.

Deprecated

Use pluginId instead.

`Readonly`pluginId

pluginId: string

The plugin ID.

`Readonly`routes

routes: TRoutes

`Optional` `Readonly`title

title?: string

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

Methods

info

info(): Promise<FrontendPluginInfo>
Loads the plugin info.

Returns Promise<FrontendPluginInfo>
- Defined in packages/frontend-plugin-api/src/wiring/createFrontendPlugin.ts:170