capacitor-face-id
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.2 • Public • Published

    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

    Install

    npm i capacitor-face-id

    DownloadsWeekly Downloads

    144

    Version

    2.0.2

    License

    MIT

    Unpacked Size

    190 kB

    Total Files

    63

    Last publish

    Collaborators

    • danielsogl