Skip to main content

Checkbox

Give users binary choices. Whether it is checked or not.

Properties

PropertyTypeDescription
namestringUnique identifier for the checkbox component
labelstringText displayed next to the checkbox
defaultValuestring (boolean)Code that returns the default value
isDisabledbooleanWhether the checkbox is disabled
isHiddenbooleanWhether the checkbox is hidden in deployed pages

name

Unique identifier for the checkbox component. Please refer to the component naming rules

label

Sets the text displayed on the left side of the checkbox. (Supports Template Text)

defaultValue

Sets the default checked value for the component.
Can be set through workflow results, direct input.

isDisabled

Sets the disabled state of the component.
Can be set through workflow results, direct input.
When enabled, prevents user interaction with the component.

isHidden

Controls visibility of the component.
When set to true:

  • Hidden in deployed view
  • Visible with reduced opacity in edit mode

States

PropertyTypeDescription
checkedbooleanChecked state of the checkbox