@reason-react-native/picker

1.9.1 • Public • Published

@reason-react-native/picker

Build Status Version Chat

ReScript / Reason bindings for @react-native-picker/picker.

Exposed as ReactNativePicker module.

@reason-react-native/picker X.y.* means it's compatible with @react-native-picker/picker X.y.*

Installation

When @react-native-picker/picker is properly installed & configured by following their installation instructions, you can install the bindings:

npm install @reason-react-native/picker
# or
yarn add @reason-react-native/picker

@reason-react-native/picker should be added to bs-dependencies in your bsconfig.json:

{
  //...
  "bs-dependencies": [
    "reason-react",
    "reason-react-native",
    // ...
+    "@reason-react-native/picker"
  ],
  //...
}

Components

ReactNativePicker Component

Supported on Android and iOS.

Props

Prop Name and Type Notes
onValueChange:
('a, int) => unit
Callback for when an item is selected. Takes as arguements item value of any type ('a) and index of the selected item as int.
selectedValue: 'a Value should be that of one of the items.
enabled: bool Android only
Making a selection will be disabled when set to false.
mode:
[ | `dialog | `dropdown ]
Android only
Specifies how selection items will be displayed the picker is tapped.

- `dialog: modal dialog (default)
- `dropdown: dropdown anchored to the Picker view.
prompt: string Android only
Title of the modal dialog when mode is set to `dialog.
itemStyle: ReactNative.Style.t iOS only
Style to be applied to each item label.

Note: only Text style props are supported.

Please also see Reason React Native documentation of View props for additional supported props.

ReactNativePickerIOS Component

Supported on iOS.

Props

Prop Name and Type Notes
onValueChange:
('a, int) => unit
Callback for when an item is selected. Takes as arguements item value of any type ('a) and index of the selected item as int.
selectedValue: 'a Value should be that of one of the items.
itemStyle: ReactNative.Style.t Style to be applied to each item label.

Note: only Text style props are supported.

Please also see Reason React Native documentation of View props for additional supported props.

ReactNativePicker.Item and ReactNativePickerIOS.Item Components

Props

Prop Name and Type Notes
value: 'a Value of the item.
label: string Label for the item in the Picker.
color: ReactNative.Color.t Color of the item label.
testID: string ID string to locate the item in tests.

Changelog

Check the changelog for more informations about recent releases.


Contribute

Read the contribution guidelines before contributing.

Code of Conduct

We want this community to be friendly and respectful to each other. Please read our full code of conduct so that you can understand what actions will and will not be tolerated.

Package Sidebar

Install

npm i @reason-react-native/picker

Weekly Downloads

2

Version

1.9.1

License

MIT

Unpacked Size

16.4 kB

Total Files

7

Last publish

Collaborators

  • sgny
  • naturalclar
  • fham_
  • cknittel
  • moox