Skip to content
👆 📱 Cordova Plugin for fingerprint sensors (and FaceID) with Android and iOS support
Branch: master
Clone or download
Latest commit a37e199 Jan 26, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
.vscode Add check if faceid or touchid is available see #50 Nov 24, 2017
res/android
src Fix crash for fragment dismiss Jan 22, 2019
tests Add check if faceid or touchid is available see #50 Nov 24, 2017
www Add eslint Oct 8, 2017
.eslintrc.json
.gitignore
.npmignore Version bump 1.4.0, documentation and github templates Aug 11, 2018
.travis.yml Saucelabs job name Apr 12, 2018
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Jun 23, 2017
CONTRIBUTING.md Contributing infos Nov 10, 2017
LICENSE Ignore package lock Mar 23, 2018
README.md
package.json 1.6.0 Jan 26, 2019
plugin.xml

README.md

Cordova Plugin Fingerprint All-In-One

For Android and iOS

Gitter chat GitHub license Build Status Issue Count

NPM

This plugin provides a single and simple interface for accessing fingerprint APIs on both Android 6+ and iOS.

Features

  • Check if a fingerprint scanner is available
  • Fingerprint authentication
  • Ionic Native support
  • ngCordova support
  • Fallback options
  • Now with FaceID on iPhone X
  • ⚡️ Works with Capacitor. Try it out ⚡️

Platforms

  • Android - Minimum SDK 23
  • iOS - XCode 9.2 or higher required
    • Please set <preference name="UseSwiftLanguageVersion" value="3.2" /> in your config.xml

How to use


Tutorial about using this plugin with Ionic thanks to Paul Halliday

Examples

ngCordova Example

Ionic Native Example


Install

Install from NPM

cordova plugin add cordova-plugin-fingerprint-aio --save

If you want to set a FaceID description use:

cordova plugin add cordova-plugin-fingerprint-aio --variable FACEID_USAGE_DESCRIPTION="Login now...."

Use the release candidate for testing the latest fixes

You can use preview versions with the rc tag on npm.

cordova plugin add cordova-plugin-fingerprint-aio@rc

Use this Github repo

Get the latest development version. Not recommended!

cordova plugin add https://github.com/NiklasMerz/cordova-plugin-fingerprint-aio.git

Check if fingerprint authentication is available

Fingerprint.isAvailable(isAvailableSuccess, isAvailableError);

    function isAvailableSuccess(result) {
      /*
      result depends on device and os. 
      iPhone X will return 'face' other Android or iOS devices will return 'finger'  
      */
      alert("Fingerprint available");
    }

    function isAvailableError(message) {
      alert(message);
    }

Show authentication dialogue

Fingerprint.show({
      clientId: "Fingerprint-Demo",
      clientSecret: "password" //Only necessary for Android
    }, successCallback, errorCallback);

    function successCallback(){
      alert("Authentication successfull");
    }

    function errorCallback(err){
      alert("Authentication invalid " + err);
    }

Optional parameters

  • disableBackup: If true remove backup option on authentication dialogue for Android. Default: false.
  • localizedFallbackTitle (iOS only): Title of fallback button.
  • localizedReason (iOS only): Description in authentication dialogue.

Thanks to the authors of the original fingerprint plugins

Some code is refactored from their projects and I learned how to make Cordova plugins from their great plugins:

@EddyVerbruggen and @mjwheatley

Android

iOS

License

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.