Interface UIContainerConfig

Configuration interface for a UIContainer.

interface UIContainerConfig {
    ariaLabel?: LocalizableText;
    components?: Component<ComponentConfig>[];
    cssClass?: string;
    cssClasses?: string[];
    cssPrefix?: string;
    disabled?: boolean;
    hidden?: boolean;
    hideDelay?: number;
    hideImmediatelyOnMouseLeave?: boolean;
    hidePlayerStateExceptions?: PlayerState[];
    id?: string;
    role?: string;
    tabIndex?: number;
    tag?: string;
    userInteractionEventSource?: HTMLElement;
}

Hierarchy (view full)

Properties

ariaLabel? components? cssClass? cssClasses? cssPrefix? disabled? hidden? hideDelay? hideImmediatelyOnMouseLeave? hidePlayerStateExceptions? id? role? tabIndex? tag? userInteractionEventSource?

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 control bar will be hidden when there is no user interaction. Set to -1 for the UI to be always shown. Default: 5 seconds (5000)

OptionalhideImmediatelyOnMouseLeave

hideImmediatelyOnMouseLeave?: boolean

Specify whether the UI should be hidden immediatly if the mouse leaves the userInteractionEventSource. If false or not set it will wait for the hideDelay. Default: false

OptionalhidePlayerStateExceptions

hidePlayerStateExceptions?: PlayerState[]

An array of player states in which the UI will not be hidden, no matter what the hideDelay is.

Optionalid

id?: string

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

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'

OptionaluserInteractionEventSource

userInteractionEventSource?: HTMLElement

The HTML element on which user interaction events (e.g. mouse and touch events) will be tracked to detect interaction with the UI. These basically trigger showing and hiding of the UI. Default: the UI container itself

Settings

Member Visibility

On This Page

Properties