• Stars
    star
    129
  • Rank 279,262 (Top 6 %)
  • Language
    JavaScript
  • License
    Other
  • Created over 9 years ago
  • Updated 8 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A playlist video picker for video.js

videojs-playlist-ui

NPM

A playlist video picker for video.js and videojs-playlist

Maintenance Status: Stable

Getting Started

Include the plugin script in your page, and a placeholder list element with the class vjs-playlist to house the playlist menu:

<!-- Include the playlist menu styles somewhere in your page -->
<link href="videojs-playlist-ui.css" rel="stylesheet">

<!-- Your player will be created here: -->
<video-js data-setup='{}' controls></video-js>

<!-- The playlist menu will be built automatically in here -->
<div class="vjs-playlist"></div>

<!-- Include video.js, the videojs-playlist plugin and this plugin -->
<script src="video.js"></script>
<script src="videojs-playlist.js"></script>
<script src="videojs-playlist-ui.js"></script>

<script>
  // Initialize the player
  const player = videojs(document.querySelector('video-js'));

  // Initialize the plugin and render the playlist
  player.playlistUi();
</script>

There's also a working example of the plugin you can check out if you're having trouble.

Root Element

Before this plugin will work at all, it needs an element in the DOM to which to attach itself. There are three ways to find or provide this element.

NOTE: In v2.x of this plugin, the root element was expected to be a list element (i.e., <ol> or <ul>). As of v3.x, the plugin creates a list; so, this root element must be a non-list container element (e.g., <div>).

Using Automatic Discovery (default, example)

By default, the plugin will search for the first element in the DOM with the vjs-playlist class.

To defend against problems caused by multiple playlist players on a page, the plugin will only use an element with the vjs-playlist class if that element has not been used by another player's playlist.

Using a Custom Class (example)

A custom className option can be passed to override the class the plugin will search for to find the root element. The same defense against multiple playlist players is reused in this case.

player.playlistUi({
  className: 'hello-world'
});

Using a Custom Element (example)

A custom element can be passed using the el option to explicitly define a specific root element.

player.playlistUi({
  el: document.getElementById('hello-world')
});

Other Options

The options passed to the plugin are passed to the internal PlaylistMenu video.js Component; so, you may pass in any option that is accepted by a component.

In addition, the options object may contain the following specialized properties:

className

Type: string Default: "vjs-playlist"

As mentioned above, the name of the class to search for to populate the playlist menu.

playOnSelect

Type: boolean Default: false

The default behavior is that the play state is expected to stay the same between videos. If the player is playing when switching playlist items, continue playing. If paused, stay paused.

When this boolean is set to true, clicking on the playlist menu items will always play the video.

Playlists and Advertisements

The PlaylistMenu automatically adapts to ad integrations based on videojs-contrib-ads. When a linear ad is being played, the menu will darken and stop responding to click or touch events. If you'd prefer to allow your viewers to change videos during ad playback, you can override this behavior through CSS. You will also need to make sure that your ad integration is properly cancelled and cleaned up before switching -- consult the documentation for your ad library for details on how to do that.

More Repositories

1

video.js

Video.js - open source HTML5 video player
JavaScript
37,903
star
2

videojs-contrib-hls

HLS library for video.js
JavaScript
2,840
star
3

http-streaming

HLS, DASH, and future HTTP streaming protocols library for video.js
JavaScript
2,490
star
4

videojs-youtube

YouTube playback technology for Video.js
JavaScript
1,123
star
5

mux.js

Lightweight utilities for inspecting and manipulating video container formats.
JavaScript
1,104
star
6

videojs-vr

A plugin to add 360 and VR video support to video.js.
JavaScript
540
star
7

m3u8-parser

An m3u8 parser.
JavaScript
475
star
8

videojs-contrib-ads

A Tool for Building Video.js Ad Plugins
JavaScript
382
star
9

videojs-playlist

Playlist plugin for videojs
JavaScript
365
star
10

video-js-swf

Custom Flash Player for VideoJS
JavaScript
336
star
11

videojs-contrib-dash

Video.js plugin for supporting the MPEG-DASH playback through a video.js player
JavaScript
293
star
12

videojs-overlay

A video.js plugin to display simple overlays during playback.
JavaScript
245
star
13

videojs-flash

The Flash tech for video.js
JavaScript
215
star
14

videojs-contrib-eme

