You are here:
Checkbox Screen Input Component
Offer flow users a yes-or-no choice with a checkbox.
Required Editions
Configure the Checkbox Component
| Attribute | Description |
|---|---|
| API Name | The API name of the component. An API name can include underscores and alphanumeric characters without spaces. It must begin with a letter and can’t end with an underscore. It also can’t have two consecutive underscores. |
| Default Value |
Pre-populated value for the component.
If the associated screen isn’t run or the conditions for component visibility
aren’t met, the stored value of the component is null.
|
| Disabled | If set to true, the user can’t modify the value. The default value is false. This attribute accepts a resource with a Boolean value. |
| Label | The text that appears with the screen component that tells the running user how to use it. |
| Provide Help | Give your users more context with this screen component. The text you enter is available in an info bubble next to the component. |
Set the Component Visibility
Specify the logic that determines when the flow displays the component.
| Option | Description |
|---|---|
| When to Display Component | Configure when the component is displayed by using conditional logic. You can set the components to:
|
Validate Input
Provide a formula that evaluates whether what the user entered is valid and the error message to display if invalid.
| Option | Description |
|---|---|
| Error Message | Specify the error message that appears below the component if the user enters an invalid value. |
| Formula | Provide a formula expression that returns a Boolean value. If the formula expression evaluates to true, the input is valid. If the formula expression evaluates to false, the error message appears below the component. If the user leaves the field blank and the field is required, the flow shows the default error message and not your custom error message. |
Specify the Behavior of Values on Revisited Screens
Specify what this component does when a user enters a value, navigates to a previous screen, and then returns to the screen with this component.
Usage
When the user selects the checkbox, the screen component evaluates to
true. If the user doesn’t select the checkbox, the screen component
evaluates to false. If the associated screen isn’t run, the screen
component evaluates to null.
