UIButtonRowElementCreate


The parameters for creating a button row element.

See UIButtonRowElement for more details.

Properties

type

type: "ButtonRow"


items

items: UIButtonElementCreate[]

The items to add to the button row.


align?

optional align: "start" | "end"

The alignment of the button row.

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.

Last updated

Was this helpful?