<ons-tabbar />

A component to display a tab bar on the bottom of a page. Used with <ons-tab> to manage pages using tabs.

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
animation String
none
If this attribute is set to "none" the transitions will not be animated. Optional.
animation-options Expression Specify the animation’s duration, timing and delay with an object literal. E.g. {duration: 0.2, delay: 1, timing: 'ease-in'}. Optional.
position String
bottom
Tabbar’s position. Available values are "bottom" and "top". Use "auto" to choose position depending on platform (bottom for iOS flat design, top for Material Design). Optional. Works only during initialization.
swipeable If this attribute is set the tab bar can be scrolled by drag or swipe. Optional.
ignore-edge-width Number
20
Distance in pixels from both edges. Swiping on these areas will prioritize parent components such as ons-splitter or ons-navigator. Optional.
active-index Number
0
The index of the tab that is currently active. Optional.
hide-tabs Whether to hide the tabs. Optional.
tab-border If this attribute is set the tabs show a dynamic bottom border. Only works for iOS flat design since the border is always visible in Material Design. Optional.
modifier String The appearance of the tabbar. Optional.
Name Description
animationOptions Specify the animation’s duration, timing and delay with an object literal. E.g. {duration: 0.2, delay: 1, timing: 'ease-in'}.
activeIndex The index of the tab that is currently active.
hideTabs Whether to hide the tabs.
tabBorder If this property is set the tabs show a dynamic bottom border. Only works for iOS flat design since the border is always visible in Material Design.
visible Whether the tabbar is visible or not.
swipeable Enable swipe interaction.
onSwipe Hook called whenever the user slides the tabbar. It gets a decimal index and an animationOptions object as arguments.
Name Description
material A tabbar in Material Design.
autogrow Tabs automatically grow depending on their content instead of having a fixed width.
top-border Shows a static border-bottom in tabs for iOS top tabbars.
Signature Description
setActiveTab(index, [options]) Show specified tab page. Animations and their options can be specified by the second parameter.
setTabbarVisibility(visible) Used to hide or show the tab bar.
getActiveTabIndex() Returns tab index on current active tab. If active tab is not found, returns -1.
setActiveTab(index, [options]): Promise

Show specified tab page. Animations and their options can be specified by the second parameter.

Returns: A promise that resolves to the new page element.

Parameters
Name Type Description
index Number Tab index.
options Object Parameter object.
options.callback Function Function that runs when the new page has loaded.
options.animation String If this option is “none”, the transition won’t slide.
options.animationOptions String Specify the animation’s duration, delay and timing. E.g. {duration: 0.2, delay: 0.4, timing: 'ease-in'}.
setTabbarVisibility(visible)

Used to hide or show the tab bar.

Parameters
Name Type Description
visible Boolean
getActiveTabIndex(): Number

Returns tab index on current active tab. If active tab is not found, returns -1.

Returns: The index of the currently active tab.

Name Description
prechange Fires just before the tab is changed.
postchange Fires just after the tab is changed.
reactive Fires if the already open tab is tapped again.
swipe Fires when the tabbar swipes.
prechange

Fires just before the tab is changed.

Parameters
Name Type Description
event Object Event object.
event.index Number Current index.
event.tabItem Object Tab item object.
event.cancel Function Call this function to cancel the change event.
postchange

Fires just after the tab is changed.

Parameters
Name Type Description
event Object Event object.
event.index Number Current index.
event.tabItem Object Tab item object.
reactive

Fires if the already open tab is tapped again.

Parameters
Name Type Description
event Object Event object.
event.index Number Current index.
event.tabItem Object Tab item object.
swipe

Fires when the tabbar swipes.

Parameters
Name Type Description
event Object Event object.
event.index Number Current index.
event.options Object Animation options object.

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.