The “Checkbox” parameter represents a checkbox control (multi-choice) on the form. It is usually used when a user needs or wants to select multiple objects. All options are required to be present on the screen at the same time, if this is not required better option is to use the “Dropdown” parameter.
The value type is object.
name
string
Label of a widget.
Example: Segment
hintText
string
Provides help text describing what value is expected in control.
Example: Define segment value
optionsList
selectionOption
Effectively a data source for the parameter options
component provides drag and drop functionality to determine the ordering of options.
Example:
defaultValue
string
(optional) Used to mark default selection if needed (supports multi-selection).
Example: [“sellerAddress”]
{
"name": "Select items",
"hintText": "Pick all the items you want",
"optionsList": [
{
"label": "Microsoft Office 365",
"value": "ms_office_365"
},
{
"label": "Microsoft Dynamycs",
"value": "dynamics"
},
{
"label": "Other Products",
"value": "products"
}
]
}[]
string
List of selected checkbox values.
Example: my val3
[
"dynamics",
"products"
][
{
"label": "None",
"value": "none"
},
{
"label": "Seller address",
"value": "sellerAddress"
},
{
"label": "Buyer address",
"value": "buyerAddress"
}
]