rename showIcons config to showNavItemIcons
Signed-off-by: Andreas Berger <andreas@berger-ecommerce.com>
This commit is contained in:
@@ -708,7 +708,7 @@ app:
|
||||
- page:catalog/entity:
|
||||
config:
|
||||
# Show icons next to group and tab titles
|
||||
showIcons: true
|
||||
showNavItemIcons: true
|
||||
|
||||
# Optionally override default groups and their icons
|
||||
groups:
|
||||
@@ -726,7 +726,7 @@ app:
|
||||
Notes:
|
||||
|
||||
- Icons for groups and tabs are resolved via the app's IconsApi. When using a string icon id (for example `"dashboard"`), ensure that the corresponding icon bundles are enabled/installed in your app (see the [IconBundleBlueprint documentation](../../reference/frontend-plugin-api.iconbundleblueprint.md)).
|
||||
- Group icons are only rendered if `showIcons` is set to `true`.
|
||||
- Group icons are only rendered if `showNavItemIcons` is set to `true`.
|
||||
|
||||
### Overriding or disabling a tab's group (per extension)
|
||||
|
||||
@@ -741,7 +741,7 @@ app:
|
||||
config:
|
||||
# Move this tab to a custom group you defined above
|
||||
group: custom
|
||||
# Show an icon for this entity content page but only if `showIcons` is enabled for the `page:catalog/entity` extension
|
||||
# Show an icon for this entity content page but only if `showNavItemIcons` is enabled for the `page:catalog/entity` extension
|
||||
icon: my-icon
|
||||
|
||||
# Disassociate from any group and show as a standalone tab
|
||||
@@ -754,5 +754,5 @@ app:
|
||||
|
||||
Entity content extensions can also declare an `icon` parameter. When provided as a string, the icon id is looked up via the IconsApi. For the icon to render:
|
||||
|
||||
- The entity page must have `showIcons: true` (see configuration above).
|
||||
- The entity page must have `showNavItemIcons: true` (see configuration above).
|
||||
- The icon id must be available in the app's enabled icon bundles.
|
||||
|
||||
@@ -78,7 +78,7 @@ 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 — 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:
|
||||
To render icons in the entity page tabs, the page must also have icons enabled via app configuration. Set `showNavItemIcons: true` on the catalog entity page config (created via `page:catalog/entity`). Example:
|
||||
|
||||
```yaml
|
||||
app:
|
||||
@@ -87,7 +87,7 @@ app:
|
||||
- page:catalog/entity:
|
||||
config:
|
||||
# Enable tab- and group-icons
|
||||
showIcons: true
|
||||
showNavItemIcons: true
|
||||
# Optionally override default groups and their icons
|
||||
groups:
|
||||
- overview:
|
||||
|
||||
@@ -47,7 +47,7 @@ app:
|
||||
# Pages
|
||||
- page:catalog/entity:
|
||||
config:
|
||||
showIcons: true
|
||||
showNavItemIcons: true
|
||||
groups:
|
||||
# placing a tab at the beginning
|
||||
- overview:
|
||||
|
||||
@@ -1040,8 +1040,7 @@ const _default: OverridableFrontendPlugin<
|
||||
}
|
||||
>[]
|
||||
| undefined;
|
||||
showIcons: boolean;
|
||||
} & {
|
||||
showNavItemIcons: boolean;
|
||||
path: string | undefined;
|
||||
};
|
||||
configInput: {
|
||||
@@ -1054,8 +1053,7 @@ const _default: OverridableFrontendPlugin<
|
||||
}
|
||||
>[]
|
||||
| undefined;
|
||||
showIcons?: boolean | undefined;
|
||||
} & {
|
||||
showNavItemIcons?: boolean | undefined;
|
||||
path?: string | undefined;
|
||||
};
|
||||
output:
|
||||
|
||||
@@ -80,7 +80,7 @@ export interface EntityLayoutProps {
|
||||
*/
|
||||
parentEntityRelations?: string[];
|
||||
groupDefinitions: EntityContentGroupDefinitions;
|
||||
showIcons?: boolean;
|
||||
showNavItemIcons?: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -110,7 +110,7 @@ export const EntityLayout = (props: EntityLayoutProps) => {
|
||||
NotFoundComponent,
|
||||
parentEntityRelations,
|
||||
groupDefinitions,
|
||||
showIcons,
|
||||
showNavItemIcons,
|
||||
} = props;
|
||||
const { kind } = useRouteRefParams(entityRouteRef);
|
||||
const { entity, loading, error } = useAsyncEntity();
|
||||
@@ -164,7 +164,7 @@ export const EntityLayout = (props: EntityLayoutProps) => {
|
||||
<EntityTabs
|
||||
routes={routes}
|
||||
groupDefinitions={groupDefinitions}
|
||||
showIcons={showIcons}
|
||||
showIcons={showNavItemIcons}
|
||||
/>
|
||||
)}
|
||||
|
||||
|
||||
@@ -110,7 +110,7 @@ export const catalogEntityPage = PageBlueprint.makeWithOverrides({
|
||||
),
|
||||
)
|
||||
.optional(),
|
||||
showIcons: z => z.boolean().optional().default(false),
|
||||
showNavItemIcons: z => z.boolean().optional().default(false),
|
||||
},
|
||||
},
|
||||
factory(originalFactory, { config, inputs }) {
|
||||
@@ -170,7 +170,7 @@ export const catalogEntityPage = PageBlueprint.makeWithOverrides({
|
||||
header={header}
|
||||
contextMenuItems={filteredMenuItems}
|
||||
groupDefinitions={groupDefinitions}
|
||||
showIcons={config.showIcons}
|
||||
showNavItemIcons={config.showNavItemIcons}
|
||||
>
|
||||
{inputs.contents.map(output => (
|
||||
<EntityLayout.Route
|
||||
|
||||
Reference in New Issue
Block a user