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

videojs-mobile-ui 1.1.4 → 1.2.0

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 (47) hide show

package/README.md +104 -53
package/dist/videojs-mobile-ui.cjs.js +194 -42
package/dist/videojs-mobile-ui.css +6 -0
package/dist/videojs-mobile-ui.es.js +194 -42
package/dist/videojs-mobile-ui.js +194 -42
package/dist/videojs-mobile-ui.min.js +2 -2
package/docs/api/TouchOverlay.html +772 -0
package/docs/api/fonts/OpenSans-Bold-webfont.eot +0 -0
package/docs/api/fonts/OpenSans-Bold-webfont.svg +1830 -0
package/docs/api/fonts/OpenSans-Bold-webfont.woff +0 -0
package/docs/api/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
package/docs/api/fonts/OpenSans-BoldItalic-webfont.svg +1830 -0
package/docs/api/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
package/docs/api/fonts/OpenSans-Italic-webfont.eot +0 -0
package/docs/api/fonts/OpenSans-Italic-webfont.svg +1830 -0
package/docs/api/fonts/OpenSans-Italic-webfont.woff +0 -0
package/docs/api/fonts/OpenSans-Light-webfont.eot +0 -0
package/docs/api/fonts/OpenSans-Light-webfont.svg +1831 -0
package/docs/api/fonts/OpenSans-Light-webfont.woff +0 -0
package/docs/api/fonts/OpenSans-LightItalic-webfont.eot +0 -0
package/docs/api/fonts/OpenSans-LightItalic-webfont.svg +1835 -0
package/docs/api/fonts/OpenSans-LightItalic-webfont.woff +0 -0
package/docs/api/fonts/OpenSans-Regular-webfont.eot +0 -0
package/docs/api/fonts/OpenSans-Regular-webfont.svg +1831 -0
package/docs/api/fonts/OpenSans-Regular-webfont.woff +0 -0
package/docs/api/global.html +1485 -0
package/docs/api/index.html +159 -0
package/docs/api/plugin.js.html +266 -0
package/docs/api/scripts/linenumber.js +25 -0
package/docs/api/scripts/prettify/Apache-License-2.0.txt +202 -0
package/docs/api/scripts/prettify/lang-css.js +2 -0
package/docs/api/scripts/prettify/prettify.js +28 -0
package/docs/api/styles/jsdoc-default.css +358 -0
package/docs/api/styles/prettify-jsdoc.css +111 -0
package/docs/api/styles/prettify-tomorrow.css +132 -0
package/docs/api/swipeFullscreen.js.html +173 -0
package/docs/api/touchOverlay.js.html +203 -0
package/index.html +238 -170
package/package.json +6 -4
package/scripts/netlify.js +16 -0
package/scripts/readme-options.js +370 -0
package/src/plugin.css +6 -0
package/src/plugin.js +64 -38
package/src/swipeFullscreen.js +122 -0
package/src/touchOverlay.js +6 -2
package/test/plugin.test.js +57 -41
package/test/swipeFullscreen.test.js +365 -0

package/docs/api/global.html ADDED Viewed

@@ -0,0 +1,1485 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Global</title>
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+<body>
+<div id="main">
+    <h1 class="page-title">Global</h1>
+<section>
+<header>
+        <h2></h2>
+</header>
+<article>
+    <div class="container-overview">
+<dl class="details">
+</dl>
+    </div>
+        <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>
+    <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">
+    Add UI and event listeners
+</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>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>
+            <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">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>
+<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">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th>Attributes</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>fullscreen</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </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 class="attributes">
+                    &lt;optional><br>
+                </td>
+            <td class="description last">If the device is rotated, enter fullscreen.
+ Default true.</td>
+        </tr>
+        <tr>
+                <td class="name"><code>exitOnRotate</code></td>
+            <td class="type">
+<span class="param-type">boolean</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </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 class="type">
+<span class="param-type">boolean</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+            <td class="description last">If the device is rotated, lock the orientation (not supported by iOS).
+ Default true.</td>
+        </tr>
+        <tr>
+                <td class="name"><code>lockToLandscapeOnEnter</code></td>
+            <td class="type">
+<span class="param-type">boolean</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+            <td class="description last">When fullscreen is entered, lock the orientation (not supported by iOS).
+ Default false.</td>
+        </tr>
+        <tr>
+                <td class="name"><code>swipeToFullscreen</code></td>
+            <td class="type">
+<span class="param-type">boolean</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+            <td class="description last">Swipe up to enter fullscreen.
+ Default false.</td>
+        </tr>
+        <tr>
+                <td class="name"><code>swipeFromFullscreen</code></td>
+            <td class="type">
+<span class="param-type">boolean</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </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>
+        </tr>
+        <tr>
+                <td class="name"><code>disabled</code></td>
+            <td class="type">
+<span class="param-type">boolean</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+            <td class="description last">All fullscreen functionality provided by this plugin disabled.
+ Default false.</td>
+        </tr>
+    </tbody>
+</table>
+            </td>
+        </tr>
+        <tr>
+                <td class="name"><code>touchControls</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+            <td class="description last">Options for tap overlay.
+                <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>seekSeconds</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+            <td class="description last">Increment to seek in seconds.
+ Default 10.</td>
+        </tr>
+        <tr>
+                <td class="name"><code>tapTimeout</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+            <td class="description last">Timeout to tap on the button after display, in ms. ???
+ Default 300.</td>
+        </tr>
+        <tr>
+                <td class="name"><code>disableOnEnd</code></td>
+            <td class="type">
+<span class="param-type">boolean</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+            <td class="description last">Disable the touch overlay when the video ends.
+ Useful if an end screen overlay is used.
+ Default false.</td>
+        </tr>
+        <tr>
+                <td class="name"><code>disabled</code></td>
+            <td class="type">
+<span class="param-type">boolean</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+            <td class="description last">All tap overlay functionality provided by this plugin disabled.
+ Default false.</td>
+        </tr>
+    </tbody>
+</table>
+            </td>
+        </tr>
+        <tr>
+                <td class="name"><code>forceForTesting</code></td>
+            <td class="type">
+<span class="param-type">boolean</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+            <td class="description last">Used in unit tests</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#line7">line 7</a>
+    </li></ul></dd>
+</dl>
+</article>
+</section>
+</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>
+</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)
+</footer>
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>