Cordova Plugin Fingerprint All-In-One
For Android and iOS
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
- Please set
How to use
Tutorial about using this plugin with Ionic thanks to Paul Halliday
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; { /* result depends on device and os. iPhone X will return 'face' other Android or iOS devices will return 'finger' */ ; } { ; }
Show authentication dialogue
Fingerprint; { ; } { ; }
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
License
- Project and iOS source: MIT
- Android source: MIT and Apache 2.0