Interface ISettingDropdownAttrs

Hierarchy

Properties

accessibleToggleLabel? buttonClassName? caretIcon? defaultLabel icon? label lazyDraw? menuClassName? onhide? onshow? options setting? tooltip?

Properties

Optional accessibleToggleLabel

accessibleToggleLabel?: string

The label used to describe the dropdown toggle button to assistive readers. Defaults to 'Toggle dropdown menu'.

Optional buttonClassName

buttonClassName?: string

A class name to apply to the dropdown toggle button.

Optional caretIcon

caretIcon?: string

The name of an icon to show on the right of the button.

defaultLabel

defaultLabel: Children

Optional icon

icon?: string

The name of an icon to show in the dropdown toggle button.

label

label: Children

The label of the dropdown toggle button. Defaults to 'Controls'.

Optional lazyDraw

lazyDraw?: boolean

Optional menuClassName

menuClassName?: string

A class name to apply to the dropdown menu.

Optional onhide

onhide?: (() => void)

Type declaration

    • (): void

    • An action to take when the dropdown is collapsed.

      Returns void

Optional onshow

onshow?: (() => void)

Type declaration

    • (): void

    • An action to take when the dropdown is opened.

      Returns void

options

options: SettingDropdownOption[]

Optional setting

setting?: string

Optional tooltip

tooltip?: string

An optional tooltip to show when hovering over the dropdown toggle button.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc v0.24.8