Skip to main content

QR Code

Ant Design

The QR Code component is Ant Design's QR code. It turns a URL or any text into a code that people scan with a phone, for example to open an order page or check in to an event.

Properties​

Property
Description
Expected Value
ValueText or URL the code holds. Text too long for a QR code shows a notice instead.Text. Default: https://tooljet.com
Size (px)Width and height of the code.Number. Default: 160
ColorColor of the code's dots. Leave it empty to follow the theme's text color.Text
BackgroundBackground color behind the code. Leave it empty to follow the theme.Text
Error levelHow much of the code can be damaged or covered and still scan: L about 7%, M 15%, Q 25% and H 30%. Higher levels make denser codes.L, M, Q, H. Default: M
IconURL of an image, such as a logo, drawn in the middle of the code. Use Error level H so the code still scans.Text
BorderedDraws a border around the code.On or off. Default: On

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
Set visibilityShows the component when true, hides it when false.components.qrcode1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.qrcode1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.qrcode1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
valueText or URL the code holds. Text too long for a QR code shows a notice instead.{{components.qrcode1.value}}
sizeWidth and height of the code.{{components.qrcode1.size}}
colorColor of the code's dots. Leave it empty to follow the theme's text color.{{components.qrcode1.color}}
bgColorBackground color behind the code. Leave it empty to follow the theme.{{components.qrcode1.bgColor}}
errorLevelHow much of the code can be damaged or covered and still scan: L about 7%, M 15%, Q 25% and H 30%. Higher levels make denser codes.{{components.qrcode1.errorLevel}}
iconURL of an image, such as a logo, drawn in the middle of the code. Use Error level H so the code still scans.{{components.qrcode1.icon}}
borderedDraws a border around the code.{{components.qrcode1.bordered}}
isVisibleWhether the component is visible.{{components.qrcode1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.qrcode1.isLoading}}
isDisabledWhether the component is disabled.{{components.qrcode1.isDisabled}}

Styles​

Style
Default
Primary colorTheme: Brand primary
Text colorTheme: Primary text
Container backgroundTheme: Surface 1
Border colorTheme: Default border
Border radius—
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.