Skip to main content

Checkbox (ALPHA)

Alpha feature: invite only

Responsive Widgets are in alpha and available by invitation only on Business and Enterprise plans. Behavior and properties may change. To request access, open a support ticket and name the feature Responsive Widgets (ALPHA).

The Checkbox widget shows one checkbox with a label. Users check or clear it to make a yes or no choice. Use it for consent, for example "I agree to the terms," or for a single on or off option in a form.

Checkbox widget in a Responsive app
Checkbox widget

Widget type: WDS_CHECKBOX_WIDGET

Content properties​

These properties appear in the Content tab of the property pane.

Label​

Text string​

Sets the label shown next to the checkbox. Default: Label.

Tooltip string​

Shows help text next to the label.

Validations​

Required boolean​

Makes checking the box mandatory. When on and the box is not checked, the checkbox shows as invalid. Default: off.

General​

Default state boolean​

Sets whether the box is checked when the widget loads. If you change this value, the widget's checked state updates to match. Default: on (checked).

Visible boolean​

Controls whether the widget is visible when the app runs. Default: on.

Disabled boolean​

Stops users from checking or clearing the box. Default: off.

Animate loading boolean​

Shows a loading animation while the widget's data loads. Default: on.

Style properties​

These properties appear in the Style tab of the property pane.

Custom styling​

These settings are in the Custom styling section, at the end of the Style tab. An empty setting uses the theme value. For theme colors, dark mode, and the rules for custom CSS, see Custom styling.

Accent color string​

Builds the hover, pressed, focus, and text colors of this widget from one color, in light and dark mode. Lists and menus that the widget opens use them too. Empty means the accent of the nearest container that sets one, or the theme accent.

Custom CSS string​

Adds plain CSS to this widget. Rules apply only inside the widget, and & is the box around the widget, its label included, not the part inside it. To style an inner part, use its element selector, for example button or input. You cannot bind this property.

Reference properties​

Reference properties let you read the widget's state in bindings and code, for example {{Checkbox1.isVisible}}. You cannot set them directly.

isVisible boolean​

Shows whether the widget is visible.

Example:

{{Checkbox1.isVisible}}

isChecked boolean​

Shows whether the box is checked.

Example:

{{Checkbox1.isChecked}}

isDisabled boolean​

Shows whether the widget is disabled.

Example:

{{Checkbox1.isDisabled}}

Methods​

Methods let you change the widget's properties from code, for example in a JS Object.

setVisibility (param: boolean): Promise​

Shows or hides the widget.

Example:

Checkbox1.setVisibility(true)

setDisabled (param: boolean): Promise​

Turns the disabled state on or off.

Example:

Checkbox1.setDisabled(false)

setRequired (param: boolean): Promise​

Turns the Required setting on or off.

Example:

Checkbox1.setRequired(true)

setValue (param: boolean): Promise​

Checks or clears the box.

Example:

Checkbox1.setValue(false)

Events​

onCheckChange​

Runs when the user checks or clears the box.