Tabs

Tabs organize content into multiple sections and allow users to navigate between them. The content under the set of tabs should be related and form a coherent unit.

installyarn add @adobe/react-spectrum
version3.0.1
usageimport {Item, TabList, TabPanels, Tabs} from '@adobe/react-spectrum'

Example#


<Tabs aria-label="History of Ancient Rome">
  <TabList>
    <Item key="FoR">Founding of Rome</Item>
    <Item key="MaR">Monarchy and Republic</Item>
    <Item key="Emp">Empire</Item>
  </TabList>
  <TabPanels>
    <Item key="FoR">Arma virumque cano, Troiae qui primus ab oris.</Item>
    <Item key="MaR">Senatus Populusque Romanus.</Item>
    <Item key="Emp">Alea jacta est.</Item>
  </TabPanels>
</Tabs>
<Tabs aria-label="History of Ancient Rome">
  <TabList>
    <Item key="FoR">Founding of Rome</Item>
    <Item key="MaR">Monarchy and Republic</Item>
    <Item key="Emp">Empire</Item>
  </TabList>
  <TabPanels>
    <Item key="FoR">
      Arma virumque cano, Troiae qui primus ab oris.
    </Item>
    <Item key="MaR">Senatus Populusque Romanus.</Item>
    <Item key="Emp">Alea jacta est.</Item>
  </TabPanels>
</Tabs>
<Tabs aria-label="History of Ancient Rome">
  <TabList>
    <Item key="FoR">
      Founding of Rome
    </Item>
    <Item key="MaR">
      Monarchy and
      Republic
    </Item>
    <Item key="Emp">
      Empire
    </Item>
  </TabList>
  <TabPanels>
    <Item key="FoR">
      Arma virumque
      cano, Troiae qui
      primus ab oris.
    </Item>
    <Item key="MaR">
      Senatus
      Populusque
      Romanus.
    </Item>
    <Item key="Emp">
      Alea jacta est.
    </Item>
  </TabPanels>
</Tabs>

Content#


Tabs expects <TabList> and <TabPanels> elements as children, however additional elements may wrap them to allow for layout flexibility. TabList and TabPanels follow the Collection Components API, accepting both static and dynamic collections. TabList and TabPanel accept <Item> elements as children, each with a key prop. The key passed to the TabList <Item> must match its corresponding TabPanel <Item>. Static collections, as in the previous example, can be used when the full list of tabs and their contents is known ahead of time.

Dynamic collections, as shown below, can be used when the options come from an external data source such as an API call, or update over time. As seen below, an iterable list of options is passed to the Tabs using the items prop. Each item accepts a key prop, which is passed to the onSelectionChange handler to identify the selected item. Alternatively, if the item objects contain an id property, as shown in the example below, then this is used automatically and a key prop is not required. See the Events section for more detail on selection.

function Example() {
  let tabs = [
    {
      id: 1,
      name: 'Founding of Rome',
      children: 'Arma virumque cano, Troiae qui primus ab oris.'
    },
    {
      id: 2,
      name: 'Monarchy and Republic',
      children: 'Senatus Populusque Romanus.'
    },
    {id: 3, name: 'Empire', children: 'Alea jacta est.'}
  ];
  let [tabId, setTabId] = React.useState(1);

  return (
    <>
      <p>Current tab id: {tabId}</p>
      <Tabs
        aria-label="History of Ancient Rome"
        items={tabs}
        onSelectionChange={setTabId}>
        <TabList>{(item) => <Item>{item.name}</Item>}</TabList>
        <TabPanels>{(item) => <Item>{item.children}</Item>}</TabPanels>
      </Tabs>
    </>
  );
}
function Example() {
  let tabs = [
    {
      id: 1,
      name: 'Founding of Rome',
      children:
        'Arma virumque cano, Troiae qui primus ab oris.'
    },
    {
      id: 2,
      name: 'Monarchy and Republic',
      children: 'Senatus Populusque Romanus.'
    },
    {id: 3, name: 'Empire', children: 'Alea jacta est.'}
  ];
  let [tabId, setTabId] = React.useState(1);

  return (
    <>
      <p>Current tab id: {tabId}</p>
      <Tabs
        aria-label="History of Ancient Rome"
        items={tabs}
        onSelectionChange={setTabId}>
        <TabList>
          {(item) => <Item>{item.name}</Item>}
        </TabList>
        <TabPanels>
          {(item) => <Item>{item.children}</Item>}
        </TabPanels>
      </Tabs>
    </>
  );
}
function Example() {
  let tabs = [
    {
      id: 1,
      name:
        'Founding of Rome',
      children:
        'Arma virumque cano, Troiae qui primus ab oris.'
    },
    {
      id: 2,
      name:
        'Monarchy and Republic',
      children:
        'Senatus Populusque Romanus.'
    },
    {
      id: 3,
      name: 'Empire',
      children:
        'Alea jacta est.'
    }
  ];
  let [
    tabId,
    setTabId
  ] = React.useState(1);

  return (
    <>
      <p>
        Current tab id:{' '}
        {tabId}
      </p>
      <Tabs
        aria-label="History of Ancient Rome"
        items={tabs}
        onSelectionChange={
          setTabId
        }>
        <TabList>
          {(item) => (
            <Item>
              {item.name}
            </Item>
          )}
        </TabList>
        <TabPanels>
          {(item) => (
            <Item>
              {
                item.children
              }
            </Item>
          )}
        </TabPanels>
      </Tabs>
    </>
  );
}

Internationalization#

To internationalize Tabs, a localized string should be passed as children to the TabList <Item>. Any text content within the Tab's panel should also be localized accordingly. For languages that are read right-to-left (e.g. Hebrew and Arabic), the layout of Tabs is automatically flipped.

Icons in tabs#

Icons can also be used in Tabs in addition to a text label. Tabs use Slots in order to style Icons and Text together.

