Interface UIDropdown

UIDropdown is a dropdown UI element.

The associated value of the UIDropdown is the id of the selected entry. If no entry is selected, use undefined or omit the value entry in the UIElementValues.

interface UIDropdown {
    disabled?: boolean;
    entries: DropdownEntry[];
    id: string;
    label: string;
    tooltip?: string;
    type: "dropdown";
}

Hierarchy

Properties

disabled? entries id label tooltip? type

Properties

Optional disabled

disabled?: boolean

disabled passes down a boolean to disable the dropdown options.

entries

entries: DropdownEntry[]

entries define the possible options that the dropdown makes available.

id

id: string

label

label: string

label defines the dropdown label to be shown aside the dropdown element.

Optional tooltip

tooltip?: string

tooltip defines the text a user sees on hovering a disabled dropdown element.

type

type: "dropdown"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc