Tabs

An accessible tabs component.

The Tab and TabPanel elements are associated by their order in the tree. None of the components are empty wrappers, each is associated with a real DOM element in the document, giving you maximum control over styling and composition.

Import

import { Tabs, TabList, TabPanels, Tab, TabPanel } from '@sajari-ui/core';

import { Tabs, TabList, TabPanels, Tab, TabPanel } from '@sajari-ui/core';

Usage

You can render any element within Tabs, but TabList should only have Tab as children, and TabPanels should have TabPanel as children.

Tabs expects TabList and TabPanels as children. The order doesn't matter, you can have tabs at the top, at the bottom, or both.

Editable Example

one!

<Tabs>
  <TabList margin="mb-2">
    <Tab>One</Tab>
    <Tab>Two</Tab>
    <Tab>Three</Tab>
  </TabList>

  <TabPanels>
    <TabPanel>
      <p>one!</p>
    </TabPanel>
    <TabPanel>
      <p>two!</p>
    </TabPanel>
    <TabPanel>
      <p>three!</p>
    </TabPanel>
  </TabPanels>
</Tabs>

<Tabs>
  <TabList margin="mb-2">
    <Tab>One</Tab>
    <Tab>Two</Tab>
    <Tab>Three</Tab>
  </TabList>
  <TabPanels>
    <TabPanel>
      <p>one!</p>
    </TabPanel>
    <TabPanel>
      <p>two!</p>
    </TabPanel>
    <TabPanel>
      <p>three!</p>
    </TabPanel>
  </TabPanels>
</Tabs>

Change the tabs alignment

You can change the alignment of the TabList by passing align prop. We support 3 sizes start, center, end.

Editable Example

one!

<Tabs align="end">
  <TabList margin="mb-2">
    <Tab>One</Tab>
    <Tab>Two</Tab>
  </TabList>
  <TabPanels>
    <TabPanel>
      <p>one!</p>
    </TabPanel>
    <TabPanel>
      <p>two!</p>
    </TabPanel>
  </TabPanels>
</Tabs>

<Tabs align="end">
  <TabList margin="mb-2">
    <Tab>One</Tab>
    <Tab>Two</Tab>
  </TabList>
  <TabPanels>
    <TabPanel>
      <p>one!</p>
    </TabPanel>
    <TabPanel>
      <p>two!</p>
    </TabPanel>
  </TabPanels>
</Tabs>

Fitted Tabs

Stretch the tab list to fit the container by passing fitted prop.

Editable Example

one!

<Tabs fitted>
  <TabList margin="mb-2">
    <Tab>One</Tab>
    <Tab>Two</Tab>
  </TabList>
  <TabPanels>
    <TabPanel>
      <p>one!</p>
    </TabPanel>
    <TabPanel>
      <p>two!</p>
    </TabPanel>
  </TabPanels>
</Tabs>

<Tabs fitted>
  <TabList margin="mb-2">
    <Tab>One</Tab>
    <Tab>Two</Tab>
  </TabList>
  <TabPanels>
    <TabPanel>
      <p>one!</p>
    </TabPanel>
    <TabPanel>
      <p>two!</p>
    </TabPanel>
  </TabPanels>
</Tabs>

Tabs onChange

The onChange callback returns the active tab's index whenever the user changes tabs. If you intend to control the tabs programmatically, use this with the index prop.

Editable Example

The Primary Colors

function Example() {
  const colors = ['bg-red-50', 'bg-green-50', 'bg-blue-50'];
  const [tabIndex, setTabIndex] = React.useState(0);
  const bg = colors[tabIndex];

  return (
    <Tabs onChange={(index) => setTabIndex(index)} backgroundColor={bg}>
      <TabList margin="mb-2">
        <Tab>Red</Tab>
        <Tab>Green</Tab>
        <Tab>Blue</Tab>
      </TabList>
      <TabPanels p="2rem">
        <TabPanel>The Primary Colors</TabPanel>
        <TabPanel>Are 1, 2, 3</TabPanel>
        <TabPanel>Red, green and blue.</TabPanel>
      </TabPanels>
    </Tabs>
  );
}

