@naturalclar/segmented-control
TypeScript icon, indicating that this package has built-in type declarations

1.1.1 • Public • Published

@react-native-community/segmented-control

CircleCI branch npm Lean Core Extracted

React Native SegmentedControlIOS library. Use SegmentedControlIOS to render a UISegmentedControl iOS.

Getting started

Install the library using either Yarn:

yarn add @react-native-community/segmented-control

or npm:

npm install --save @react-native-community/segmented-control

Migrating from the core react-native module

This module was created when the segmentedControlIos was split out from the core of React Native. To migrate to this module you need to follow the installation instructions above and then change you imports from:

import { SegmentedControlIOS } from "react-native";

to:

import SegmentedControlIOS from "@react-native-community/segmented-control";

Usage

Start by importing the library:

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.

import SegmentedControlIOS from "@react-native-community/segmented-control";

return (
  <SegmentedControlIOS
    values={["One", "Two"]}
    selectedIndex={this.state.selectedIndex}
    onChange={event => {
      this.setState({ selectedIndex: event.nativeEvent.selectedSegmentIndex });
    }}
  />
);

type SegmentedControlIOSProps = $ReadOnly<{|
  ...ViewProps,
  /**
   * The labels for the control's segment buttons, in order.
   */
  values?: $ReadOnlyArray<string>,
  /**
   * The index in `props.values` of the segment to be (pre)selected.
   */
  selectedIndex?: ?number,
  /**
   * Callback that is called when the user taps a segment;
   * passes the segment's value as an argument
   */
  onValueChange?: ?(value: number) => mixed,
  /**
   * Callback that is called when the user taps a segment;
   * passes the event as an argument
   */
  onChange?: ?(event: Event) => mixed,
  /**
   * If false the user won't be able to interact with the control.
   * Default value is true.
   */
  enabled?: boolean,
  /**
   * Accent color of the control.
   */
  tintColor?: ?string,
  /**
   * If true, then selecting a segment won't persist visually.
   * The `onValueChange` callback will still work as expected.
   */
  momentary?: ?boolean,
|}>;

Maintainers

Contributing

Please see the contributing guide.

License

The library is released under the MIT licence. For more information see LICENSE.

Package Sidebar

Install

npm i @naturalclar/segmented-control

Weekly Downloads

0

Version

1.1.1

License

MIT

Unpacked Size

46.1 kB

Total Files

19

Last publish

Collaborators

  • naturalclar