Capacitor Face Id Save

Allow users to authenticate with Face ID or Touch ID on iOS devices

Project README

Capacitor Face ID Plugin

npm version Build

Allow users to authenticate with Face ID or Touch ID on iOS devices

Logo

Installation

npm install capacitor-face-id

iOS Notes

iOS requires the following usage description be added and filled out for your app in Info.plist:

Name: Privacy - Face ID Usage Description
Key: NSFaceIDUsageDescription

Example

import { Plugins, PluginResultError } from '@capacitor/core';

const { FaceId } = Plugins;

...
// check if device supports Face ID or Touch ID
FaceId.isAvailable().then(checkResult => {
  if(checkResult.value) {
    FaceId.auth().then(() => {
      console.log('authenticated');
    }).catch((error: PluginResultError) => {
      // handle rejection errors
      console.error(error.message);
    });
  } else {
    // use custom fallback authentication here
  }
});

API

Method Default Type Description
isAvailable() Promise<{ value: string }> Checks if Face ID or Touch ID is available, and returns type if so.
auth(options?: {reason?: string}) options: {reason: "Access requires authentication"} Promise<void> Displays the Face ID or Touch ID screen
Open Source Agenda is not affiliated with "Capacitor Face Id" Project. README Source: danielsogl/capacitor-face-id
Stars
93
Open Issues
9
Last Commit
2 weeks ago
License
MIT

Open Source Agenda Badge

Open Source Agenda Rating