Skip to content

Commit

Permalink
feat: Add breakpoints option to support toggling classes based on pla…
Browse files Browse the repository at this point in the history
…yer width. (#5471)

This adds a breakpoints option. By default, this option is false meaning this is an opt-in feature.

When passing true, it will use a default set of breakpoints. Or custom breakpoints can be passed if users do not like our breakpoints (or previously-existing style decisions).

- Add breakpoints option.
- Adds some new (currently unused) classes: vjs-layout-medium, vjs-layout-large, vjs-layout-x-large, and vjs-layout-huge.
- Add updateCurrentBreakpoint and currentBreakpoint methods to the player.
- Update css/components/_adaptive.scss
- Add sandbox/responsive.html.example

Closes #4371
  • Loading branch information
misteroneill authored and gkatsev committed Oct 31, 2018
1 parent 4aee891 commit f857523
Show file tree
Hide file tree
Showing 16 changed files with 472 additions and 44 deletions.
2 changes: 1 addition & 1 deletion docs/examples/elephantsdream/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
don't currently support 'description' text tracks in any
useful way! Currently this means that iOS will not display
ANY text tracks -->
<video id="example_video_1" class="video-js vjs-default-skin" controls preload="none" width="640" height="360"
<video id="example_video_1" class="video-js" controls preload="none" width="640" height="360"
data-setup='{ "html5" : { "nativeTextTracks" : false } }'
poster="http://d2zihajmogu5jn.cloudfront.net/elephantsdream/poster.png">

Expand Down
2 changes: 1 addition & 1 deletion docs/examples/simple-embed/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
</head>
<body>

<video id="example_video_1" class="video-js vjs-default-skin" controls preload="none" width="640" height="264" poster="http://vjs.zencdn.net/v/oceans.png" data-setup="{}">
<video id="example_video_1" class="video-js" controls preload="none" width="640" height="264" poster="http://vjs.zencdn.net/v/oceans.png" data-setup="{}">
<source src="http://vjs.zencdn.net/v/oceans.mp4" type="video/mp4">
<source src="http://vjs.zencdn.net/v/oceans.webm" type="video/webm">
<source src="http://vjs.zencdn.net/v/oceans.ogv" type="video/ogg">
Expand Down
41 changes: 41 additions & 0 deletions docs/guides/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,47 @@ Prevents the player from running the autoSetup for media elements with `data-set

> **Note**: this must be set globally with `videojs.options.autoSetup = false` in the same tick as videojs source is loaded to take effect.
### `breakpoints`

> Type: `boolean|Array`, Default: `false`
Set layout breakpoints that will configure how class names are toggled on the player to adjust the UI based on the player's dimensions.

By default, no breakpoints are supported, but passing `true` will set some sensible default breakpoints:

Class Name | Width Range
---------------------|------------
`vjs-layout-tiny` | 0-210
`vjs-layout-x-small` | 211-320
`vjs-layout-small` | 321-425
`vjs-layout-medium` | 426-768
`vjs-layout-large` | 769-1440
`vjs-layout-x-large` | 1441-2560
`vjs-layout-huge` | 2561+

While the class names cannot be changed, the width ranges can be configured via an object like this:

```js
breakpoints: {
tiny: 300,
xsmall: 400,
small: 500,
medium: 600,
large: 700,
xlarge: 800,
huge: 900
}
```

* The _keys_ of the `breakpoints` object are derived from the associated class names by removing the `vjs-layout-` prefix and any `-` characters.
* The _values_ of the `breakpoints` object define the max width for a range.
* Not all keys need to be defined. You can easily override a single breakpoint by passing an object with one key/value pair! Customized breakpoints will be merged with default breakpoints when the player is created.

When the player's size changes, the merged breakpoints will be inspected in the size order until a matching breakpoint is found.

That breakpoint's associated class name will be added as a class to the player. The previous breakpoint's class will be removed.

See the file `sandbox/responsive.html.example` for an example of a fluid/responsive player using the default breakpoints.

### `children`

Expand Down
2 changes: 1 addition & 1 deletion sandbox/combined-tracks.html.example
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
<pre>open http://localhost:9999/sandbox/index.html</pre>
</div>

<video id="vid1" class="video-js vjs-default-skin" lang="en" controls preload="auto" width="640" height="360" poster="//d2zihajmogu5jn.cloudfront.net/elephantsdream/poster.png">
<video id="vid1" class="video-js" lang="en" controls preload="auto" width="640" height="360" poster="//d2zihajmogu5jn.cloudfront.net/elephantsdream/poster.png">
<source src="//d2zihajmogu5jn.cloudfront.net/elephantsdream/ed_hd.mp4" type="video/mp4">
<source src="//d2zihajmogu5jn.cloudfront.net/elephantsdream/ed_hd.ogg" type="video/ogg">
<track kind="captions" src="//d2zihajmogu5jn.cloudfront.net/elephantsdream/captions.en.vtt" srclang="en" label="English"></track><!-- Tracks need an ending tag thanks to IE9 -->
Expand Down
2 changes: 1 addition & 1 deletion sandbox/descriptions.html.example
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
don't currently support 'description' text tracks in any
useful way! Currently this means that iOS will not display
ANY text tracks -->
<video id="example_video_1" class="video-js vjs-default-skin" controls preload="none" width="640" height="360"
<video id="example_video_1" class="video-js" controls preload="none" width="640" height="360"
data-setup='{ "html5" : { "nativeTextTracks" : false } }'
poster="http://d2zihajmogu5jn.cloudfront.net/elephantsdream/poster.png">

Expand Down
2 changes: 1 addition & 1 deletion sandbox/flash.html.example
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
<pre>open http://localhost:9999/sandbox/flash.html</pre>
</div>

<video id="vid1" class="video-js vjs-default-skin" controls preload="auto" width="640" height="264"
<video id="vid1" class="video-js" controls preload="auto" width="640" height="264"
poster="http://vjs.zencdn.net/v/oceans.png"
data-setup=''>
<source src="http://vjs.zencdn.net/v/oceans.mp4" type="video/mp4">
Expand Down
23 changes: 9 additions & 14 deletions sandbox/index.html.example
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,8 @@
<!-- Add ES5 shim and sham for IE8 -->
<script src="../dist/ie8/videojs-ie8.js"></script>

<!-- Load the source files -->
<link href="../dist/video-js.css" rel="stylesheet" type="text/css">
<script src="../dist/video.js"></script>
<script src="../node_modules/videojs-flash/dist/videojs-flash.js"></script>

<!-- Set the location of the flash SWF -->
<script>
videojs.options.flash.swf = '../node_modules/videojs-flash/node_modules/videojs-swf/dist/video-js.swf';
</script>

</head>
<body>
<div style="background-color:#eee; border: 1px solid #777; padding: 10px; margin-bottom: 20px; font-size: .8em; line-height: 1.5em; font-family: Verdana, sans-serif;">
Expand All @@ -26,20 +18,23 @@
<pre>open http://localhost:9999/sandbox/index.html</pre>
</div>

<video id="vid1" class="video-js vjs-default-skin" controls preload="auto" width="640" height="264"
poster="http://vjs.zencdn.net/v/oceans.png"
data-setup='{}'>
<video-js
id="vid1"
controls
preload="auto"
width="640"
height="264"
poster="http://vjs.zencdn.net/v/oceans.png">
<source src="http://vjs.zencdn.net/v/oceans.mp4" type="video/mp4">
<source src="http://vjs.zencdn.net/v/oceans.webm" type="video/webm">
<source src="http://vjs.zencdn.net/v/oceans.ogv" type="video/ogg">
<track kind="captions" src="../docs/examples/shared/example-captions.vtt" srclang="en" label="English"></track><!-- Tracks need an ending tag thanks to IE9 -->
<p class="vjs-no-js">To view this video please enable JavaScript, and consider upgrading to a web browser that <a href="http://videojs.com/html5-video-support/" target="_blank">supports HTML5 video</a></p>
</video>
</video-js>

<script>
var vid = document.getElementById("vid1");
var vid = document.getElementById('vid1');
var player = videojs(vid);

</script>

</body>
Expand Down
2 changes: 1 addition & 1 deletion sandbox/language.html.example
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@

</head>
<body>
<video id="vid1" class="video-js vjs-default-skin" controls preload="auto" width="640" height="264" data-setup=''>
<video id="vid1" class="video-js" controls preload="auto" width="640" height="264" data-setup=''>
<!--
<source src="http://video-js.zencoder.com/oceans-clip.mp4" type='video/mp4'>
<source src="http://video-js.zencoder.com/oceans-clip.webm" type='video/webm'>
Expand Down
2 changes: 1 addition & 1 deletion sandbox/plugin.html.example
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<body>
<p style="background-color:#eee; border: 1px solid #777; padding: 10px; font-size: .8em; line-height: 1.5em; font-family: Verdana, sans-serif;">This page shows you how to create, register and initialize a Video.js plugin.</p>

<video id="vid1" class="video-js vjs-default-skin" controls preload="auto" width="640" height="264" poster="http://vjs.zencdn.net/v/oceans.png">
<video id="vid1" class="video-js" controls preload="auto" width="640" height="264" poster="http://vjs.zencdn.net/v/oceans.png">
<source src="http://vjs.zencdn.net/v/oceans.mp4" type="video/mp4">
<source src="http://vjs.zencdn.net/v/oceans.webm" type="video/webm">
<source src="http://vjs.zencdn.net/v/oceans.ogv" type="video/ogg">
Expand Down
160 changes: 160 additions & 0 deletions sandbox/responsive.html.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<title>Video.js Sandbox - Responsive</title>
<link href="../dist/video-js.css" rel="stylesheet" type="text/css">
<script src="../dist/video.js"></script>
<style type="text/css">
body {
margin: 0;
padding: 0;
}

.breakpoints, .video-js, table {
margin: 1em 0;
}

table {
border-collapse: collapse;
}

th, td {
border: 1px solid #ccc;
padding: 0.5em 1em;
}

tbody tr {
color: #999;
}

tbody tr:first-child {
color: #000;
}

.breakpoints div {
background-color: red;
color: white;
padding: 0.5em 1em;
}

@media (max-width: 210px) {
.breakpoints .tiny {
background-color: green;
}
}

@media (min-width: 211px) and (max-width: 320px) {
.breakpoints .x-small {
background-color: green;
}
}

@media (min-width: 321px) and (max-width: 425px) {
.breakpoints .small {
background-color: green;
}
}

@media (min-width: 426px) and (max-width: 768px) {
.breakpoints .medium {
background-color: green;
}
}

@media (min-width: 769px) and (max-width: 1440px) {
.breakpoints .large {
background-color: green;
}
}

@media (min-width: 1441px) and (max-width: 2560px) {
.breakpoints .x-large {
background-color: green;
}
}

@media (min-width: 2561px) {
.breakpoints .huge {
background-color: green;
}
}
</style>
</head>
<body>
<p>
The following boxes indicate which breakpoint should be applied to the
player when it fills the width of its containing viewport.
</p>
<p>
Use these to validate that the default breakpoints match up with how
CSS media queries work.
</p>
<p>
<b>Because these bars are updated by CSS, they will change before the <code>playerresize</code> event occurs!</b>
</p>
<div class="breakpoints">
<div class="tiny">vjs-layout-tiny (0px-210px)</div>
<div class="x-small">vjs-layout-x-small (211px-320px)</div>
<div class="small">vjs-layout-small (321px-425px)</div>
<div class="medium">vjs-layout-medium (426px-768px)</div>
<div class="large">vjs-layout-large (769px-1440px)</div>
<div class="x-large">vjs-layout-x-large (1441px-2560px)</div>
<div class="huge">vjs-layout-huge (2561px+)</div>
</div>

<video-js
class="vjs-fluid"
controls
preload="auto"
poster="http://vjs.zencdn.net/v/oceans.png">
<source src="http://vjs.zencdn.net/v/oceans.mp4" type="video/mp4">
<source src="http://vjs.zencdn.net/v/oceans.webm" type="video/webm">
<source src="http://vjs.zencdn.net/v/oceans.ogv" type="video/ogg">
<track kind="captions" src="../docs/examples/shared/example-captions.vtt" srclang="en" label="English">
<p class="vjs-no-js">To view this video please enable JavaScript, and consider upgrading to a web browser that <a href="http://videojs.com/html5-video-support/" target="_blank">supports HTML5 video</a></p>
</video-js>

<p>
Each time the player size changes, a row is prepended to this table.
</p>
<table>
<thead>
<tr>
<th>Class</th>
<th>Player Width</th>
</tr>
</thead>
<tbody>
</tbody>
</table>

<script>
var vid = document.querySelector('video-js');
var player = videojs(vid, {breakpoints: true});
var tbody = document.querySelector('table tbody');

player.on('playerresize', function() {
var values = {
breakpoint: player.currentBreakpoint(),
className: player.el().className.match(/vjs-layout-([a-z\-]+)/)[0],
playerWidth: player.currentWidth()
};

videojs.log('playerresize', values);

var tr = document.createElement('tr');

tr.innerHTML = '<td>' +
values.className +
'</td><td>' +
values.playerWidth +
'</td>';

tbody.insertBefore(tr, tbody.firstChild);
});
</script>

</body>
</html>
20 changes: 12 additions & 8 deletions src/css/components/_adaptive.scss
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,18 @@
// - Play button
// - Fullscreen Button
.video-js.vjs-layout-tiny:not(.vjs-fullscreen) {
.vjs-custom-control-spacer { @include flex(auto); }
.vjs-custom-control-spacer {
@include flex(auto);
display: block;
}

&.vjs-no-flex .vjs-custom-control-spacer { width: auto; }

.vjs-current-time, .vjs-time-divider, .vjs-duration, .vjs-remaining-time,
.vjs-playback-rate, .vjs-progress-control,
.vjs-mute-control, .vjs-volume-control,
.vjs-mute-control, .vjs-volume-control, .vjs-volume-panel,
.vjs-chapters-button, .vjs-descriptions-button, .vjs-captions-button,
.vjs-subtitles-button, .vjs-audio-button { display: none; }
.vjs-subtitles-button, .vjs-subs-caps-button, .vjs-audio-button { display: none; }
}

// When the player is x-small, display nothing but:
Expand All @@ -19,22 +23,22 @@
.video-js.vjs-layout-x-small:not(.vjs-fullscreen) {
.vjs-current-time, .vjs-time-divider, .vjs-duration, .vjs-remaining-time,
.vjs-playback-rate,
.vjs-mute-control, .vjs-volume-control,
.vjs-mute-control, .vjs-volume-control, .vjs-volume-panel,
.vjs-chapters-button, .vjs-descriptions-button, .vjs-captions-button,
.vjs-subtitles-button, .vjs-audio-button { display: none; }
.vjs-subtitles-button, .vjs-subs-caps-button, .vjs-audio-button { display: none; }
}


// When the player is small, display nothing but:
// - Play button
// - Progress bar
// - Volume menu button
// - Captions Button
// - Subs-Caps Button
// - Fullscreen button
.video-js.vjs-layout-small:not(.vjs-fullscreen) {
.vjs-current-time, .vjs-time-divider, .vjs-duration, .vjs-remaining-time,
.vjs-playback-rate,
.vjs-mute-control, .vjs-volume-control,
.vjs-mute-control, .vjs-volume-control, .vjs-volume-panel,
.vjs-chapters-button, .vjs-descriptions-button, .vjs-captions-button,
.vjs-subtitles-button .vjs-audio-button { display: none; }
.vjs-subtitles-button, .vjs-audio-button { display: none; }
}
Loading

0 comments on commit f857523

Please sign in to comment.