update doc

Signed-off-by: Andreas Berger <andreas@berger-ecommerce.com>
2025-09-11 16:07:10 +02:00
parent f053baa2f7
commit d04264404e
3 changed files with 62 additions and 11 deletions
@@ -198,15 +198,6 @@ const exampleEntityContent = EntityContentBlueprint.make({
  params: {
    path: 'example',
    title: 'Example',
-    // Optional: associate this content with a group on the entity page tabs
-    // Use a known default group id like "overview", "quality", "documentation",
-    // or provide a custom string. You can also override or disable this via app-config (see note below).
-    // group: 'overview',
-    // Optional: set a tab icon. When using a string, the icon is resolved via the IconsApi.
-    // Ensure your app has icon bundles enabled/installed so the icon id is available.
-    // Note: icons are shown in the entity page tab groups only if `showIcons` is enabled in the
-    //       catalog entity page config (page:catalog/entity) via app-config.
-    // icon: 'dashboard',
    loader: () =>
      import('./components/ExampleEntityContent').then(m => (
        <m.ExampleEntityContent />
@@ -73,10 +73,10 @@ Avoid using `convertLegacyEntityCardExtension` from `@backstage/core-compat-api`

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

-Supports optional params such as `group` and `icon` in addition to `path`, `title`, `loader`, `filter`, and `routeRef`:
+Supports optional params such as `group` and `icon`to:

 - group: string | false — associates the content with a tab group on the entity page (for example "overview", "quality", "deployment", or any custom id). You can override or disable this per-installation via app-config using `app.extensions[...].config.group`, where `false` removes the grouping.
- icon: string | ReactElement — sets the tab icon. Note: when providing a string, the icon is looked up via the app's IconsApi; make sure icon bundles are enabled/installed in your app (see the Icons blueprint reference above) so that the icon id you use is available.
+- icon: string — sets the tab icon. Note: when providing a string, the icon is looked up via the app's IconsApi; make sure icon bundles are enabled/installed in your app (see the Icons blueprint reference above) so that the icon id you use is available.

 To render icons in the entity page tabs, the page must also have icons enabled via app configuration. Set `showIcons: true` on the catalog entity page config (created via `page:catalog/entity`). Example: