Tabs

Let users navigate between related sections of content, displaying one section at a time.

Props

initialTab
number
The initially active tab (1-based index). If not set, the first tab is active.
navigation
GoabTabsNavigation
Controls URL navigation mode on tab change.
Defaults to hash.
orientation
GoabTabsOrientation
Tab layout orientation. "auto" stacks vertically on mobile, "horizontal" keeps horizontal on all screen sizes.
Defaults to auto.
testId
string
Sets a data-testid attribute for automated testing.
variant
GoabTabsVariant
Visual style variant. "segmented" shows pill-style tabs with animation.
Defaults to default.
initialTab
number
The initially active tab (1-based index). If not set, the first tab is active.
navigation
GoabTabsNavigation
Sets the navigation mode for tab switching. "hash" updates the URL hash when switching tabs.
orientation
GoabTabsOrientation
Tab layout orientation. "auto" stacks vertically on mobile (default), "horizontal" keeps horizontal on all screen sizes.
testId
string
Sets a data-testid attribute for automated testing.
variant
GoabTabsVariant
Visual style variant. "segmented" shows pill-style tabs with animation.
initialtab
number
The initially active tab (1-based index). If not set, the first tab is active.
Defaults to -1.
navigation
"hash" | "none"
Defaults to hash.
orientation
"auto" | "horizontal"
Tab layout orientation. "auto" stacks vertically on mobile, "horizontal" keeps horizontal on all screen sizes.
Defaults to auto.
testid
string
Sets a data-testid attribute for automated testing.
variant
"default" | "segmented"
Visual style variant. "segmented" shows pill-style tabs with animation.
Defaults to default.
version
"1" | "2"
Design system version for styling.
Defaults to 1.

Events

onChange
(detail: GoabTabsOnChangeDetail) => void
Callback fired when the active tab changes.
onChange
(event: GoabTabsOnChangeDetail) => void
Emits when the active tab changes. Emits the new tab index as GoabTabsOnChangeDetail.
_change
CustomEvent<{ tab: number }>

Tab Props

disabled
boolean
When true, disables the tab so it cannot be selected.
heading
string | React.ReactNode
The text label for this tab. Can also pass React nodes for custom heading content.
slug
string
URL-friendly identifier for the tab, used for hash-based navigation.
disabled
boolean
When true, disables the tab.
heading
string | TemplateRef<any>
The text label for this tab. Can also use the heading slot for custom content.
slug
string
Sets the URL slug for the tab.
disabled
boolean true | false
Defaults to false.
heading
string
The text label for this tab. Can also use the heading slot for custom content.
open
boolean true | false
Whether this tab is currently selected/active.
Defaults to false.
slug
string

Tab ReactNode

heading
ReactNode
The text label for this tab. Can also pass React nodes for custom heading content.
heading
TemplateRef
The text label for this tab. Can also pass React nodes for custom heading content.
heading
slot
The text label for this tab. Can also pass React nodes for custom heading content.
Examples

Activate a specific tab with a button

Set a specific tab to be active

Show different views of data in a table

Usage

Step 1 contentStep 2 contentStep 3 content
Don't
Don't use tabs to indicate progress.
Data the user needs to compare……with data in another tab
Don't
Don't use tabs if users need to see content from multiple tabs simultaneously.
Nested contentNested contentContent
Don't
Avoid nesting tabs inside other tabs.

Content

ContentContentContent
Don't
Don't truncate tab labels - use short labels instead.

Interaction

Open contentCompleted contentArchived content
Do
Always have one of the tabs pre-selected on page load.
All GoA Design System components are built to meet WCAG 2.2 AA standards. The following guidelines provide additional context for accessible implementation.

No accessibility-specific guidelines have been documented for this component yet.
View old component docs