Interface SettingsPanelConfig

Configuration interface for a SettingsPanel.

interface SettingsPanelConfig {
    ariaLabel?: LocalizableText;
    components?: Component<ComponentConfig>[];
    cssClass?: string;
    cssClasses?: string[];
    cssPrefix?: string;
    disabled?: boolean;
    hidden?: boolean;
    hideDelay?: number;
    id?: string;
    pageTransitionAnimation?: boolean;
    role?: string;
    tabIndex?: number;
    tag?: string;
}

Hierarchy (view full)

Properties

ariaLabel? components? cssClass? cssClasses? cssPrefix? disabled? hidden? hideDelay? id? pageTransitionAnimation? role? tabIndex? tag?

Properties

OptionalariaLabel

ariaLabel?: LocalizableText

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

Optionalcomponents

components?: Component<ComponentConfig>[]

Child components of the container.

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

OptionalhideDelay

hideDelay?: number

The delay in milliseconds after which the settings panel will be hidden when there is no user interaction. Set to -1 to disable automatic hiding. Default: 3 seconds (3000)

Optionalid

id?: string

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

OptionalpageTransitionAnimation

pageTransitionAnimation?: boolean

Flag to specify if there should be an animation when switching SettingsPanelPages. Default: true

Optionalrole

role?: string

Specifies the component role for WCAG20 standard

OptionaltabIndex

tabIndex?: number

WCAG20 requirement for screen reader navigation

Optionaltag

tag?: string

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

Settings

Member Visibility

On This Page

Properties