Checkbox

The Checkbox component gives users a binary choice (select/clear).

Example

You can use the Checkbox component to make sure the user agrees to continue with a process. In this example, the button becomes active when the user agrees to terms and conditions.

Note: The Checkbox component follows the WCAG 2.0 AA accessibility guidelines.

Properties

The following Checkbox component properties are available:

Main

Property	Description	Required
Component ID	Enter a unique name for the component. See Templating in components for more details.	Yes
Label	Enter the text you want to appear next to the checkbox.	Yes
Default value	Enter a Boolean value (true/false) to select/clear the component by default. You can use templating or write a string, for example, the string "true" will show a selected component.	No

Note: See Templating drop-down for more details on rendering dynamic content using Liquid.

Interactions

Property	Description	Required
Hidden	Select the checkbox to hide the component in the end-user app. To hide it in the canvas, use the eye icon in the Layers panel.	No
Add rule	You can set rules to hide the component using Liquid. If no rules are set, the component will be hidden in all instances.	No
Disabled	Select the checkbox to disable the component in the end-user app.	No
Add rule	You can set rules to disable the component using Liquid. If no rules are set, the component will be disabled in all instances.	No

Note: See Add rules to trigger properties for more information on setting rules for these properties.

Accessibility

Property	Description	Required
Title	Enter a text that is displayed as a tooltip when hovering the mouse over the component in the end-user app.	No

Events

The Checkbox component supports the On update event. See Events and actions for more details.