|
#### Android
| **[Hamadakram/AlertView](https://github.com/Hamadakram/AlertView)** |
|------------------------------------------------------------------------------------------|
| 
|
| **[Hamadakram/AlertView](https://github.com/Hamadakram/AlertView)** |
|--------------------------------------------------------------------------------------------------------------------|
| 
|
## 📖 Getting started
`$ npm install react-native-selection-menu --save`
`$ react-native link react-native-selection-menu`
* Android
* Please add below script in your build.gradle
```
buildscript {
repositories {
jcenter()
maven { url "https://maven.google.com" }
maven { url "https://jitpack.io" }
...
}
}
allprojects {
repositories {
mavenLocal()
jcenter()
maven { url "https://maven.google.com" }
maven { url "https://jitpack.io" }
...
}
}
```
> **Note:** Android SDK 27 > is supported
* iOS
> **iOS Prerequisite:** Please make sure CocoaPods is installed on your system
* After `react-native link react-native-selection-menu`, please verify `node_modules/react-native-selection-menu/ios/` contains `Pods` folder. If does not exist please execute `pod install` command on `node_modules/react-native-selection-menu/ios/`, if any error => try `pod repo update` then `pod install`
* After verification, open your project and create a folder 'RSSelectionMenu' under Libraries.
* Drag `node_modules/react-native-selection-menu/ios/pods/Pods.xcodeproject` into RNSelectionMenu, as well as the RNSelectionMenu.xcodeproject if it does not exist.
* Add the `RSSelectionMenu.framework` into your project's `Embedded Binaries` and make sure the framework is also in linked libraries.
* Go to your project's `Build Settings -> Frameworks Search Path` and add `${BUILT_PRODUCTS_DIR}/RSSelectionMenu` non-recursive.
* Now build your iOS app through Xcode
## 💻 Usage
```javascript
import { RNSelectionMenu } from 'react-native-selection-menu'
```
* **Actionsheet**: `RNSelectionMenu.Actionsheet(props)`
* **Alert**: `RNSelectionMenu.Alert(props)`
* **Formsheet**: `RNSelectionMenu.Formsheet(props)`
## 💡 Props
- **General(iOS & Android)**
| Prop | Type | Default | Note |
|---------------|----------|-------------------|-----------------------------------------------------------------|
| `values` | `array` | | Specify `string` array values you want to display for selection |
| `title` | `string` | `Pick your value` | Specify title of selection menu |
| `onSelection` | `func` | | Specify onSelection callback function |
- **iOS**
| Prop | Type | Default | Note |
|------------------|---------------------|-----------|---------------------------------------------------------------------|
| `selectedValues` | `array` | | Specify selected values marked with tick |
| `tickColor` | `string: HEX-COLOR` | `#157efb` | Specify tick color |
| `actionTitle` | `string` | `Select` | Specify action title, this appear when selection type is `multiple` |
- **Android**
| Prop | Type | Default | Note |
|------------|----------|---------|------------------------------------------------------|
| `subtitle` | `string` | | Specify subtitle of menu |
| `theme` | `int` | | Specify theme of selection menu `[Light: 0/Dark: 1]` |
- **Selection**
| Type | Value |
|------------|-------|
| `Single` | `0` |
| `Multiple` | `1` |
> **Limitation**: `Multiple selection is currently not supported on Android`
- **Presentation Style**
| Type | Value |
|---------------|-------|
| `Actionsheet` | `0` |
| `Alert` | `1` |
| `Formsheet` | `2` |
- **Search**
| Prop | Type | Default | Note |
|------------------------|---------------------|-----------|---------------------------------------|
| `enableSearch` | `bool` | `false` | Enable/Disable search capability |
| `searchPlaceholder` | `string` | `Search` | Specify your search placeholder value |
| `searchTintColor: iOS` | `string: HEX-COLOR` | `#d3d3d3` | Specify search tint color |
> **Limitation**
> - Android: Search is supported only for `Formsheet` presentation style
> - Formsheet: By default has search capability
## ✨ Credits
- iOS: [rushisangani/RSSelectionMenu](https://github.com/rushisangani/RSSelectionMenu)
- Android: [Hamadakram/AlertView](https://github.com/Hamadakram/AlertView)
- Android: [mirrajabi/search-dialog](https://github.com/mirrajabi/search-dialog)
## 🤔 How to contribute
Have an idea? Found a bug? Please raise to [ISSUES](https://github.com/prscX/react-native-selection-menu/issues).
Contributions are welcome and are greatly appreciated! Every little bit helps, and credit will always be given.
## 💫 Where is this library used?
If you are using this library in one of your projects, add it in this list below. ✨
## 📜 License
This library is provided under the Apache 2 License.
RNSelectionMenu @ [prscX](https://github.com/prscX)
## 💖 Support my projects
I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
* Starring and sharing the projects you like 🚀
* If you're feeling especially charitable, please follow [prscX](https://github.com/prscX) on GitHub.
Thanks! ❤️