<Tabs aria-label="History of Ancient Rome">
  <TabList>
    <Item key="FoR">
      <Bookmark />
      <Text>Founding of Rome</Text>
    </Item>
    <Item key="MaR">
      <Calendar />
      <Text>Monarchy and Republic</Text>
    </Item>
    <Item key="Emp">
      <Dashboard />
      <Text>Empire</Text>
    </Item>
  </TabList>
  <TabPanels>
    <Item key="FoR">Arma virumque cano, Troiae qui primus ab oris.</Item>
    <Item key="MaR">Senatus Populusque Romanus.</Item>
    <Item key="Emp">Alea jacta est.</Item>
  </TabPanels>
</Tabs>
<Tabs aria-label="History of Ancient Rome">
  <TabList>
    <Item key="FoR">
      <Bookmark />
      <Text>Founding of Rome</Text>
    </Item>
    <Item key="MaR">
      <Calendar />
      <Text>Monarchy and Republic</Text>
    </Item>
    <Item key="Emp">
      <Dashboard />
      <Text>Empire</Text>
    </Item>
  </TabList>
  <TabPanels>
    <Item key="FoR">
      Arma virumque cano, Troiae qui primus ab oris.
    </Item>
    <Item key="MaR">Senatus Populusque Romanus.</Item>
    <Item key="Emp">Alea jacta est.</Item>
  </TabPanels>
</Tabs>
<Tabs aria-label="History of Ancient Rome">
  <TabList>
    <Item key="FoR">
      <Bookmark />
      <Text>
        Founding of
        Rome
      </Text>
    </Item>
    <Item key="MaR">
      <Calendar />
      <Text>
        Monarchy and
        Republic
      </Text>
    </Item>
    <Item key="Emp">
      <Dashboard />
      <Text>
        Empire
      </Text>
    </Item>
  </TabList>
  <TabPanels>
    <Item key="FoR">
      Arma virumque
      cano, Troiae qui
      primus ab oris.
    </Item>
    <Item key="MaR">
      Senatus
      Populusque
      Romanus.
    </Item>
    <Item key="Emp">
      Alea jacta est.
    </Item>
  </TabPanels>
</Tabs>

Customizing layout#

If you need to add additional structure to Tabs such as buttons in-line with the TabList, we support this too. TabList and TabPanels are not required to be the immediate children of Tabs.

function Example() {
  let [tabs, setTabs] = React.useState([
    {name: 'Tab 1', children: 'Tab Body 1'},
    {name: 'Tab 2', children: 'Tab Body 2'},
    {name: 'Tab 3', children: 'Tab Body 3'}
  ]);
  let addTab = () => {
    let newTabs = [...tabs];
    newTabs.push({
      name: `Tab ${tabs.length + 1}`,
      children: `Tab Body ${tabs.length + 1}`
    });

    setTabs(newTabs);
  };

  let removeTab = () => {
    if (tabs.length > 1) {
      let newTabs = [...tabs];
      newTabs.pop();
      setTabs(newTabs);
    }
  };

  return (
    <Tabs {...props} aria-label="Tab example" items={tabs}>
      <Flex>
        <TabList flex="1 1 auto" minWidth="0px">
          {(item) => <Item key={item.name}>{item.name}</Item>}
        </TabList>
        <div
          style={{
            display: 'flex',
            flex: '0 0 auto',
            borderBottom:
              'var(--spectrum-alias-border-size-thick) solid var(--spectrum-global-color-gray-200)'
          }}>
          <ActionGroup
            disabledKeys={tabs.length === 1 ? ['remove'] : undefined}
            onAction={(val) => (val === 'add' ? addTab() : removeTab())}>
            <Item key="add">Add Tab</Item>
            <Item key="remove">Remove Tab</Item>
          </ActionGroup>
        </div>
      </Flex>
      <TabPanels>
        {(item) => <Item key={item.name}>{item.children}</Item>}
      </TabPanels>
    </Tabs>
  );
}
function Example() {
  let [tabs, setTabs] = React.useState([
    {name: 'Tab 1', children: 'Tab Body 1'},
    {name: 'Tab 2', children: 'Tab Body 2'},
    {name: 'Tab 3', children: 'Tab Body 3'}
  ]);
  let addTab = () => {
    let newTabs = [...tabs];
    newTabs.push({
      name: `Tab ${tabs.length + 1}`,
      children: `Tab Body ${tabs.length + 1}`
    });

    setTabs(newTabs);
  };

  let removeTab = () => {
    if (tabs.length > 1) {
      let newTabs = [...tabs];
      newTabs.pop();
      setTabs(newTabs);
    }
  };

  return (
    <Tabs {...props} aria-label="Tab example" items={tabs}>
      <Flex>
        <TabList flex="1 1 auto" minWidth="0px">
          {(item) => (
            <Item key={item.name}>{item.name}</Item>
          )}
        </TabList>
        <div
          style={{
            display: 'flex',
            flex: '0 0 auto',
            borderBottom:
              'var(--spectrum-alias-border-size-thick) solid var(--spectrum-global-color-gray-200)'
          }}>
          <ActionGroup
            disabledKeys={
              tabs.length === 1 ? ['remove'] : undefined
            }
            onAction={(val) =>
              val === 'add' ? addTab() : removeTab()
            }>
            <Item key="add">Add Tab</Item>
            <Item key="remove">Remove Tab</Item>
          </ActionGroup>
        </div>
      </Flex>
      <TabPanels>
        {(item) => (
          <Item key={item.name}>{item.children}</Item>
        )}
      </TabPanels>
    </Tabs>
  );
}
function Example() {
  let [
    tabs,
    setTabs
  ] = React.useState([
    {
      name: 'Tab 1',
      children:
        'Tab Body 1'
    },
    {
      name: 'Tab 2',
      children:
        'Tab Body 2'
    },
    {
      name: 'Tab 3',
      children:
        'Tab Body 3'
    }
  ]);
  let addTab = () => {
    let newTabs = [
      ...tabs
    ];
    newTabs.push({
      name: `Tab ${
        tabs.length + 1
      }`,
      children: `Tab Body ${
        tabs.length + 1
      }`
    });

    setTabs(newTabs);
  };

  let removeTab = () => {
    if (
      tabs.length > 1
    ) {
      let newTabs = [
        ...tabs
      ];
      newTabs.pop();
      setTabs(newTabs);
    }
  };

  return (
    <Tabs
      {...props}
      aria-label="Tab example"
      items={tabs}>
      <Flex>
        <TabList
          flex="1 1 auto"
          minWidth="0px">
          {(item) => (
            <Item
              key={
                item.name
              }>
              {item.name}
            </Item>
          )}
        </TabList>
        <div
          style={{
            display:
              'flex',
            flex:
              '0 0 auto',
            borderBottom:
              'var(--spectrum-alias-border-size-thick) solid var(--spectrum-global-color-gray-200)'
          }}>
          <ActionGroup
            disabledKeys={
              tabs.length ===
              1
                ? [
                    'remove'
                  ]
                : undefined
            }
            onAction={(
              val
            ) =>
              val ===
              'add'
                ? addTab()
                : removeTab()
            }>
            <Item key="add">
              Add Tab
            </Item>
            <Item key="remove">
              Remove Tab
            </Item>
          </ActionGroup>
        </div>
      </Flex>
      <TabPanels>
        {(item) => (
          <Item
            key={
              item.name
            }>
            {
              item.children
            }
          </Item>
        )}
      </TabPanels>
    </Tabs>
  );
}