function Example() {
  const colors = ['bg-red-50', 'bg-green-50', 'bg-blue-50'];
  const [tabIndex, setTabIndex] = React.useState(0);
  const bg = colors[tabIndex];
  return (
    <Tabs onChange={(index) => setTabIndex(index)} backgroundColor={bg}>
      <TabList margin="mb-2">
        <Tab>Red</Tab>
        <Tab>Green</Tab>
        <Tab>Blue</Tab>
      </TabList>
      <TabPanels p="2rem">
        <TabPanel>The Primary Colors</TabPanel>
        <TabPanel>Are 1, 2, 3</TabPanel>
        <TabPanel>Red, green and blue.</TabPanel>
      </TabPanels>
    </Tabs>
  );
}

Make a tab initally active

If you want a tab to be initially active, simply pass the defaultIndex prop and set it to the index of that tab.

Editable Example

<Tabs defaultIndex={1}>
  <TabPanels>
    <TabPanel>
      <Image
        size="200px"
        objectFit="cover"
        src="https://resizing.flixster.com/wTgvsiM8vNLhCcCH-6ovV8n5z5U=/300x300/v1.bjsyMDkxMzI5O2o7MTgyMDQ7MTIwMDsxMjAwOzkwMA"
      />
    </TabPanel>
    <TabPanel>
      <Image
        size="200px"
        objectFit="cover"
        src="https://vignette.wikia.nocookie.net/naruto/images/2/21/Sasuke_Part_1.png/revision/latest?cb=20170716092103"
      />
    </TabPanel>
  </TabPanels>
  <TabList margin="mt-2">
    <Tab>Naruto</Tab>
    <Tab>Sasuke</Tab>
  </TabList>
</Tabs>

<Tabs defaultIndex={1}>
  <TabPanels>
    <TabPanel>
      <Image
        size="200px"
        objectFit="cover"
        src="https://resizing.flixster.com/wTgvsiM8vNLhCcCH-6ovV8n5z5U=/300x300/v1.bjsyMDkxMzI5O2o7MTgyMDQ7MTIwMDsxMjAwOzkwMA"
      />
    </TabPanel>
    <TabPanel>
      <Image
        size="200px"
        objectFit="cover"
        src="https://vignette.wikia.nocookie.net/naruto/images/2/21/Sasuke_Part_1.png/revision/latest?cb=20170716092103"
      />
    </TabPanel>
  </TabPanels>
  <TabList margin="mt-2">
    <Tab>Naruto</Tab>
    <Tab>Sasuke</Tab>
  </TabList>
</Tabs>

Make a Tab disabled

When a Tab is disabled, it's skipped during keyboard navigation and it's not clickable.

Editable Example

function Example() {
  return (
    <Tabs>
      <TabList margin="mb-2">
        <Tab>One</Tab>
        <Tab disabled>Two</Tab>
        <Tab>Three</Tab>
      </TabList>
      <TabPanels>
        <TabPanel>1</TabPanel>
        <TabPanel>2</TabPanel>
        <TabPanel>3</TabPanel>
      </TabPanels>
    </Tabs>
  );
}

function Example() {
  return (
    <Tabs>
      <TabList margin="mb-2">
        <Tab>One</Tab>
        <Tab disabled>Two</Tab>
        <Tab>Three</Tab>
      </TabList>
      <TabPanels>
        <TabPanel>1</TabPanel>
        <TabPanel>2</TabPanel>
        <TabPanel>3</TabPanel>
      </TabPanels>
    </Tabs>
  );
}

Manually Activated Tabs

By default, Tabs are activated automatically. This means when you use the arrow keys to change tabs, the tab is activated and focused.

The content of a TabPanel should ideally be preloaded. However, if switching to a tab panel causes a network request and possibly a page refresh, there might be some notable latency and this might affect the experience for keyboard and screen reader users.

