0.1.7 • Published 3 years ago

react-native-otp-autoverification v0.1.7

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

React Native Auto OTP Verification

react-native-OTPAutoverification is a small library which use Google's SMS Retriever API and auto fill inputs from SMS received includes OTP. For Android, It will fill as the SMS arrives automatically no user concern is required And on iOS the input suggestion arrives when the OTP SMS is received. It includes all the features you need regarding Focus and inputs and all the edge cases has been taken care of. You can always customize the UI of the Input elements and container as you need it and like it.

Installation Process

npm install --save react-native-otp-autoverification or yarn add react-native-otp-autoverification

Basic Usage

Android

Option: Manually

  • Edit android/settings.gradle to look like this:
     include ':react-native-otp-autoverification'
     project(':react-native-otp-autoverification').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-otp-autoverification/android')
  • Edit android/app/build.gradle (note: app folder) to look like this:

    dependencies {
    
         implementation project(':react-native-otp-autoverification')
    }
- Edit your `MainApplication.java` (deep in `android/app/src/main/java/...`) to look like this (note **two** places to edit):

 ``` java
 import com.otpautoverification.OTPAutoVerificationPackage;

    public class MainApplication extends Application implements ReactApplication {

    // …
  
  @Override
  protected List<ReactPackage> getPackages() {
    @SuppressWarnings("UnnecessaryLocalVariable")
    List<ReactPackage> packages = new PackageList(this).getPackages();
    // …
    packages.add(new OTPAutoVerificationPackage());
    return packages;
  }

    // …
    }  

JS

import {OTPAutoVerification} from 'react-native-otp-autoverification'
  ...

 <OTPAutoVerification numberOfInputs={6} /> 

More Advanced Usage

import {OTPAutoVerification} from 'react-native-otp-autoverification'

...

<OTPAutoVerification
    inputStyles={{width: 50, height: 50}}
    numberOfInputs={6}
    secureTextEntry
    selectionColor = {'grey'}
/>

Dependencies

No such Dependencies.

Parameters

ParameterrequiredDescription
numberOfInputsYESNumber of Input Fileds in the component
selectionColorNOColor of the selection done of the text
secureTextEntryNOContent hidden when Text entered
keyboardAppearanceNOTheme for the keyboard to appear as.
keyboardTypeNOType of keyboard
placeholderNODefault text shown in text fields
placeholderTextColorNOPlaceholder Color

Notes to Remember

On Android, it will be auto filled when SMS with OTP arrives but make sure you render the OTP Input fileds screen first and then SMS with OTP should arrive.

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

Author

for Sig Shashank Kumawat