The Scanner component for Retool Apps
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.
| 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
The ID of the camera to use.
Properties
event
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 |
false | A user sets the value to |
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
The JavaScript method to perform when type is datasource, widget, state, or localStorage.
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
Whether the object is globally scoped for use in all app pages.
id
The unique identifier.
ignoreDuplicates
Whether to ignore duplicate scans.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden is true.
paused
Whether the operation is paused.
pluginType
The plugin type.
showInEditor
Whether to remain visible in the editor if hidden is true.
singleScan
Whether to allow only a single scan.
timeBetweenScans
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
The scroll options.
Properties
behavior
The scroll behavior.
Values
auto | Scroll immediately to the specified position. |
smooth | Scroll gradually to the specified position. |
block
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
setIgnoreDuplicates
Whether to ignore duplicates.
scanner.setIgnoreDuplicates(ignoreDuplicates)
Parameters
ignoreDuplicates
Whether to ignore duplicate scans.
setSingleScan
Whether to scan once.
scanner.setSingleScan(singleScan)
Parameters
singleScan
Whether to allow only a single scan.
setTimeBetweenScans
The time, in milliseconds, between scans.
scanner.setTimeBetweenScans(timeBetweenScans)
Parameters
timeBetweenScans
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.