react-native/website/versioned_docs/0.22/segmentedcontrolios.md

id, title, original_id

id	title	original_id
version-0.22-segmentedcontrolios	segmentedcontrolios	segmentedcontrolios

SegmentedControlIOS #

Edit on GitHub

Use SegmentedControlIOS to render a UISegmentedControl iOS.

Props #

View props... #

enabled bool #

If false the user won't be able to interact with the control. Default value is true.

momentary bool #

If true, then selecting a segment won't persist visually. The onValueChange callback will still work as expected.

onChange function #

Callback that is called when the user taps a segment; passes the event as an argument

onValueChange function #

Callback that is called when the user taps a segment; passes the segment's value as an argument

selectedIndex number #

The index in props.values of the segment to be pre-selected

tintColor string #

Accent color of the control.

values [string] #

The labels for the control's segment buttons, in order.

Examples #

Edit on GitHub

'use strict';

var React = require('react-native'); var { SegmentedControlIOS, Text, View, StyleSheet } = React;

var BasicSegmentedControlExample = React.createClass({ render() { return ( <View> <View style={{marginBottom: 10}}> <SegmentedControlIOS values={['One', 'Two']} /> </View> <View> <SegmentedControlIOS values={['One', 'Two', 'Three', 'Four', 'Five']} /> </View> </View> ); } });

var PreSelectedSegmentedControlExample = React.createClass({ render() { return ( <View> <View> <SegmentedControlIOS values={['One', 'Two']} selectedIndex={0} /> </View> </View> ); } });

var MomentarySegmentedControlExample = React.createClass({ render() { return ( <View> <View> <SegmentedControlIOS values={['One', 'Two']} momentary={true} /> </View> </View> ); } });

var DisabledSegmentedControlExample = React.createClass({ render() { return ( <View> <View> <SegmentedControlIOS enabled={false} values={['One', 'Two']} selectedIndex={1} /> </View> </View> ); }, });

var ColorSegmentedControlExample = React.createClass({ render() { return ( <View> <View style={{marginBottom: 10}}> <SegmentedControlIOS tintColor="#ff0000" values={['One', 'Two', 'Three', 'Four']} selectedIndex={0} /> </View> <View> <SegmentedControlIOS tintColor="#00ff00" values={['One', 'Two', 'Three']} selectedIndex={1} /> </View> </View> ); }, });

var EventSegmentedControlExample = React.createClass({ getInitialState() { return { values: ['One', 'Two', 'Three'], value: 'Not selected', selectedIndex: undefined }; },

render() { return ( <View> <Text style={styles.text} > Value: {this.state.value} </Text> <Text style={styles.text} > Index: {this.state.selectedIndex} </Text> <SegmentedControlIOS values={this.state.values} selectedIndex={this.state.selectedIndex} onChange={this._onChange} onValueChange={this._onValueChange} /> </View> ); },

_onChange(event) { this.setState({ selectedIndex: event.nativeEvent.selectedSegmentIndex, }); },

_onValueChange(value) { this.setState({ value: value, }); } });

var styles = StyleSheet.create({ text: { fontSize: 14, textAlign: 'center', fontWeight: '500', margin: 10, }, });

exports.title = '<SegmentedControlIOS>'; exports.displayName = 'SegmentedControlExample'; exports.description = 'Native segmented control'; exports.examples = [ { title: 'Segmented controls can have values', render(): ReactElement { return <BasicSegmentedControlExample />; } }, { title: 'Segmented controls can have a pre-selected value', render(): ReactElement { return <PreSelectedSegmentedControlExample />; } }, { title: 'Segmented controls can be momentary', render(): ReactElement { return <MomentarySegmentedControlExample />; } }, { title: 'Segmented controls can be disabled', render(): ReactElement { return <DisabledSegmentedControlExample />; } }, { title: 'Custom colors can be provided', render(): ReactElement { return <ColorSegmentedControlExample />; } }, { title: 'Change events can be detected', render(): ReactElement { return <EventSegmentedControlExample />; } } ];

Next →