Supports Encrypted Media Extensions for playback of encrypted content in Video.js
JavaScript
201
star
15

videojs-vimeo

Support Vimeo source for Video.js
JavaScript
196
star
16

hls-fetcher

JavaScript
162
star
17

videojs-contrib-quality-levels

JavaScript
154
star
18

videojs-contrib-media-sources

Code for working with the media source extensions API and video.js
JavaScript
144
star
19

themes

Videojs themes 💅
CSS
140
star
20

thumbcoil

Tools for inspecting MPEG2TS, fMP4, and FLV files and the codec bitstreams therein
JavaScript
124
star
21

videojs-errors

A video.js plugin that displays error messages to video viewers.
JavaScript
88
star
22

generator-videojs-plugin

Yeoman generator for video.js plugins.
JavaScript
80
star
23

mpd-parser

JavaScript
78
star
24

vtt.js

A JavaScript implementation of the WebVTT specification, forked from vtt.js for use with Video.js
JavaScript
70
star
25

font

Icon font used for Video.js
CSS
60
star
26

videojs.com

The Video.js Website
MDX
58
star
27

designer

A video.js player skin editor using a live CSS editor
JavaScript
42
star
28

aes-decrypter

JavaScript
34
star
29

videojs-playbackrate-adjuster

A Video.js middleware that adjusts controls based on playback rate
JavaScript
28
star
30

videojs-contextmenu-ui

A cross-device context menu UI for video.js players.
JavaScript
28
star
31

cdn

The video.js CDN
JavaScript
24
star
32

ie8

Video.js files for IE8 compatibility
JavaScript
23
star
33

video.js-component

Video.js - HTML5 Video Player - Component
JavaScript
15
star
34

docs

videojs docs
JavaScript
14
star
35

plugin-concat

Concatenate videos for playback by videojs/http-streaming in a Video.js player
JavaScript
11
star
36

videojs-adaptive

Building support for adaptive streaming video formats into video.js
JavaScript
9
star
37

doc-generator

Auto-generate API docs for the video.js codebase and plugins
JavaScript
8
star
38

videojs-settings-menu

A place to incubate a new settings menu for videojs.
JavaScript
8
star
39

videojs-media-session

Media Session API plugin
JavaScript
8
star
40

vhs-utils

Objects and functions shared throughout @videojs/http-streaming code
JavaScript
7
star
41

videojs-4to5

Tools to ease the transition from video.js 4.x to 5.x.
JavaScript
7
star
42

thumb.co.il

The fancy front-end for Thumbcoil!
JavaScript
7
star
43

monorepo

Monorepo for all videojs packages
TypeScript
7
star
44

standard

JavaScript Standard Style — One Style to Rule Them All
JavaScript
6
star
45

remark-preset-lint-videojs

A remark linting preset for Video.js
JavaScript
5
star
46

blog

The video.js blog
Stylus
5
star
47

videojs-placeholder

A placeholder for videojs packages
5
star
48

videojs-contrib-quality-menu

Adds a quality selector button to the Video.js control bar for Video.js 8+
JavaScript
5
star
49

videojs-languages

JavaScript
4
star
50

grunt-videojs-languages

A grunt task to convert video.js language JSON files in to includable scripts.
JavaScript
4
star
51

autoplay-tests

Autoplay test examples
HTML
3
star
52

videojs-generate-rollup-config

Generate a standard rollup config, so that plugins don't need the same script in every repository.
JavaScript
3
star
53

eslint-config-videojs

JavaScript
3
star
54

webwackify

launch a web worker that can require() in the browser with browserify and webpack
JavaScript
3
star
55

tooling

A monorepo for all videojs project and plugin tooling
JavaScript
2
star
56

spellbook

JavaScript
2
star
57

rfcs

RFCs for changes to Video.js
2
star
58

generator-helpers

A package to keep all of our generator helpers packages, so everything can be updated more easily.
1
star
59

ffrwd

ffrwd is an extensible HTML5 streaming media player capable of playing HLS, MPEG-DASH and more!
1
star
60

.github

1
star
61

xhr

A small xhr wrapper
JavaScript
1
star
62

babel-config

A standard babel config, so that plugins don't need the same script in every repository.
JavaScript
1
star
63

videojs-bundler-sample

sample and test project for using Video.js with various bundler configurations
JavaScript
1
star
64

admin

Video.js organizational documentation
Shell
1
star
65

svg-sprite-generator

1
star