@backstage/frontend-plugin-api

Home > @backstage/frontend-plugin-api

Core API used by Backstage frontend plugins.

Functions

Function	Description
AnalyticsContext(options)	Provides components in the child react tree an Analytics Context, ensuring all analytics events captured within the context have relevant attributes.
createExtension(options)	Creates a new extension definition for installation in a Backstage app.
createExtensionBlueprint(options)	Creates a new extension blueprint that encapsulates the creation of extensions of particular kinds.
createExtensionBlueprintParams(params)	Wraps a plain blueprint parameter object in an opaque ExtensionBlueprintParams object. This is used in the definition of the defineParams option of ExtensionBlueprint.
createExtensionDataRef()
createExtensionInput(extensionData, config)
createExternalRouteRef(options)	Creates a route descriptor, to be later bound to a concrete route by the app. Used to implement cross-plugin route references.
createFrontendFeatureLoader(options)
createFrontendModule(options)	Creates a new module that can be installed in a Backstage app.
createFrontendPlugin(options)	Creates a new plugin that can be installed in a Backstage app.
createRouteRef(config)	Create a RouteRef from a route descriptor.
createSubRouteRef(config)	Create a SubRouteRef from a route descriptor.
createSwappableComponent(options)	Creates a SwappableComponent that can be used to render the component, optionally overridden by the app.
ExtensionBoundary(props)
useAnalytics()	Gets a pre-configured analytics tracker.
useAppNode()	React hook providing access to the current AppNode.
useRouteRef(routeRef)	React hook for constructing URLs to routes.
useRouteRefParams(_routeRef)	React hook for retrieving dynamic params from the current URL.

Interfaces

Interface	Description
AnalyticsContextValue	Analytics context envelope.
AppNode	A node in the AppTree.
AppNodeEdges	The connections from this AppNode to other nodes.
AppNodeInstance	The instance of this AppNode in the AppTree.
AppNodeSpec	The specification for this AppNode in the AppTree.
AppTree	The app tree containing all AppNodes of the app.
AppTreeApi	The API for interacting with the AppTree.
ConfigurableExtensionDataRef
CreateFrontendFeatureLoaderOptions
CreateFrontendModuleOptions
DialogApi	A Utility API for showing dialogs that render in the React tree and return a result.
DialogApiDialog	A handle for an open dialog that can be used to interact with it.
Extension
ExtensionBlueprint
ExtensionBoundaryProps
ExtensionInput
ExternalRouteRef	Route descriptor, to be later bound to a concrete route by the app. Used to implement cross-plugin route references.
FrontendFeatureLoader
FrontendModule
FrontendPlugin
FrontendPluginInfo	Information about the plugin.
IconsApi	API for accessing app icons.
NavContentComponentProps	The props for the NavContentComponent.
PluginOptions
RouteRef	Absolute route reference.
RouteResolutionApi
SubRouteRef	Descriptor of a route relative to an absolute RouteRef.
SwappableComponentsApi	API for looking up components based on component refs.

Namespaces

Namespace	Description
ExtensionBoundary

Variables

Variable	Description
analyticsApiRef	The API reference of AnalyticsApi.
AnalyticsImplementationBlueprint	Creates analytics implementations.
ApiBlueprint	Creates utility API extensions.
AppRootElementBlueprint	Creates extensions that render a React element at the app root, outside of the app layout. This is useful for example for shared popups and similar.
AppRootWrapperBlueprint	Creates a extensions that render a React wrapper at the app root, enclosing the app layout. This is useful for example for adding global React contexts and similar.
appTreeApiRef	The ApiRef of AppTreeApi.
coreExtensionData
dialogApiRef	The ApiRef of DialogApi.
ErrorDisplay
IconBundleBlueprint
iconsApiRef	The ApiRef of IconsApi.
NavContentBlueprint	Creates an extension that replaces the entire nav bar with your own component.
NavItemBlueprint	Creates extensions that make up the items of the nav bar.
NotFoundErrorPage
PageBlueprint	Createx extensions that are routable React page components.
Progress
RouterBlueprint
routeResolutionApiRef	The ApiRef of RouteResolutionApi.
SignInPageBlueprint	Creates an extension that replaces the sign in page.
SwappableComponentBlueprint	Blueprint for creating swappable components from a SwappableComponentRef and a loader
swappableComponentsApiRef	The ApiRef of SwappableComponentsApi.
ThemeBlueprint	Creates an extension that adds/replaces an app theme.
TranslationBlueprint	Creates an extension that adds translations to your app.

Type Aliases

Type Alias	Description
AnalyticsApi	The Analytics API is used to track user behavior in a Backstage instance.
AnalyticsEvent	Represents an event worth tracking in an analytics system that could inform how users of a Backstage instance are using its features.
AnalyticsEventAttributes	A structure allowing other arbitrary metadata to be provided by analytics event emitters.
AnalyticsImplementation	Analytics implementations are used to track user behavior in a Backstage instance.
AnalyticsImplementationFactory
AnalyticsTracker	Represents a tracker with methods that can be called to track events in a configured analytics service.
AnyExtensionDataRef
AnyRouteRefParams	Catch-all type for route params.
CreateExtensionBlueprintOptions
CreateExtensionOptions
CreateSwappableComponentOptions	Options for creating an SwappableComponent.
ErrorDisplayProps
ExtensionAttachToSpec
ExtensionBlueprintDefineParams	A function used to define a parameter mapping function in order to facilitate advanced parameter typing for extension blueprints.
ExtensionBlueprintParameters
ExtensionBlueprintParams	An opaque type that represents a set of parameters to be passed to a blueprint.
ExtensionDataContainer
ExtensionDataRef
ExtensionDataRefToValue
ExtensionDataValue
ExtensionDefinition
ExtensionDefinitionParameters
ExtensionFactoryMiddleware
FeatureFlagConfig	Feature flag configuration.
FrontendFeature
FrontendPluginInfoOptions	Options for providing information for a plugin.
IconComponent	IconComponent is the common icon type used throughout Backstage when working with and rendering generic icons, including the app system icons.
NavContentComponent	A component that renders the nav bar content, to be passed to the NavContentBlueprint.
NotFoundErrorPageProps
PortableSchema
ProgressProps
ResolvedExtensionInput	Convert a single extension input into a matching resolved input.
ResolvedExtensionInputs	Converts an extension input map into a matching collection of resolved inputs.
RouteFunc	TS magic for handling route parameters.
SwappableComponentRef