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

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
2.2.0	Capacitor 5
2.3.0	Capacitor 6
2.3.1	Capacitor 6
2.3.3	Capacitor 6

Changelog

version 1.0.1 updated for capacitor 5 version 2.1.2 updated MLKit version in android version 2.3.0 capacitor 6 support version 2.3.3 Fix Android ladybug build

iOS

In XCode -> App info.plist add key NSCameraUsageDescription

Web implementation on 2.3.1

On versión 2.3.1+ the web versión will call an input image for QR Only detection using JSQR, this feature is experimental and for debuging purposes

API

<docgen-index>

scan()
multiScan(...)
Interfaces

</docgen-index> <docgen-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

</docgen-api>

Package detail