diff --git a/Libraries/Components/SegmentedControlIOS/SegmentedControlIOS.ios.js b/Libraries/Components/SegmentedControlIOS/SegmentedControlIOS.ios.js index 6393e89da4..34ef75a8a7 100644 --- a/Libraries/Components/SegmentedControlIOS/SegmentedControlIOS.ios.js +++ b/Libraries/Components/SegmentedControlIOS/SegmentedControlIOS.ios.js @@ -31,6 +31,23 @@ type Event = Object; /** * Use `SegmentedControlIOS` to render a UISegmentedControl iOS. + * + * #### Programmatically changing selected index + * + * The selected index can be changed on the fly by assigning the + * selectIndex prop to a state variable, then changing that variable. + * Note that the state variable would need to be updated as the user + * selects a value and changes the index, as shown in the example below. + * + * ```` + * { + * this.setState({selectedIndex: event.nativeEvent.selectedSegmentIndex}); + * }} + * /> + * ```` */ var SegmentedControlIOS = React.createClass({ mixins: [NativeMethodsMixin], @@ -43,7 +60,7 @@ var SegmentedControlIOS = React.createClass({ values: PropTypes.arrayOf(PropTypes.string), /** - * The index in `props.values` of the segment to be pre-selected + * The index in `props.values` of the segment to be (pre)selected. */ selectedIndex: PropTypes.number,