@phil-r/react-native-prompt

1.0.10 • Public • Published

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.

react-native-prompt

A cross-platform prompt component for React Native.

Installation

$ npm install @phil-r/react-native-prompt --save

Demo

iOS Android

Basic Usage

import Prompt from '@phil-r/react-native-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) -- When true, the prompt is displayed, closes otherwise
  • title (string, required) -- The title text of the prompt
  • placeholder (string) -- The placeholder text of the prompt
  • defaultValue (string) -- The default value of the prompt
  • onCancel (function, required) -- Function that is called when user cancels prompt
  • onSubmit (function, required) -- Function that is called with user's value when they submit
  • submitText (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
  • limit (number) -- limit the length of the text

Testing

Install dev modules:

npm install

Run tests

npm test

Changelog

1.0.7

  • Add limit support

1.0.6

  • Deprecation warnings fix

1.0.3

1.0.0

0.18.6

  • Adds textInputProps to allow additional props to be passed to the input element. Thanks @yueshuaijie!

0.18.5

Package Sidebar

Install

npm i @phil-r/react-native-prompt

Weekly Downloads

0

Version

1.0.10

License

ISC

Unpacked Size

11 kB

Total Files

6

Last publish

Collaborators

  • phil-r