Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
4ian committed Sep 9, 2016
1 parent c0a06e7 commit 1e11fb0
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 1 deletion.
37 changes: 36 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,37 @@
# RNNumberPickerDialog
# react-native-numberpicker-dialog

Show an Android modal dialog with a list of choices displayed using a `android.widget.NumberPicker`.

![Android modal dialog with a list of choices displayed using a `android.widget.NumberPicker`](docs/preview.png)

This is only for Android. There is the built-in [React Native Picker component](https://facebook.github.io/react-native/docs/picker.html) for iOS. It works for Android too, but display a dialog (or dropdown) with a long list of choices that can be confusing.

## Setup

Install the package with React Native:
```
react-native install react-native-numberpicker-dialog
```

## Usage example

```javascript
import NumberPickerDialog from 'react-native-numberpicker-dialog';

NumberPickerDialog.show({
values: ['First item', 'Second item', 'Third item'],
positiveButtonLabel: 'Ok',
negativeButtonLabel: 'Cancel',
message: 'What would you like to have?',
title: 'Nice dialog',
}).then((id) => {
// id is the index of the chosen item, or -1 if the user cancelled.
});
```

## Other open-source modules by the folks at [BAM](http://github.com/bamlab)

* [react-native-image-resizer](/~https://github.com/bamlab/react-native-image-resizer)
* [rn-camera-roll](/~https://github.com/bamlab/rn-camera-roll)
* [react-native-animated-picker](/~https://github.com/bamlab/react-native-animated-picker)
* [cordova-plugin-native-routing](/~https://github.com/bamlab/cordova-plugin-native-routing)
Binary file added docs/preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1e11fb0

Please sign in to comment.