Labeling#


Accessibility#

While an aria-label is not explicitly required for a tab list, Tabs should be labeled using a aria-label in the absence of an ancestor landmark. This will prevent screen readers from announcing non-focused tabs, allowing for a more focused experience.

Selection#


Setting a selected tab can be done by using the defaultSelectedKey or selectedKey prop. The selected key corresponds to the key of an item. See Events for more details on selection events. Additionally, see the react-stately Selection docs for caveats regarding selection prop typing.

function Example() {
  let tabs = [
    {id: 1, name: 'Keyboard Settings', children: 'No keyboard detected.'},
    {id: 2, name: 'Mouse Settings', children: 'No mouse detected.'},
    {id: 3, name: 'Gamepad Settings', children: 'No gamepad detected'}
  ];
  let [tab, setTab] = React.useState(2);

  return (
    <Flex gap="size-150" wrap>
      <span id="label-2">Settings (uncontrolled)</span>
      <Tabs
        aria-labelledby="label-2"
        items={tabs}
        defaultSelectedKey={2}
        marginBottom="size-400">
        <TabList>{(item) => <Item>{item.name}</Item>}</TabList>
        <TabPanels>{(item) => <Item>{item.children}</Item>}</TabPanels>
      </Tabs>
      <span id="label-3">Settings (controlled)</span>
      <Tabs
        aria-labelledby="label-3"
        items={tabs}
        selectedKey={tab}
        onSelectionChange={setTab}>
        <TabList>{(item) => <Item>{item.name}</Item>}</TabList>
        <TabPanels>{(item) => <Item>{item.children}</Item>}</TabPanels>
      </Tabs>
    </Flex>
  );
}
function Example() {
  let tabs = [
    {
      id: 1,
      name: 'Keyboard Settings',
      children: 'No keyboard detected.'
    },
    {
      id: 2,
      name: 'Mouse Settings',
      children: 'No mouse detected.'
    },
    {
      id: 3,
      name: 'Gamepad Settings',
      children: 'No gamepad detected'
    }
  ];
  let [tab, setTab] = React.useState(2);

  return (
    <Flex gap="size-150" wrap>
      <span id="label-2">Settings (uncontrolled)</span>
      <Tabs
        aria-labelledby="label-2"
        items={tabs}
        defaultSelectedKey={2}
        marginBottom="size-400">
        <TabList>
          {(item) => <Item>{item.name}</Item>}
        </TabList>
        <TabPanels>
          {(item) => <Item>{item.children}</Item>}
        </TabPanels>
      </Tabs>
      <span id="label-3">Settings (controlled)</span>
      <Tabs
        aria-labelledby="label-3"
        items={tabs}
        selectedKey={tab}
        onSelectionChange={setTab}>
        <TabList>
          {(item) => <Item>{item.name}</Item>}
        </TabList>
        <TabPanels>
          {(item) => <Item>{item.children}</Item>}
        </TabPanels>
      </Tabs>
    </Flex>
  );
}
function Example() {
  let tabs = [
    {
      id: 1,
      name:
        'Keyboard Settings',
      children:
        'No keyboard detected.'
    },
    {
      id: 2,
      name:
        'Mouse Settings',
      children:
        'No mouse detected.'
    },
    {
      id: 3,
      name:
        'Gamepad Settings',
      children:
        'No gamepad detected'
    }
  ];
  let [
    tab,
    setTab
  ] = React.useState(2);

  return (
    <Flex
      gap="size-150"
      wrap>
      <span id="label-2">
        Settings
        (uncontrolled)
      </span>
      <Tabs
        aria-labelledby="label-2"
        items={tabs}
        defaultSelectedKey={
          2
        }
        marginBottom="size-400">
        <TabList>
          {(item) => (
            <Item>
              {item.name}
            </Item>
          )}
        </TabList>
        <TabPanels>
          {(item) => (
            <Item>
              {
                item.children
              }
            </Item>
          )}
        </TabPanels>
      </Tabs>
      <span id="label-3">
        Settings
        (controlled)
      </span>
      <Tabs
        aria-labelledby="label-3"
        items={tabs}
        selectedKey={tab}
        onSelectionChange={
          setTab
        }>
        <TabList>
          {(item) => (
            <Item>
              {item.name}
            </Item>
          )}
        </TabList>
        <TabPanels>
          {(item) => (
            <Item>
              {
                item.children
              }
            </Item>
          )}
        </TabPanels>
      </Tabs>
    </Flex>
  );
}

Events#


Tabs supports selection via mouse, keyboard, and touch. You can handle all of these via the onSelectionChange prop. Tabs will pass the selected key to the onSelectionChange handler.

The following example uses an onSelectionChange handler to update the tab selection stored in React state.