In this scenario, you should use a manually activated tab, it moves focus without activating the tabs. With focus on a specifc tab, users can activate a tab by pressing Space or Enter.

Editable Example

one!

<Tabs manual>
  <TabList margin="mb-2">
    <Tab>One</Tab>
    <Tab>Two</Tab>
  </TabList>
  <TabPanels>
    <TabPanel>
      <p>one!</p>
    </TabPanel>
    <TabPanel>
      <p>two!</p>
    </TabPanel>
  </TabPanels>
</Tabs>

<Tabs manual>
  <TabList margin="mb-2">
    <Tab>One</Tab>
    <Tab>Two</Tab>
  </TabList>
  <TabPanels>
    <TabPanel>
      <p>one!</p>
    </TabPanel>
    <TabPanel>
      <p>two!</p>
    </TabPanel>
  </TabPanels>
</Tabs>

Controlled Tabs

Like form inputs, a tab's state can be controlled. Make sure to include an onChange as well, or else the tabs will not be interactive.

Editable Example

Click the tabs or pull the slider around

function ControlledExample() {
  const [tabIndex, setTabIndex] = React.useState(0);
  const handleSliderChange = (event) => setTabIndex(parseInt(event.target.value, 10));
  const handleTabsChange = (index) => setTabIndex(index);

  return (
    <Box>
      <input type="range" min="0" max="2" value={tabIndex} onChange={handleSliderChange} />

      <Tabs index={tabIndex} onChange={handleTabsChange}>
        <TabList margin="mb-2">
          <Tab>One</Tab>
          <Tab>Two</Tab>
          <Tab>Three</Tab>
        </TabList>
        <TabPanels>
          <TabPanel>
            <p>Click the tabs or pull the slider around</p>
          </TabPanel>
          <TabPanel>
            <p>Yeah yeah. What's up?</p>
          </TabPanel>
          <TabPanel>
            <p>Oh, hello there.</p>
          </TabPanel>
        </TabPanels>
      </Tabs>
    </Box>
  );
}

function ControlledExample() {
  const [tabIndex, setTabIndex] = React.useState(0);
  const handleSliderChange = (event) => setTabIndex(parseInt(event.target.value, 10));
  const handleTabsChange = (index) => setTabIndex(index);
  return (
    <Box>
      <input type="range" min="0" max="2" value={tabIndex} onChange={handleSliderChange} />
      <Tabs index={tabIndex} onChange={handleTabsChange}>
        <TabList margin="mb-2">
          <Tab>One</Tab>
          <Tab>Two</Tab>
          <Tab>Three</Tab>
        </TabList>
        <TabPanels>
          <TabPanel>
            <p>Click the tabs or pull the slider around</p>
          </TabPanel>
          <TabPanel>
            <p>Yeah yeah. What's up?</p>
          </TabPanel>
          <TabPanel>
            <p>Oh, hello there.</p>
          </TabPanel>
        </TabPanels>
      </Tabs>
    </Box>
  );
}

Creating custom tab components

Because TabList needs to know the order of the children, we use cloneElement to pass state internally. If you want to know if a tab is active, you can wrap it, and then inspect clone props passed in.

Editable Example

function CoolTabsExample() {
  const CoolTab = React.forwardRef((props, ref) => {
    // `selected` is passed to all children of `TabList`.
    return (
      <Tab ref={ref} selected={props.selected} {...props}>
        {props.selected ? '😎' : '😐'}
        {props.children}
      </Tab>
    );
  });

  return (
    <Tabs>
      <TabList margin="mb-2">
        <CoolTab>One</CoolTab>
        <CoolTab>Two</CoolTab>
      </TabList>
      <TabPanels>
        <TabPanel>1</TabPanel>
        <TabPanel>2</TabPanel>
      </TabPanels>
    </Tabs>
  );
}

