rn-prompt
v1.0.4
Published
A cross-platform prompt component for React Native.
Downloads
388
Maintainers
Readme
Disclaimer:
I did not create and do not maintain this project! (at least not at the moment)
This project belongs to jaysoo and is a fork from lightman73's fork that includes changes to remove the prop-types error. This fork is only and only because the original package is not maintained anymore and i wanted to publish it to use it with my projects.
Feel free to use it, and if the community wants the package to be maintained from this repo, it's all fine by me.
rn-prompt
A cross-platform prompt component for React Native.
Installation
$ npm install rn-prompt --save
Demo
| iOS | Android | | --- | ------- | | | |
Basic Usage
import Prompt from 'rn-prompt';
// Inside render()
<Prompt
title="Say something"
placeholder="Start typing"
defaultValue="Hello"
visible={ this.state.promptVisible }
onCancel={ () => this.setState({
promptVisible: false,
message: "You cancelled"
}) }
onSubmit={ (value) => this.setState({
promptVisible: false,
message: `You said "${value}"`
}) }/>
Please refer to the full working example here.
API
Props:
visible
(boolean) -- Whentrue
, the prompt is displayed, closes otherwisetitle
(string, required) -- The title text of the promptplaceholder
(string) -- The placeholder text of the promptdefaultValue
(string) -- The default value of the promptonCancel
(function, required) -- Function that is called when user cancels promptonSubmit
(function, required) -- Function that is called with user's value when they submitsubmitText
(string) -- The string that is displayed on the submit button (defaults to "OK")cancelText
(string) -- The string that is displayed on the cancel button (defaults to "Cancel")onChangeText
(function) -- Function that is called with user input when it changes.textInputProps
(Object) -- Additional props on the input element
Testing
Install dev modules:
npm install
Run tests
npm test
Changelog
1.0.3
- Added Keyboard return as a submit (Thanks https://github.com/aquacash5)
- Compatibility problems with React >= 15.5
1.0.0
- Updates
value
whendefaultValue
changes. (Thanks https://github.com/vessp) - Removes unnecessary
flex: 1
style. (Thanks https://github.com/stevehollaar)
0.18.6
- Adds
textInputProps
to allow additional props to be passed to the input element. Thanks @yueshuaijie!