ZBar

Improve this doc

$ ionic plugin add cordova-plugin-cszbar
$ npm install --save @ionic-native/zbar

Repo: https://github.com/tjwoon/csZBar

The ZBar Scanner Plugin allows you to scan 2d barcodes.

Requires Cordova plugin: cordova-plugin-cszbar. For more info, please see the zBar plugin docs.

Supported platforms

Usage

import { ZBar, ZBarOptions } from '@ionic-native/z-bar';

constructor(private zbar: ZBar) { }

...

let ZBarOptions = {
      flash: "off",
      drawSight: false
    };

this.zbar.scan(zBarOptions)
   .then(result => {
      console.log(result); // Scanned code
   })
   .catch(error => {
      console.log(error); // Error message
   });

Instance Members

scan(options)

Open the scanner

Param Type Details
options ZBarOptions

Scan options

Returns: Promise<any> Returns a Promise that resolves with the scanned string, or rejects with an error.

ZBarOptions

Param Type Details
text_title string

A string representing the title text (Android only). Default: "Scan QR Code"

(optional)
text_instructions string

A string representing the instruction text (Android only). Default: "Please point your camera at the QR code."

(optional)
camera string

A string defining the active camera when opening the scanner. Possible values: "front", "back" Default: "back"

(optional)
flash string

A string defining the state of the flash. Possible values: "on", "off", "auto" Default: "auto"

(optional)
drawSight boolean

A boolean to show or hide a line in the center of the scanner. Default: true

(optional)

API

Native

General