<ons-tab />

Represents a tab inside tab bar. Each <ons-tab> represents a page.

Tutorial

Tabbar

The Tabbar component is used to add tab navigation to an app. It is a very common navigation pattern in mobile apps.

Every tab is defined by one Page component and one Tab component. The Tab component displays the actual tab and the Page component will be displayed when the tab is tapped.

The Tabbar component has a index property which is used to specify the page that is currently visible. To handle changing tabs by user input, the property onPreChange should be implemented.

<Ons.Tabbar
  index={this.state.index}
  onPreChange={(event) =>
    {
      if (event.index != index) {
        this.setState({index: event.index});
      }
    }
  }
  renderTabs={this.renderTabs}
/>

There is also a renderTabs property that should be set to a function that returns an array of objects with the keys content and tab:

{
  content: <Page />,
  tab: <Tab />
}

Every tab has, by default, the same width. 50% with two tabs, 25% with four tabs and so on. To allow tabs grow depending on their content (i.e. shorter/ longer labels), use the autogrow modifier in Tabbar component. Optionally, max-width CSS property can be specified to set the width of the tab (for each Tab component).

The Tab component

There are two ways to define a tab. Either the tab label can be put as a child of the Tab component or the label and icon props can be used to specify its appearance.

Swipes and Animations

By default, the tab bar will slide from one page to another on tab click. Use animation='none' prop to have an instant change.

swipeable={true} prop can be used to enable this functionality. It can be toggled to allow or prevent swipes at different moments of the app.

These props can be combined to have a tab bar with instant changes that can also be swiped:

<Tabbar swipeable={true} animation='none' ... />

For iOS, tabBorder prop can be included to show a tab border that updates position during swipe (this is always default on Android).

See also

Name Type Description
page String The page that is displayed when the tab is tapped. Optional. Works only during initialization.
icon String The icon name for the tab. Can specify the same icon name as <ons-icon>. Check See also section for more information. Optional.
active-icon String The name of the icon when the tab is active. Optional.
label String The label of the tab item. Optional.
badge String Display a notification badge on top of the tab. Optional.
active This attribute should be set to the tab that is active by default. Optional.

Need Help?

If you have any questions, use our Community Forum or talk to us on Discord chat. The Onsen UI team and your peers in the community will work together to help solve your issues.

For bug reports and feature requests use our GitHub Issues page.