Skip to main content

The Scanner component for Retool Apps

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

Demo

Settings​

Scanner includes the following configurable options when building apps in the IDE.

DataEvent handlersIgnore duplicate codesShow on desktopShow on mobileMaintain space when hiddenMarginAlways show in edit modeSingle scanStyles

Properties​

All properties for Scanner with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

cameraId​

string

The ID of the camera to use.

data​

any[]

The source data.

events​

object[]

A list of configured event handlers that trigger actions or queries.

Properties

event​

enum

The event type. Refer to the events section for a list of supported events.

method​

enum

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

The type of action to perform.

Values
datasource

Control query.

widget

Control component.

script

Run script.

state

Set variable.

localStorage

Set localStorage.

util

Perform utility action (e.g., Open URL or Confetti).

global​

boolean

Whether the object is globally scoped for use in all app pages.

​

boolean

Whether the component is visible.

id​

string

The unique identifier.

Whether to ignore duplicate scans.

Whether the component is visible in the desktop layout.

Whether the component is visible in the mobile layout.

Whether the component takes up space on the canvas if hidden is true.

The amount of margin to render outside.

Values
4px 8px

Normal margin.

0

No margin.

paused​

boolean

Whether the operation is paused.

pluginType​

string

The plugin type.

Whether to remain visible in the editor if hidden is true.

Whether to allow only a single scan.

style​

object

Custom style options in use. Not all style options may be available for all components.

timeBetweenScans​

number

The time between scans, in milliseconds.

Methods​

JavaScript API methods for interacting with Scanner. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

clearValue​

Clear the current values.

scanner.clearValue()

pause​

Pause operation.

scanner.pause()

resume​

Resume operation.

scanner.resume()

scrollIntoView​

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

scanner.scrollIntoView(scrollIntoViewOptions)
Parameters

scrollIntoViewOptions​

object

The scroll options.

Properties

behavior​

enum

The scroll behavior.

Values
auto

Scroll immediately to the specified position.

smooth

Scroll gradually to the specified position.

block​

enum

The scroll position relative to the component.

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.

setHidden​

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

scanner.setHidden(hidden)
Parameters

​

boolean

Whether the component is visible.

setIgnoreDuplicates​

Whether to ignore duplicates.

scanner.setIgnoreDuplicates(ignoreDuplicates)
Parameters

Whether to ignore duplicate scans.

setSingleScan​

Whether to scan once.

scanner.setSingleScan(singleScan)
Parameters

Whether to allow only a single scan.

setTimeBetweenScans​

The time, in milliseconds, between scans.

scanner.setTimeBetweenScans(timeBetweenScans)
Parameters

timeBetweenScans​

number

The time between scans, in milliseconds.

Events​

Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.