Skip to content

Top tabbed navigation that you can swipe between, each tab can have its own ScrollView and maintain its own scroll position between swipes.

Notifications You must be signed in to change notification settings

rawaniharsh/react-native-top-tab-view

Repository files navigation

react-native-top-tab-view

npm version

It's a react native top tab navigator for both Android and IOS with the scrollview in each tab and sliding between the tabs. For more information about how the animations behind this work, check out the Rebound section of the React Native Animation Guide

Add it to your project

  1. Run npm install react-native-top-tab-view --save
  2. var ScrollableTabView = require('react-native-top-tab-view');

Basic usage

var ScrollableTabView = require('react-native-top-tab-view');

var App = React.createClass({
  render() {
    return (
      <ScrollableTabView>
        <ReactPage tabLabel="React" />
        <FlowPage tabLabel="Flow" />
        <JestPage tabLabel="Jest" />
      </ScrollableTabView>
    );
  }
});

Injecting a custom tab bar

Suppose we had a custom tab bar called CustomTabBar, we would inject it into our ScrollableTabView like this:

var ScrollableTabView = require('react-native-top-tab-view');
var CustomTabBar = require('./CustomTabBar');

var App = React.createClass({
  render() {
    return (
      <ScrollableTabView renderTabBar={() => <CustomTabBar someProp={'here'} />}>
        <ReactPage tabLabel="React" />
        <FlowPage tabLabel="Flow" />
        <JestPage tabLabel="Jest" />
      </ScrollableTabView>
    );
  }
});

Props

  • renderTabBar (Function:ReactComponent) - accept 1 argument props and should return a component to use as the tab bar. The component has goToPage, tabs, activeTab and ref added to the props, and should implement setAnimationValue to be able to animate itself along with the tab content. You can manually pass the props to the TabBar component.
  • tabBarPosition (String) Defaults to "top".
    • "bottom" to position the tab bar below content.
    • "overlayTop" or "overlayBottom" for a semitransparent tab bar that overlays content. Custom tab bars must consume a style prop on their outer element to support this feature: style={this.props.style}.
  • onChangeTab (Function) - function to call when tab changes, should accept 1 argument which is an Object containing two keys: i: the index of the tab that is selected, ref: the ref of the tab that is selected
  • onScroll (Function) - function to call when the pages are sliding, should accept 1 argument which is an Float number representing the page position in the slide frame.
  • locked (Bool) - disables horizontal dragging to scroll between tabs, default is false.
  • initialPage (Integer) - the index of the initially selected tab, defaults to 0 === first tab.
  • page (Integer) - set selected tab(can be buggy see #126
  • children (ReactComponents) - each top-level child component should have a tabLabel prop that can be used by the tab bar component to render out the labels. The default tab bar expects it to be a string, but you can use anything you want if you make a custom tab bar.
  • tabBarUnderlineStyle (View.propTypes.style) - style of the default tab bar's underline.
  • tabBarBackgroundColor (String) - color of the default tab bar's background, defaults to white
  • tabBarActiveTextColor (String) - color of the default tab bar's text when active, defaults to navy
  • tabBarInactiveTextColor (String) - color of the default tab bar's text when inactive, defaults to black
  • tabBarTextStyle (Object) - Additional styles to the tab bar's text. Example: {fontFamily: 'Roboto', fontSize: 15}
  • style (View.propTypes.style)
  • contentProps (Object) - props that are applied to root ScrollView/ViewPagerAndroid. Note that overriding defaults set by the library may break functionality; see the source for details.
  • scrollWithoutAnimation (Bool) - on tab press change tab without animation.
  • prerenderingSiblingsNumber (Integer) - pre-render nearby # sibling, Infinity === render all the siblings, default to 0 === render current page.

About

Top tabbed navigation that you can swipe between, each tab can have its own ScrollView and maintain its own scroll position between swipes.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published