Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface VideoLayersOptions

Options for the plugin

Hierarchy

  • VideoLayersOptions

Index

Properties

Properties

Optional classes

classes: object

Css classes to use

Type declaration

  • Optional layer?: "c-video-layers__layer"

    Class to add to the layers

    default

    c-video-layers__video

  • Optional layersContainer?: "c-video-layers__container"

    Class to add to the layers container

    default

    c-video-layers__visible

  • Optional root?: "c-video-layers"

    Root element

    default

    c-video-layers

  • Optional video?: "c-video-layers__video"

    Class to add to the video element

    default

    c-video-layers

  • Optional visible?: "c-video-layers__visible"

    Class to add to the layer when is visible

    default

    c-video-layers__layer

Optional layers

layers: VideoLayer[] | VideoLayerOptions[]

Layers to use

namespace

namespace: "videolayers"

Namespace for events. Update this option will reconstruct the markup and the progress will be lost

default

jq-videolayers

Optional useParentAsContainer

useParentAsContainer: string | JQuery | Element

The element to use as parent of the video. The layers container will be appended to this element. By default, a new <div> will be created and the video will be appended to the new element, however, is possible to set a different element as container The element must be a parent of the video. This option is useful when the layers are used with a custom player instead of the html5 default

example

For example, if plyr video player is used: useParentAsContainer:'.plyr__video-wrapper' This will look for the first parent that matches with the selector

Generated using TypeDoc