Skip to main content

Common Extension Blueprints

NOTE: The new frontend system is in alpha and is only supported by a small number of plugins.

This section covers many of the extension blueprints available at your disposal when building Backstage frontend plugins.

Built-in extension blueprints​

These are the extension blueprints provided by the Backstage frontend framework itself.

Api - Reference​

An API extension is used to add or override Utility API factories in the app. They are commonly used by plugins for both internal and shared APIs. There are also many built-in Api extensions provided by the framework that you are able to override.

Component - Reference​

Components extensions are used to override the component associated with a component reference throughout the app. This uses an extension creator function rather than a blueprint, but will likely be migrated to a blueprint in the future.

NavItem - Reference​

Navigation item extensions are used to provide menu items that link to different parts of the app. By default nav items are attached to the app nav extension, which by default is rendered as the left sidebar in the app.

Page - Reference​

Page extensions provide content for a particular route in the app. By default pages are attached to the app routes extensions, which renders the root routes.

SignInPage - Reference​

Sign-in page extension have a single purpose - to implement a custom sign-in page. They are always attached to the app root extension and are rendered before the rest of the app until the user is signed in.

Theme - Reference​

Theme extensions provide custom themes for the app. They are always attached to the app extension and you can have any number of themes extensions installed in an app at once, letting the user choose which theme to use.

Icons - Reference​

Icon bundle extensions provide the ability to replace or provide new icons to the app. You can use the above blueprint to make new extension instances which can be installed into the app.

Translation - Reference​

Translation extension provide custom translation messages for the app. They can be used both to override the default english messages to custom ones, as well as provide translations for additional languages.

Core feature extension blueprints​

These are the extension blueprints provided by the Backstage core feature plugins.

EntityCard - Reference​

Creates entity cards to be displayed on the entity pages of the catalog plugin. Exported as EntityCardBlueprint.

EntityContent - Reference​

Creates entity content to be displayed on the entity pages of the catalog plugin. Exported as EntityContentBlueprint.

SearchResultListItem - Reference​

Creates search result list items for different types of search results, to be displayed in search result lists. Exported as SearchResultListItemBlueprint.