UIToggleGroupElementUpdate
The parameters for updating a toggle group element.
See UIToggleGroupElement for more details.
Properties
type
type:
"ToggleGroup"
id
id:
string
The ID of the element.
alignment?
optional
alignment:"start"
|"end"
The alignment of the toggle group.
Default Value
"start"
value?
optional
value:string
[] =valueSchema
The value of the toggle group.
Default Value
[]
options?
optional
options:UIControlElementOption
[]
The options to display in the toggle group.
onChange()?
optional
onChange: (args
: {value
:string
[];id
:string
; }) =>void
The function to call when the value of the toggle group changes.
Parameters
args
{ value
: string
[]; id
: string
; }
The arguments passed to the function.
args.value
string
[]
Array of the selected values.
args.id
string
The id of the toggle group element.
Returns
void
onCreate()?
optional
onCreate: (args
: {id
:string
; }) =>void
A function to call when the element is created.
Parameters
args
{ id
: string
; }
The arguments passed to the function.
args.id
string
The id of the element.
Returns
void
onDestroy()?
optional
onDestroy: (args
: {id
:string
; }) =>void
A function to call when the element is destroyed.
Parameters
args
{ id
: string
; }
The arguments passed to the function.
args.id
string
The id of the element.
Returns
void
label?
optional
label:string
Label text to display above the element and used for screen readers.
Last updated
Was this helpful?