function Example() {
  let tabs = [
    {
      name: 'Triassic',
      children:
        'The Triassic ranges roughly from 252 million to 201 million years ago, preceding the Jurassic Period.'
    },
    {
      name: 'Jurassic',
      children:
        'The Jurassic ranges from 200 million years to 145 million years ago.'
    },
    {
      name: 'Cretaceous',
      children:
        'The Cretaceous is the longest period of the Mesozoic, spanning from 145 million to 66 years ago.'
    }
  ];
  let [timePeriod, setTimePeriod] = React.useState('Triassic');

  return (
    <>
      <p>Selected time period: {timePeriod}</p>
      <Tabs
        aria-label="Mesozoic time periods"
        items={tabs}
        selectedKey={timePeriod}
        onSelectionChange={setTimePeriod}>
        <TabList>{(item) => <Item key={item.name}>{item.name}</Item>}</TabList>
        <TabPanels>
          {(item) => <Item key={item.name}>{item.children}</Item>}
        </TabPanels>
      </Tabs>
    </>
  );
}
function Example() {
  let tabs = [
    {
      name: 'Triassic',
      children:
        'The Triassic ranges roughly from 252 million to 201 million years ago, preceding the Jurassic Period.'
    },
    {
      name: 'Jurassic',
      children:
        'The Jurassic ranges from 200 million years to 145 million years ago.'
    },
    {
      name: 'Cretaceous',
      children:
        'The Cretaceous is the longest period of the Mesozoic, spanning from 145 million to 66 years ago.'
    }
  ];
  let [timePeriod, setTimePeriod] = React.useState(
    'Triassic'
  );

  return (
    <>
      <p>Selected time period: {timePeriod}</p>
      <Tabs
        aria-label="Mesozoic time periods"
        items={tabs}
        selectedKey={timePeriod}
        onSelectionChange={setTimePeriod}>
        <TabList>
          {(item) => (
            <Item key={item.name}>{item.name}</Item>
          )}
        </TabList>
        <TabPanels>
          {(item) => (
            <Item key={item.name}>{item.children}</Item>
          )}
        </TabPanels>
      </Tabs>
    </>
  );
}
function Example() {
  let tabs = [
    {
      name: 'Triassic',
      children:
        'The Triassic ranges roughly from 252 million to 201 million years ago, preceding the Jurassic Period.'
    },
    {
      name: 'Jurassic',
      children:
        'The Jurassic ranges from 200 million years to 145 million years ago.'
    },
    {
      name: 'Cretaceous',
      children:
        'The Cretaceous is the longest period of the Mesozoic, spanning from 145 million to 66 years ago.'
    }
  ];
  let [
    timePeriod,
    setTimePeriod
  ] = React.useState(
    'Triassic'
  );

  return (
    <>
      <p>
        Selected time
        period:{' '}
        {timePeriod}
      </p>
      <Tabs
        aria-label="Mesozoic time periods"
        items={tabs}
        selectedKey={
          timePeriod
        }
        onSelectionChange={
          setTimePeriod
        }>
        <TabList>
          {(item) => (
            <Item
              key={
                item.name
              }>
              {item.name}
            </Item>
          )}
        </TabList>
        <TabPanels>
          {(item) => (
            <Item
              key={
                item.name
              }>
              {
                item.children
              }
            </Item>
          )}
        </TabPanels>
      </Tabs>
    </>
  );
}

Keyboard Activation#

By default, pressing the arrow keys while focus is on a Tab will switch selection to the adjacent Tab in that direction, updating the content displayed accordingly. If you would like to prevent selection change from happening automatically you can set the keyboardActivation prop to "manual". This will prevent tab selection from changing on arrow key press, requiring a subsequent Enter or Space key press to confirm tab selection.

function Example() {
  let tabs = [
    {
      name: 'Triassic',
      children:
        'The Triassic ranges roughly from 252 million to 201 million years ago, preceding the Jurassic Period.'
    },
    {
      name: 'Jurassic',
      children:
        'The Jurassic ranges from 200 million years to 145 million years ago.'
    },
    {
      name: 'Cretaceous',
      children:
        'The Cretaceous is the longest period of the Mesozoic, spanning from 145 million to 66 years ago.'
    }
  ];

  return (
    <Tabs
      aria-label="Mesozoic time periods"
      items={tabs}
      keyboardActivation="manual">
      <TabList>{(item) => <Item key={item.name}>{item.name}</Item>}</TabList>
      <TabPanels>
        {(item) => <Item key={item.name}>{item.children}</Item>}
      </TabPanels>
    </Tabs>
  );
}
function Example() {
  let tabs = [
    {
      name: 'Triassic',
      children:
        'The Triassic ranges roughly from 252 million to 201 million years ago, preceding the Jurassic Period.'
    },
    {
      name: 'Jurassic',
      children:
        'The Jurassic ranges from 200 million years to 145 million years ago.'
    },
    {
      name: 'Cretaceous',
      children:
        'The Cretaceous is the longest period of the Mesozoic, spanning from 145 million to 66 years ago.'
    }
  ];

  return (
    <Tabs
      aria-label="Mesozoic time periods"
      items={tabs}
      keyboardActivation="manual">
      <TabList>
        {(item) => <Item key={item.name}>{item.name}</Item>}
      </TabList>
      <TabPanels>
        {(item) => (
          <Item key={item.name}>{item.children}</Item>
        )}
      </TabPanels>
    </Tabs>
  );
}
function Example() {
  let tabs = [
    {
      name: 'Triassic',
      children:
        'The Triassic ranges roughly from 252 million to 201 million years ago, preceding the Jurassic Period.'
    },
    {
      name: 'Jurassic',
      children:
        'The Jurassic ranges from 200 million years to 145 million years ago.'
    },
    {
      name: 'Cretaceous',
      children:
        'The Cretaceous is the longest period of the Mesozoic, spanning from 145 million to 66 years ago.'
    }
  ];

  return (
    <Tabs
      aria-label="Mesozoic time periods"
      items={tabs}
      keyboardActivation="manual">
      <TabList>
        {(item) => (
          <Item
            key={
              item.name
            }>
            {item.name}
          </Item>
        )}
      </TabList>
      <TabPanels>
        {(item) => (
          <Item
            key={
              item.name
            }>
            {
              item.children
            }
          </Item>
        )}
      </TabPanels>
    </Tabs>
  );
}

Props#


Tabs Props#

