Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

rn-local-authentication

bebnev6.6kMIT1.2.5TypeScript support: included

The library helps you to authenticate users biometrically

react-native, biometry, local authentication, authentication, touch ID, face ID, fingerprint, BiometricPrompt, biometric, FingerprintManager, BiometricManager

readme

React Native Local Authentication

The library helps you to authenticate users biometrically natively on both iOS and Android devices. For iOS LocalAuthentication Framework is used, and for android: androidx.biometric:biometric framework (BiometricPrompt, BiometricManager)

Inspired by react-native-fingerprint-scanner and Android BiometricPrompt class that manages a system-provided biometric prompt.

Under construction

Platforms Supported

  • <input checked="" disabled="" type="checkbox"> iOS
  • <input checked="" disabled="" type="checkbox"> Android

Getting Started

Read Getting Started Guide. If any step seems unclear, please create a detailed issue.

TOC

Versioning

Breaking History:

  • 1.0.0 - first release

Usage

iOS example

Import LocalAuthentication from rn-local-authentication and use it like so:


import React from 'react';
import { View } from 'react-native';
import LocalAuthentication from 'rn-local-authentication';

// ...
class MyComponent extends React.Component {
  componentDidMount() {
    LocalAuthentication.authenticateAsync({
      reason: "Authorize please!"
    }).then(response => {
      if (response.success) {
        console.log('Authorized successfully!');
      } else {
        console.log(`Something went wrong. Error: ${response.error}`);
      }
    })
  }

  render() {
    return (<View />);
  }

  // ...
}

link to example launch

License

MIT