64d80b13db
Summary: Now that the Component and API docs are no longer auto-generated, we need to consolidate on a new format for our jsdoc comments. Any help from the community will be appreciated. In this initial pull request, we'll be tackling the following docs: - `AccessibilityInfo`, an API doc. - `ActivityIndicator`, a Component doc. - `View`, a Component doc. This top comment will serve as a style guide, and when in doubt, please refer to the individual commits in this PR. Each commit should update a single component or API, along with any relevant markdown files. - Documentation in the JavaScript source files should be succinct. Any verbosity should be moved over to the markdown docs in the website... - ...by adding a link to the relevant method/prop on the website to every comment block. - Avoid markdown style links in JavaScript source files, opt for plain old URIs. Let code document itself: - If a method is Flow typed, the comment block does not need to repeat this information. - If a param can be one of several values, and the type definition is easily determined from the code, the values should not be repeated in the comment block. Again, move this to the markdown doc if not present already. Closes https://github.com/facebook/react-native/pull/16790 Differential Revision: D6353840 Pulled By: hramos fbshipit-source-id: 9712c459acc33092aae9909f3dd0b58a00b26afc
2.2 KiB
| id | title | layout | category | permalink | next | previous |
|---|---|---|---|---|---|---|
| segmentedcontrolios | SegmentedControlIOS | docs | components | docs/segmentedcontrolios.html | slider | sectionlist |
Use SegmentedControlIOS to render a UISegmentedControl iOS.
Programmatically changing selected index
The selected index can be changed on the fly by assigning the selectedIndex 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.
<SegmentedControlIOS
values={['One', 'Two']}
selectedIndex={this.state.selectedIndex}
onChange={(event) => {
this.setState({selectedIndex: event.nativeEvent.selectedSegmentIndex});
}}
/>
Props
Reference
Props
enabled
If false the user won't be able to interact with the control. Default value is true.
| Type | Required |
|---|---|
| bool | No |
momentary
If true, then selecting a segment won't persist visually.
The onValueChange callback will still work as expected.
| Type | Required |
|---|---|
| bool | No |
onChange
Callback that is called when the user taps a segment; passes the event as an argument
| Type | Required |
|---|---|
| function | No |
onValueChange
Callback that is called when the user taps a segment; passes the segment's value as an argument
| Type | Required |
|---|---|
| function | No |
selectedIndex
The index in props.values of the segment to be (pre)selected.
| Type | Required |
|---|---|
| number | No |
tintColor
Accent color of the control.
| Type | Required |
|---|---|
| string | No |
values
The labels for the control's segment buttons, in order.
| Type | Required |
|---|---|
| array of string | No |