TabGroup
Tab Group allows multiple panels to be contained within a single window, using tabs as a navigational element.
Properties
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
label | label | Adds an accessible label to the tab list container. | string | '' |
padding | padding | Controls the padding of the tab group component. | 'm' | 'l' | 'none' | undefined | 'm' |
sticky | sticky | Whether the tab list sticks to the top of the tab group as you scroll. | boolean | false |
Slots
| Slot name | Description |
|---|---|
Default slot | The element which contains the content to be revealed. |
tab | The element which contains all tabs to reveal tabbed content. |
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-tab-group-padding | Controls the padding around the tab group (including the tab list), using our spacing tokens. | 0 |
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
- Use to allow multiple panels to be contained within a single window.
- Use the tab panel and tab components within the tab group component.
- Use the tab and tab panel components in order to create a tab group content structure.
Don’t
- Don’t use tabs to navigate to other pages. Use navigation or links instead.
- Don't use other components to the tab and tab panel within the tab group component.
- Don't obscure important information within a tab panel that isn't revealed by default.
- Don't add a tab or tab panel component without providing an accompanying panel or tab.
Content guidelines
When writing tab 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 tab labels, such as “the”, “an” or “a”:
Avoid ending tab labels in punctuation:
Use as few words as possible to describe each tab label:
Avoid all caps for tab labels:
Additional considerations
- If the content contained within the tabs UI has significance or is important for the user to see, consider using a different form of presentation that doesn't obscure it.
- If there is a particular tab panel you wish to show out of order of the tabs UI itself consider using the
selectedoption on the tab component related to the panel to select the tab but prevent the order of the tabs being affected.
Integration
For integration guidelines, please see Web Components documentation .