update doc
Signed-off-by: Andreas Berger <andreas@berger-ecommerce.com>
This commit is contained in:
@@ -696,3 +696,63 @@ filter:
|
||||
targetRef:
|
||||
$in: [group:default/admins, group:default/viewers]
|
||||
```
|
||||
|
||||
### Configure groups, titles, and icons
|
||||
|
||||
You can define and customize the tab groups that appear on the entity page, as well as enable icons for both groups and individual tabs.
|
||||
|
||||
```yaml
|
||||
app:
|
||||
extensions:
|
||||
# Entity page (new frontend system)
|
||||
- page:catalog/entity:
|
||||
config:
|
||||
# Show icons next to group and tab titles
|
||||
showIcons: true
|
||||
|
||||
# Optionally override default groups and their icons
|
||||
groups:
|
||||
- overview:
|
||||
title: Overview
|
||||
icon: dashboard
|
||||
- quality:
|
||||
title: Quality
|
||||
icon: verified
|
||||
- documentation:
|
||||
title: Docs
|
||||
icon: description
|
||||
```
|
||||
|
||||
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 Icons blueprint in the frontend system documentation).
|
||||
- Group icons are only rendered if `showIcons` is set to `true`.
|
||||
|
||||
### Overriding or disabling a tab's group (per extension)
|
||||
|
||||
Each entity content extension (tabs on the entity page) can declare a default `group` in code. You can override or disable this per installation in `app-config.yaml` using the extension's config:
|
||||
|
||||
```yaml
|
||||
app:
|
||||
extensions:
|
||||
# ...
|
||||
# Example entity content extension instance id
|
||||
- entity-content:example/my-content:
|
||||
config:
|
||||
# Move this tab to a custom group you defined above
|
||||
group: custom
|
||||
# Show an icon for this entity content page but only if
|
||||
icon: my-icon
|
||||
|
||||
# Disassociate from any group and show as a standalone tab
|
||||
- entity-content:example/another-content:
|
||||
config:
|
||||
group: false
|
||||
```
|
||||
|
||||
### Tab icons for entity content
|
||||
|
||||
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 icon id must be available in the app's enabled icon bundles.
|
||||
|
||||
Reference in New Issue
Block a user