docs/frontend-system: update to use icon element
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
@@ -52,12 +52,12 @@ export default createFrontendPlugin({
|
||||
|
||||
### `icon` option
|
||||
|
||||
The display icon of the plugin, used in page headers and navigation. The type is `IconComponent` from `@backstage/frontend-plugin-api`, which is a React component that accepts an optional `fontSize` prop.
|
||||
The display icon of the plugin, used in page headers and navigation. The type is `IconElement` (`JSX.Element | null`) from `@backstage/frontend-plugin-api`.
|
||||
|
||||
```tsx
|
||||
export default createFrontendPlugin({
|
||||
pluginId: 'my-plugin',
|
||||
icon: MyPluginIcon,
|
||||
icon: <MyPluginIcon />,
|
||||
extensions: [...],
|
||||
});
|
||||
```
|
||||
|
||||
@@ -44,11 +44,11 @@ The `title` data reference can be used for defining the extension input/output o
|
||||
|
||||
### `icon`
|
||||
|
||||
| id | type |
|
||||
| :---------: | :-------------: |
|
||||
| `core.icon` | `IconComponent` |
|
||||
| id | type |
|
||||
| :---------: | :-----------: |
|
||||
| `core.icon` | `IconElement` |
|
||||
|
||||
The `icon` data reference can be used for defining the extension input/output of icon components. The type is `IconComponent` from `@backstage/frontend-plugin-api`.
|
||||
The `icon` data reference can be used for defining the extension input/output of icon elements. The type is `IconElement` (`JSX.Element | null`) from `@backstage/frontend-plugin-api`.
|
||||
|
||||
### `routePath`
|
||||
|
||||
|
||||
Reference in New Issue
Block a user