react-toolbox/components/tabs

Tabs

Tabs make it easy to explore and switch between different views or functional aspects of an app or to browse categorized data sets. Tabs are composed with their content, but only the active tab's content is rendered. In the future, we may add the ability to render headers only, with event listeners.

import {Tab, Tabs} from 'react-toolbox';

class TabsTest extends React.Component {
  state = {
    index: 1,
    fixedIndex: 1,
    inverseIndex: 1
  };

  handleTabChange = (index) => {
    this.setState({index});
  };

  handleFixedTabChange = (index) => {
    this.setState({fixedIndex: index});
  };

  handleInverseTabChange = (index) => {
    this.setState({inverseIndex: index});
  };

  handleActive = () => {
    console.log('Special one activated');
  };

  render () {
    return (
      <section>
        <Tabs index={this.state.index} onChange={this.handleTabChange}>
          <Tab label='Primary'><small>Primary content</small></Tab>
          <Tab label='Secondary' onActive={this.handleActive}><small>Secondary content</small></Tab>
          <Tab label='Third' disabled><small>Disabled content</small></Tab>
          <Tab label='Fourth' hidden><small>Fourth content hidden</small></Tab>
          <Tab label='Fifth'><small>Fifth content</small></Tab>
        </Tabs>
        <h5>Fixed Tabs</h5>
        <Tabs index={this.state.fixedIndex} onChange={this.handleFixedTabChange} fixed>
          <Tab label='First'><small>First Content</small></Tab>
          <Tab label='Second'><small>Second Content</small></Tab>
          <Tab label='Third'><small>Third Content</small></Tab>
        </Tabs>
        <h5>Inverse Tabs</h5>
        <Tabs index={this.state.inverseIndex} onChange={this.handleInverseTabChange} inverse>
          <Tab label='First'><small>First Content</small></Tab>
          <Tab label='Second'><small>Second Content</small></Tab>
          <Tab label='Third'><small>Third Content</small></Tab>
          <Tab label='Disabled' disabled><small>Disabled Content</small></Tab>
        </Tabs>
      </section>
    );
  }
}

If you want to provide a theme via context, the component key is RTTabs.

Tabs

This component acts as the wrapper and the main controller of the content that is being displayed. It gets some properties that can be spread to the children.

Properties

Name	Type	Default	Description
className	String	''	Additional class name to provide custom styling.
disableAnimatedBottomBorder	Boolean	false	Disable the animation below the active tab.
fixed	Boolean	false	If True, the tabs will be 'fixed tabs'.
hideMode	enum('display','unmounted')	unmounted	unmounted mode will not mount the tab content of inactive tabs. display mode will mount but hide inactive tabs. Consider holding state outside of the Tabs component before using display mode
index	Number	0	Current
inverse	Boolean	false	If True, the tabs will have an inverse style.
onChange	Function		Callback function that is fired when the tab changes.

Theming

Name	Description
active	Added to the active tab content and header.
fixed	Used to make the tabs 'fixed tabs'.
inverse	Used to invert the colors.
navigation	Used for the navigation element.
pointer	Used for the moving underline element.
tabs	Used as a root classname for the component.
tab	Used for the tab content element.

Tab

Represent a single tab element and it should include some properties to describe the tab itself and get children elements as content.

Properties

Name	Type	Default	Description
active	Boolean	false	If true, the current component is visible.
activeClassName	String	''	Additional class name to provide custom styling for the active tab.
className	String	''	Additional class name to provide custom styling for each tab.
disabled	Boolean	false	If true, the current component is not clickable.
hidden	Boolean	false	If true, the current component is not visible.
icon	String		Icon for navigation header.
label	String		Label text for navigation header.
onActive	Function		Callback function that is fired when the tab is activated.
onClick	Function		Callback function that is fired when the tab is clicked.

It is required to provide either a label or an icon (or both).

Theme

Name	Description
active	Added to the navigation tab element in case it's active.
disabled	Added to the navigation tab element in case it's disabled.
hidden	Added to the navigation tab element in case it's hidden.
label	Added to the navigation tab element in case it's active.
rippleWrapper	Used for the ripple wrapper element.