UIToggleGroupElementCreate

---

The parameters for creating a toggle group element.

See UIToggleGroupElement for more details.

Properties

type

type: "ToggleGroup"

---

value

value: string[] = valueSchema

The value of the toggle group.

Default Value

[]

---

options

options: UIControlElementOption[]

The options to display in the toggle group.

---

onChange()

onChange: (args: { value: string[]; id: string; }) => void

The function to call when the value of the toggle group changes.

Parameters

Parameter	Type	Description
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

---

alignment?

optional alignment: "start" | "end"

The alignment of the toggle group.

Default Value

"start"

---

onCreate()?

optional onCreate: (args: { id: string; }) => void

A function to call when the element is created.

Parameters

Parameter	Type	Description
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

Parameter	Type	Description
args	{ id: string; }	The arguments passed to the function.
args.id	string	The id of the element.

Returns

void

---

id?

optional id: string

The ID of the element.

Remarks

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.

Default Value

undefined

---

label?

optional label: string

Label text to display above the element and used for screen readers.