Skip to main content

The Scanner component for Retool Mobile

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

Settings

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

Auto closeSizeLabelDataDisabledEvent handlersPrefix iconShow on desktopShow on mobileMaintain space when hiddenMarginRatioAlways show in edit modeStylesWidth

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.

Whether to automatically close after input.


The size of the button.


The text label to display.


data

any[]

The source data.


Whether input, interaction, selection, or triggering is disabled.


events

object[]

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

Properties

event

enum

The event type.

Values
change

A user changes the value.

click

A user clicks or taps the component.

submit

A user submits the value.

focus

A user selects the input field.

blur

A user deselects the input field.

scan

A user scans a barcode.

open

A user opens the component.

close

A user closes the component.

true

A user sets the value to true.

false

A user sets the value to false.

select

A user selects a value.

clear

A user clears the value.

upload

A user uploads a file.

parse

An uploaded file is parsed.

inputValueChange

A user changes the value of the input field.


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.


The prefix icon to display.

Values

You can select an icon or dynamically set one with a valid icon key.


id

string

The unique identifier.


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.


opened

boolean

Whether the component is open.


pluginType

string

The plugin type.


The ratio of width-to-height.

Values
2

2:1 ratio.

1.3333333333333333

4:3 ratio.

1

1:1 ratio.

0.75

3:4 ratio.


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


style

object

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


width

number

The width.


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

close

Close the component.

scanner.close()

open

Open the component.

scanner.open()

setDisabled

Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.

scanner.setDisabled(disabled)
Parameters

Whether input, interaction, selection, or triggering is disabled.



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.



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.

capture

A value is captured.


Supported barcode formats

Mobile Scanner supports a range of barcode formats on iOS and Android.

NameShort nameiOSAndroid
Aztec Codeaztec
Codabarcodabar
Code 39code39
Code 39 with 43 check digitcode39mod43
Code 93code93
Code 128code128
Data Matrixdatamatrix
EAN-13ean13
EAN-8ean8
Interleaved 2 of 5interleaved2of5
ITF-14itf14
MaxiCodemaxicode
PDF417pdf417
RSS 14rss14
RSS Expandedrssexpanded
UPC-Aupc_a
UPC-Eupc_e
UPC/EAN-13upc_ean
QRqr