Fix for scroll direction on volume (fixes #258)

FIx Plyr to work with RTL systems

changelog.md

@@ -1,5 +1,21 @@
 # Changelog
 
+# v1.6.19
+- Fix for scroll direction issues on volume control (fixes #258)
+
+# v1.6.18
+- Reduced rounding of seek value from 1 decimal point to 4 (fixes #242)
+
+# v1.6.17
+- Added `disableContextMenu` option to hide the right click context menu (fixes #248 and #225)
+
+# v1.6.16
+- Always hide standard controls (fixes #225)
+- Fix for Tooltips overflowing (fixes #230)
+
+## v1.6.15
+- Restore scroll position when exiting full screen (fixes #236)
+
 ## v1.6.14
 - SVG sprite loading automatically for an easier setup
 - Touch devices now show controls on touch rather than pausing playback
@@ -82,18 +98,18 @@
 - Docs fixes inc controls HTML (fixes #180)
 
 ## v1.5.17
-- Expose YouTube and Vimeo API (docs update required) (Fixes #176)
+- Expose YouTube and Vimeo API (docs update required) (fixes #176)
 - Auto set title based on YouTube getVideoData() title property
 - Bug fix for Vimeo API change (Uncaught TypeError: Cannot read property 'value' of undefined) due to a change their end
 
 ## v1.5.16
-- Cancel requests on source change (Fixes #174)
+- Cancel requests on source change (fixes #174)
 
 ## v1.5.15
-- Fix for CustomEvent polyfill and related bug (See #172)
+- Fix for CustomEvent polyfill and related bug (see #172)
 
 ## v1.5.14
-- Volume storage fix (Fixes #171)
+- Volume storage fix (fixes #171)
 
 ## v1.5.13
 - Fix for manual caption rendering
@@ -196,11 +212,11 @@
 ## v1.2.3
 - Fix for YouTube on iPhone or unsupported browsers (fallback to YouTube native)
 - Docs tidy up
-- Fullscreen for Safari fix (Fixes #96)
+- Fullscreen for Safari fix (fixes #96)
 
 ## v1.2.2
-- Fix for :focus keyboard vs mouse (Fixes #61)
-- Fix for caption positioning in full screen (Fixes #92)
+- Fix for :focus keyboard vs mouse (fixes #61)
+- Fix for caption positioning in full screen (fixes #92)
 
 ## v1.2.1
 - Tooltip bug fix
@@ -227,7 +243,7 @@
 - Bug fix for 1.1.8
 
 ## v1.1.8
-- setVolume API method improvements (Fixes #83)
+- setVolume API method improvements (fixes #83)
 
 ## v1.1.7
 - Restore classname on destroy()
@@ -236,7 +252,7 @@
 - New API methods (fixes #77), Fix for non strict mode (fixes #78)
 
 ## v1.1.5
-- Fix for incorrect `isFullscreen()` return value in Mozilla (Fixes #38)
+- Fix for incorrect `isFullscreen()` return value in Mozilla (fixes #38)
 
 ## v1.1.4
 - Minor bug fixes
@@ -260,17 +276,17 @@
 - Display duration on `metadataloaded`
 
 ## v1.0.30
-- Fixed bug with media longer than 60 minutes (Fixes #69)
+- Fixed bug with media longer than 60 minutes (fixes #69)
 
 ## v1.0.29
-- Added option to hide controls on fullscreen (default `true`) while palying, after 1s. Pause, mouse hover on progress, or focus on a child control re-shows the controls. On touch a tap of the video (which plays/pauses the video by default) is required. (Fixes #47)
+- Added option to hide controls on fullscreen (default `true`) while palying, after 1s. Pause, mouse hover on progress, or focus on a child control re-shows the controls. On touch a tap of the video (which plays/pauses the video by default) is required. (fixes #47)
 - Fixed a bug with caption toggle in 1.0.28
 
 ## v1.0.28
 - Added API support for browsers that don't have full plyr support (pretty much <=IE9 and `<video>` on iPhone/iPod)
 
 ## v1.0.27
-- Keyboard accessibility improvements (Fixes #66)
+- Keyboard accessibility improvements (fixes #66)
 
 ## v1.0.26
 - Fixes for SASS (cheers @brunowego)
@@ -281,29 +297,29 @@
 - Classnames for left/right controls changed
 
 ## v1.0.24
-- Added tooltip option to display labels as tooltips (Fixes #50)
+- Added tooltip option to display labels as tooltips (fixes #50)
 
 ## v1.0.23
-- Handling loading states in the UI (Fixes #36)
+- Handling loading states in the UI (fixes #36)
 
 ## v1.0.22
 - Added support() API method for checking mimetype support
-- Added source() API method for setting media source(s) (Fixes #44)
+- Added source() API method for setting media source(s) (fixes #44)
 - Added poster() API method for setting poster source
 - Refactored captions logic for manual captions
 
 ## v1.0.21
-- Added an <input type="range"> for seeking to improve experience (and support dragging) (Fixes #40, #42)
-- Icons for restart and captions improved (and some IDs changed) (Fixes #49)
+- Added an <input type="range"> for seeking to improve experience (and support dragging) (fixes #40, #42)
+- Icons for restart and captions improved (and some IDs changed) (fixes #49)
 
 ## v1.0.20
 - Default controls included (Fixes #45)
-- Volume changes on `input` as well as `change` (Fixes #43)
+- Volume changes on `input` as well as `change` (fixes #43)
 - Fix for undefined Play text
 - License changed to MIT
 
 ## v1.0.19
-- Fixed firefox fullscreen issue (Fixes #38)
+- Fixed firefox fullscreen issue (fixes #38)
 
 ## v1.0.18
 - Added CDN references
@@ -327,7 +343,7 @@
 - Minor tweaks
 
 ## v1.0.12
-- Handle native events (Issue #34)
+- Handle native events (issue #34)
 
 ## v1.0.11
 - Bug fixes for fullscreen mode

package.json

@@ -1,6 +1,6 @@
 {
   "name": "plyr",
-  "version": "1.6.14",
+  "version": "1.6.19",
   "description": "A simple, accessible and customizable HTML5, YouTube and Vimeo media player",
   "homepage": "http://plyr.io",
   "main": "src/js/plyr.js",

readme.md

@@ -21,6 +21,7 @@ We wanted a lightweight, accessible and customizable media player that supports
 - **[Fullscreen](#fullscreen)** - supports native fullscreen with fallback to "full window" modes
 - **i18n support** - support for internationalization of controls
 - **No dependencies** - written in "vanilla" JavaScript, no jQuery required
+- **SASS and LESS provided** - If you like _these_ over plain CSS
 
 Oh and yes, it works with Bootstrap.
 
@@ -38,9 +39,9 @@ Check out the [changelog](changelog.md) to see what's new with Plyr.
 If you have any cool ideas or features, please let me know by [creating an issue](https://github.com/Selz/plyr/issues/new) or, of course, forking and sending a pull request.
 
 ## Implementation
-Check `docs/index.html` and `docs/dist/docs.js` for an example setup.
+Check `docs/index.html` and `docs/src/js/docs.js` for an example setup.
 
-**Heads up:** the example `index.html` file needs to be served from a webserver (such as Apache, Nginx, IIS or similar) unless you change the file sources to include http or https. e.g. change `//cdn.plyr.io/1.6.14/plyr.js` to `https://cdn.plyr.io/1.6.14/plyr.js`
+**Heads up:** the example `index.html` file needs to be served from a webserver (such as Apache, Nginx, IIS or similar) unless you change the file sources to include http or https. e.g. change `//cdn.plyr.io/1.6.19/plyr.js` to `https://cdn.plyr.io/1.6.19/plyr.js`
 
 ### npm
 
@@ -52,7 +53,7 @@ npm install plyr
 
 ### Bower
 
-If bower is your thang, you can grab Plyr using:
+If bower is your thing, you can grab Plyr using:
 ```
 bower install plyr
 ```
@@ -71,11 +72,11 @@ More info is on [npm](https://www.npmjs.com/package/ember-cli-plyr) and [GitHub]
 If you want to use our CDN, you can use the following:
 
 ```html
-<link rel="stylesheet" href="https://cdn.plyr.io/1.6.14/plyr.css">
-<script src="https://cdn.plyr.io/1.6.14/plyr.js"></script>
+<link rel="stylesheet" href="https://cdn.plyr.io/1.6.19/plyr.css">
+<script src="https://cdn.plyr.io/1.6.19/plyr.js"></script>
 ```
 
-The SVG sprite/defs file can be found here: `https://cdn.plyr.io/1.6.14/plyr.svg`.
+The SVG sprite/defs file can be found here: `https://cdn.plyr.io/1.6.19/plyr.svg`.
 
 ### CSS & Styling
 If you want to use the default css, add the `plyr.css` file from `/dist` into your head, or even better use `plyr.less` or `plyr.scss` file included in `/src` in your build to save a request.
@@ -87,7 +88,7 @@ If you want to use the default css, add the `plyr.css` file from `/dist` into yo
 The default setup uses the BEM methodology with `plyr` as the block, e.g. `.plyr__controls`. You can change the class hooks in the options. Check out the source for more on this.
 
 ### SVG
-The icons used in the Plyr controls are loaded in an SVG sprite. The icons can be used in your own SVG sprite build (see `/src/sprite` for source icons) or using the default settings which sprite from the CDN automatically for a hassle free setup. 
+The icons used in the Plyr controls are loaded in an SVG sprite. The sprite is automatically loaded from our CDN by default. If you already have an icon build system in place, you can include the source plyr icons (see `/src/sprite` for source icons).
 
 #### Using the `iconUrl` option
 You can however specify your own `iconUrl` option and Plyr will determine if the url is absolute and requires loading by AJAX/CORS due to current browser limitations or if it's a relative path, just use the path directly. 
@@ -163,7 +164,7 @@ Be sure to [validate your caption files](https://quuz.org/webvtt/)
 Here's an example of a default setup:
 
 ```html
-<script src="https://cdn.plyr.io/1.6.14/plyr.js"></script>
+<script src="https://cdn.plyr.io/1.6.19/plyr.js"></script>
 <script>plyr.setup();</script>
 ```
 
@@ -196,7 +197,13 @@ Some touch browsers (particularly Mobile Safari on iOS) seem to have issues with
 
 #### Options
 
-Options must be passed as an object to the `setup()` method as above or as JSON in `data-plyr` attribute on each of your target elements (e.g. data-plyr='{ title: "testing" }') - note the single quotes encapsulating the JSON.
+Options must be passed as an object to the `setup()` method as above or as JSON in `data-plyr` attribute on each of your target elements:
+
+```html
+<div class="plyr" data-plyr='{ title: "testing" }'>
+```
+
+Note the single quotes encapsulating the JSON and double quotes on the object keys.
 
 <table class="table" width="100%">
 <thead>
@@ -280,6 +287,12 @@ Options must be passed as an object to the `setup()` method as above or as JSON
     <td><code>true</code></td>
     <td>Click (or tap) of the video container will toggle pause/play.</td>
   </tr>
+  <tr>
+    <td><code>disableContextMenu</code></td>
+    <td>Boolean</td>
+    <td><code>true</code></td>
+    <td>Disable right click menu on video to <em>help</em> as very primitive obfuscation to prevent downloads of content.</td>
+  </tr>
   <tr>
     <td><code>hideControls</code></td>
     <td>Boolean</td>
@@ -403,7 +416,7 @@ Or you can use the returned object from your call to the setup method:
 var player = plyr.setup('.js-plyr')[0];
 ```
 
-This will return an array of plyr instances setup, so you need to specify the index of the instance you want. This is less useful if you are setting up mutliple instances. You can listen for the `setup` [event](#events) documented below which will return each instance one by one, as they are setup (in the `plyr` key of the event object).
+This will return an array of plyr instances setup, so you need to specify the index of the instance you want. This is less useful if you are setting up multiple instances. You can listen for the `setup` [event](#events) documented below which will return each instance one by one, as they are setup (in the `plyr` key of the event object).
 
 Once you have your instance, you can use the API methods below on it. For example to pause it:
 
@@ -829,7 +842,7 @@ Fullscreen in Plyr is supported for all browsers that [currently support it](htt
   </tbody>
 </table>
 
-&sup1; Mobile Safari on the iPhone forces the native player for `<video>` so no useful customisation is possible. `<audio>` elements have volume controls disabled.
+&sup1; Mobile Safari on the iPhone forces the native player for `<video>` so no useful customization is possible. `<audio>` elements have volume controls disabled.
 
 &sup2; Native player used (no support for `<progress>` or `<input type="range">`) but the API is supported (v1.0.28+)
 

src/js/plyr.js

@@ -1,6 +1,6 @@
 // ==========================================================================
 // Plyr
-// plyr.js v1.6.14
+// plyr.js v1.6.19
 // https://github.com/selz/plyr
 // License: The MIT License (MIT)
 // ==========================================================================
@@ -26,10 +26,11 @@
     /*global YT,$f*/
 
     // Globals
-    var fullscreen;
+    var fullscreen, 
+    scroll = { x: 0, y: 0 },
 
     // Default config
-    var defaults = {
+    defaults = {
         enabled:                true,
         debug:                  false,
         autoplay:               false,
@@ -43,10 +44,11 @@
         displayDuration:        true,
         loadSprite:             true,
         iconPrefix:             'plyr',
-        iconUrl:                'https://cdn.plyr.io/1.6.14/plyr.svg',
+        iconUrl:                'https://cdn.plyr.io/1.6.19/plyr.svg',
         clickToPlay:            true,
         hideControls:           true,
         showPosterOnEnd:        false,
+        disableContextMenu:     true,
         tooltips: {
             controls:           false,
             seek:               true
@@ -1437,8 +1439,6 @@
                 _setAttributes(vimeo, {
                     'src':                      'https://player.vimeo.com/video/' + mediaId + '?player_id=' + id + '&api=1&badge=0&byline=0&portrait=0&title=0',
                     'id':                       id,
-                    'webkitallowfullscreen':    '',
-                    'mozallowfullscreen':       '',
                     'allowfullscreen':          '',
                     'frameborder':              0
                 });
@@ -1888,7 +1888,7 @@
             // Set the current time
             // Try/catch incase the media isn't set and we're calling seek() from source() and IE moans
             try {
-                plyr.media.currentTime = targetTime.toFixed(1);
+                plyr.media.currentTime = targetTime.toFixed(4);
             }
             catch(e) {}
 
@@ -1953,6 +1953,19 @@
             _toggleControls(plyr.media.paused);
         }
 
+        // Save scroll position
+        function _saveScrollPosition() {
+            scroll = {
+                x: window.pageXOffset || 0,
+                y: window.pageYOffset || 0
+            };
+        }
+
+        // Restore scroll position
+        function _restoreScrollPosition() {
+            window.scrollTo(scroll.x, scroll.y);
+        }
+
         // Toggle fullscreen
         function _toggleFullscreen(event) {
             // Check for native support
@@ -1966,6 +1979,10 @@
             else if (nativeSupport) {
                 // Request fullscreen
                 if (!fullscreen.isFullScreen(plyr.container)) {
+                    // Save scroll position
+                    _saveScrollPosition();
+
+                    // Request full screen
                     fullscreen.requestFullScreen(plyr.container);
                 }
                 // Bail from fullscreen
@@ -2010,6 +2027,11 @@
 
             // Trigger an event
             _triggerEvent(plyr.container, plyr.isFullscreen ? 'enterfullscreen' : 'exitfullscreen');
+
+            // Restore scroll position
+            if (!plyr.isFullscreen && nativeSupport) {
+                _restoreScrollPosition();
+            }
         }
 
         // Bail from faux-fullscreen
@@ -2819,14 +2841,28 @@
             _on(plyr.volume.input, 'wheel', function(event) {
                 event.preventDefault();
 
-                // Scroll down to decrease
+                // Detect "natural" scroll - suppored on OS X Safari only
+                // Other browsers on OS X will be inverted until support improves
+                var inverted = event.webkitDirectionInvertedFromDevice;
+
+                // Scroll down (or up on natural) to decrease
                 if (event.deltaY < 0 || event.deltaX > 0) {
-                    _decreaseVolume();
+                    if (inverted) {
+                        _decreaseVolume();
+                    }
+                    else {
+                        _increaseVolume();
+                    }
                 }
 
-                // Scroll up to increase
+                // Scroll up (or down on natural) to increase
                 if (event.deltaY > 0 || event.deltaX < 0) {
-                    _increaseVolume();
+                    if (inverted) {
+                        _increaseVolume();
+                    }
+                    else {
+                        _decreaseVolume();
+                    }
                 }
             });
         }
@@ -2910,6 +2946,11 @@
                 });
             }
 
+            // Disable right click
+            if (config.disableContextMenu) {
+                _on(plyr.media, 'contextmenu', function(event) { event.preventDefault(); });
+            }
+
             // Proxy events to container
             _on(plyr.media, config.events.join(' '), function(event) {
                 _triggerEvent(plyr.container, event.type, true);

src/less/plyr.less

@@ -20,6 +20,7 @@
     max-width: 100%;
     min-width: 200px;
     font-family: Avenir, "Avenir Next", "Helvetica Neue", "Segoe UI", Helvetica, Arial, sans-serif;
+    direction: ltr;
 
     & when (@plyr-border-box = true) {
         // border-box everything
@@ -177,7 +178,6 @@
     padding-bottom: 56.25%; /* 16:9 */
     height: 0;
     overflow: hidden;
-    border-radius: inherit;
 
     iframe {
         position: absolute;
@@ -246,6 +246,11 @@
 
 // Controls
 // --------------------------------------------------------------
+// Hide native controls
+.plyr ::-webkit-media-controls {
+    display: none;
+}
+
 // Playback controls
 .plyr__controls {
     display: flex;
@@ -280,7 +285,7 @@
         flex-shrink: 0;
         overflow: visible; // IE11
         vertical-align: middle;
-        padding: (@plyr-control-spacing * .7);
+        padding: @plyr-control-padding;
         border: 0;
         background: transparent;
         border-radius: 3px;
@@ -289,8 +294,8 @@
         color: inherit;
 
         svg {
-            width: 18px;
-            height: 18px;
+            width: @plyr-control-icon-size;
+            height: @plyr-control-icon-size;
             display: block;
             fill: currentColor;
         }
@@ -480,6 +485,40 @@
     z-index: 3;
 }
 
+// First tooltip
+.plyr__controls button:first-child .plyr__tooltip {
+    left: 0;
+    transform: translate(0, 10px) scale(.8);
+    transform-origin: 0 100%;
+
+    &::before {
+        left: (@plyr-control-icon-size / 2) + @plyr-control-padding;
+    }
+}
+
+// Last tooltip
+.plyr__controls button:last-child .plyr__tooltip {
+    right: 0;
+    transform: translate(0, 10px) scale(.8);
+    transform-origin: 100% 100%;
+
+    &::before {
+        left: auto;
+        right: (@plyr-control-icon-size / 2) + @plyr-control-padding;
+        transform: translateX(50%);
+    }
+}
+
+.plyr__controls button:first-child,
+.plyr__controls button:last-child {
+    &:hover .plyr__tooltip,
+    &.tab-focus:focus .plyr__tooltip,
+    .plyr__tooltip--visible {
+        transform: translate(0, 0) scale(1);
+    }
+}
+
+
 // Playback progress
 // --------------------------------------------------------------
 // <progress> element

src/less/variables.less

@@ -16,14 +16,16 @@
 @plyr-font-size-base:                   16px;
 
 // Captions
-@plyr-captions-bg: 						fade(#000, 70%);
-@plyr-captions-color: 					#fff;
+@plyr-captions-bg:                      fade(#000, 70%);
+@plyr-captions-color:                   #fff;
 @plyr-font-size-captions-base:          @plyr-font-size-base;
 @plyr-font-size-captions-medium:        ceil(@plyr-font-size-base * 1.5);
 @plyr-font-size-captions-large:         (@plyr-font-size-base * 2);
 
 // Controls
+@plyr-control-icon-size:                18px;
 @plyr-control-spacing:                  10px;
+@plyr-control-padding:                  (@plyr-control-spacing * .7);
 @plyr-video-controls-bg:                #000;
 @plyr-video-control-color:              #fff;
 @plyr-video-control-color-hover:        #fff;
@@ -37,7 +39,7 @@
 
 // Tooltips
 @plyr-tooltip-bg:                       fade(#000, 70%);
-@plyr-tooltip-color:                   	#fff;
+@plyr-tooltip-color:                    #fff;
 @plyr-tooltip-padding:                  (@plyr-control-spacing / 2);
 @plyr-tooltip-arrow-size:               4px;
 @plyr-tooltip-radius:                   3px;
@@ -62,7 +64,7 @@
 @plyr-range-thumb-active-scale:         1.25;
 @plyr-video-range-track-bg:             @plyr-video-progress-buffered-bg;
 @plyr-audio-range-track-bg:             @plyr-audio-progress-buffered-bg;
-@plyr-range-selected-bg: 				@plyr-color-main;
+@plyr-range-selected-bg:                @plyr-color-main;
 
 // Breakpoints
 @plyr-bp-screen-sm:                     480px;

src/scss/plyr.scss

@@ -20,6 +20,7 @@
     max-width: 100%;
     min-width: 200px;
     font-family: Avenir, "Avenir Next", "Helvetica Neue", "Segoe UI", Helvetica, Arial, sans-serif;
+    direction: ltr;
 
     @if $plyr-border-box == true {
         // border-box everything
@@ -245,6 +246,11 @@
 
 // Controls
 // --------------------------------------------------------------
+// Hide native controls
+.plyr ::-webkit-media-controls {
+    display: none;
+}
+
 // Playback controls
 .plyr__controls {
     display: flex;
@@ -479,6 +485,40 @@
     z-index: 3;
 }
 
+// First tooltip
+.plyr__controls button:first-child .plyr__tooltip {
+    $tooltip-arrow-offset: ;
+    left: 0;
+    transform: translate(0, 10px) scale(.8);
+    transform-origin: 0 100%;
+
+    &::before {
+        left: ($plyr-control-icon-size / 2) + $plyr-control-padding;
+    }
+}
+
+// Last tooltip
+.plyr__controls button:last-child .plyr__tooltip {
+    right: 0;
+    transform: translate(0, 10px) scale(.8);
+    transform-origin: 100% 100%;
+
+    &::before {
+        left: auto;
+        right: ($plyr-control-icon-size / 2) + $plyr-control-padding;
+        transform: translateX(50%);
+    }
+}
+
+.plyr__controls button:first-child,
+.plyr__controls button:last-child {
+    &:hover .plyr__tooltip,
+    &.tab-focus:focus .plyr__tooltip,
+    .plyr__tooltip--visible {
+        transform: translate(0, 0) scale(1);
+    }
+}
+
 // Playback progress
 // --------------------------------------------------------------
 // <progress> element

src/scss/variables.scss

@@ -17,14 +17,16 @@ $plyr-font-size-small:                  14px !default;
 $plyr-font-size-base:                   16px !default;
 
 // Captions
-$plyr-captions-bg: 						transparentize(#000, .3) !default;
-$plyr-captions-color: 					#fff !default;
+$plyr-captions-bg:                      transparentize(#000, .3) !default;
+$plyr-captions-color:                   #fff !default;
 $plyr-font-size-captions-base:          $plyr-font-size-base !default;
 $plyr-font-size-captions-medium:        ceil($plyr-font-size-base * 1.5) !default;
 $plyr-font-size-captions-large:         ($plyr-font-size-base * 2) !default;
 
 // Controls
+$plyr-control-icon-size:                18px !default;
 $plyr-control-spacing:                  10px !default;
+$plyr-control-padding:                  ($plyr-control-spacing * .7) !default;
 $plyr-video-controls-bg:                #000 !default;
 $plyr-video-control-color:              #fff !default;
 $plyr-video-control-color-hover:        #fff !default;
@@ -63,7 +65,7 @@ $plyr-range-thumb-active-bg:            $plyr-video-control-bg-hover !default;
 $plyr-range-thumb-active-scale:         1.25 !default;
 $plyr-video-range-track-bg:             $plyr-video-progress-buffered-bg !default;
 $plyr-audio-range-track-bg:             $plyr-audio-progress-buffered-bg !default;
-$plyr-range-selected-bg: 				$plyr-color-main !default;
+$plyr-range-selected-bg:                $plyr-color-main !default;
 
 // Breakpoints
 $plyr-bp-screen-sm:                     480px !default;