NameTypeDefaultDescription
childrenReactNodeThe children of the element. Should include <TabList> and <TabPanels> elements.
itemsIterable<T>The item objects for each tab, for dynamic collections.
disabledKeysIterable<Key>The keys of the tabs that are disabled. These tabs cannot be selected, focused, or otherwise interacted with.
isQuietbooleanWhether the tabs are displayed in a quiet style.
density'compact''regular'The amount of space between the tabs.
keyboardActivation'automatic''manual''automatic'Whether tabs are activated automatically on focus or manually.
orientationOrientation'horizontal'The orientation of the tabs.
isDisabledbooleanWhether the Tabs are disabled. Shows that a selection exists, but is not available in that circumstance.
disallowEmptySelectionbooleanWhether the collection allows empty selection.
selectedKeyKeyThe currently selected key in the collection (controlled).
defaultSelectedKeyKeyThe initial selected key in the collection (uncontrolled).
Events
NameTypeDefaultDescription
onSelectionChange( (key: Key )) => anyHandler that is called when the selection changes.
Layout
NameTypeDefaultDescription
flexResponsive<stringnumberboolean>When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
flexGrowResponsive<number>When used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
flexShrinkResponsive<number>When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
flexBasisResponsive<numberstring>When used in a flex layout, specifies the initial main size of the element. See MDN.
alignSelfResponsive<'auto''normal''start''end''center''flex-start''flex-end''self-start''self-end''stretch'>Overrides the alignItems property of a flex or grid container. See MDN.
justifySelfResponsive<'auto''normal''start''end''flex-start''flex-end''self-start''self-end''center''left''right''stretch'>Specifies how the element is justified inside a flex or grid container. See MDN.
orderResponsive<number>The layout order for the element within a flex or grid container. See MDN.
gridAreaResponsive<string>When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
gridColumnResponsive<string>When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
gridRowResponsive<string>When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
gridColumnStartResponsive<string>When used in a grid layout, specifies the starting column to span within the grid. See MDN.
gridColumnEndResponsive<string>When used in a grid layout, specifies the ending column to span within the grid. See MDN.
gridRowStartResponsive<string>When used in a grid layout, specifies the starting row to span within the grid. See MDN.
gridRowEndResponsive<string>When used in a grid layout, specifies the ending row to span within the grid. See MDN.
Spacing
NameTypeDefaultDescription
marginResponsive<DimensionValue>The margin for all four sides of the element. See MDN.
marginTopResponsive<DimensionValue>The margin for the top side of the element. See MDN.
marginBottomResponsive<DimensionValue>The margin for the bottom side of the element. See MDN.
marginStartResponsive<DimensionValue>The margin for the logical start side of the element, depending on layout direction. See MDN.
marginEndResponsive<DimensionValue>The margin for the logical end side of an element, depending on layout direction. See MDN.
marginXResponsive<DimensionValue>The margin for both the left and right sides of the element. See MDN.
marginYResponsive<DimensionValue>The margin for both the top and bottom sides of the element. See MDN.
Sizing
NameTypeDefaultDescription
widthResponsive<DimensionValue>The width of the element. See MDN.
minWidthResponsive<DimensionValue>The minimum width of the element. See MDN.
maxWidthResponsive<DimensionValue>The maximum width of the element. See MDN.
heightResponsive<DimensionValue>The height of the element. See MDN.
minHeightResponsive<DimensionValue>The minimum height of the element. See MDN.
maxHeightResponsive<DimensionValue>The maximum height of the element. See MDN.
Positioning
NameTypeDefaultDescription
positionResponsive<'static''relative''absolute''fixed''sticky'>Specifies how the element is positioned. See MDN.
topResponsive<DimensionValue>The top position for the element. See MDN.
bottomResponsive<DimensionValue>The bottom position for the element. See MDN.
leftResponsive<DimensionValue>The left position for the element. See MDN. Consider using start instead for RTL support.
rightResponsive<DimensionValue>The right position for the element. See MDN. Consider using start instead for RTL support.
startResponsive<DimensionValue>The logical start position for the element, depending on layout direction. See MDN.
endResponsive<DimensionValue>The logical end position for the element, depending on layout direction. See MDN.
zIndexResponsive<number>The stacking order for the element. See MDN.
isHiddenResponsive<boolean>Hides the element.
Accessibility
NameTypeDefaultDescription
idstringThe element's unique identifier. See MDN.
Advanced
NameTypeDefaultDescription
UNSAFE_classNamestringSets the CSS className for the element. Only use as a last resort. Use style props instead.
UNSAFE_styleCSSPropertiesSets inline style for the element. Only use as a last resort. Use style props instead.

TabList Props#

