Interface SettingsToggleButtonConfig

Configuration interface for the SettingsToggleButton.

interface SettingsToggleButtonConfig {
    acceptsTouchWithUiHidden?: boolean;
    ariaLabel?: LocalizableText;
    autoHideWhenNoActiveSettings?: boolean;
    cssClass?: string;
    cssClasses?: string[];
    cssPrefix?: string;
    disabled?: boolean;
    hidden?: boolean;
    id?: string;
    offAriaLabel?: LocalizableText;
    offClass?: string;
    onAriaLabel?: LocalizableText;
    onClass?: string;
    role?: string;
    settingsPanel: SettingsPanel;
    tabIndex?: number;
    tag?: string;
    text?: LocalizableText;
}

Hierarchy (view full)

Properties

acceptsTouchWithUiHidden? ariaLabel? autoHideWhenNoActiveSettings? cssClass? cssClasses? cssPrefix? disabled? hidden? id? offAriaLabel? offClass? onAriaLabel? onClass? role? settingsPanel tabIndex? tag? text?

Properties

OptionalacceptsTouchWithUiHidden

acceptsTouchWithUiHidden?: boolean

Specifies whether the first touch event received by the UIContainer should be prevented or not.

Default: false

OptionalariaLabel

ariaLabel?: LocalizableText

WCAG20 standard for defining info about the component (usually the name)

It is recommended to use onAriaLabel and offAriaLabel for toggle buttons as the component can then update them as the button is used.

If both ariaLabel and onAriaLabel are set, onAriaLabel is used.

OptionalautoHideWhenNoActiveSettings

autoHideWhenNoActiveSettings?: boolean

Decides if the button should be automatically hidden when the settings panel does not contain any active settings. Default: true

OptionalcssClass

cssClass?: string

The CSS classes of the component. This is usually the class from where the component takes its styling.

OptionalcssClasses

cssClasses?: string[]

Additional CSS classes of the component.

OptionalcssPrefix

cssPrefix?: string

A prefix to prepend all CSS classes with.

Optionaldisabled

disabled?: boolean

Specifies if the component is enabled (interactive) or not. Default: false

Optionalhidden

hidden?: boolean

Specifies if the component should be hidden at startup. Default: false

Optionalid

id?: string

The HTML ID of the component. Default: automatically generated with pattern 'ui-id-{guid}'.

OptionaloffAriaLabel

offAriaLabel?: LocalizableText

The aria label that marks the off-state of the button.

OptionaloffClass

offClass?: string

The CSS class that marks the off-state of the button.

OptionalonAriaLabel

onAriaLabel?: LocalizableText

The aria label that marks the on-state of the button.

OptionalonClass

onClass?: string

The CSS class that marks the on-state of the button.

Optionalrole

role?: string

Specifies the component role for WCAG20 standard

settingsPanel

settingsPanel: SettingsPanel

The settings panel whose visibility the button should toggle.

OptionaltabIndex

tabIndex?: number

WCAG20 requirement for screen reader navigation

Optionaltag

tag?: string

The HTML tag name of the component. Default: 'div'

Optionaltext

text?: LocalizableText

The text as string or as localize callback on the button.

Settings

Member Visibility

On This Page

Properties