Storybook
SketchExamples
Code
React
<Tabs> component
Tabs is a container component that manages the state of your tabs for you. In most cases, you'll want to use this component rather than the presentational components (Tab, TabPanel) on their own.
| Name | Type | Default | Description |
|---|---|---|---|
childrenrequired | React.ReactNode | Must only contain | |
defaultSelectedId | string | Sets the initial selected | |
onChange | (selectedId: string, prevSelectedId: string) => any | A callback function that's invoked when the selected tab is changed.
| |
tablistClassName | string | Additional classes to be added to the component wrapping the tabs |
<TabPanel> component
A TabPanel is a presentational component which accepts a tab's content as its children.
| Name | Type | Default | Description |
|---|---|---|---|
childrenrequired | React.ReactNode | ||
className | string | Additional classes to be added to the root element. | |
idrequired | string | A unique | |
selected | boolean | false | |
disabled | boolean | ||
tab | string | The associated tab's label. Only applicable when the panel is a
child of | |
tabClassName | string | Additional classes for the associated tab. Only applicable when the panel
is a child of | |
tabHref | string | The associated tab's | |
tabId | string | The |
Styles
The following Sass variables can be overridden to customize Tab components:
Guidance
When to use
- If you have sub-sections of a page, and there's the need to only show one sub-section at a time.
When to consider alternatives
- If you have more than four tabs. Consider using a different pattern if your content requires being split into more than four panels.
- If the panel contents can be displayed at once. This will improve the scanability of your page's content and it's more likely the user will be able to find what they're looking for. Typography, including clear section headers, should be enough to allow the user to navigate the page.
Usage
- Avoid overflowing tabs to new lines. If the tabs can't fit on one row on small screens, consider using utility classes to apply additional responsive styles or use a different pattern.
- Tab labels should be descriptive of their content and set the user's expectations.
- Tab labels should be short — aim for no more than two words.
Accessibility
- Use an anchor link (
a) to create the tabs. This allows you to link directly to a tab, and allows you to progressively enhance the page, retaining default browser behavior like opening links in a new window. Note: You'll need to implement the logic for selecting the correct tab based on the current URL. - Ensure the HTML markup includes the proper ARIA attributes:
- For tabs:
role,aria-selected,aria-controls - For the tabs list parent:
role,aria-label - For a tab panel:
role,aria-labelledby
- For tabs:
Related patterns
Learn more
Component maturity
For more information about how we tested and validated our work for each checklist item, read our component maturity documentation.