Interface StyleConfig

Example:

style : {
  width: '100%',
  aspectratio: '16:9',
}
interface StyleConfig {
    aspectratio?: string | number;
    container?: (() => HTMLElement);
    height?: string;
    width?: string;
}

Properties

aspectratio? container? height? width?

Properties

Optional aspectratio

aspectratio?: string | number

The aspect ratio of the player, e.g. 16:9, 16:10, 4:3. Not more than two options of width, height, and aspect ratio should be given. Defaults to 16:9.

Optional container

container?: (() => HTMLElement)

A callback to specify the element that the player will add style elements to. Defaults to the head element.

Type declaration

    • (): HTMLElement

    • Returns HTMLElement

Optional height

height?: string

The height of the player. Can have any value including the unit (e.g. px, %, em, vh) usable in CSS, e.g. 500px or 90%. Not more than two options of width, height, and aspect ratio should be given. If no unit is give, 'px' is assumed. If no height is given, the height is controlled via CSS aspect-ratio classes (default)

Optional width

width?: string

The width of the player. Can have any value including the unit (e.g. px, %, em, vw) usable in CSS, e.g. 500px or 90%. Not more than two options of width, height, and aspect ratio should be given. If no unit is given, 'px' is assumed. If no width is given, the width is controlled via CSS aspect-ratio classes (default)

Settings

Member Visibility

Theme

On This Page

aspectratiocontainerheightwidth