Interface CreateFrontendPluginOptions<TId, TRoutes, TExternalRoutes, TExtensions>

Options for createFrontendPlugin.

interface CreateFrontendPluginOptions<
    TId extends string,
    TRoutes extends { [name in string]: RouteRef | SubRouteRef },
    TExternalRoutes extends { [name in string]: ExternalRouteRef },
    TExtensions extends readonly ExtensionDefinition[],
> {
    extensions?: TExtensions;
    externalRoutes?: TExternalRoutes;
    featureFlags?: FeatureFlagConfig[];
    icon?: IconElement;
    if?: FilterPredicate;
    info?: FrontendPluginInfoOptions;
    pluginId: TId;
    routes?: TRoutes;
    title?: string;
}

Type Parameters

TId extends string
TRoutes extends { [name in string]: RouteRef | SubRouteRef }
TExternalRoutes extends { [name in string]: ExternalRouteRef }
TExtensions extends readonly ExtensionDefinition[]

Index

Properties

extensions? externalRoutes? featureFlags? icon? if? info? pluginId routes? title?

Properties

`Optional`extensions

extensions?: TExtensions

`Optional`externalRoutes

externalRoutes?: TExternalRoutes

`Optional`featureFlags

featureFlags?: FeatureFlagConfig[]

`Optional`icon

icon?: IconElement

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

`Optional`if

if?: FilterPredicate

`Optional`info

info?: FrontendPluginInfoOptions

pluginId

pluginId: TId

`Optional`routes

routes?: TRoutes

`Optional`title

title?: string

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