A customizable checkbox that a user can toggle between a selected/checked and unselected/unchecked state.

Adding a Checkbox component

To add and use a Checkbox component:

  • Select the Checkbox component from the Components drawer. You can open the list of components by clicking the + button next to Components.
  • The Checkbox component takes up a boolean variable. When the variable is true, the checkbox is in a selected state and when the variable is false, the component is in unselected taste.
  • Select the Checkbox component in the Components tree.
  • Go to the Data tab (third tab) in the Properties Panel.
  • On Initial Value, select the boolean variable. This variable can be created under Variables modal or can be an incoming field from a REST API endpoint.

In the example below, the Initial Value property on the Checkbox is assigned to false.

28782878

To manipulate the value of the Checkbox in an API request, you will use its Field Name property value to send as the body of the API request action. The Field Name property value is available in the Configs tab (second tab).

800800

Configuration Properties

Property

Description

Component name

To alter the name of the component. The name is reflected in the Components tree. Defaults to Checkbox.

Field Name

Set the name of the field in the onPress function that controls toggling the checkbox value and its state.

If you have multiple checkboxes on a screen, make sure to assign each one a different Field name. Without doing so, all checkboxes will be toggled by single user interaction.

Color

Set the background color of the checkbox for its selected state.

Unselected Color

Set the background color of the checkbox for its unselected state.

Indeterminate Color

Set the background color of the checkbox for its undefined state.

Size

Size of the checkbox.

Checked Icon

Select an icon from the icon picker to display when for the selected state.

Unchecked Icon

Select an icon from the icon picker to display when for the unselected state.

Indeterminate Icon

Select an icon from the icon picker to display when for the undefined state.

Data Configuration

Property

Description

Initial value

Initialize the stateful component with a value from a data source.

Disabled

Initialize by a boolean value from a data source.
Remove check functionality, gray out the checkbox, and sets it as unselected.

Accepted values: true or false.

Interactions

The Checkbox component offers several ways for you to trigger Actions when a user interacts with it in your app.

Trigger

Description

On Press

This Trigger will fire every time the Checkbox is clicked/tapped and runs the associated Actions

On Check

This Trigger will fire every time the Checkbox's state changes to 'checked' and runs the associated Actions

On Uncheck

This Trigger will fire every time the Checkbox's state changes to 'unchecked' and runs the associated Actions


Did this page help you?