bitmovin-player-ui
    Preparing search index...

    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;
        stateResetDelay?: number;
        tabIndex?: number;
        tag?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    ariaLabel?: LocalizableText

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

    components?: Component<ComponentConfig>[]

    Child components of the container.

    cssClass?: string

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

    cssClasses?: string[]

    Additional CSS classes of the component.

    cssPrefix?: string

    A prefix to prepend all CSS classes with.

    disabled?: boolean

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

    hidden?: boolean

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

    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: 5 seconds (5000)

    id?: string

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

    pageTransitionAnimation?: boolean

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

    role?: string

    Specifies the component role for WCAG20 standard

    stateResetDelay?: number

    The delay in milliseconds after hiding the settings panel before its internal state (e.g., navigation stack and scroll position) is reset. Set to -1 to disable automatic state reset. Default: 5 seconds (5000)

    tabIndex?: number

    WCAG20 requirement for screen reader navigation

    tag?: string

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

    Settings

    Member Visibility

    On This Page

    Properties