UIRadioGroupElementUpdate
The parameters for updating a radio group element.
See UIRadioGroupElement for more details.
Properties
type
type:
"RadioGroup"
id
id:
string
The ID of the element.
value?
optional
value:string
=valueSchema
The value of the radio group.
Default Value
undefined
options?
optional
options:UIControlElementOption
[]
The options to display in the radio group.
onChange()?
optional
onChange: (args
: {value
:undefined
|string
;id
:string
; }) =>void
The function to call when the value of the radio group changes.
Parameters
args
{ value
: undefined
| string
; id
: string
; }
The arguments passed to the function.
args.value
undefined
| string
The selected value.
args.id
string
The id of the radio 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?