Interface DropdownEntry

DropdownEntry defines the structure needed for a UI dropdown entry to be used for UIDropdown or a section of a UIGroupDropdown.

interface DropdownEntry {
    activeLabel?: DropdownEntryLabel;
    hidden?: boolean;
    id: string;
    label: DropdownEntryLabel;
}

Properties

activeLabel? hidden? id label

Properties

Optional activeLabel

activeLabel?: DropdownEntryLabel

activeLabel is displayed in the dropdown's button, when the entry is selected. In case activeLabel is not defined, it fall backs to label.

Optional hidden

hidden?: boolean

hidden represents an optional parameter to hide an entry in the dropdown. It will then not render at all.

id

id: string

id declares an identificator for the dropdown entry.

label

label: DropdownEntryLabel

label defines the entry's label to be used in the options dropdown. It can contain different data types, depending on what information we would like to show in the dropdown

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc