Vertical Tabs
- HTML/CSS:Dev Ready
- Layout:Desktop Only
A component that shows groups of content, separated into tabs, and controlled by the tabs
Base
Preview
About Base
The default Vertical Tabs component renders a list of tabs and their related content. The tab list is not truncated by default, but truncation can be added with a modifier class on the link elements.
About Vertical Tabs
The Vertical Tabs component serves as a container to show groups of content, divided into tabs. Each tab label should correspond with a block of related content. Only one tab's contents are visible at any given time.
This component varies from the regular 'tabs' component, with the tabs arranged on the left in a vertical space, instead of on the top in a horizontal space.
Implementation Notes and Requirements
The Tab Component has the following markup requirements:
- The
.slds-is-activemodifier class is required on the.slds-vertical-tabs__nav-itemelement that is active (its content is being shown). - The
.slds-has-focusmodifier class is required on the.slds-vertical-tabs__nav-itemelement that has focus. - The
.slds-showmodifier class is required on the.slds-vertical-tabs__contentelement that is being shown (their tab label is selected). - The
.slds-hidemodifier class is required on all.slds-vertical-tabs__contentelements that are not being shown (their tab label is not selected). - If an icon or badge is to be used in combination with a tab nav item label, you can wrap an icon on the left of the label in a
spanwith the classslds-vertical-tabs__left-icon. If you require an icon or badge to the right of the label, you can wrap the element in aspanwith the classslds-vertical-tabs__right-icon.
Accessibility
Vertical Tabbed UIs have three parts with specific ARIA role requirements:
- The tab list, which should have
role="tablist" - The tabs in that list, which should each be an
<a role="tab">anchor wrapped in a<li role="presentation">li - The tab panels, which display each tab's content and should each have
role="tabpanel"
Expected markup:
- Selected tab’s anchor has
aria-selected="true", all other tabs’ anchors havearia-selected="false" - Selected tab’s anchor has
tabindex="0", all other tabs havetabindex="-1" - Each tab’s anchor has an
aria-controlsattribute whose value is the id of the associated<div role="tabpanel"> - Each tab panel has an
aria-labelledbyattribute whose value is the id of its associated<a role="tab">
Expected keyboard interactions:
- Arrow keys, when focus is on selected tab, cycle selection to the next or previous tab
- Tab key, when focus is before the tab list, moves focus to the selected tab
- Tab key, when focus is on selected tab, moves focus into the selected tab’s associated tab panel or to the next focusable element on the page if that panel has no focusable elements
- Shift+Tab keys, when focus is on first element in a tab panel, move focus to the selected tab
Overview of CSS Classes
- Selector
- The CSS class being referred to.
- Summary
- A description of what the class does.
- Support
- Whether the class name is dev-ready (meaning it's fully vetted and tested and safe to use) or prototype (which means it's not fully vetted yet).
- Restrict
- The selector that the class name is allowed to be used on.
- Variant
- The base level pattern for a component. A variant can be extended to create another variant of that component, for example, a stateful button is a derivative of the base button.
- Modifier
- A single class that can be added to an HTML element of a component to modify its output. Typically these will be colors, sizing and positioning.
| Selector | .slds-vertical-tabs |
|---|---|
| Summary | Renders a vertical tablist. |
| Support | dev-ready |
| Restrict | div, section |
| Variant | True |
| Selector | .slds-vertical-tabs__nav |
|---|---|
| Summary | Tab navigation container element |
| Restrict | .slds-vertical-tabs > ul |
| Selector | .slds-vertical-tabs__nav-item |
|---|---|
| Summary | Tab navigation item |
| Restrict | .slds-vertical-tabs__nav li |
| Selector | .slds-vertical-tabs__link |
|---|---|
| Summary | Tab Navigation Link |
| Restrict | .slds-vertical-tabs__nav-item a |
| Selector | .slds-vertical-tabs__left-icon |
|---|---|
| Summary | Left icon inside of vertical tabs nav item |
| Restrict | .slds-vertical-tabs__nav-item span |
| Selector | .slds-vertical-tabs__right-icon |
|---|---|
| Summary | Right icon inside of vertical tabs nav item |
| Restrict | .slds-vertical-tabs__nav-item span |
| Selector | .slds-is-active |
|---|---|
| Summary | Active state for a tab navigation item |
| Restrict | .slds-vertical-tabs__nav-item |
| Modifier | True |
| Selector | .slds-has-focus |
|---|---|
| Summary | Focus state for a tab navigation item |
| Restrict | .slds-vertical-tabs__nav-item |
| Modifier | True |
| Selector | .slds-vertical-tabs__content |
|---|---|
| Summary | Tab Content Container |
| Restrict | .slds-vertical-tabs div |