The QR Code component for Retool Apps

A content area to display a QR code.

Version: Cloud and 3.178 Edge

For more information about this component, refer to the Embedded media guide.

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.

heightType

Whether the height automatically adjusts to fit content or is a fixed size.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Spacing
Allowed Values	Value Description fixed Fixed height. auto Expand to fit content.
Default	fixed

---

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

---

horizontalAlign

The horizontal alignment of the contents.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Appearance
Allowed Values	Value Description left Left alignment. center Center alignment. right Right alignment.
Default	left

---

id

The unique identifier (name).

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

Examples

query1

button1

---

style

Custom style options.

Type	object
Mutability	Control Usage Retool UI Inspector > Appearance

---

value

The current or default value.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content Method setValue()
Default	null

Examples

Hello world!

---

Methods

JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

qrCode.clearValue()

Clear the current values.

Definition

qrCode.clearValue()

Examples

Clear the current value of qrCode.

qrCode.clearValue();

---

qrCode.resetValue()

Reset the current value to the default value.

Definition

qrCode.resetValue()

Examples

Reset the current value of qrCode.

qrCode.resetValue();

---

qrCode.scrollIntoView()

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

Definition

qrCode.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 qrCode into view.

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

---

qrCode.setHidden()

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

Definition

qrCode.setHidden(hidden)

Parameters

hidden

boolean

Whether this object is hidden from view.

Examples

Hide qrCode.

qrCode.setHidden(true);

Unhide qrCode.

qrCode.setHidden(false);

---

qrCode.setValue()

Set the current value.

Definition

qrCode.setValue(id, pluginType, global, isHiddenOnDesktop, isHiddenOnMobile, style, maintainSpaceWhenHidden, showInEditor, margin, value)

Parameters

id

unknown

pluginType

unknown

global

unknown

isHiddenOnDesktop

unknown

isHiddenOnMobile

unknown

style

unknown

maintainSpaceWhenHidden

unknown

showInEditor

unknown

margin

unknown

value

unknown

Examples

Set the current value of qrCode to userValue.

qrCode.setValue(userValue);

---

Events

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