NavGroup
Navigation group includes all the actions or items in a single group and is used for grouping items into related categories.
Properties
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
heading | heading | Heading and accessible label for the nav group | string | undefined | — |
Slots
| Slot name | Description |
|---|---|
Default slot | The default slot used for the nav items. |
| Event | Detail Type | Description |
|---|---|---|
toggle | NordEvent | Dispatched whenever a nav item's state changes between open and closed. |
activate | NordEvent | Dispatched whenever a nav item has been marked as active |
CSS Properties
CSS Custom Properties provide more fine grain control over component presentation. We advise utilizing existing properties on the component before using these.
| Property | Description | Default |
|---|---|---|
--n-nav-group-heading-display | Controls the display of the group's heading. Set to none to hide it — useful for a slot="subnav" group whose heading repeats the parent item's label inline; the heading is still shown in the rail flyout where it titles the projected list. | block |
Dependencies
This component is internally dependent on the following components:
Usage
This section includes guidelines for designers and developers about the usage of this component in different contexts.
Do
- Group navigation items into navigation groups based on related categories.
- Use group headings to clarify the category of a section.
- Use icons for all top level navigation items.
Don’t
- Don’t use for grouping other types of content.
Content guidelines
When writing navigation item labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):
Avoid unnecessary words and articles in item labels, such as “the”, “an” or “a”:
Avoid ending item labels in punctuation:
Use as few words as possible to describe each item label:
Avoid all caps for item labels and group titles:
Integration
For integration guidelines, please see Web Components documentation .