Skip to content
Easy, convenient, quick-forming PinView component.
Branch: master
Clone or download
Talut TASGIRAN
Talut TASGIRAN eslint config file added
Latest commit c9c20aa Jul 16, 2019

README.md

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

PinView 1

What's new at v2.3.1
What's new at v2.2.2
What's new at v2.2.1
  • With this update you can change input style and keyboard number style.
  • Typescript definitions added.
TODO's
What was new at v2.1.0

Getting Started

via Yarn

yarn add react-native-pin-view

via NPM

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

Basic Usage


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

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

Props

Prop Type Default Description Required
buttonTextColor string #333 Color of the texts on the number keyboard. No
buttonBgColor string #FFF Background of the buttons on the number keyboard No
inputBgColor string #333 Input color before entering the pin No
inputBgOpacity number 0.1 Input opacity before entering the pin No
inputActiveBgColor string #333 The input color that is active when entering the pin. No
deleteText string DEL Appears when the user starts entering the pin. No
onComplete func none When 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
returnType string string onComplete returning value type. It can be string or array No
pinLength number none (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
disabled boolean false Optionally, you can set this props true or false. If true, the user can not enter the password. No
delayBeforeOnComplete number 175 Optionally, you can set this props for delaying before onComplete event. No
showInputs boolean false If you want to show inputted pin use this props. No
inputTextStyle object {color:'#FFF',fontWeight:'bold'} This props for styling inputted pin text. No
inputViewStyle object {borderRadius:6} This props for styling input view item. No
keyboardViewStyle object {borderRadius:6} This props for styling keyboard view item. No
keyboardViewTextStyle object {fontWeight:'normal'} This props for styling keyboard view text. No
keyboardContainerStyle object {marginTop:10} This props for styling keyboard container view text. No
onPress func undefined When the user presses the keypad, the inputted value (PIN code) will return. Also clear() is returned and the value of the pressed key. So if you want to remove user input after onPress call clear() func in onPress, or if you want to disable a submit button when the PIN code is not completely filled you can check it's length with value.length. 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")
    }
  }
  onPress(inputtedPin, clear, pressed) {
    console.log("Pressed: "+ pressed);
    console.log("inputtedPin: "+ inputtedPin)
    // clear()
  }
  render() {
    return (
      <View style={{
        flex           : 1,
        backgroundColor: '#f1f1f1',
        justifyContent : 'center'
      }}>
        <PinView
        onPress={this.onPress}
        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

You can’t perform that action at this time.