@almostbearded/react-tabs
TypeScript icon, indicating that this package has built-in type declarations

1.0.4 • Public • Published

react-tabs

A minimalist, accessible React tabs component. The rendered content is fully accessible. The implementation, styling, and configuration has purposely been kept as simple as possible.

The storybook demonstrating some common usage examples can be found at https://almostbearded-react-tabs.netlify.app.

Installation

This package has only a dependency on React. The easiest way to install is via npm:

npm install @almostbearded/react-tabs

Basic Usage

Import the Tabs component from the @almostbearded/react-tabs package:

import { Tabs } from '@almostbearded/react-tabs'

The currently selected tab could itself be stored in a state variable or derived from one. For example, to store the selected tab in state:

const [selectedTab, setSelectedTab] = useState('default-tab-id')

Afterwards, the Tabs component can simply be used in other components:

<Tabs
    tabs={[
        { id: 'tab-1', title: 'Tab 1', content: 'Content of Tab 1' },
        { id: 'tab-2', title: 'Tab 2', content: 'Content of Tab 2' },
    ]}
    selectedTab={selectedTab}
    onSelectTab={setSelectedTab} />

It is also possible to pass more complex nodes to the title and content props:

<Tabs
    tabs={[
        {
            id: 'tab-1',
            title: <h3>Tab 1</h3>,
            content: <p>Complex content of tab 1</p>
        },
        {
            id: 'tab-2',
            title: <h3>Tab 2</h3>,
            content: <p>Complex content of tab 2</p>
        },
    ]}
    selectedTab={selectedTab}
    onSelectTab={setSelectedTab} />

API

The Tabs component can be configured via a number of props:

  • The tabs prop is an array containing the configuration of the titles and contents of tabs. Every tab consists of an unique id, a title shown in the tab, and content shown in the panel linked to a tab.
  • The selectedTab prop defines which tab is currently selected and therefore which content is currently shown.
  • The onSelectTab prop takes a callback that is invoked with the id of the newly selected tab, whenever a user clicks one of the tabs.

Demos

The following demos show the Tabs component being used with different configurations.

Single tab

Demo showing a single tab

Two Tabs

Demo showing two tabs

Many Tabs

Demo showing many tabs

Tabs Containing Sign in and Sign up Forms

Demo showing sign in and sign up forms

Known Issues

No known issues at the moment.

Additional Resources

Package Sidebar

Install

npm i @almostbearded/react-tabs

Weekly Downloads

28

Version

1.0.4

License

MIT

Unpacked Size

13.8 kB

Total Files

17

Last publish

Collaborators

  • almostbearded