NameTypeDefaultDescription
childrenCollectionChildren<T>The tab items to display. Item keys should match the key of the corresponding <Item> within the <TabPanels> element.
Layout
NameTypeDefaultDescription
flexResponsive<stringnumberboolean>When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
flexGrowResponsive<number>When used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
flexShrinkResponsive<number>When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
flexBasisResponsive<numberstring>When used in a flex layout, specifies the initial main size of the element. See MDN.
alignSelfResponsive<'auto''normal''start''end''center''flex-start''flex-end''self-start''self-end''stretch'>Overrides the alignItems property of a flex or grid container. See MDN.
justifySelfResponsive<'auto''normal''start''end''flex-start''flex-end''self-start''self-end''center''left''right''stretch'>Specifies how the element is justified inside a flex or grid container. See MDN.
orderResponsive<number>The layout order for the element within a flex or grid container. See MDN.
gridAreaResponsive<string>When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
gridColumnResponsive<string>When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
gridRowResponsive<string>When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
gridColumnStartResponsive<string>When used in a grid layout, specifies the starting column to span within the grid. See MDN.
gridColumnEndResponsive<string>When used in a grid layout, specifies the ending column to span within the grid. See MDN.
gridRowStartResponsive<string>When used in a grid layout, specifies the starting row to span within the grid. See MDN.
gridRowEndResponsive<string>When used in a grid layout, specifies the ending row to span within the grid. See MDN.
Spacing
NameTypeDefaultDescription
marginResponsive<DimensionValue>The margin for all four sides of the element. See MDN.
marginTopResponsive<DimensionValue>The margin for the top side of the element. See MDN.
marginBottomResponsive<DimensionValue>The margin for the bottom side of the element. See MDN.
marginStartResponsive<DimensionValue>The margin for the logical start side of the element, depending on layout direction. See MDN.
marginEndResponsive<DimensionValue>The margin for the logical end side of an element, depending on layout direction. See MDN.
marginXResponsive<DimensionValue>The margin for both the left and right sides of the element. See MDN.
marginYResponsive<DimensionValue>The margin for both the top and bottom sides of the element. See MDN.
Sizing
NameTypeDefaultDescription
widthResponsive<DimensionValue>The width of the element. See MDN.
minWidthResponsive<DimensionValue>The minimum width of the element. See MDN.
maxWidthResponsive<DimensionValue>The maximum width of the element. See MDN.
heightResponsive<DimensionValue>The height of the element. See MDN.
minHeightResponsive<DimensionValue>The minimum height of the element. See MDN.
maxHeightResponsive<DimensionValue>The maximum height of the element. See MDN.
Positioning
NameTypeDefaultDescription
positionResponsive<'static''relative''absolute''fixed''sticky'>Specifies how the element is positioned. See MDN.
topResponsive<DimensionValue>The top position for the element. See MDN.
bottomResponsive<DimensionValue>The bottom position for the element. See MDN.
leftResponsive<DimensionValue>The left position for the element. See MDN. Consider using start instead for RTL support.
rightResponsive<DimensionValue>The right position for the element. See MDN. Consider using start instead for RTL support.
startResponsive<DimensionValue>The logical start position for the element, depending on layout direction. See MDN.
endResponsive<DimensionValue>The logical end position for the element, depending on layout direction. See MDN.
zIndexResponsive<number>The stacking order for the element. See MDN.
isHiddenResponsive<boolean>Hides the element.
Accessibility
NameTypeDefaultDescription
idstringThe element's unique identifier. See MDN.
Advanced
NameTypeDefaultDescription
UNSAFE_classNamestringSets the CSS className for the element. Only use as a last resort. Use style props instead.
UNSAFE_styleCSSPropertiesSets inline style for the element. Only use as a last resort. Use style props instead.

TabPanels Props#

NameTypeDefaultDescription
childrenCollectionChildren<T>The contents of each tab. Item keys should match the key of the corresponding <Item> within the <TabList> element.
Layout
NameTypeDefaultDescription
flexResponsive<stringnumberboolean>When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
flexGrowResponsive<number>When used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
flexShrinkResponsive<number>When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
flexBasisResponsive<numberstring>When used in a flex layout, specifies the initial main size of the element. See MDN.
alignSelfResponsive<'auto''normal''start''end''center''flex-start''flex-end''self-start''self-end''stretch'>Overrides the alignItems property of a flex or grid container. See MDN.
justifySelfResponsive<'auto''normal''start''end''flex-start''flex-end''self-start''self-end''center''left''right''stretch'>Specifies how the element is justified inside a flex or grid container. See MDN.
orderResponsive<number>The layout order for the element within a flex or grid container. See MDN.
gridAreaResponsive<string>When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
gridColumnResponsive<string>When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
gridRowResponsive<string>When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
gridColumnStartResponsive<string>When used in a grid layout, specifies the starting column to span within the grid. See MDN.
gridColumnEndResponsive<string>When used in a grid layout, specifies the ending column to span within the grid. See MDN.
gridRowStartResponsive<string>When used in a grid layout, specifies the starting row to span within the grid. See MDN.
gridRowEndResponsive<string>When used in a grid layout, specifies the ending row to span within the grid. See MDN.
Spacing
NameTypeDefaultDescription
marginResponsive<DimensionValue>The margin for all four sides of the element. See MDN.
marginTopResponsive<DimensionValue>The margin for the top side of the element. See MDN.
marginBottomResponsive<DimensionValue>The margin for the bottom side of the element. See MDN.
marginStartResponsive<DimensionValue>The margin for the logical start side of the element, depending on layout direction. See MDN.
marginEndResponsive<DimensionValue>The margin for the logical end side of an element, depending on layout direction. See MDN.
marginXResponsive<DimensionValue>The margin for both the left and right sides of the element. See MDN.
marginYResponsive<DimensionValue>The margin for both the top and bottom sides of the element. See MDN.
Sizing
NameTypeDefaultDescription
widthResponsive<DimensionValue>The width of the element. See MDN.
minWidthResponsive<DimensionValue>The minimum width of the element. See MDN.
maxWidthResponsive<DimensionValue>The maximum width of the element. See MDN.
heightResponsive<DimensionValue>The height of the element. See MDN.
minHeightResponsive<DimensionValue>The minimum height of the element. See MDN.
maxHeightResponsive<DimensionValue>The maximum height of the element. See MDN.
Positioning
NameTypeDefaultDescription
positionResponsive<'static''relative''absolute''fixed''sticky'>Specifies how the element is positioned. See MDN.
topResponsive<DimensionValue>The top position for the element. See MDN.
bottomResponsive<DimensionValue>The bottom position for the element. See MDN.
leftResponsive<DimensionValue>The left position for the element. See MDN. Consider using start instead for RTL support.
rightResponsive<DimensionValue>The right position for the element. See MDN. Consider using start instead for RTL support.
startResponsive<DimensionValue>The logical start position for the element, depending on layout direction. See MDN.
endResponsive<DimensionValue>The logical end position for the element, depending on layout direction. See MDN.
zIndexResponsive<number>The stacking order for the element. See MDN.
isHiddenResponsive<boolean>Hides the element.
Accessibility
NameTypeDefaultDescription
idstringThe element's unique identifier. See MDN.
Advanced
NameTypeDefaultDescription
UNSAFE_classNamestringSets the CSS className for the element. Only use as a last resort. Use style props instead.
UNSAFE_styleCSSPropertiesSets inline style for the element. Only use as a last resort. Use style props instead.

Visual options#


Density#

View guidelines

<Tabs aria-label="Chat log density example" density="compact">
  <TabList>
    <Item key="item1">John Doe</Item>
    <Item key="item2">Jane Doe</Item>
    <Item key="item3">Joe Bloggs</Item>
  </TabList>
  <TabPanels>
    <Item key="item1">There is no prior chat history with John Doe.</Item>
    <Item key="item2">There is no prior chat history with Jane Doe.</Item>
    <Item key="item3">There is no prior chat history with Joe Bloggs.</Item>
  </TabPanels>
