The parameters for creating a checkbox group element.
See UICheckboxGroupElement for more details.
type: "CheckboxGroup"
value: string[] = valueSchema
The value of the checkbox group.
[]
options: UIControlElementOption[]
The options to display in the checkbox group.
onChange: (args: { value: string[]; id: string; }) => void
The function to call when the value of the checkbox group changes.
{ value: string[]; id: string; }
The arguments passed to the function.
Array of the selected values.
The id of the checkbox group element.
void
optional onCreate: (args: { id: string; }) => void
A function to call when the element is created.
The arguments passed to the function.
void
optional onDestroy: (args: { id: string; }) => void
A function to call when the element is destroyed.
The arguments passed to the function.
void
optional id: string
The ID of the element.
If not provided, the element will be assigned a random ID, but it is recommended to provide it to perform further updates on the element.
If provided, it must be unique within the UI.
undefined
optional label: string
Label text to display above the element and used for screen readers.
Last updated
