Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wrathchaos/react-native-picker-modal
Easy and fully customizable picker modal for React Native
https://github.com/wrathchaos/react-native-picker-modal
android app apple application development front-end google ios mobile mobile-development modal picker picker-modal react-native reactjs select select-modal ui ux
Last synced: about 2 months ago
JSON representation
Easy and fully customizable picker modal for React Native
- Host: GitHub
- URL: https://github.com/wrathchaos/react-native-picker-modal
- Owner: WrathChaos
- License: mit
- Created: 2022-01-02T16:31:20.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-07-10T20:01:05.000Z (over 1 year ago)
- Last Synced: 2024-10-25T16:59:13.842Z (2 months ago)
- Topics: android, app, apple, application, development, front-end, google, ios, mobile, mobile-development, modal, picker, picker-modal, react-native, reactjs, select, select-modal, ui, ux
- Language: TypeScript
- Homepage: https://freakycoder.com
- Size: 7.01 MB
- Stars: 28
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/WrathChaos/react-native-picker-modal)
[](https://github.com/WrathChaos/react-native-picker-modal)
[](https://www.npmjs.com/package/@freakycoder/react-native-picker-modal)
[](https://www.npmjs.com/package/@freakycoder/react-native-picker-modal)
[](https://opensource.org/licenses/MIT)
[](https://github.com/prettier/prettier)
# Installation
Add the dependency:
```bash
npm i react-native-picker-modal
```
## Peer Dependencies
IMPORTANT! You need install them
```ts
"react-native-modal": ">= 13.0.0"
```
# Usage
## Import
```tsx
import PickerModal from "@freakycoder/react-native-picker-modal";
```
## Fundamental Usage
```tsx
{
console.log({ selectedItem, index });
}}
onCancelPress={() => {
setVisible(false);
}}
onBackdropPress={() => {
setVisible(false);
}}
/>
```
## Example Project 😍
You can checkout the example project 🥰
Simply run
```
npm i
```
```
react-native run-ios/android
```
should work of the `example` project.
# Configuration - Props
## Fundamentals [Required]
| Property | Type | Default | Description |
| ------------- | :------: | :-------: | ------------------------------------------------------------------------- |
| title | string | undefined | change the title |
| data | string[] | undefined | set the picker modal dataset as string array |
| isVisible | boolean | undefined | change the picker modal visibility |
| onPress | function | undefined | set your own logic for the button functionality when it is pressed |
| onCancelPress | function | undefined | set your own logic for the cancel button functionality when it is pressed |
## Customization (Optionals)
| Property | Type | Default | Description |
| ------------------------- | :-------------------: | :-------------------: | ---------------------------------------------------------------------------------------- |
| onBackdropPress | function | undefined | set your own logic for the backdrop of the modal functionality when it is pressed |
| TouchableComponent | `TouchableHightlight` | default | set your own component instead of default `react-native` `TouchableHightlight` component |
| style | ViewStyle | default | set or override the style object for the main container |
| dividerStyle | ViewStyle | default | set or override the style object for the divider style |
| cancelButtonStyle | ViewStyle | default | set or override the style object for the cancel button style |
| titleTextContainer | ViewStyle | default | set or override the style object for the title text container |
| titleTextStyle | TextStyle | default | set or override the style object for the title text style |
| cancelButtonTextStyle | ViewStyle | default | set or override the style object for the cancel button text container |
| actionButtonStyle | ViewStyle | default | set or override the style object for the action button container |
| actionButtonTextStyle | ViewStyle | default | set or override the style object for the action button text |
| actionButtonUnderlayColor | string | rgba(0,0,0,0.3) | change the action button's underlay color |
| cancelButtonUnderlayColor | string | rgba(200,200,200,0.1) | change the cancel button's underlay color |
## Future Plans
- [x] ~~LICENSE~~
- [ ] Write an article about the lib on Medium
## Author
FreakyCoder, [email protected]
## License
React Native Picker Modal is available under the MIT license. See the LICENSE file for more info.