From 34545d7bf02abef23cd3ea9c43ca8ab230169618 Mon Sep 17 00:00:00 2001 From: Suhair Zain Date: Thu, 30 Mar 2017 14:00:30 +0530 Subject: [PATCH] Updated README with usage of 3.0 --- README.md | 29 ++++++++++++++++++++++++----- 1 file changed, 24 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d3c29ff..d916847 100644 --- a/README.md +++ b/README.md @@ -15,19 +15,39 @@ A react native component with the same concept of react native's SegmantedContro `npm install react-native-segmented-control-tab --save` ## Usage + +### IMPORTANT +This has been made into a controlled component from 3.0. Those who are familiar with 2.0, read below for the updated usage. + ``` import SegmentedControlTab from 'react-native-segmented-control-tab' class ConsumerComponent extends Component { + constructor(){ + super() + this.state = { + selectedIndex: 0, + }; + } + + handleIndexChange = (index) => { + this.setState({ + ...this.state, + selectedIndex: index, + }); + } + render() { return ( console.log(index))} + selectedIndex={this.state.selectedIndex} + onTabPress={this.handleIndexChange} /> - ) + + ); } } ``` @@ -35,16 +55,15 @@ class ConsumerComponent extends Component { Name | Description | Default | Type ------|-------------|----------|----------- values | titles of tabs | `['One', 'Two', 'Three']` | array -selectedIndex | index of tab item to be selected initially| 0 | number +selectedIndex | index of tab item to be selected initially| [0] | arrayOf(PropTypes.number) multiple | Boolean which enables the multiple selection option | false | bool -selectedIndices |Array of indices of tab items to be selected initially - when multiple prop is true else it will take selectedIndex| [0] | arrayOf(PropTypes.number) borderRadius | borderRadius of whole tab | 5 | number tabsContainerStyle | external styles can be passed to override the default styles of the segmentedControl wrapper| base styles added in SegmentedControlTab.js | object(styles) tabStyle | external styles can be passed to override the default styles of the tabs| base styles added in SegmentedControlTab.js | object(styles) tabTextStyle | external styles can be passed to override the default styles of the tab title| base styles added in SegmentedControlTab.js | object(styles) activeTabStyle | external styles can be passed to override the default styles of the active tab| base styles added in SegmentedControlTab.js | object(styles) activeTabTextStyle | external styles can be passed to override the default styles of the active tab text| base styles added in SegmentedControlTab.js | object(styles) -onTabPress | call-back function for each item | () => {} | func +onTabPress | call-back function when a tab is selected | () => {} | func ## Custom styling ```