Checkbox

A checkbox component is used to capture multiple choices from as many options as you want to provide. You can submit the options by:

  • Using a button component (which will submit all interactive components in the canvas)

When a submit action takes place, the results are given in a hash with the id from the checkbox component used as the key and an array containing the id of each chosen option as the value.

Checkbox Parameters

ParameterPossible ValuesRequiredDescription
typecheckboxYesThe type of component you are rendering.
idAny stringYesA unique identifier for the component.
optionArray (See Below)YesThe list of options.Minimum of 1.
labelAny stringNoThe text shown above the options.
valueArray containing the id of option'sNoThe option's that are selected by default.
save_stateunsaved``saved``failedNoStyles the input.Default is unsaved.Prevent action with saved.
disabledfalse``trueNoStyles all options and prevents the action.Default is false.Will be overriden if save_state is saved.

Options Parameters

ParameterPossible ValuesRequiredDescription
typeoptionYesThe type of component you are rendering.
idAny stringYesA unique identifier for the option.
textAny stringYesThe text shown next to the checkbox.
disabledfalse``trueNoStyles the option and prevents the action.Default is false.