Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@twotalltotems/react-native-otp-input

Package Overview
Dependencies
Maintainers
3
Versions
32
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@twotalltotems/react-native-otp-input

is a tiny JS library for one time passcode (OTP). Supports smart input suggestion on iOS and code autofill on Android (it will be filled when you press the copy button on the SMS notification bar)

  • 1.0.18
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
17K
increased by2.24%
Maintainers
3
Weekly downloads
 
Created
Source

react-native-otp-input

react-native-otp-input is a tiny JS library which provides an elegant UI for user to input one time passcode (OTP). It handles the input suggestion on iOS when the OTP SMS is received. For Android, it will autofill when you press the copy button on the SMS notification bar. It also features a carefully crafted flow to handle edge cases for volatile user gestures. We provide default UI but you can always customize the appearance as you like.

demo.gif demo.gif

Installation

npm install --save @twotalltotems/react-native-otp-input or yarn add @twotalltotems/react-native-otp-input

Dependencies

It does not have additional dependencies except for react native itself.

Basic Usage

import OTPInputView from 'react-native-otp-input'

<OTPInputView
    style={{width: '80%', height: 200}}
    pinCount={4}
    code=""
    // codeInputFieldStyle={styles.borderStyleBase}
    // codeInputHighlightStyle={styles.borderStyleHighLighted}
    codeInputFieldStyle={styles.underlineStyleBase}
    codeInputHighlightStyle={styles.underlineStyleHighLighted}
    onCodeFilled = {(code => {
        console.log(`Code is ${code}, you are good to go!`)
    })}
/>

const styles = StyleSheet.create({
  borderStyleBase: {
    width: 30,
    height: 45
  },

  borderStyleHighLighted: {
    borderColor: "#03DAC6",
  },

  underlineStyleBase: {
    width: 30,
    height: 45,
    borderWidth: 0,
    borderBottomWidth: 1,
  },

  underlineStyleHighLighted: {
    borderColor: "#03DAC6",
  },
});

Parameters

ParameterrequiredDescription
pinCountYESNumber of digits you want
codeNOBesides providing an initial value, you can also give this value using state or props. It will override the user input and reset the focus. For example, you can use it to hook up with the Android SMS Retriever API.
codeInputFieldStyleNOThe style of the input field which is NOT focused
codeInputHighlightStyleNOThe style of the input field which is focused
onCodeFilledNOcallback when the code is done

Notes

The iOS input suggestion requires React Native 0.58+ and works for iOS 12 and above.

On Android, it will be autofilled when you press the copy code button in the notification bar (see above gif). It will do so only if the code is sent after the view is loaded. So make sure you request the code AFTER this view is loaded.

If you are interested in Android SMS Retriever API, I would suggest @Faizal's repo React-Native-OTP-Verify. It looks pretty cool and it should be straight-forward to use React-Native-OTP-Verify along with this library.

RoadMap

  • Typescript
  • Add tests

Developers

The library is developed by Anson Yao, Felipe Peña and other mobile team members in TTT studios.

TTT studios is a software developement agency operating in Vancouver. We craft software in mobile, web, backend, facial recognition, AI, AR/VR.

ttt-logo.png

Keywords

FAQs

Package last updated on 07 May 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc