From Documentation



A barcodescanner component is used to scan and decode the barcode on the client side. There are many properties to dealing with the barcodescanner component. First, you could use the type property to specify the type of barcode, for example: qr, code128, ..., after choosing the type you want, you could scan the barcode by the scanner. You can choose the continue scanning by setting continuous="true", and setting the scan rate by setting interval="1000", the unit of interval is millisecond. You can turn on the scanner switch by setting enable="true", or close it by enable="false".


BarScanner demo.png

 <barcodescanner type="qr,code128" continuous="true" interval="500" height="100px"  onDetected='Clients.log(event.getType() + " " + event.getResult())'/>


The Barcodescanner has 9 types for 1D and 1 type for 2D by default. After choosing the type of barcode, and you can scan the barcode as the type you choose. You also can scan multiple types at one time, just setting type="xxx1,xxx2". For example

 <barcodescanner type="qr,code128"/>


(1) The type that barcodescanner supported can be referenced as Supported Barcode Type (Default).

(2) Warn: if too many types are set for the widget, it may reduce the detecting accuracy.

(3) The barcodescanner will restart every time you change the type.


Continuous is a boolean attribute to let the barcodescanner can continuous scan or not.

 <barcodescanner type="qr" continuous="true"/>


The interval is a subsidiary, integer attribute for continuous. The interval="500" means the scanner will scan once every 500 millisecond.

 <barcodescanner type="code128" continuous="true" interval="500"/>


The enable is boolean attribute to switch the barcodescanner. You can use the zk mvvm mechanism to to switch the barcodescanner.

 <window viewModel="@id('vm')@init('xxxVM')">
   <barcodescanner type="code128" enable= "@bind('vm.enable')"/>

height, width

Height and width are string attributes to define the height and width of barcodescanner component.

 <barcodescanner type="qr" height="100px", width="200px"/>


(1) height is a string as a format of "number+px"

(2) Because of some browsers issue, the ratio of camera screen can only show as default value. The camera screen would fill up the space as user defined.


registerLibrary(constructor, library_name, [array of types] ) is a client-side, class-level method to register a custom library into barcode widget. The mechanism is like the registerLibrary in Barcode. The constructor is a json-format parameter to define all the need setting for the library.

constructor = 
	create: the function to create a reader prototype,
	name: the name of the reader, and we will mount the reader on the widget by wgt._'name'+'Reader',
	init: a function to initialize the reader properties,
	enable: a function to enable the detecting function,
	decodeOnce: a reader decode method, and zk will implement the contScan attribute for you,
	setType: a function to connect the reader and widget types function,
	other: a json properties to let you to attend the reader method.(future feature)

Like barcode, if you register the own custom library into Barcodescanner, every single widget should use the custom library object. The way to registering is zkmax.barscanner.Barcodescanner.registerLibrary(...). Here is the example that how we inject the quagga library object into the widget

<?script src="mybarscannerLibrary.js"?>
    zk.afterLoad('zkmax.barcode', function () {
            create: zkmax.barscanner.Barcodescanner._quaggaCreate, //the create function to the reader
            name: "QUAGGA",
            init: zkmax.barscanner.Barcodescanner._quaggaInit,  //@param(wgt, video, canvas)
            enable: zkmax.barscanner.Barcodescanner._quaggaEnable, //@param(wgt, video, canvas)
            decode: zkmax.barscanner.Barcodescanner._quaggaDecode,//@param(wgt, reader) 
            setTypes: zkmax.barscanner.Barcodescanner._quaggaSetType, //@param()
            other: null
         }, 'library-name', ['type1', 'type2', ...]);

And, you need to implement some method to build the reader.

<?script src="implementation.js"?>
    zkmax.barscanner.Barcodescanner._quaggaCreate: function () {
        /***the method to clone quagga reader***/
		return jq.extend(true, {}, zkmax.barscanner.quagga);
    zkmax.barscanner.Barcodescanner._quaggaInit: function (wgt, video, canvas) {
       /***the reader init method***/
      reader.onDetected() {
         reader.processing = false;
    zkmax.barscanner.Barcodescanner. _quaggaEnable: function (wgt, video, canvas) {
       /***the enable method for quagga reader init method***/
    zkmax.barscanner.Barcodescanner._quaggaDecode: function (wgt, reader) {
       reader.processing = true;
       /***the decode method for quagga reader***/
   zkmax.barscanner.Barcodescanner._quaggaSetType: function (wgt, video, canvas) {
       /***the set type method for quagga reader***/

For most barcode reader, they would have some some common points: init, enable, decode, on detect... When injecting reader into widget, we use the those common points to connect the reader and the widget. Here you have to implements the some function for this. As above, you need to implements the create. init, enable, decode and some other requiring method. Here is a little reminder that, because different library has different design for the decode and onDetected in their library, you may need to add a reader.processing = true at the beginner of decoding function, and reader.processing = false at the detected callback function by yourself. After you inject the library object into the widget, we will generate the javascript object mount on the widget. We generate zinit, zexecute, zenable, method onto the reader and we will use it internally. You can get the reader by wgt._'your_libarary_name'Reader.


(1) registerLibrary is the pure-client-side method.

(2) As barcode, If you want to register the custom library for all the web application, you can add <javascript src="mybarscannerLibrary.js"/>the source file at WEB-INF/lang-addon.xml.


    zk.afterLoad('zkmax.barcode', function () {
        zkmax.barscanner.Barcodescanner.registerLibrary(function mybarcode(wgt) {
         }, 'library-name', ['type1', 'type2', ...]);


When the scanner is enable, it would send a detect event when the scanner detected a barcode. The DetectEvent has two getter method, one is getType(), and the second is getResult. The getType() is the method to get what the type of the barcode is detected, and getResult() is the barcode value which the scanner detected.

For example:

If you want to show the type and result on the clients.log.

  <barcodescanner type="qy,code128" continuous="true" onDetect='Clients.log(event.getType() + " " + event.getResult())'/>

And at the clients log will display the type and value that scanner detected.

Supported Barcode Type (Default)

Barcode Type
1D CODE Family


1D EAN Family


1D Others




Supported Events

Event Type
Event: Event

Notifies if the barcode scanner detect a barcode message.

Supported Children


Use Cases

Version Description Example Location

Version History

Last Update : 2022/01/12

Version Date Content
8.6.0 May, 2018 Barcodescanner

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.