Backstage
    Preparing search index...

    Module @backstage/frontend-plugin-api

    Core API used by Backstage frontend plugins.

    @backstage/frontend-plugin-api

    The new frontend system that this package is part of is in alpha, and we do not yet recommend using it for production deployments

    This package provides the framework API used by Backstage frontend plugins. It implements the design outlined in RFC: Frontend System Evolution.

    Namespaces

    ExtensionBoundary
    FeatureFlagState
    SessionState

    Interfaces

    AnalyticsContextValue
    AppNode
    AppNodeEdges
    AppNodeInstance
    AppNodeSpec
    AppTree
    AppTreeApi
    ConfigurableExtensionDataRef
    CreateFrontendFeatureLoaderOptions
    CreateFrontendModuleOptions
    DialogApi
    DialogApiDialog
    Extension
    ExtensionBlueprint
    ExtensionBoundaryProps
    ExtensionDefinition
    ExtensionInput
    ExternalRouteRef
    FeatureFlagsApi
    FrontendFeatureLoader
    FrontendModule
    FrontendPlugin
    FrontendPluginInfo
    IconsApi
    OverridableExtensionDefinition
    OverridableFrontendPlugin
    PluginOptions
    RouteRef
    RouteResolutionApi
    StorageApi
    SubRouteRef
    SwappableComponentsApi
    TranslationMessages
    TranslationMessagesOptions
    TranslationRef
    TranslationRefOptions
    TranslationResource
    TranslationResourceOptions

    Type Aliases

    AlertApi
    AlertMessage
    AnalyticsApi
    AnalyticsEvent
    AnalyticsEventAttributes
    AnalyticsImplementation
    AnalyticsImplementationFactory
    AnalyticsTracker
    AnyApiFactory
    AnyApiRef
    AnyExtensionDataRef
    AnyRouteRefParams
    ApiFactory
    ApiHolder
    ApiRef
    ApiRefConfig
    AppLanguageApi
    AppTheme
    AppThemeApi
    AuthProviderInfo
    AuthRequestOptions
    BackstageIdentityApi
    BackstageIdentityResponse
    BackstageUserIdentity
    ConfigApi
    CreateExtensionBlueprintOptions
    CreateExtensionOptions
    CreateSwappableComponentOptions
    DiscoveryApi
    ErrorApi
    ErrorApiError
    ErrorApiErrorContext
    ErrorDisplayProps
    ExtensionAttachTo
    ExtensionAttachToSpec
    ExtensionBlueprintDefineParams
    ExtensionBlueprintParameters
    ExtensionBlueprintParams
    ExtensionDataContainer
    ExtensionDataRef
    ExtensionDataRefToValue
    ExtensionDataValue
    ExtensionDefinitionAttachTo
    ExtensionDefinitionParameters
    ExtensionFactoryMiddleware
    FeatureFlag
    FeatureFlagConfig
    FeatureFlagsSaveOptions
    FeatureFlagState
    FetchApi
    FrontendFeature
    FrontendPluginInfoOptions
    IconComponent
    IdentityApi
    NotFoundErrorPageProps
    OAuthApi
    OAuthRequestApi
    OAuthRequester
    OAuthRequesterOptions
    OAuthScope
    OpenIdConnectApi
    PendingOAuthRequest
    PortableSchema
    ProfileInfo
    ProfileInfoApi
    ProgressProps
    ResolvedExtensionInput
    ResolvedExtensionInputs
    RouteFunc
    SessionApi
    SessionState
    SignInPageProps
    StorageValueSnapshot
    SwappableComponentRef
    TranslationApi
    TranslationFunction
    TranslationSnapshot
    TypesToApiRefs

    Variables

    alertApiRef
    analyticsApiRef
    AnalyticsImplementationBlueprint
    ApiBlueprint
    appLanguageApiRef
    AppRootElementBlueprint
    AppRootWrapperBlueprint
    appThemeApiRef
    appTreeApiRef
    atlassianAuthApiRef
    bitbucketAuthApiRef
    bitbucketServerAuthApiRef
    configApiRef
    coreExtensionData
    dialogApiRef
    discoveryApiRef
    errorApiRef
    ErrorDisplay
    featureFlagsApiRef
    FeatureFlagState
    fetchApiRef
    githubAuthApiRef
    gitlabAuthApiRef
    googleAuthApiRef
    IconBundleBlueprint
    iconsApiRef
    identityApiRef
    microsoftAuthApiRef
    NotFoundErrorPage
    oauthRequestApiRef
    oktaAuthApiRef
    oneloginAuthApiRef
    openshiftAuthApiRef
    PageBlueprint
    Progress
    RouterBlueprint
    routeResolutionApiRef
    SessionState
    SignInPageBlueprint
    storageApiRef
    SwappableComponentBlueprint
    swappableComponentsApiRef
    ThemeBlueprint
    translationApiRef
    TranslationBlueprint
    vmwareCloudAuthApiRef

    Functions

    AnalyticsContext
    createApiFactory
    createApiRef
    createExtension
    createExtensionBlueprint
    createExtensionBlueprintParams
    createExtensionDataRef
    createExtensionInput
    createExternalRouteRef
    createFrontendFeatureLoader
    createFrontendModule
    createFrontendPlugin
    createRouteRef
    createSubRouteRef
    createSwappableComponent
    createTranslationMessages
    createTranslationRef
    createTranslationResource
    ExtensionBoundary
    useAnalytics
    useApi
    useApiHolder
    useAppNode
    useRouteRef
    useRouteRefParams
    useTranslationRef
    withApis