npm - videojs-mobile-ui - Versions diffs - 1.2.0 → 1.2.1 - Mend

videojs-mobile-ui 1.2.0 → 1.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

package/README.md +3 -3
package/dist/videojs-mobile-ui.cjs.js +2 -2
package/dist/videojs-mobile-ui.es.js +2 -2
package/dist/videojs-mobile-ui.js +2 -2
package/dist/videojs-mobile-ui.min.js +2 -2
package/docs/api/TouchOverlay.html +241 -49
package/docs/api/global.html +298 -826
package/docs/api/index.html +4 -4
package/docs/api/plugin.js.html +86 -131
package/docs/api/scripts/linenumber.js +9 -9
package/docs/api/styles/jsdoc-default.css +2 -2
package/docs/api/touchOverlay.js.html +61 -53
package/package.json +1 -1

package/docs/api/global.html CHANGED Viewed

@@ -94,569 +94,9 @@
-        <h3 class="subsection-title">Members</h3>
-<h4 class="name" id="Component"><span class="type-signature">(constant) </span>Component<span class="type-signature"></span></h4>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="touchOverlay.js.html">touchOverlay.js</a>, <a href="touchOverlay.js.html#line11">line 11</a>
-    </li></ul></dd>
-</dl>
-<h4 class="name" id="defaults"><span class="type-signature">(constant) </span>defaults<span class="type-signature"> :<a href="global.html#MobileUiOptions">MobileUiOptions</a></span></h4>
-    <h5>Type:</h5>
-    <ul>
-        <li>
-<span class="param-type"><a href="global.html#MobileUiOptions">MobileUiOptions</a></span>
-        </li>
-    </ul>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="plugin.js.html">plugin.js</a>, <a href="plugin.js.html#line54">line 54</a>
-    </li></ul></dd>
-</dl>
-        <h3 class="subsection-title">Methods</h3>
-    <h4 class="name" id="getOrientation"><span class="type-signature"></span>getOrientation<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
-<div class="description">
-    Gets 'portrait' or 'lanscape' from the two orientation APIs
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="plugin.js.html">plugin.js</a>, <a href="plugin.js.html#line79">line 79</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    orientation
-</div>
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">string</span>
-    </dd>
-</dl>
-    <h4 class="name" id="initSwipe"><span class="type-signature"></span>initSwipe<span class="signature">(player, pluginOptions)</span><span class="type-signature"></span></h4>
-<div class="description">
-    Sets up swiping to enter and exit fullscreen.
-</div>
-    <h5>This:</h5>
-    <ul><li>{Plugin}</li></ul>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>player</code></td>
-            <td class="type">
-<span class="param-type">Player</span>
-            </td>
-            <td class="description last">The player to initialise on.</td>
-        </tr>
-        <tr>
-                <td class="name"><code>pluginOptions</code></td>
-            <td class="type">
-<span class="param-type"><a href="global.html#MobileUiOptions">MobileUiOptions</a></span>
-            </td>
-            <td class="description last">The options used by the mobile ui plugin.</td>
-        </tr>
-    </tbody>
-</table>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="swipeFullscreen.js.html">swipeFullscreen.js</a>, <a href="swipeFullscreen.js.html#line14">line 14</a>
-    </li></ul></dd>
-</dl>
-    <h4 class="name" id="mobileUi"><span class="type-signature"></span>mobileUi<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
-<div class="description">
-    Adds a mobile UI for player control, and fullscreen orientation control
-</div>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th>Attributes</th>
-        <th>Default</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>options</code></td>
-            <td class="type">
-<span class="param-type"><a href="global.html#MobileUiOptions">MobileUiOptions</a></span>
-            </td>
-                <td class="attributes">
-                    &lt;optional><br>
-                </td>
-                <td class="default">
-                    {}
-                </td>
-            <td class="description last"></td>
-        </tr>
-    </tbody>
-</table>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="plugin.js.html">plugin.js</a>, <a href="plugin.js.html#line195">line 195</a>
-    </li></ul></dd>
-</dl>
+        <h3 class="subsection-title">Methods</h3>
@@ -664,7 +104,7 @@
-    <h4 class="name" id="onPlayerReady"><span class="type-signature"></span>onPlayerReady<span class="signature">(player, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
+    <h4 class="name" id="mobileUi"><span class="type-signature"></span>mobileUi<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
@@ -672,7 +112,8 @@
 <div class="description">
-    Add UI and event listeners
+    <p>A video.js plugin.</p>
+<p>Adds a monile UI for player control, and fullscreen orientation control</p>
 </div>
@@ -710,41 +151,6 @@
     <tbody>
-        <tr>
-                <td class="name"><code>player</code></td>
-            <td class="type">
-<span class="param-type">Player</span>
-            </td>
-                <td class="attributes">
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last">A Video.js player object.</td>
-        </tr>
         <tr>
                 <td class="name"><code>options</code></td>
@@ -753,7 +159,7 @@
             <td class="type">
-<span class="param-type"><a href="global.html#MobileUiOptions">MobileUiOptions</a></span>
+<span class="param-type">Object</span>
@@ -779,111 +185,11 @@
                 </td>
-            <td class="description last">A plain object containing options for the plugin.</td>
-        </tr>
-    </tbody>
-</table>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="plugin.js.html">plugin.js</a>, <a href="plugin.js.html#line100">line 100</a>
-    </li></ul></dd>
-</dl>
-        <h3 class="subsection-title">Type Definitions</h3>
+            <td class="description last"><p>Plugin options.</p>
+                <h6>Properties</h6>
-<h4 class="name" id="MobileUiOptions">MobileUiOptions</h4>
-    <h5>Type:</h5>
-    <ul>
-        <li>
-<span class="param-type">Object</span>
-        </li>
-    </ul>
-    <h5 class="subsection-title">Properties:</h5>
-<table class="props">
+<table class="params">
     <thead>
     <tr>
@@ -897,6 +203,8 @@
+        <th>Default</th>
         <th class="last">Description</th>
     </tr>
@@ -907,13 +215,13 @@
         <tr>
-                <td class="name"><code>fullscreen</code></td>
+                <td class="name"><code>forceForTesting</code></td>
             <td class="type">
-<span class="param-type">Object</span>
+<span class="param-type">boolean</span>
@@ -926,77 +234,33 @@
-                </td>
-            <td class="description last">Options for fullscreen behaviours.
-                <h6>Properties</h6>
-<table class="props">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th>Attributes</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>enterOnRotate</code></td>
-            <td class="type">
-<span class="param-type">boolean</span>
+                </td>
-            </td>
-                <td class="attributes">
-                    &lt;optional><br>
+                <td class="default">
+                    false
                 </td>
-            <td class="description last">If the device is rotated, enter fullscreen.
- Default true.</td>
+            <td class="description last"><p>Enables the display regardless of user agent, for testing purposes</p></td>
         </tr>
         <tr>
-                <td class="name"><code>exitOnRotate</code></td>
+                <td class="name"><code>fullscreen</code></td>
             <td class="type">
-<span class="param-type">boolean</span>
+<span class="param-type">Object</span>
@@ -1009,52 +273,50 @@
-                </td>
-            <td class="description last">If the device is rotated, exit fullscreen.
- Default true.</td>
-        </tr>
-        <tr>
-                <td class="name"><code>lockOnRotate</code></td>
+                </td>
-            <td class="type">
+                <td class="default">
-<span class="param-type">boolean</span>
+                    {}
+                </td>
-            </td>
-                <td class="attributes">
-                    &lt;optional><br>
+            <td class="description last"><p>Fullscreen options.</p>
+                <h6>Properties</h6>
-                </td>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th>Attributes</th>
-            <td class="description last">If the device is rotated, lock the orientation (not supported by iOS).
- Default true.</td>
-        </tr>
+        <th>Default</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
         <tr>
-                <td class="name"><code>lockToLandscapeOnEnter</code></td>
+                <td class="name"><code>enterOnRotate</code></td>
             <td class="type">
@@ -1073,20 +335,27 @@
                 </td>
+                <td class="default">
+                    true
+                </td>
-            <td class="description last">When fullscreen is entered, lock the orientation (not supported by iOS).
- Default false.</td>
+            <td class="description last"><p>Whether to go fullscreen when rotating to landscape</p></td>
         </tr>
         <tr>
-                <td class="name"><code>swipeToFullscreen</code></td>
+                <td class="name"><code>exitOnRotate</code></td>
             <td class="type">
@@ -1105,20 +374,27 @@
                 </td>
+                <td class="default">
+                    true
+                </td>
-            <td class="description last">Swipe up to enter fullscreen.
- Default false.</td>
+            <td class="description last"><p>Whether to leave fullscreen when rotating to portrait (if not locked)</p></td>
         </tr>
         <tr>
-                <td class="name"><code>swipeFromFullscreen</code></td>
+                <td class="name"><code>lockOnRotate</code></td>
             <td class="type">
@@ -1137,21 +413,28 @@
                 </td>
+                <td class="default">
+                    true
+                </td>
-            <td class="description last">Swipe down to exit fullscreen.
- Won't do anything on iOS native fullscreen, which has its own swipe down exit gesture.
- Default false.</td>
+            <td class="description last"><p>Whether to lock orientation when rotating to landscape
+          Unlocked when exiting fullscreen or on 'ended'</p></td>
         </tr>
         <tr>
-                <td class="name"><code>disabled</code></td>
+                <td class="name"><code>iOS</code></td>
             <td class="type">
@@ -1170,13 +453,20 @@
                 </td>
+                <td class="default">
+                    false
+                </td>
-            <td class="description last">All fullscreen functionality provided by this plugin disabled.
- Default false.</td>
+            <td class="description last"><p>Whether to disable iOS's native fullscreen so controls can work</p></td>
         </tr>
@@ -1209,15 +499,24 @@
                 </td>
+                <td class="default">
+                    {}
+                </td>
-            <td class="description last">Options for tap overlay.
+            <td class="description last"><p>Touch UI options.</p>
                 <h6>Properties</h6>
-<table class="props">
+<table class="params">
     <thead>
     <tr>
@@ -1231,6 +530,8 @@
+        <th>Default</th>
         <th class="last">Description</th>
     </tr>
@@ -1247,7 +548,7 @@
             <td class="type">
-<span class="param-type">number</span>
+<span class="param-type">int</span>
@@ -1260,13 +561,20 @@
                 </td>
+                <td class="default">
+                    10
+                </td>
-            <td class="description last">Increment to seek in seconds.
- Default 10.</td>
+            <td class="description last"><p>Number of seconds to seek on double-tap</p></td>
         </tr>
@@ -1279,7 +587,7 @@
             <td class="type">
-<span class="param-type">number</span>
+<span class="param-type">int</span>
@@ -1292,13 +600,20 @@
                 </td>
+                <td class="default">
+                    300
+                </td>
-            <td class="description last">Timeout to tap on the button after display, in ms. ???
- Default 300.</td>
+            <td class="description last"><p>Interval in ms to be considered a doubletap</p></td>
         </tr>
@@ -1324,27 +639,164 @@
                 </td>
+                <td class="default">
+                    false
+                </td>
+            <td class="description last"><p>Whether to disable when the video ends (e.g., if there is an endscreen)
+          Never shows if the endscreen plugin is present</p></td>
+        </tr>
+    </tbody>
+</table>
-            <td class="description last">Disable the touch overlay when the video ends.
- Useful if an end screen overlay is used.
- Default false.</td>
+            </td>
+        </tr>
+    </tbody>
+</table>
+            </td>
         </tr>
+    </tbody>
+</table>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="plugin.js.html">plugin.js</a>, <a href="plugin.js.html#line125">line 125</a>
+    </li></ul></dd>
+</dl>
+    <h4 class="name" id="onPlayerReady"><span class="type-signature"></span>onPlayerReady<span class="signature">(player, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
+<div class="description">
+    <p>Add UI and event listeners</p>
+</div>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th>Attributes</th>
+        <th>Default</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
         <tr>
-                <td class="name"><code>disabled</code></td>
+                <td class="name"><code>player</code></td>
             <td class="type">
-<span class="param-type">boolean</span>
+<span class="param-type">Player</span>
@@ -1353,7 +805,7 @@
                 <td class="attributes">
-                    &lt;optional><br>
@@ -1361,29 +813,25 @@
+                <td class="default">
+                </td>
-            <td class="description last">All tap overlay functionality provided by this plugin disabled.
- Default false.</td>
-        </tr>
-    </tbody>
-</table>
-            </td>
+            <td class="description last"><p>A Video.js player object.</p></td>
         </tr>
         <tr>
-                <td class="name"><code>forceForTesting</code></td>
+                <td class="name"><code>options</code></td>
             <td class="type">
-<span class="param-type">boolean</span>
+<span class="param-type">Object</span>
@@ -1396,12 +844,20 @@
                 </td>
+                <td class="default">
+                    {}
+                </td>
-            <td class="description last">Used in unit tests</td>
+            <td class="description last"><p>A plain object containing options for the plugin.</p></td>
         </tr>
@@ -1411,6 +867,8 @@
 <dl class="details">
@@ -1440,7 +898,7 @@
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="plugin.js.html">plugin.js</a>, <a href="plugin.js.html#line7">line 7</a>
+        <a href="plugin.js.html">plugin.js</a>, <a href="plugin.js.html#line39">line 39</a>
     </li></ul></dd>
@@ -1456,7 +914,21 @@
@@ -1470,13 +942,13 @@
 </div>
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="TouchOverlay.html">TouchOverlay</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Component">Component</a></li><li><a href="global.html#defaults">defaults</a></li><li><a href="global.html#getOrientation">getOrientation</a></li><li><a href="global.html#initSwipe">initSwipe</a></li><li><a href="global.html#mobileUi">mobileUi</a></li><li><a href="global.html#onPlayerReady">onPlayerReady</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="TouchOverlay.html">TouchOverlay</a></li></ul><h3>Global</h3><ul><li><a href="global.html#mobileUi">mobileUi</a></li><li><a href="global.html#onPlayerReady">onPlayerReady</a></li></ul>
 </nav>
 <br class="clear">
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.5</a> on Fri Jan 23 2026 14:03:20 GMT+0100 (Mitteleuropäische Normalzeit)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Feb 02 2021 09:43:56 GMT+0100 (CET)
 </footer>
 <script> prettyPrint(); </script>