2.1.1 • Published 5 years ago

styled-react-native-pin-view v2.1.1

Weekly downloads
14
License
MIT
Repository
github
Last release
5 years ago

React Native Pin View

Easy, convenient, quick-forming PinView component. It runs smoothly for both IOS and Android, and has only keyboard and input. Thats means you can use everywhere also there is no need to run react-native link

What's new at v2.1.0
TODO's
What was new at v2.0.1

With v2.0.1 user inputted pin will not verified by react-native-pin-view. PinView component will only return the inputted value.

  • returnType added (Return type of inputted value : array or string)
  • onComplete added (This will return inputtedVal and clear() callback) (When user inputted the pin it will run. (Will return inputted value as returnType))
  • pinLength added (User pin length or default pin length for all users.)
  • clear() you can use this in onComplete callback. If you want to clear user input you should call this.

Getting Started

via Yarn

yarn add styled-react-native-pin-view

via NPM

npm install --save styled-react-native-pin-view

Basic Usage

import PinView from 'react-native-pin-view'

...
        <PinView
            onComplete={(val, clear)=>{alert(val)}}
            pinLength={5}
        />

Props

PropTypeDefaultDescriptionRequired
buttonTextColorstring#333Color of the texts on the number keyboard.No
buttonBgColorstring#FFFBackground of the buttons on the number keyboardNo
inputBgColorstring#333Input color before entering the pinNo
inputBgOpacitynumber0.1Input opacity before entering the pinNo
inputActiveBgColorstring#333The input color that is active when entering the pin.No
deleteTextstringDELAppears when the user starts entering the pin.No
onCompletefuncnoneWhen the user completed input the pin, then inputted value will return. Also clear() is returning too. So if you want to remove user input after onComplete call clear() func in onComplete.Yes
returnTypestringstringonComplete returning value type. It can be string or arrayNo
pinLengthnumbernone(Min length: 3 , Max length: 8) User pin length like this.state.pin.length or 5 If you're using hashed pin then set default length all pin or use pin length.Yes
disabledbooleanfalseOptionally, you can set this props true or false. If true, the user can not enter the password.No
delayBeforeOnCompletenumber175Optionally, you can set this props for delaying before onComplete event.No

Example App

import React, { Component } from 'react';
import { View } from 'react-native';
import PinView from 'react-native-pin-view'

type Props = {};
export default class Master extends Component<Props> {
  constructor(props) {
    super(props);
    this.onComplete = this.onComplete.bind(this);
    this.state = {
        pin: "896745"
    }
  }
  onComplete(inputtedPin, clear) {
  if(val!==this.state.pin){
  clear();
  }else{
  console.log("Pin is correct")
  }
  }
  render() {
    return (
      <View style={ {
        flex           : 1,
        backgroundColor: '#f1f1f1',
        justifyContent : 'center'
      } }>
        <PinView
        onComplete={this.onComplete}
        pinLength={this.state.pin.length}
        // pinLength={6} // You can also use like that.
        />
      </View>
    );
  }
}

Contributors (Thank you all)

Built With

License

This project is licensed under the MIT License - see the LICENSE.md file for details