bitmovin-player-ui
    Preparing search index...

    Interface SettingsPanelItemConfig

    Configuration interface for a SettingsPanelItem

    interface SettingsPanelItemConfig {
        addSettingAsComponent?: boolean;
        ariaLabel?: LocalizableText;
        components?: Component<ComponentConfig>[];
        cssClass?: string;
        cssClasses?: string[];
        cssPrefix?: string;
        disabled?: boolean;
        hidden?: boolean;
        id?: string;
        isSetting?: boolean;
        label?: Component<ComponentConfig> | LocalizableText;
        labelStyle?: LabelStyle;
        role?: string;
        settingComponent?: Component<ComponentConfig>;
        tabIndex?: number;
        tag?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    addSettingAsComponent? ariaLabel? components? cssClass? cssClasses? cssPrefix? disabled? hidden? id? isSetting? label? labelStyle? role? settingComponent? tabIndex? tag?

    Properties

    addSettingAsComponent?: boolean

    If the setting should be added as a component to this item.

    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

    id?: string

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

    isSetting?: boolean

    Indicates if the SettingsPanelItem is representing an actual setting or if it just a label. E.g. when used as a title.

    label?: Component<ComponentConfig> | LocalizableText

    The label component or the text for the label.

    labelStyle?: LabelStyle

    The style of the label in case config.label is not a component already. Default: LabelStyle.Text

    role?: string

    Specifies the component role for WCAG20 standard

    settingComponent?: Component<ComponentConfig>

    The component that configures a setting.

    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