iRoachie / react-native-material-tabs

Material Design implementation of Tabs
MIT License
121 stars 56 forks source link
component material material-design react-native tabs typescript

React Native Material Tabs

Material Design implementation of Tabs

Travis npm version npm downloads code style: prettier style: styled-components

## Getting Started #### Step 1 Install the dependency ```bash npm i --save react-native-material-tabs ``` Or if you use yarn ```bash yarn add react-native-material-tabs ``` #### Step 2 Start using the component ```jsx import MaterialTabs from 'react-native-material-tabs'; ``` ## Usage ![Demo](https://user-images.githubusercontent.com/5962998/59991843-f2e43600-9616-11e9-913b-b8fb8a566d68.gif) ```jsx import React, { useState } from 'react'; import { StyleSheet, SafeAreaView } from 'react-native'; import MaterialTabs from 'react-native-material-tabs'; const Example = () => { const [selectedTab, setSelectedTab] = useState(0); return ( ); }; const styles = StyleSheet.create({ container: { flex: 1, }, }); ``` ## Available Props | prop | default | type | description | | ------------------------- | ------------------------ | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | barColor | #13897b | string | Color of the tab bar | | barHeight | 48 | number | Height of the tab bar | | indicatorColor | #fff | string | Color of the indicator | | indicatorHeight | 2 | number | Height of the indicator | activeTextColor | #fff | string | Color of the text for the selected tab | | inactiveTextColor | rgba(255, 255, 255, 0.7) | string | Color of the text for inactive tabs | | items | none | array(string | element) | The headers for the individual tabs | | selectedIndex | 0 | number | The index of current tab selected. Indexes are mapped to the items prop | | scrollable | false | boolean | Option between having fixed tabs or scrollable tabs | | textStyle | null | object(style) | Text style for tab titles | | activeTextStyle | {} | object(style) | Optional text style for the selected tab | | onChange | none | Function | Handler that's emitted every time the user presses a tab. You can use this to change the selected index | | allowFontScaling | true | boolean | Specifies whether fonts should scale to respect Text Size accessibility settings | | uppercase | true | boolean | Specifies whether to uppercase the tab labels | | keyboardShouldPersistTaps | never | string | Specifies how the [ScrollView](https://facebook.github.io/react-native/docs/scrollview#keyboardshouldpersisttaps) should respond to taps while keyboard is open |