bitmovin-player-ui
    Preparing search index...

    Interface SettingsPanelPageNavigatorConfig

    Configuration interface for a SettingsPanelPageNavigatorButton

    interface SettingsPanelPageNavigatorConfig {
        acceptsTouchWithUiHidden?: boolean;
        ariaLabel?: LocalizableText;
        ariaLabelledBy?: string;
        buttonStyle?: ButtonStyle;
        container: SettingsPanel<SettingsPanelConfig>;
        cssClass?: string;
        cssClasses?: string[];
        cssPrefix?: string;
        disabled?: boolean;
        hidden?: boolean;
        id?: string;
        role?: string;
        tabIndex?: number;
        tag?: string;
        targetPage?: SettingsPanelPage;
        text?: LocalizableText;
    }

    Hierarchy (View Summary)

    Index

    Properties

    acceptsTouchWithUiHidden? ariaLabel? ariaLabelledBy? buttonStyle? container cssClass? cssClasses? cssPrefix? disabled? hidden? id? role? tabIndex? tag? targetPage? text?

    Properties

    acceptsTouchWithUiHidden?: boolean

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

    Default: false

    ariaLabel?: LocalizableText

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

    ariaLabelledBy?: string

    WCAG20 standard: Establishes relationships between objects and their label(s)

    buttonStyle?: ButtonStyle

    The style of the button. Default: ButtonStyle.Icon

    container: SettingsPanel<SettingsPanelConfig>

    Container SettingsPanel where the navigation takes place

    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

    id?: string

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

    role?: string

    Specifies the component role for WCAG20 standard

    tabIndex?: number

    WCAG20 requirement for screen reader navigation

    tag?: string

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

    targetPage?: SettingsPanelPage

    Page where the button should navigate to If empty it will navigate to the root page (not intended to use as navigate back behavior)

    Optionaltext

    text?: LocalizableText

    The text as string or localize callback on the button.

    Settings

    Member Visibility

    On This Page

    Properties