The Scanner component for Retool Mobile
An interface to scan a barcode or QR code using the device's camera.
Properties
All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
autoClose
Whether to automatically close after input.
| Type | boolean | ||||
| Format | True/False | ||||
| Mutability |
| ||||
| Default | |
Examples
true
buttonSize
The size of the button.
| Type | string | ||||||
| Mutability |
| ||||||
| Allowed Values |
|
buttonText
The text label to display.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
| ||||
| Default | |
Examples
"Label"
data
The data.
| Type | string | number | boolean | object | array | ||||||
| Format | Custom data | ||||||
| Mutability |
|
disabled
Whether input, interaction, selection, or triggering is disabled.
| Type | boolean | ||||||
| Format | True/False | ||||||
| Mutability |
| ||||||
| Default | |
Examples
true
hidden
Whether this object is hidden from view.
| Type | boolean | ||||||
| Format | True/False | ||||||
| Mutability |
| ||||||
| Default | |
Examples
true
iconBefore
The prefix icon to display.
| Type | string | ||||
| Format | Icon Key | ||||
| Mutability |
| ||||
| Default | |
Examples
/icon:bold/shopping-gift
ratio
The ratio of width-to-height.
| Type | string | ||||||||||
| Mutability |
| ||||||||||
| Allowed Values |
|
Examples
1280
Methods
JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
scanner.clearValue()
Examples
Clear the current value of scanner.
scanner.clearValue();
scanner.setDisabled()
Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.
scanner.setDisabled(disabled)
Parameters
disabled
Whether input, interaction, selection, or triggering is disabled.
| Type | boolean |
| Format | True/False |
| Default | |
Examples
true
Examples
Disable scanner.
scanner.setDisabled(true);
Enable scanner.
scanner.setDisabled(false);
scanner.setHidden()
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
scanner.setHidden(hidden)
Parameters
Examples
true
Examples
Hide scanner.
scanner.setHidden(true);
Unhide scanner.
scanner.setHidden(false);
Events
Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.
| Event | Description |
|---|---|
| Capture | A value is captured. |
Supported barcode formats
Mobile Scanner supports a range of barcode formats on iOS and Android.
| Name | Short name | iOS | Android |
|---|---|---|---|
| Aztec Code | aztec | ||
| Codabar | codabar | ||
| Code 39 | code39 | ||
| Code 39 with 43 check digit | code39mod43 | ||
| Code 93 | code93 | ||
| Code 128 | code128 | ||
| Data Matrix | datamatrix | ||
| EAN-13 | ean13 | ||
| EAN-8 | ean8 | ||
| Interleaved 2 of 5 | interleaved2of5 | ||
| ITF-14 | itf14 | ||
| MaxiCode | maxicode | ||
| PDF417 | pdf417 | ||
| RSS 14 | rss14 | ||
| RSS Expanded | rssexpanded | ||
| UPC-A | upc_a | ||
| UPC-E | upc_e | ||
| UPC/EAN-13 | upc_ean | ||
| QR | qr |