Code Monkey home page Code Monkey logo

cordova-plugin-zxing's Introduction

ZXing Barcode Scanner Plugin for Cordova

A plugin for Cordova using ZXing library from https://github.com/journeyapps/zxing-android-embedded, exposing a JavaScript interface for scanning barcodes (QR, 1D/2D).

This library enables an inverted scan, enabling scan on dark background with white patterns.

Works only on Android devices.

Barcode formats supported

1D product 1D industrial 2D
UPC_A CODE_39 QR_CODE
UPC_E CODE_93 DATA_MATRIX
EAN_8 CODE_128 PDF_417
EAN_13 ITF
RSS_14
RSS_EXPANDED

Installation

cordova plugin add cordova-plugin-zxing

API

Scan barcode

window.plugins.zxingPlugin.scan(params, onSuccess, onFailure)

Arguments:

  • params: All parameters are optional:

    {
        'prompt_message':'Scan a barcode', // Change the info message. A blank message ('') will show a default message
        'orientation_locked':true, // Lock the orientation screen
        'camera_id':0, // Choose the camera source
        'beep_enabled':true, // Enables a beep after the scan
        'scan_type':'normal', // Types of scan mode: normal = default black with white background / inverted = white bars on dark background / mixed = normal and inverted modes
        'barcode_formats':[
            'QR_CODE',
            'CODE_39',
            'CODE_128'], // Put a list of formats that the scanner will find. A blank list ([]) will enable scan of all barcode types
        'extras':{} // Additional extra parameters. See [ZXing Journey Apps][1] IntentIntegrator and Intents for more details
    }
  • onSuccess: function (s) {...} Callback for successful scan.

  • onFailure: function (s) {...} Callback for cancelled scan or error.

Return:

  • success('scanned bar code') Successful scan with value of scanned code
  • error('cancelled') If user cancelled the scan (with back button etc)
  • error('misc error message') Misc failure

This plugin is released under the Apache License 2.0

Copyright 2012-2018 ZXing authors, Journey Mobile, Marcelo Buregio

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

cordova-plugin-zxing's People

Contributors

marceloburegio avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.