capacitor-barcode-scanner
TypeScript icon, indicating that this package has built-in type declarations

2.1.2 • Public • Published

capacitor-barcode-scanner

Simple Barcode scanner for capacitor, shows popup camera view to scan. Supports code 128 and QR Uses Google MLKit in android, and AVFoundation on iOS

version 1.0.1 updated for capacitor 5 version 2.1.2 updated MLKit version in android

Install

npm i capacitor-barcode-scanner
npx cap sync

Capacitor Compatibility

Plugin Version Capacitor Version
0.0.2 Capacitor 3
1.0.1 Capacitor 5
2.0.0 Capacitor 5
2.1.1 Capacitor 5
2.1.2 Capacitor 5

iOS

In XCode -> App info.plist add key NSCameraUsageDescription

API

scan()

scan() => Promise<ScanResult>

Start scan screen This promise will fail if permission for camera is denied

Returns: Promise<ScanResult>


multiScan(...)

multiScan(opts?: MultiScanOptions | undefined) => Promise<MultiScanResult>

Start scan screen the difference vs scan is this will not close automatically, and continues scannning multiple codes ! Added in v1.1.1

Param Type
opts MultiScanOptions

Returns: Promise<MultiScanResult>


Interfaces

ScanResult

Represents a Scan Result

Prop Type Description
result boolean sucess status, its true when scanner got code
code string scanned code

MultiScanResult

Represents a Multiple scan result

Prop Type
result boolean
count number
codes string[]

MultiScanOptions

Prop Type Description
maxScans number Max quantity of codes to scan, when reached the amount activity or viewcontroller will close and return the scanned codes, it defaults to 9999

Package Sidebar

Install

npm i capacitor-barcode-scanner

Weekly Downloads

38

Version

2.1.2

License

MIT

Unpacked Size

114 kB

Total Files

44

Last publish

Collaborators

  • ruedaderepuesto