react-native-selection-menu
v1.0.2
Published
React Native: Native Selection Menu
Downloads
7
Readme
ReactNative: Native Selection Menu (Android/iOS)
If this project has helped you out, please support us with a star 🌟
Limitation:
Multiple selection is currently not supported on Android
iOS
| rushisangani/RSSelectionMenu | |-------------------------------------------------------------------------------------| | |
Android
| Hamadakram/AlertView | |------------------------------------------------------------------------------------------| | |
| Hamadakram/AlertView | |--------------------------------------------------------------------------------------------------------------------| | |
📖 Getting started
$ yarn add react-native-selection-menu --save
RN60 >= RNSM V1 >
RN60 above please use
react-native-selection-menu
V1 and above
- iOS
iOS Prerequisite: Please make sure
CocoaPods
is installed on your system
- Add the following to your `Podfile` -> `ios/Podfile` and run pod update:
use_native_modules!
pod 'RNSelectionMenu', :path => '../node_modules/react-native-selection-menu/ios'
use_frameworks!
pod 'RSSelectionMenu', :git => 'https://github.com/prscX/RSSelectionMenu.git', :branch => 'react-native'
post_install do |installer|
installer.pods_project.targets.each do |target|
if target.name.include?('RSSelectionMenu')
target.build_configurations.each do |config|
config.build_settings['SWIFT_VERSION'] = '4.2'
end
end
end
end
dynamic_frameworks = ['RSSelectionMenu']
# Make all the other frameworks into static frameworks by overriding the static_framework? function to return true
pre_install do |installer|
installer.pod_targets.each do |pod|
if !dynamic_frameworks.include?(pod.name)
def pod.static_framework?;
true
end
def pod.build_type;
Pod::BuildType.static_library
end
end
end
end
- Android
RN60 < RNSM V1 <
RN60 below please use
react-native-selection-menu
V.0.*
$ 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 verifynode_modules/react-native-selection-menu/ios/
containsPods
folder. If does not exist please executepod install
command onnode_modules/react-native-selection-menu/ios/
, if any error => trypod repo update
thenpod 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'sEmbedded 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
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
- Android: Hamadakram/AlertView
- Android: mirrajabi/search-dialog
🤔 How to contribute
Have an idea? Found a bug? Please raise to 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
💖 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 on GitHub.
Thanks! ❤️ prscX.github.io </ Pranav >