@backstage/frontend-plugin-api
Home > @backstage/frontend-plugin-api
Core API used by Backstage frontend plugins.
Functions
Function | Description |
---|---|
createComponentExtension(options) | |
createComponentRef(options) | |
createExtension(options) | |
createExtensionBlueprint(options) | A simpler replacement for wrapping up createExtension inside a kind or type. This allows for a cleaner API for creating types and instances of those types. |
createExtensionDataRef(id) | |
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. |
createFrontendModule(options) | |
createFrontendPlugin(options) | |
createRouteRef(config) | Create a RouteRef from a route descriptor. |
createSubRouteRef(config) | Create a SubRouteRef from a route descriptor. |
ExtensionBoundary(props) | |
useAnalytics() | Gets a pre-configured analytics tracker. |
useComponentRef(ref) | Returns the component associated with the given ref. |
useRouteRef(routeRef) | React hook for constructing URLs to routes. |
useRouteRefParams(_routeRef) | React hook for retrieving dynamic params from the current URL. |
Interfaces
Interface | Description |
---|---|
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. |
ComponentsApi | API for looking up components based on component refs. |
ConfigurableExtensionDataRef | |
CreateFrontendModuleOptions | |
Extension | |
ExtensionBlueprint | |
ExtensionBoundaryProps | |
ExtensionInput | |
ExtensionOverrides | |
ExternalRouteRef | Route descriptor, to be later bound to a concrete route by the app. Used to implement cross-plugin route references. |
FrontendModule | |
FrontendPlugin | |
IconsApi | API for accessing app icons. |
PluginOptions | |
RouteRef | Absolute route reference. |
RouteResolutionApi | |
SubRouteRef | Descriptor of a route relative to an absolute RouteRef. |
Namespaces
Namespace | Description |
---|---|
createComponentExtension | |
ExtensionBoundary |
Variables
Variable | Description |
---|---|
analyticsApiRef | The API reference of AnalyticsApi. |
AnalyticsContext | Provides components in the child react tree an Analytics Context, ensuring all analytics events captured within the context have relevant attributes. |
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. |
componentsApiRef | The ApiRef of ComponentsApi. |
coreComponentRefs | |
coreExtensionData | |
IconBundleBlueprint | |
iconsApiRef | The ApiRef of IconsApi. |
NavItemBlueprint | Creates extensions that make up the items of the nav bar. |
NavLogoBlueprint | Creates an extension that replaces the logo in the nav bar with your own. |
PageBlueprint | Createx extensions that are routable React page components. |
RouterBlueprint | |
routeResolutionApiRef | The ApiRef of RouteResolutionApi. |
SignInPageBlueprint | Creates an extension that replaces the sign in page. |
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. |
AnalyticsContextValue | Analytics context envelope. |
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. |
AnalyticsTracker | Represents a tracker with methods that can be called to track events in a configured analytics service. |
AnyExtensionDataRef | |
AnyExternalRoutes | |
AnyRouteRefParams | Catch-all type for route params. |
AnyRoutes | |
CommonAnalyticsContext | Common analytics context attributes. |
ComponentRef | |
CoreErrorBoundaryFallbackProps | |
CoreNotFoundErrorPageProps | |
CoreProgressProps | |
CreateExtensionBlueprintOptions | |
CreateExtensionOptions | |
ExtensionBlueprintParameters | |
ExtensionDataContainer | |
ExtensionDataRef | |
ExtensionDataRefToValue | |
ExtensionDataValue | |
ExtensionDefinition | |
ExtensionDefinitionParameters | |
FeatureFlagConfig | Feature flag configuration. |
FrontendFeature | |
IconComponent | IconComponent is the common icon type used throughout Backstage when working with and rendering generic icons, including the app system icons. |
PortableSchema | |
ResolvedExtensionInput | Convert a single extension input into a matching resolved input. |
ResolvedExtensionInputs | Converts an extension input map into a matching collection of resolved inputs. |
ResolveInputValueOverrides | |
RouteFunc | TS magic for handling route parameters. |
RouteResolutionApiResolveOptions |