The Scanner component for Retool Apps

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

Version: Self-hosted 3.114 Stable

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
Mutability	Control Usage Retool UI Inspector
Default	false

Examples

true

---

data

The data.

Type	array
Format	Custom data
Mutability	Control Usage Retool UI Inspector Method copyToClipboard()

---

ephemeralConfirm

Whether to automatically confirm each scan.

Type	boolean
Mutability	Control Usage Retool UI Inspector

---

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance Method setHidden()
Default	false

Examples

true

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector
Default	scanner1

Examples

query1

button1

---

ignoreDuplicates

Whether to ignore duplicate scans.

Type	boolean
Mutability	Control Usage Retool UI Inspector Method setIgnoreDuplicates()

---

launchButtonLabel

The primary text content.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons

Examples

Submit

---

onScan

The event handler that runs when a barcode is scanned.

Type	string
Mutability	Read-only

---

style

Custom style options.

Type	object
Mutability	Control Usage Retool UI Inspector > Appearance

---

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 Required

object

The scroll options.

Object Properties

behavior Required

string

The scroll behavior.

Supported Values

auto	Scroll immediately to the specified position.
smooth	Scroll gradually to the specified position.

block Required

string

The scroll position relative to the component.

Supported Values

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

boolean

Whether this object is hidden from view.

Examples

Hide scanner.

scanner.setHidden(true);

Unhide scanner.

scanner.setHidden(false);

---

scanner.setIgnoreDuplicates()

Whether to ignore duplicates.

Definition

scanner.setIgnoreDuplicates(ignoreDuplicates)

Parameters

ignoreDuplicates

boolean

Whether to ignore duplicate scans.

---

scanner.setSingleScan()

Whether to scan once.

Definition

scanner.setSingleScan(singleScan)

Parameters

singleScan

boolean

Whether to allow only a single scan.

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

number

The time between scans, in milliseconds.

---

Events

Events triggered by user interactions. Use event handlers to trigger queries or other actions in response to events.