</Tabs>
<Tabs
  aria-label="Chat log density example"
  density="compact">
  <TabList>
    <Item key="item1">John Doe</Item>
    <Item key="item2">Jane Doe</Item>
    <Item key="item3">Joe Bloggs</Item>
  </TabList>
  <TabPanels>
    <Item key="item1">
      There is no prior chat history with John Doe.
    </Item>
    <Item key="item2">
      There is no prior chat history with Jane Doe.
    </Item>
    <Item key="item3">
      There is no prior chat history with Joe Bloggs.
    </Item>
  </TabPanels>
</Tabs>
<Tabs
  aria-label="Chat log density example"
  density="compact">
  <TabList>
    <Item key="item1">
      John Doe
    </Item>
    <Item key="item2">
      Jane Doe
    </Item>
    <Item key="item3">
      Joe Bloggs
    </Item>
  </TabList>
  <TabPanels>
    <Item key="item1">
      There is no prior
      chat history with
      John Doe.
    </Item>
    <Item key="item2">
      There is no prior
      chat history with
      Jane Doe.
    </Item>
    <Item key="item3">
      There is no prior
      chat history with
      Joe Bloggs.
    </Item>
  </TabPanels>
</Tabs>

Quiet#

View guidelines

<Tabs aria-label="Chat log quiet example" isQuiet>
  <TabList>
    <Item key="item1">John Doe</Item>
    <Item key="item2">Jane Doe</Item>
    <Item key="item3">Joe Bloggs</Item>
  </TabList>
  <TabPanels>
    <Item key="item1">There is no prior chat history with John Doe.</Item>
    <Item key="item2">There is no prior chat history with Jane Doe.</Item>
    <Item key="item3">There is no prior chat history with Joe Bloggs.</Item>
  </TabPanels>
</Tabs>
<Tabs aria-label="Chat log quiet example" isQuiet>
  <TabList>
    <Item key="item1">John Doe</Item>
    <Item key="item2">Jane Doe</Item>
    <Item key="item3">Joe Bloggs</Item>
  </TabList>
  <TabPanels>
    <Item key="item1">
      There is no prior chat history with John Doe.
    </Item>
    <Item key="item2">
      There is no prior chat history with Jane Doe.
    </Item>
    <Item key="item3">
      There is no prior chat history with Joe Bloggs.
    </Item>
  </TabPanels>
</Tabs>
<Tabs
  aria-label="Chat log quiet example"
  isQuiet>
  <TabList>
    <Item key="item1">
      John Doe
    </Item>
    <Item key="item2">
      Jane Doe
    </Item>
    <Item key="item3">
      Joe Bloggs
    </Item>
  </TabList>
  <TabPanels>
    <Item key="item1">
      There is no prior
      chat history with
      John Doe.
    </Item>
    <Item key="item2">
      There is no prior
      chat history with
      Jane Doe.
    </Item>
    <Item key="item3">
      There is no prior
      chat history with
      Joe Bloggs.
    </Item>
  </TabPanels>
</Tabs>

Disabled#

View guidelines

<Flex direction="column" rowGap="size-150">
  <Tabs
    aria-label="Chat log single tab disabled example"
    disabledKeys={['item2']}>
    <TabList>
      <Item key="item1">John Doe</Item>
      <Item key="item2">Jane Doe</Item>
      <Item key="item3">Joe Bloggs</Item>
    </TabList>
    <TabPanels>
      <Item key="item1">There is no prior chat history with John Doe.</Item>
      <Item key="item2">There is no prior chat history with Jane Doe.</Item>
      <Item key="item3">There is no prior chat history with Joe Bloggs.</Item>
    </TabPanels>
  </Tabs>
  <Tabs aria-label="Chat log all tabs disabled example" isDisabled>
    <TabList>
      <Item key="item1">John Doe</Item>
      <Item key="item2">Jane Doe</Item>
      <Item key="item3">Joe Bloggs</Item>
    </TabList>
    <TabPanels>
      <Item key="item1">There is no prior chat history with John Doe.</Item>
      <Item key="item2">There is no prior chat history with Jane Doe.</Item>
      <Item key="item3">There is no prior chat history with Joe Bloggs.</Item>
    </TabPanels>
  </Tabs>
</Flex>
<Flex direction="column" rowGap="size-150">
  <Tabs
    aria-label="Chat log single tab disabled example"
    disabledKeys={['item2']}>
    <TabList>
      <Item key="item1">John Doe</Item>
      <Item key="item2">Jane Doe</Item>
      <Item key="item3">Joe Bloggs</Item>
    </TabList>
    <TabPanels>
      <Item key="item1">
        There is no prior chat history with John Doe.
      </Item>
      <Item key="item2">
        There is no prior chat history with Jane Doe.
      </Item>
      <Item key="item3">
        There is no prior chat history with Joe Bloggs.
      </Item>
    </TabPanels>
  </Tabs>
  <Tabs
    aria-label="Chat log all tabs disabled example"
    isDisabled>
    <TabList>
      <Item key="item1">John Doe</Item>
      <Item key="item2">Jane Doe</Item>
      <Item key="item3">Joe Bloggs</Item>
    </TabList>
    <TabPanels>
      <Item key="item1">
        There is no prior chat history with John Doe.
      </Item>
      <Item key="item2">
        There is no prior chat history with Jane Doe.
      </Item>
      <Item key="item3">
        There is no prior chat history with Joe Bloggs.
      </Item>
    </TabPanels>
  </Tabs>