function CoolTabsExample() {
  const CoolTab = React.forwardRef((props, ref) => {
    // `selected` is passed to all children of `TabList`.
    return (
      <Tab ref={ref} selected={props.selected} {...props}>
        {props.selected ? '😎' : '😐'}
        {props.children}
      </Tab>
    );
  });
  return (
    <Tabs>
      <TabList margin="mb-2">
        <CoolTab>One</CoolTab>
        <CoolTab>Two</CoolTab>
      </TabList>
      <TabPanels>
        <TabPanel>1</TabPanel>
        <TabPanel>2</TabPanel>
      </TabPanels>
    </Tabs>
  );
}

Data Tabs

If you'd like to drive your tabs with an array instead of using the granular components, you can create your own DataTabs component.

Editable Example

Perhaps the greatest dish ever invented.

function Example() {
  // First, you create the component...
  function DataTabs({ data }) {
    return (
      <Tabs>
        <TabList margin="mb-2">
          {data.map((tab, index) => (
            <Tab key={index}>{tab.label}</Tab>
          ))}
        </TabList>
        <TabPanels>
          {data.map((tab, index) => (
            <TabPanel p={4} key={index}>
              {tab.content}
            </TabPanel>
          ))}
        </TabPanels>
      </Tabs>
    );
  }

  // Next, you have an array of data...
  const tabData = [
    {
      label: 'Nigerian Jollof',
      content: 'Perhaps the greatest dish ever invented.',
    },
    {
      label: 'Pounded Yam & Egusi',
      content: 'Perhaps the surest dish ever invented but fills the stomach more than rice.',
    },
  ];

  // you can just pass it in:
  return <DataTabs data={tabData} />;
}

function Example() {
  // First, you create the component...
  function DataTabs({ data }) {
    return (
      <Tabs>
        <TabList margin="mb-2">
          {data.map((tab, index) => (
            <Tab key={index}>{tab.label}</Tab>
          ))}
        </TabList>
        <TabPanels>
          {data.map((tab, index) => (
            <TabPanel p={4} key={index}>
              {tab.content}
            </TabPanel>
          ))}
        </TabPanels>
      </Tabs>
    );
  }
  // Next, you have an array of data...
  const tabData = [
    {
      label: 'Nigerian Jollof',
      content: 'Perhaps the greatest dish ever invented.',
    },
    {
      label: 'Pounded Yam & Egusi',
      content: 'Perhaps the surest dish ever invented but fills the stomach more than rice.',
    },
  ];
  // you can just pass it in:
  return <DataTabs data={tabData} />;
}

Accessibility

Keyboard

Key	Action
`ArrowLeft`	Moves focus to the next tab
`ArrowUp`	Moves focus to the previous tab
`Tab`	When focus moves into the tab list, places focus on the active tab element
`Space` or `Enter`	Activates the tab if it was not activated automatically on focus
`Home`	Moves focus to the first tab
`End`	Moves focus to the last tab

ARIA roles

Component	Aria	Usage
Tab	`role="tab"`	Indicates that it's a tab
	`aria-selected`	Set to `true` a tab is selected and all other Tabs have it set to `false`.
	`aria-controls`	Set to the `id` of its associated `TabPanel`
TabList	`id`	The `id` of the `TabPanel` that's referencd by its associated `Tab`
	`aria-orientation`	Set to vertical or horizontal based on the value of the `orientation` prop.
	`role="tablist"`	Indicates that it's a tablist
	`aria-labelledby`	Set to the `id` of the `Tab` that labels the `TabPanel`.

Props

Tabs Props

Tabs composes Box so you call pass all Box related props.

Name	Type	Description
`onChange`	`(index: number) => void`	The callback to update the active tab index.
`index`	`number`	The controlled index of the tabs.
`defaultIndex`	`number`	The index of the initial active tab.
`manual`	`boolean`	If `true`, keyboard navigation changes focus between tabs but doens't activate it. User will have to press `Enter` to active it
`children`	`React.ReactNode`	The children of the switch.
`fitted`	`boolean`	If `true`, the tabs will stretch to fill the available space

Tab Props

Name	Type	Default	Description
`disabled`	`boolean`		If `true`, the tab will be disabled