Components / primitive
Tabs
Switches between labelled panels of related content.
Generated from @oods/foundry 0.10.1
- Categories
- primitive
- Contexts
- detail, form
- Readiness
proven-in-generated-apps
Playground
Documented example tabs-keyboard : ArrowRight from Overview, billing selected and focused.
The render follows the page's theme switch: light, dark or high contrast. Both frameworks render the same example.
Events it emits: change, update. Use either render above, and each event shows here with the framework that sent it.
Code
The documented example. HTML is the markup the React component renders for it, which @oods/component-styles styles.
import { Tabs } from '@oods/components-react';
import '@oods/component-styles/css';
const items = [
{
"id": "overview",
"label": "Overview",
"panel": "Summary"
},
{
"id": "billing",
"label": "Billing",
"panel": "Invoices"
}
];
export function Example() {
return (
<Tabs
ariaLabel="Account sections"
defaultSelectedId="overview"
items={items}
/>
);
}Props, slots and events
Contract version 1.1.0. Types are from the React declarations in @oods/components-react.
| Prop | Type | Required | Documented example |
|---|---|---|---|
items | readonly TabItem[] | yes | [{"id":"overview","label":"Overview","panel":"Summary"},{"id":"billing","label":"Billing","panel":"Invoices"}] |
selected | string | undefined | no | |
default | string | undefined | no | overview |
size | ComponentSize | undefined | no | |
overflow | string | undefined | no | |
aria | string | undefined | no | Account sections |
Slots
itemLabel, panel
Events
change, update
States
selected, unselected, disabled, overflow
Accessibility
- Role
tab- How it gets its name
labelon[role="tab"][data-tab-id="overview"]
Keyboard
| Key | What it does |
|---|---|
| Tab | Move focus to the named native control |
| ArrowRight | Select and focus the next tab |
Obligations in the contract
- tablist/tab/tabpanel semantics
- Arrow/Home/End keyboard navigation
- Focus follows the selected tab
Item-driven API; overflow helper and Popover remain private.
Tokens
The token roles this component reads.
tabs.backgroundtabs.bordertabs.texttabs.selectedtabs.focus
Readiness
The evidence recorded for this component, with its label.
proven-in-generated-apps: catalog_list gives this label when generated React and Vue apps in the runtime sweep that ships with this version both use the component. That sweep was measured on the published 0.4.1, not on this version.
| Evidence | React | Vue |
|---|---|---|
| state | implemented-evidence-complete | implemented-evidence-complete |
| versioned contract | passed | passed |
| target implementation | passed | passed |
| package export | passed | passed |
| public declaration | passed | passed |
| dependency closure | passed | passed |
| framework scenario | passed | passed |
| accessibility | verified | verified |
| interaction | verified | verified |
| visual themes | verified | verified |
Use your own
You can replace this component with your own React or Vue component. Map it, and generated code imports yours at the exact version you name. A contract report, run in a real browser, lists what your component met, what it didn't, and what wasn't checked.
The component_map call, with the parts in angle brackets yours to fill:
{
"action": "create",
"apply": true,
"externalSystem": "<your design system>",
"externalComponent": "<YourTabs>",
"oodsTraits": [
"<trait names>"
],
"substitution": {
"component": "Tabs",
"react": {
"package": "<your-package>/react",
"version": "<exact version>",
"export": "<YourTabs>"
},
"vue": {
"package": "<your-package>/vue",
"version": "<exact version>",
"export": "<YourTabs>"
}
}
} How this page was made
Generated at build from the published data, each source with the hash of what was read. The page's manifest.
- Contract:
@oods/component-contracts@0.10.1 componentContracts.Tabssha256:35095ba5f082… - Documented example:
@oods/component-contracts@0.10.1 sharedScenarios tabs-keyboardsha256:af0db6d84520… - Catalog entry (catalog_list):
generated/0.10.1/system/catalog.json Tabssha256:980d758b0582… - React readiness:
@oods/components-react@0.10.1 readiness Tabssha256:857c8b7578b0… - Vue readiness:
@oods/components-vue@0.10.1 readiness Tabssha256:ff979a83cccb… - Prop types:
generated/0.10.1/components/prop-types.json Tabssha256:8f0882c95cc6…