Interface UIButton

UIButton defines the configuration for a button UIElement.

This element has no associated value in UIElementValues.

interface UIButton {
    click?: (() => void);
    disabled?: boolean;
    id: string;
    label: string | UIButtonLabel;
    selected?: boolean;
    tooltip?: string;
    type: "button";
}

Hierarchy

Properties

click? disabled? id label selected? tooltip? type

Properties

Optional click

click?: (() => void)

Type declaration

    • (): void

    • click allows to react to click events for an specific button.

      Returns void

Optional disabled

disabled?: boolean

disabled defines, if the button is currently disabled.

Default Value

false

id

id: string

label

label: string | UIButtonLabel

label defines the button's label.

Deprecated

string type is deprecated. Use UIButtonLabel instead.

Optional selected

selected?: boolean

selected defines, if the button is currently selected or not.

Default Value

false

Optional tooltip

tooltip?: string

tooltip defines the text that will be displayed in the tooltip.

type

type: "button"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc