1. Fields
  2. Checkbox Field

Fields

Checkbox Field

The Checkbox Field allows for capturing a binary state, such as true/false or yes/no.

Basic usage

Adds a checkbox field to the fields of an action.

loading...

Result

The field will be displayed as a checkbox in the form, as below: Preview of a checkbox in a form

The resultant data that will be available in stubpost.data will be as follows:

loading...

This can be substituted with eg. ~~stubpost.data.receive_promotional_content where required.

Parameters

See fields for common field parameters like validation and conditional rendering.

params.checkedvalue

required

The output of a checked checkbox. For example can be set to 'yes' or 'agree' instead of true.

Default: true


params.uncheckedvalue

required

The output of an unchecked checkbox. For example can be set to 'no' or 'disagree' instead of false.

Default: false