paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 33 Packages Projects Releases Wiki Activity

docs/frontend-system: migrate plugin extension types docs to blueprints

Browse Source 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2024-08-15 21:43:44 +02:00
parent c6072b1083
commit 6d1d1779b1
5 changed files with 24 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/frontend-system/building-plugins/01-index.md
+1 -1
View File
@@ -229,4 +229,4 @@ export const examplePlugin = createFrontendPlugin({
The `ExampleEntityContent` itself is again a regular React component where you can implement any functionality you want. To access the entity that the content is being rendered for, you can use the `useEntity` hook from `@backstage/plugin-catalog-react`. You can see a full list of APIs provided by the catalog React library in [the API reference](../../reference/plugin-catalog-react.md).
For a more complete list of the different types of extensions that you can create for your plugin, see the [extension types](./03-extension-types.md) section.
For a more complete list of the different kinds of extensions that you can create for your plugin, see the [extension blueprints](./03-extension-blueprints.md) section.
docs/frontend-system/building-plugins/03-extension-types.md → docs/frontend-system/building-plugins/03-extension-blueprints.md
+20 -20
View File
@@ -1,63 +1,63 @@
---
id: extension-types
title: Frontend System Extension Types
sidebar_label: Extension Types
id: extension-blueprints
title: Frontend System Extension Blueprints
sidebar_label: Extension Blueprints
# prettier-ignore
description: Extension types provided by the frontend system and core features
description: Extension blueprints provided by the frontend system and core features
---
> **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 types](../architecture/20-extensions.md#extension-creators) available at your disposal when building Backstage frontend plugins.
This section covers many of the [extension blueprints](../architecture/23-extension-blueprints.md) available at your disposal when building Backstage frontend plugins.
## Built-in extension types
## Built-in extension blueprints
These are the extension types provided by the Backstage frontend framework itself.
These are the [extension blueprints](../architecture/23-extension-blueprints.md) provided by the Backstage frontend framework itself.
### Api - [Reference](../../reference/frontend-plugin-api.createapiextension.md)
### Api - [Reference](../../reference/frontend-plugin-api.apiblueprint.md)
An API extension is used to add or override [Utility API factories](../utility-apis/01-index.md) 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](../../reference/frontend-plugin-api.createcomponentextension.md)
Components extensions are used to override the component associated with a component reference throughout the app.
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](../../reference/frontend-plugin-api.createnavitemextension.md)
### NavItem - [Reference](../../reference/frontend-plugin-api.navitemblueprint)
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](../../reference/frontend-plugin-api.createpageextension.md)
### Page - [Reference](../../reference/frontend-plugin-api.pageblueprint.md)
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](../../reference/frontend-plugin-api.createsigninpageextension.md)
### SignInPage - [Reference](../../reference/frontend-plugin-api.signinpageblueprint.md)
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](../../reference/frontend-plugin-api.createthemeextension.md)
### Theme - [Reference](../../reference/frontend-plugin-api.themeblueprint.md)
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](../../reference/frontend-plugin-api.iconbundleblueprint.md)
### Icons - [Reference](../../reference/frontend-plugin-api.ndleblueprint.md)
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](../../reference/frontend-plugin-api.createtranslationextension.md)
### Translation - [Reference](../../reference/frontend-plugin-api.translationblueprint.md)
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 types
## Core feature extension blueprints
These are the extension types provided by the Backstage core feature plugins.
These are the [extension blueprints](../architecture/23-extension-blueprints.md) provided by the Backstage core feature plugins.
### EntityCard - [Reference](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/api-report-alpha.md)
Creates entity cards to be displayed on the entity pages of the catalog plugin.
Creates entity cards to be displayed on the entity pages of the catalog plugin. Exported as `EntityCardBlueprint`.
### EntityContent - [Reference](https://github.com/backstage/backstage/blob/master/plugins/catalog-react/api-report-alpha.md)
Creates entity content to be displayed on the entity pages of the catalog plugin.
Creates entity content to be displayed on the entity pages of the catalog plugin. Exported as `EntityContentBlueprint`.
### SearchResultListItem - [Reference](https://github.com/backstage/backstage/blob/master/plugins/search-react/api-report-alpha.md)
Creates search result list items for different types of search results, to be displayed in search result lists.
Creates search result list items for different types of search results, to be displayed in search result lists. Exported as `SearchResultListItemBlueprint`.