Skip to main content
Version: v11.7.1

Barcode Scanner

Barcode is a number encoded in a sequence of bars (vertical line). It is used for machine reading the number.  A common example where barcode scanning is used is billing in supermarkets. Bill desk employees add a product to the bill by just scanning the product’s barcode. Barcode scanner widget brings this scanning functionality to mobile devices.

Barcode Scanner widget is a button which, when clicked, opens the device camera for scanning. The scanned information will be available as ‘datavalue’ outbound property.


Barcode scanner has two main properties.

  1. Caption to be displayed
  2. Icon class for the icon to use.


CaptionThe caption is the text that the end user sees.
NameThe name is a unique identifier for the Barcode Scanner. Special characters and spaces are not allowed in widget name.
Default Value
ValueThis is the default value to display value for an editor widget. Note that the display value is just what the user sees initially, and is not always the dataValue returned by the widget.
ShowShowing determines whether or not a component is visible. It is a bindable property.
Load on Demand (visible only when show property is bound to a variable)When this property is set and show property is bound, the initialization of the widget will be deferred till the widget becomes visible. This behavior improves the load time. Use this feature with caution, as it has a downside (as we will not be able to interact with the widget through script until the widget is initialized). When show property is not bound the widget will be initialized immediately.
Bar Code FormatYou can restrict the format of the barcode to scan based on your app requirement. The format can be: - CODABAR (not supported in iOS), - CODE_39, - CODE_93 (not supported in iOS), - CODE_128, - DATA_MATRIX, - EAN_8, - EAN_13, - ITF - PDF_417 (not supported in iOS), - QR_CODE, - RSS14 (not supported in iOS), - RSS_EXPANDED (not supported in iOS), - UPC_E, - UPC_A, - ALL is the default setting. This option can be used to scan any barcode format listed above except PDF_417 and RSS_EXPANDED.
Icon ClassThis bindable property defines the class of the icon that is applied to the button.
Icon SizeThis property defines the size of the icon. Value has to be specified along with the units (em or px).
Horizontal AlignThis property specifies how the elements should be aligned horizontally - left, center or right.


  • On Success - The event listener to call when the barcode is successfully scanned.
    Two parameters are passed -  event object and isolate scope of the widget.

Use Cases


Barcode Scanner can be used to scan and encode a barcode sequence. Example: Barcode Scanner Usage with Web Service for book details from scanned book barcode In this post, we will be creating a page that has a button to scan a book’s barcode. When a book’s barcode is scanned, information about the book has to fetched using google books API and barcode.

Step 1: Data

  1. Open or Create a Hybrid Mobile App.
  2. From the Resources section, click on Web Services option >> Plus Icon>> Rest services to import the Google books API rest web service.
  3. Use the following Url:{q}
  4. Enable Advanced Settings and specify following parameters:
    • Headers Name: q
    • Test Value: 0141912499
  5. Click TEST at the bottom of the dialog.
  6. Once the response appears, click NEXT
  7. Click IMPORT

Step 2: Layout

  1. Create a page with basic profile template.

  1. Drag and drop barcode scanner widget on the page.

Step 3: Variable & Binding

  1. Create a page level API variable to use the imported google books API.

  1. Bind the value of q with barcode scanner ‘dataValue’ property and save the variable.

Steps on the binding page

  • Bind Card Image to book thumbnail of the Variable.
  • Bind Caption of Main Label to the book title.
  • Bind Caption of the Last Label to the book description.
  • Bind Show property of Tile such that tile will be shown only if there is book information.

  1. Drag and Drop a Label to the page, set Caption property to ‘Book Not found’. Bind the Show property this label such that this label is shown when the Variable does not return any books.


  1. On the success of barcode scanner, invoke the created variable.

Step 4: Build & Run

  1. Build the apk, install it on an android phone and open the app.

  1. Click on ‘scan a book’ button. The camera will open for barcode scanning. Point the camera at any book barcode.

  1. Book data will come up on the app, provided google has the book information.