The Scanner component for Retool Apps

An interface to scan a barcode or QR code using the device's camera.

Demo

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
Configurability	Inspector
Default	false

Examples

true

---

data

The data.

Type	string | number | boolean | object | array
Format	Custom data
Configurability	Inspector
Default	null

---

ephemeralConfirm

Whether to automatically confirm each scan.

Type	boolean
Configurability	Inspector
Default	null

---

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Hidden
Default	false

Examples

true

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Configurability	Inspector
Default	scanner1

Examples

query1

button1

---

ignoreDuplicates

Whether to ignore duplicate scans.

Type	boolean
Configurability	Inspector
Default	null

---

isHiddenOnDesktop

Whether to show or hide this object in the desktop layout.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Show on desktop
Default	false

Examples

true

---

isHiddenOnMobile

Whether to show or hide this object in the mobile layout.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Show on mobile
Default	true

Examples

true

---

launchButtonLabel

The primary text content.

Type	string
Format	Plain Text
Configurability	Inspector > Content > Add-ons > Text
Default	null

Examples

Submit

---

maintainSpaceWhenHidden

Whether to take up space on the canvas if hidden is true.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Maintain space when hidden
Default	false

Examples

true

---

margin

The amount of margin to render outside.

Type	string
Format	Plain Text
Configurability	Inspector > Spacing > Margin
Allowed Values	Value UI Option Description 4px 8px Normal Normal margin. 0 None No margin.
Default	4px 8px

Examples

4px 8px

---

onScan

The event handler that runs when a barcode is scanned.

Type	string
Configurability	Read-only
Default	null

---

showInEditor

Whether the component remains visible in the editor if hidden is true.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Always show in edit mode
Default	false

Examples

true

---

style

Custom style options.

Type	object
Configurability	Inspector > Appearance > style
Default	null

---

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()

Clear the current values.

Definition

scanner.clearValue()

Examples

Clear the current value of scanner.

scanner.clearValue();

---

scanner.pause()

Pause operation.

Definition

scanner.pause()

Examples

Pause scanner.

scanner.pause();

---

scanner.resume()

Resume operation.

Definition

scanner.resume()

Examples

Resume scanner.

scanner.resume();

---

scanner.scrollIntoView()

Scrolls the canvas or parent container so that the selected component appears in the visible area.

Definition

scanner.scrollIntoView(options)

Parameters

options

The scroll options.

Type

object

Object Properties

behavior

The scroll behavior.

Type	string
Allowed Values	Value Description auto Scroll immediately to the specified position. smooth Scroll gradually to the specified position.

---

block

The scroll position relative to the component.

Type	string
Allowed Values	Value Description nearest Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view. start Scrolls to position the component at the top of the visible area. center Scrolls to position the component in the middle of the visible area. end Scrolls to position the component at the bottom of the visible area.

---

---

Examples

Scroll the minimum amount to immediately bring scanner into view.

scanner.scrollIntoView({behavior: 'auto', block: 'nearest'});

---

scanner.setHidden()

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

Definition

scanner.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide scanner.

scanner.setHidden(true);

Unhide scanner.

scanner.setHidden(false);

---

scanner.setIgnoreDuplicates()

Whether to ignore duplicates.

Definition

scanner.setIgnoreDuplicates(ignoreDuplicates)

Parameters

ignoreDuplicates

Whether to ignore duplicate scans.

Type

boolean

---

---

scanner.setSingleScan()

Whether to scan once.

Definition

scanner.setSingleScan(singleScan)

Parameters

singleScan

Whether to allow only a single scan.

Type

boolean

---

Examples

Set scanner to scan once.

scanner.setSingleScan(true);

Set scanner to scan continuously.

scanner.setSingleScan(false);

---

scanner.setTimeBetweenScans()

The time, in milliseconds, between scans.

Definition

scanner.setTimeBetweenScans(timeBetweenScans)

Parameters

timeBetweenScans

The time between scans, in milliseconds.

Type

number

---

---

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