</Flex>
<Flex
  direction="column"
  rowGap="size-150">
  <Tabs
    aria-label="Chat log single tab disabled example"
    disabledKeys={[
      'item2'
    ]}>
    <TabList>
      <Item key="item1">
        John Doe
      </Item>
      <Item key="item2">
        Jane Doe
      </Item>
      <Item key="item3">
        Joe Bloggs
      </Item>
    </TabList>
    <TabPanels>
      <Item key="item1">
        There is no
        prior chat
        history with
        John Doe.
      </Item>
      <Item key="item2">
        There is no
        prior chat
        history with
        Jane Doe.
      </Item>
      <Item key="item3">
        There is no
        prior chat
        history with
        Joe Bloggs.
      </Item>
    </TabPanels>
  </Tabs>
  <Tabs
    aria-label="Chat log all tabs disabled example"
    isDisabled>
    <TabList>
      <Item key="item1">
        John Doe
      </Item>
      <Item key="item2">
        Jane Doe
      </Item>
      <Item key="item3">
        Joe Bloggs
      </Item>
    </TabList>
    <TabPanels>
      <Item key="item1">
        There is no
        prior chat
        history with
        John Doe.
      </Item>
      <Item key="item2">
        There is no
        prior chat
        history with
        Jane Doe.
      </Item>
      <Item key="item3">
        There is no
        prior chat
        history with
        Joe Bloggs.
      </Item>
    </TabPanels>
  </Tabs>
</Flex>

Orientation#

View guidelines

<Tabs aria-label="Chat log orientation example" orientation="vertical">
  <TabList>
    <Item key="item1">John Doe</Item>
    <Item key="item2">Jane Doe</Item>
    <Item key="item3">Joe Bloggs</Item>
  </TabList>
  <TabPanels>
    <Item key="item1">There is no prior chat history with John Doe.</Item>
    <Item key="item2">There is no prior chat history with Jane Doe.</Item>
    <Item key="item3">There is no prior chat history with Joe Bloggs.</Item>
  </TabPanels>
</Tabs>
<Tabs
  aria-label="Chat log orientation example"
  orientation="vertical">
  <TabList>
    <Item key="item1">John Doe</Item>
    <Item key="item2">Jane Doe</Item>
    <Item key="item3">Joe Bloggs</Item>
  </TabList>
  <TabPanels>
    <Item key="item1">
      There is no prior chat history with John Doe.
    </Item>
    <Item key="item2">
      There is no prior chat history with Jane Doe.
    </Item>
    <Item key="item3">
      There is no prior chat history with Joe Bloggs.
    </Item>
  </TabPanels>
</Tabs>
<Tabs
  aria-label="Chat log orientation example"
  orientation="vertical">
  <TabList>
    <Item key="item1">
      John Doe
    </Item>
    <Item key="item2">
      Jane Doe
    </Item>
    <Item key="item3">
      Joe Bloggs
    </Item>
  </TabList>
  <TabPanels>
    <Item key="item1">
      There is no prior
      chat history with
      John Doe.
    </Item>
    <Item key="item2">
      There is no prior
      chat history with
      Jane Doe.
    </Item>
    <Item key="item3">
      There is no prior
      chat history with
      Joe Bloggs.
    </Item>
  </TabPanels>
</Tabs>

Collapse (overflow behavior)#

View guidelines

If there isn't enough horizontal room to render every tab on a single line, the component will collapse all tabs into a Picker. Note that this does not apply to vertical Tabs.

Try the example below to see the above behavior.

function Example() {
  let [collapse, setCollapse] = React.useState(false);

  return (
    <>
      <div
        style={{
          width: collapse ? '150px' : '300px',
          marginBottom: '50px',
          height: '150px',
          maxWidth: '100%'
        }}>
        <Tabs aria-label="Chat log collapse example">
          <TabList>
            <Item key="item1">John Doe</Item>
            <Item key="item2">Jane Doe</Item>
            <Item key="item3">Joe Bloggs</Item>
          </TabList>
          <TabPanels>
            <Item key="item1">
              There is no prior chat history with John Doe.
            </Item>
            <Item key="item2">
              There is no prior chat history with Jane Doe.
            </Item>
            <Item key="item3">
              There is no prior chat history with Joe Bloggs.
            </Item>
          </TabPanels>
        </Tabs>
      </div>
      <Button
        variant="primary"
        onPress={() => setCollapse((collapse) => !collapse)}>
        Toggle tab container size.
      </Button>
    </>
  );
}
function Example() {
  let [collapse, setCollapse] = React.useState(false);

  return (
    <>
      <div
        style={{
          width: collapse ? '150px' : '300px',
          marginBottom: '50px',
          height: '150px',
          maxWidth: '100%'
        }}>
        <Tabs aria-label="Chat log collapse example">
          <TabList>
            <Item key="item1">John Doe</Item>
            <Item key="item2">Jane Doe</Item>
            <Item key="item3">Joe Bloggs</Item>
          </TabList>
          <TabPanels>
            <Item key="item1">
              There is no prior chat history with John Doe.
            </Item>
            <Item key="item2">
              There is no prior chat history with Jane Doe.
            </Item>
            <Item key="item3">
              There is no prior chat history with Joe
              Bloggs.
            </Item>
          </TabPanels>
        </Tabs>
      </div>
      <Button
        variant="primary"
        onPress={() =>
          setCollapse((collapse) => !collapse)
        }>
        Toggle tab container size.
      </Button>
    </>
  );
}
function Example() {
  let [
    collapse,
    setCollapse
  ] = React.useState(
    false
  );

  return (
    <>
      <div
        style={{
          width: collapse
            ? '150px'
            : '300px',
          marginBottom:
            '50px',
          height:
            '150px',
          maxWidth:
            '100%'
        }}>
        <Tabs aria-label="Chat log collapse example">
          <TabList>
            <Item key="item1">
              John Doe
            </Item>
            <Item key="item2">
              Jane Doe
            </Item>
            <Item key="item3">
              Joe Bloggs
            </Item>
          </TabList>
          <TabPanels>
            <Item key="item1">
              There is no
              prior chat
              history
              with John
              Doe.
            </Item>
            <Item key="item2">
              There is no
              prior chat
              history
              with Jane
              Doe.
            </Item>
            <Item key="item3">
              There is no
              prior chat
              history
              with Joe
              Bloggs.
            </Item>
          </TabPanels>
        </Tabs>
      </div>
      <Button
        variant="primary"
        onPress={() =>
          setCollapse(
            (collapse) =>
              !collapse
          )
        }>
        Toggle tab
        container size.
      </Button>
    </>
  );
}