Capacitor plugin for the SmartScanner Core library to scan MRZ, NFC and barcodes.
This plugin can be installed from NPM:
# Using npm
npm install @idpass/smartscanner-capacitor
# Using yarn
yarn add @idpass/smartscanner-capacitorThe plugin can be used through Capacitor's Plugins object, which is the registry of all available plugins.
import { Plugins } from '@capacitor/core';
const { SmartScannerPlugin } = Plugins;MRZ scanning example:
const result = await SmartScannerPlugin.executeScanner({
action: 'START_SCANNER',
options: {
mode: 'mrz',
mrzFormat: 'MRTD_TD1',
config: {
background: '#89837c',
branding: false,
isManualCapture: true,
showGuide: true, // beta version 0.4.5-beta
},
},
});NFC scanning example:
const result = await SmartScannerPlugin.executeScanner({
action: 'START_SCANNER',
options: {
mode: 'nfc-scan',
config: {
background: '#89837c',
branding: false,
isManualCapture: false,
},
},
});Barcode scanning example:
const result = await SmartScannerPlugin.executeScanner({
action: 'START_SCANNER',
options: {
mode: 'barcode',
barcodeOptions: {
barcodeFormats: [
'AZTEC',
'CODABAR',
'CODE_39',
'CODE_93',
'CODE_128',
'DATA_MATRIX',
'EAN_8',
'EAN_13',
'QR_CODE',
'UPC_A',
'UPC_E',
'PDF_417',
],
},
config: {
background: '#ffc234',
label: 'Sample Label',
},
},
});Refer to the API Reference for more information about the available API options and the returned result.
- smartscanner-core - Android library for scanning MRZ, Barcode, and ID PASS Lite cards
- smartscanner-android-api - Provides convenience methods to simplify the SmartScanner intent call out process
- smartscanner-cordova - SmartScanner Cordova plugin
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent