videojs-mobile-ui 1.2.0-alpha.0 → 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 (53) hide show
  1. package/README.md +104 -53
  2. package/dist/lang/de.js +1 -3
  3. package/dist/lang/en.js +1 -3
  4. package/dist/lang/it.js +1 -3
  5. package/dist/videojs-mobile-ui.cjs.js +195 -43
  6. package/dist/videojs-mobile-ui.css +104 -2
  7. package/dist/videojs-mobile-ui.es.js +195 -43
  8. package/dist/videojs-mobile-ui.js +204 -53
  9. package/dist/videojs-mobile-ui.min.js +2 -2
  10. package/docs/api/TouchOverlay.html +772 -0
  11. package/docs/api/fonts/OpenSans-Bold-webfont.eot +0 -0
  12. package/docs/api/fonts/OpenSans-Bold-webfont.svg +1830 -0
  13. package/docs/api/fonts/OpenSans-Bold-webfont.woff +0 -0
  14. package/docs/api/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
  15. package/docs/api/fonts/OpenSans-BoldItalic-webfont.svg +1830 -0
  16. package/docs/api/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
  17. package/docs/api/fonts/OpenSans-Italic-webfont.eot +0 -0
  18. package/docs/api/fonts/OpenSans-Italic-webfont.svg +1830 -0
  19. package/docs/api/fonts/OpenSans-Italic-webfont.woff +0 -0
  20. package/docs/api/fonts/OpenSans-Light-webfont.eot +0 -0
  21. package/docs/api/fonts/OpenSans-Light-webfont.svg +1831 -0
  22. package/docs/api/fonts/OpenSans-Light-webfont.woff +0 -0
  23. package/docs/api/fonts/OpenSans-LightItalic-webfont.eot +0 -0
  24. package/docs/api/fonts/OpenSans-LightItalic-webfont.svg +1835 -0
  25. package/docs/api/fonts/OpenSans-LightItalic-webfont.woff +0 -0
  26. package/docs/api/fonts/OpenSans-Regular-webfont.eot +0 -0
  27. package/docs/api/fonts/OpenSans-Regular-webfont.svg +1831 -0
  28. package/docs/api/fonts/OpenSans-Regular-webfont.woff +0 -0
  29. package/docs/api/global.html +1485 -0
  30. package/docs/api/index.html +159 -0
  31. package/docs/api/plugin.js.html +266 -0
  32. package/docs/api/scripts/linenumber.js +25 -0
  33. package/docs/api/scripts/prettify/Apache-License-2.0.txt +202 -0
  34. package/docs/api/scripts/prettify/lang-css.js +2 -0
  35. package/docs/api/scripts/prettify/prettify.js +28 -0
  36. package/docs/api/styles/jsdoc-default.css +358 -0
  37. package/docs/api/styles/prettify-jsdoc.css +111 -0
  38. package/docs/api/styles/prettify-tomorrow.css +132 -0
  39. package/docs/api/swipeFullscreen.js.html +173 -0
  40. package/docs/api/touchOverlay.js.html +203 -0
  41. package/index.html +238 -170
  42. package/package.json +23 -13
  43. package/scripts/lang.js +24 -0
  44. package/scripts/netlify.js +16 -0
  45. package/scripts/postcss.config.js +29 -5
  46. package/scripts/readme-options.js +370 -0
  47. package/scripts/rollup.config.js +0 -8
  48. package/src/plugin.css +6 -0
  49. package/src/plugin.js +65 -39
  50. package/src/swipeFullscreen.js +122 -0
  51. package/src/touchOverlay.js +7 -3
  52. package/test/plugin.test.js +125 -18
  53. package/test/swipeFullscreen.test.js +365 -0
@@ -0,0 +1,772 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>JSDoc: Class: TouchOverlay</title>
6
+
7
+ <script src="scripts/prettify/prettify.js"> </script>
8
+ <script src="scripts/prettify/lang-css.js"> </script>
9
+ <!--[if lt IE 9]>
10
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11
+ <![endif]-->
12
+ <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14
+ </head>
15
+
16
+ <body>
17
+
18
+ <div id="main">
19
+
20
+ <h1 class="page-title">Class: TouchOverlay</h1>
21
+
22
+
23
+
24
+
25
+
26
+
27
+ <section>
28
+
29
+ <header>
30
+
31
+ <h2><span class="attribs"><span class="type-signature"></span></span>TouchOverlay<span class="signature">(player, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2>
32
+
33
+ <div class="class-description">The `TouchOverlay` is an overlay to capture tap events.</div>
34
+
35
+
36
+ </header>
37
+
38
+ <article>
39
+ <div class="container-overview">
40
+
41
+
42
+
43
+
44
+ <h2>Constructor</h2>
45
+
46
+
47
+
48
+ <h4 class="name" id="TouchOverlay"><span class="type-signature"></span>new TouchOverlay<span class="signature">(player, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
49
+
50
+
51
+
52
+
53
+
54
+
55
+ <div class="description">
56
+ Creates an instance of the this class.
57
+ </div>
58
+
59
+
60
+
61
+
62
+
63
+
64
+
65
+
66
+
67
+ <h5>Parameters:</h5>
68
+
69
+
70
+ <table class="params">
71
+ <thead>
72
+ <tr>
73
+
74
+ <th>Name</th>
75
+
76
+
77
+ <th>Type</th>
78
+
79
+
80
+ <th>Attributes</th>
81
+
82
+
83
+
84
+
85
+ <th class="last">Description</th>
86
+ </tr>
87
+ </thead>
88
+
89
+ <tbody>
90
+
91
+
92
+ <tr>
93
+
94
+ <td class="name"><code>player</code></td>
95
+
96
+
97
+ <td class="type">
98
+
99
+
100
+ <span class="param-type">Player</span>
101
+
102
+
103
+
104
+ </td>
105
+
106
+
107
+ <td class="attributes">
108
+
109
+
110
+
111
+
112
+
113
+ </td>
114
+
115
+
116
+
117
+
118
+ <td class="description last">The `Player` that this class should be attached to.</td>
119
+ </tr>
120
+
121
+
122
+
123
+ <tr>
124
+
125
+ <td class="name"><code>options</code></td>
126
+
127
+
128
+ <td class="type">
129
+
130
+
131
+ <span class="param-type">options</span>
132
+
133
+
134
+
135
+ </td>
136
+
137
+
138
+ <td class="attributes">
139
+
140
+ &lt;optional><br>
141
+
142
+
143
+
144
+
145
+
146
+ </td>
147
+
148
+
149
+
150
+
151
+ <td class="description last">The key/value store of player options.</td>
152
+ </tr>
153
+
154
+
155
+ </tbody>
156
+ </table>
157
+
158
+
159
+
160
+
161
+
162
+
163
+ <dl class="details">
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+ <dt class="tag-source">Source:</dt>
191
+ <dd class="tag-source"><ul class="dummy"><li>
192
+ <a href="touchOverlay.js.html">touchOverlay.js</a>, <a href="touchOverlay.js.html#line19">line 19</a>
193
+ </li></ul></dd>
194
+
195
+
196
+
197
+
198
+
199
+
200
+
201
+ </dl>
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+ </div>
224
+
225
+
226
+ <h3 class="subsection-title">Extends</h3>
227
+
228
+
229
+
230
+
231
+ <ul>
232
+ <li><a href="global.html#Component">Component</a></li>
233
+ </ul>
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+ <h3 class="subsection-title">Members</h3>
250
+
251
+
252
+
253
+ <h4 class="name" id="handleTaps_"><span class="type-signature"></span>handleTaps_<span class="type-signature"></span></h4>
254
+
255
+
256
+
257
+
258
+ <div class="description">
259
+ Debounced tap handler.
260
+ Seeks number of (taps - 1) * configured seconds to skip.
261
+ One tap is a non-op
262
+ </div>
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+ <dl class="details">
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+ <dt class="tag-source">Source:</dt>
298
+ <dd class="tag-source"><ul class="dummy"><li>
299
+ <a href="touchOverlay.js.html">touchOverlay.js</a>, <a href="touchOverlay.js.html#line57">line 57</a>
300
+ </li></ul></dd>
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+ </dl>
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+
318
+
319
+ <h3 class="subsection-title">Methods</h3>
320
+
321
+
322
+
323
+
324
+
325
+
326
+
327
+ <h4 class="name" id="createEl"><span class="type-signature"></span>createEl<span class="signature">()</span><span class="type-signature"> &rarr; {Element}</span></h4>
328
+
329
+
330
+
331
+
332
+
333
+
334
+ <div class="description">
335
+ Builds the DOM element.
336
+ </div>
337
+
338
+
339
+
340
+
341
+
342
+
343
+
344
+
345
+
346
+
347
+
348
+
349
+
350
+ <dl class="details">
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+
366
+
367
+
368
+
369
+
370
+
371
+
372
+
373
+
374
+
375
+
376
+
377
+ <dt class="tag-source">Source:</dt>
378
+ <dd class="tag-source"><ul class="dummy"><li>
379
+ <a href="touchOverlay.js.html">touchOverlay.js</a>, <a href="touchOverlay.js.html#line99">line 99</a>
380
+ </li></ul></dd>
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+ </dl>
389
+
390
+
391
+
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+ <h5>Returns:</h5>
405
+
406
+
407
+ <div class="param-desc">
408
+ The DOM element.
409
+ </div>
410
+
411
+
412
+
413
+ <dl>
414
+ <dt>
415
+ Type
416
+ </dt>
417
+ <dd>
418
+
419
+ <span class="param-type">Element</span>
420
+
421
+
422
+ </dd>
423
+ </dl>
424
+
425
+
426
+
427
+
428
+
429
+
430
+
431
+
432
+
433
+
434
+
435
+
436
+
437
+ <h4 class="name" id="disable"><span class="type-signature"></span>disable<span class="signature">()</span><span class="type-signature"></span></h4>
438
+
439
+
440
+
441
+
442
+
443
+
444
+ <div class="description">
445
+ Disables touch handler
446
+ </div>
447
+
448
+
449
+
450
+
451
+
452
+
453
+
454
+
455
+
456
+
457
+
458
+
459
+
460
+ <dl class="details">
461
+
462
+
463
+
464
+
465
+
466
+
467
+
468
+
469
+
470
+
471
+
472
+
473
+
474
+
475
+
476
+
477
+
478
+
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+
487
+ <dt class="tag-source">Source:</dt>
488
+ <dd class="tag-source"><ul class="dummy"><li>
489
+ <a href="touchOverlay.js.html">touchOverlay.js</a>, <a href="touchOverlay.js.html#line145">line 145</a>
490
+ </li></ul></dd>
491
+
492
+
493
+
494
+
495
+
496
+
497
+
498
+ </dl>
499
+
500
+
501
+
502
+
503
+
504
+
505
+
506
+
507
+
508
+
509
+
510
+
511
+
512
+
513
+
514
+
515
+
516
+
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+
525
+ <h4 class="name" id="enable"><span class="type-signature"></span>enable<span class="signature">()</span><span class="type-signature"></span></h4>
526
+
527
+
528
+
529
+
530
+
531
+
532
+ <div class="description">
533
+ Enables touch handler
534
+ </div>
535
+
536
+
537
+
538
+
539
+
540
+
541
+
542
+
543
+
544
+
545
+
546
+
547
+
548
+ <dl class="details">
549
+
550
+
551
+
552
+
553
+
554
+
555
+
556
+
557
+
558
+
559
+
560
+
561
+
562
+
563
+
564
+
565
+
566
+
567
+
568
+
569
+
570
+
571
+
572
+
573
+
574
+
575
+ <dt class="tag-source">Source:</dt>
576
+ <dd class="tag-source"><ul class="dummy"><li>
577
+ <a href="touchOverlay.js.html">touchOverlay.js</a>, <a href="touchOverlay.js.html#line137">line 137</a>
578
+ </li></ul></dd>
579
+
580
+
581
+
582
+
583
+
584
+
585
+
586
+ </dl>
587
+
588
+
589
+
590
+
591
+
592
+
593
+
594
+
595
+
596
+
597
+
598
+
599
+
600
+
601
+
602
+
603
+
604
+
605
+
606
+
607
+
608
+
609
+
610
+
611
+
612
+
613
+ <h4 class="name" id="handleTap"><span class="type-signature"></span>handleTap<span class="signature">(event)</span><span class="type-signature"></span></h4>
614
+
615
+
616
+
617
+
618
+
619
+
620
+ <div class="description">
621
+ Debounces to either handle a delayed single tap, or a double tap
622
+ </div>
623
+
624
+
625
+
626
+
627
+
628
+
629
+
630
+
631
+
632
+ <h5>Parameters:</h5>
633
+
634
+
635
+ <table class="params">
636
+ <thead>
637
+ <tr>
638
+
639
+ <th>Name</th>
640
+
641
+
642
+ <th>Type</th>
643
+
644
+
645
+
646
+
647
+
648
+ <th class="last">Description</th>
649
+ </tr>
650
+ </thead>
651
+
652
+ <tbody>
653
+
654
+
655
+ <tr>
656
+
657
+ <td class="name"><code>event</code></td>
658
+
659
+
660
+ <td class="type">
661
+
662
+
663
+ <span class="param-type">Event</span>
664
+
665
+
666
+
667
+ </td>
668
+
669
+
670
+
671
+
672
+
673
+ <td class="description last">The touch event</td>
674
+ </tr>
675
+
676
+
677
+ </tbody>
678
+ </table>
679
+
680
+
681
+
682
+
683
+
684
+
685
+ <dl class="details">
686
+
687
+
688
+
689
+
690
+
691
+
692
+
693
+
694
+
695
+
696
+
697
+
698
+
699
+
700
+
701
+
702
+
703
+
704
+
705
+
706
+
707
+
708
+
709
+
710
+
711
+
712
+ <dt class="tag-source">Source:</dt>
713
+ <dd class="tag-source"><ul class="dummy"><li>
714
+ <a href="touchOverlay.js.html">touchOverlay.js</a>, <a href="touchOverlay.js.html#line116">line 116</a>
715
+ </li></ul></dd>
716
+
717
+
718
+
719
+
720
+
721
+
722
+
723
+ </dl>
724
+
725
+
726
+
727
+
728
+
729
+
730
+
731
+
732
+
733
+
734
+
735
+
736
+
737
+
738
+
739
+
740
+
741
+
742
+
743
+
744
+
745
+
746
+
747
+
748
+
749
+
750
+ </article>
751
+
752
+ </section>
753
+
754
+
755
+
756
+
757
+ </div>
758
+
759
+ <nav>
760
+ <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>
761
+ </nav>
762
+
763
+ <br class="clear">
764
+
765
+ <footer>
766
+ 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)
767
+ </footer>
768
+
769
+ <script> prettyPrint(); </script>
770
+ <script src="scripts/linenumber.js"> </script>
771
+ </body>
772
+ </html>