@shower/core 3.2.0 → 3.3.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.
package/dist/shower.js DELETED
@@ -1,791 +0,0 @@
1
- /**
2
- * Core for Shower HTML presentation engine
3
- * @shower/core v3.1.0, https://github.com/shower/core
4
- * @copyright 2010–2021 Vadim Makeev, https://pepelsbey.net
5
- * @license MIT
6
- */
7
- (function () {
8
- 'use strict';
9
-
10
- const isInteractiveElement = (element) => element.tabIndex !== -1;
11
-
12
- const contentLoaded = (callback) => {
13
- if (document.currentScript.async) {
14
- callback();
15
- } else {
16
- document.addEventListener('DOMContentLoaded', callback);
17
- }
18
- };
19
-
20
- const defineReadOnly = (target, props) => {
21
- for (const [key, value] of Object.entries(props)) {
22
- Object.defineProperty(target, key, {
23
- value,
24
- writable: false,
25
- enumerable: true,
26
- configurable: true,
27
- });
28
- }
29
- };
30
-
31
- class ShowerError extends Error {}
32
-
33
- var defaultOptions = {
34
- containerSelector: '.shower',
35
- progressSelector: '.progress',
36
- stepSelector: '.next',
37
- fullModeClass: 'full',
38
- listModeClass: 'list',
39
-
40
- slideSelector: '.slide',
41
- slideTitleSelector: 'h2',
42
- activeSlideClass: 'active',
43
- visitedSlideClass: 'visited',
44
- };
45
-
46
- class Slide extends EventTarget {
47
- /**
48
- * @param {Shower} shower
49
- * @param {HTMLElement} element
50
- */
51
- constructor(shower, element) {
52
- super();
53
-
54
- defineReadOnly(this, {
55
- shower,
56
- element,
57
- state: {
58
- visitCount: 0,
59
- innerStepCount: 0,
60
- },
61
- });
62
-
63
- this._isActive = false;
64
- this._options = this.shower.options;
65
-
66
- this.element.addEventListener('click', (event) => {
67
- if (event.defaultPrevented) return;
68
-
69
- this.activate();
70
- this.shower.enterFullMode();
71
- });
72
- }
73
-
74
- get isActive() {
75
- return this._isActive;
76
- }
77
-
78
- get isVisited() {
79
- return this.state.visitCount > 0;
80
- }
81
-
82
- get id() {
83
- return this.element.id;
84
- }
85
-
86
- get title() {
87
- const titleElement = this.element.querySelector(this._options.slideTitleSelector);
88
- return titleElement ? titleElement.innerText : '';
89
- }
90
-
91
- /**
92
- * Deactivates currently active slide (if any) and activates itself.
93
- * @emits Slide#deactivate
94
- * @emits Slide#activate
95
- * @emits Shower#slidechange
96
- */
97
- activate() {
98
- if (this._isActive) return;
99
-
100
- const prev = this.shower.activeSlide;
101
- if (prev) {
102
- prev._deactivate();
103
- }
104
-
105
- this.state.visitCount++;
106
- this.element.classList.add(this._options.activeSlideClass);
107
-
108
- this._isActive = true;
109
- this.dispatchEvent(new Event('activate'));
110
- this.shower.dispatchEvent(
111
- new CustomEvent('slidechange', {
112
- detail: { prev },
113
- }),
114
- );
115
- }
116
-
117
- /**
118
- * @throws {ShowerError}
119
- * @emits Slide#deactivate
120
- */
121
- deactivate() {
122
- if (this.shower.isFullMode) {
123
- throw new ShowerError('In full mode, another slide should be activated instead.');
124
- }
125
-
126
- if (this._isActive) {
127
- this._deactivate();
128
- }
129
- }
130
-
131
- _deactivate() {
132
- this.element.classList.replace(
133
- this._options.activeSlideClass,
134
- this._options.visitedSlideClass,
135
- );
136
-
137
- this._isActive = false;
138
- this.dispatchEvent(new Event('deactivate'));
139
- }
140
- }
141
-
142
- const createLiveRegion = () => {
143
- const liveRegion = document.createElement('section');
144
- liveRegion.className = 'region';
145
- liveRegion.setAttribute('role', 'region');
146
- liveRegion.setAttribute('aria-live', 'assertive');
147
- liveRegion.setAttribute('aria-relevant', 'all');
148
- liveRegion.setAttribute('aria-label', 'Slide Content: Auto-updating');
149
- return liveRegion;
150
- };
151
-
152
- var a11y = (shower) => {
153
- const { container } = shower;
154
- const liveRegion = createLiveRegion();
155
- container.appendChild(liveRegion);
156
-
157
- const updateDocumentRole = () => {
158
- if (shower.isFullMode) {
159
- container.setAttribute('role', 'application');
160
- } else {
161
- container.removeAttribute('role');
162
- }
163
- };
164
-
165
- const updateLiveRegion = () => {
166
- const slide = shower.activeSlide;
167
- if (slide) {
168
- liveRegion.innerHTML = slide.element.innerHTML;
169
- }
170
- };
171
-
172
- shower.addEventListener('start', () => {
173
- updateDocumentRole();
174
- updateLiveRegion();
175
- });
176
-
177
- shower.addEventListener('modechange', updateDocumentRole);
178
- shower.addEventListener('slidechange', updateLiveRegion);
179
- };
180
-
181
- var keys = (shower) => {
182
- const doSlideActions = (event) => {
183
- const isShowerAction = !(event.ctrlKey || event.altKey || event.metaKey);
184
-
185
- switch (event.key.toUpperCase()) {
186
- case 'ENTER':
187
- if (event.metaKey && shower.isListMode) {
188
- if (event.shiftKey) {
189
- event.preventDefault();
190
- shower.first();
191
- }
192
-
193
- break;
194
- }
195
-
196
- event.preventDefault();
197
- if (event.shiftKey) {
198
- shower.prev();
199
- } else {
200
- shower.next();
201
- }
202
- break;
203
-
204
- case 'BACKSPACE':
205
- case 'PAGEUP':
206
- case 'ARROWUP':
207
- case 'ARROWLEFT':
208
- case 'H':
209
- case 'K':
210
- case 'P':
211
- if (isShowerAction) {
212
- event.preventDefault();
213
- shower.prev(event.shiftKey);
214
- }
215
- break;
216
-
217
- case 'PAGEDOWN':
218
- case 'ARROWDOWN':
219
- case 'ARROWRIGHT':
220
- case 'L':
221
- case 'J':
222
- case 'N':
223
- if (isShowerAction) {
224
- event.preventDefault();
225
- shower.next(event.shiftKey);
226
- }
227
- break;
228
-
229
- case ' ':
230
- if (isShowerAction && shower.isFullMode) {
231
- event.preventDefault();
232
- if (event.shiftKey) {
233
- shower.prev();
234
- } else {
235
- shower.next();
236
- }
237
- }
238
- break;
239
-
240
- case 'HOME':
241
- event.preventDefault();
242
- shower.first();
243
- break;
244
-
245
- case 'END':
246
- event.preventDefault();
247
- shower.last();
248
- break;
249
- }
250
- };
251
-
252
- const doModeActions = (event) => {
253
- switch (event.key.toUpperCase()) {
254
- case 'ESCAPE':
255
- if (shower.isFullMode) {
256
- event.preventDefault();
257
- shower.exitFullMode();
258
- }
259
- break;
260
-
261
- case 'ENTER':
262
- if (event.metaKey && shower.isListMode) {
263
- event.preventDefault();
264
- shower.enterFullMode();
265
- }
266
- break;
267
-
268
- case 'P':
269
- if (event.metaKey && event.altKey && shower.isListMode) {
270
- event.preventDefault();
271
- shower.enterFullMode();
272
- }
273
- break;
274
-
275
- case 'F5':
276
- if (event.shiftKey && shower.isListMode) {
277
- event.preventDefault();
278
- shower.enterFullMode();
279
- }
280
- break;
281
- }
282
- };
283
-
284
- shower.container.addEventListener('keydown', (event) => {
285
- if (event.defaultPrevented) return;
286
- if (isInteractiveElement(event.target)) return;
287
-
288
- doSlideActions(event);
289
- doModeActions(event);
290
- });
291
- };
292
-
293
- var location$1 = (shower) => {
294
- const composeURL = () => {
295
- const search = shower.isFullMode ? '?full' : '';
296
- const slide = shower.activeSlide;
297
- const hash = slide ? `#${slide.id}` : '';
298
-
299
- return location.pathname + search + hash; // path is required to clear search params
300
- };
301
-
302
- const applyURLMode = () => {
303
- const isFull = new URLSearchParams(location.search).has('full');
304
- if (isFull) {
305
- shower.enterFullMode();
306
- } else {
307
- shower.exitFullMode();
308
- }
309
- };
310
-
311
- const applyURLSlide = () => {
312
- const id = location.hash.slice(1);
313
- if (!id) return;
314
-
315
- const target = shower.slides.find((slide) => slide.id === id);
316
- if (target) {
317
- target.activate();
318
- } else if (!shower.activeSlide) {
319
- shower.first(); // invalid hash
320
- }
321
- };
322
-
323
- const applyURL = () => {
324
- applyURLMode();
325
- applyURLSlide();
326
- };
327
-
328
- applyURL();
329
- window.addEventListener('popstate', applyURL);
330
-
331
- shower.addEventListener('start', () => {
332
- history.replaceState(null, document.title, composeURL());
333
- });
334
-
335
- shower.addEventListener('modechange', () => {
336
- history.replaceState(null, document.title, composeURL());
337
- });
338
-
339
- shower.addEventListener('slidechange', () => {
340
- const url = composeURL();
341
- if (!location.href.endsWith(url)) {
342
- history.pushState(null, document.title, url);
343
- }
344
- });
345
- };
346
-
347
- var next = (shower) => {
348
- const { stepSelector, activeSlideClass, visitedSlideClass } = shower.options;
349
-
350
- let innerSteps;
351
- let activeIndex;
352
-
353
- const isActive = (step) => step.classList.contains(activeSlideClass);
354
- const isVisited = (step) => step.classList.contains(visitedSlideClass);
355
-
356
- const setInnerStepsState = () => {
357
- if (shower.isListMode) return;
358
-
359
- const slide = shower.activeSlide;
360
-
361
- innerSteps = [...slide.element.querySelectorAll(stepSelector)];
362
- activeIndex =
363
- innerSteps.length && innerSteps.every(isVisited)
364
- ? innerSteps.length
365
- : innerSteps.filter(isActive).length - 1;
366
-
367
- slide.state.innerStepCount = innerSteps.length;
368
- };
369
-
370
- shower.addEventListener('start', setInnerStepsState);
371
- shower.addEventListener('modechange', setInnerStepsState);
372
- shower.addEventListener('slidechange', setInnerStepsState);
373
-
374
- shower.addEventListener('next', (event) => {
375
- if (shower.isListMode || event.defaultPrevented || !event.cancelable) return;
376
-
377
- activeIndex++;
378
- innerSteps.forEach((step, index) => {
379
- step.classList.toggle(visitedSlideClass, index < activeIndex);
380
- step.classList.toggle(activeSlideClass, index === activeIndex);
381
- });
382
-
383
- if (activeIndex < innerSteps.length) {
384
- event.preventDefault();
385
- }
386
- });
387
-
388
- shower.addEventListener('prev', (event) => {
389
- if (shower.isListMode || event.defaultPrevented || !event.cancelable) return;
390
- if (activeIndex === -1 || activeIndex === innerSteps.length) return;
391
-
392
- activeIndex--;
393
- innerSteps.forEach((step, index) => {
394
- step.classList.toggle(visitedSlideClass, index < activeIndex + 1);
395
- step.classList.toggle(activeSlideClass, index === activeIndex);
396
- });
397
-
398
- event.preventDefault();
399
- });
400
- };
401
-
402
- var progress = (shower) => {
403
- const { progressSelector } = shower.options;
404
- const bar = shower.container.querySelector(progressSelector);
405
- if (!bar) return;
406
-
407
- bar.setAttribute('role', 'progressbar');
408
- bar.setAttribute('aria-valuemin', 0);
409
- bar.setAttribute('aria-valuemax', 100);
410
-
411
- const updateProgress = () => {
412
- const index = shower.activeSlideIndex;
413
- const { length } = shower.slides;
414
- const progress = (index / (length - 1)) * 100;
415
-
416
- bar.style.width = `${progress}%`;
417
- bar.setAttribute('aria-valuenow', progress);
418
- bar.setAttribute('aria-valuetext', `Slideshow progress: ${progress}%`);
419
- };
420
-
421
- shower.addEventListener('start', updateProgress);
422
- shower.addEventListener('slidechange', updateProgress);
423
- };
424
-
425
- const units = ['s', 'm', 'h'];
426
- const hasUnits = (timing) => {
427
- return units.some((unit) => timing.includes(unit));
428
- };
429
-
430
- const parseUnits = (timing) => {
431
- return units.map((unit) => timing.match(`(\\S+)${unit}`)).map((match) => match && match[1]);
432
- };
433
-
434
- const parseColons = (timing) => {
435
- return `::${timing}`.split(':').reverse();
436
- };
437
-
438
- const SEC_IN_MIN = 60;
439
- const SEC_IN_HOUR = SEC_IN_MIN * 60;
440
-
441
- var parseTiming = (timing) => {
442
- if (!timing) return 0;
443
-
444
- const parsed = hasUnits(timing) ? parseUnits(timing) : parseColons(timing);
445
-
446
- let [sec, min, hour] = parsed.map(Number);
447
-
448
- sec += min * SEC_IN_MIN;
449
- sec += hour * SEC_IN_HOUR;
450
-
451
- return Math.max(sec * 1000, 0);
452
- };
453
-
454
- var timer = (shower) => {
455
- let id;
456
-
457
- const resetTimer = () => {
458
- clearTimeout(id);
459
- if (shower.isListMode) return;
460
-
461
- const slide = shower.activeSlide;
462
- const { visitCount, innerStepCount } = slide.state;
463
- if (visitCount > 1) return;
464
-
465
- const timing = parseTiming(slide.element.dataset.timing);
466
- if (!timing) return;
467
-
468
- if (innerStepCount) {
469
- const stepTiming = timing / (innerStepCount + 1);
470
- id = setInterval(() => shower.next(), stepTiming);
471
- } else {
472
- id = setTimeout(() => shower.next(), timing);
473
- }
474
- };
475
-
476
- shower.addEventListener('start', resetTimer);
477
- shower.addEventListener('modechange', resetTimer);
478
- shower.addEventListener('slidechange', resetTimer);
479
-
480
- shower.container.addEventListener('keydown', (event) => {
481
- if (!event.defaultPrevented) {
482
- clearTimeout(id);
483
- }
484
- });
485
- };
486
-
487
- const mdash = '\u2014';
488
-
489
- var title = (shower) => {
490
- const { title } = document;
491
- const updateTitle = () => {
492
- if (shower.isFullMode) {
493
- const slide = shower.activeSlide;
494
- const slideTitle = slide.title;
495
- if (slideTitle) {
496
- document.title = `${slideTitle} ${mdash} ${title}`;
497
- return;
498
- }
499
- }
500
-
501
- document.title = title;
502
- };
503
-
504
- shower.addEventListener('start', updateTitle);
505
- shower.addEventListener('modechange', updateTitle);
506
- shower.addEventListener('slidechange', updateTitle);
507
- };
508
-
509
- var view = (shower) => {
510
- const { container } = shower;
511
- const { fullModeClass, listModeClass } = shower.options;
512
-
513
- if (container.classList.contains(fullModeClass)) {
514
- shower.enterFullMode();
515
- } else {
516
- container.classList.add(listModeClass);
517
- }
518
-
519
- const updateScale = () => {
520
- const firstSlide = shower.slides[0];
521
- if (!firstSlide) return;
522
-
523
- const { innerWidth, innerHeight } = window;
524
- const { offsetWidth, offsetHeight } = firstSlide.element;
525
-
526
- const listScale = 1 / (offsetWidth / innerWidth);
527
- const fullScale = 1 / Math.max(offsetWidth / innerWidth, offsetHeight / innerHeight);
528
-
529
- container.style.setProperty('--shower-list-scale', listScale);
530
- container.style.setProperty('--shower-full-scale', fullScale);
531
- };
532
-
533
- const updateModeView = () => {
534
- if (shower.isFullMode) {
535
- container.classList.remove(listModeClass);
536
- container.classList.add(fullModeClass);
537
- } else {
538
- container.classList.remove(fullModeClass);
539
- container.classList.add(listModeClass);
540
- }
541
-
542
- updateScale();
543
-
544
- if (shower.isFullMode) return;
545
-
546
- const slide = shower.activeSlide;
547
- if (slide) {
548
- slide.element.scrollIntoView({ block: 'center' });
549
- }
550
- };
551
-
552
- shower.addEventListener('start', updateModeView);
553
- shower.addEventListener('modechange', updateModeView);
554
- shower.addEventListener('slidechange', () => {
555
- if (shower.isFullMode) return;
556
-
557
- const slide = shower.activeSlide;
558
- slide.element.scrollIntoView({ block: 'nearest' });
559
- });
560
-
561
- window.addEventListener('resize', updateScale);
562
- };
563
-
564
- var touch = (shower) => {
565
- let exitFullScreen = false;
566
- let clickable = false;
567
-
568
- document.addEventListener('touchstart', (event) => {
569
- if (event.touches.length === 1) {
570
- const touch = event.touches[0];
571
- const x = touch.clientX;
572
- const { target } = touch;
573
- clickable = target.tabIndex !== -1;
574
- if (!clickable) {
575
- if (shower.isFullMode) {
576
- if (event.cancelable) event.preventDefault();
577
- if (window.innerWidth / 2 < x) {
578
- shower.next();
579
- } else {
580
- shower.prev();
581
- }
582
- }
583
- }
584
- } else if (event.touches.length === 3) {
585
- exitFullScreen = true;
586
- }
587
- });
588
-
589
- shower.container.addEventListener('touchend', (event) => {
590
- if (exitFullScreen) {
591
- event.preventDefault();
592
- exitFullScreen = false;
593
- shower.exitFullMode();
594
- } else if (event.touches.length === 1 && !clickable && shower.isFullMode)
595
- event.preventDefault();
596
- });
597
- };
598
-
599
- var installModules = (shower) => {
600
- a11y(shower);
601
- progress(shower);
602
- keys(shower);
603
- next(shower);
604
- timer(shower); // should come after `keys` and `next`
605
- title(shower);
606
- location$1(shower); // should come after `title`
607
- view(shower);
608
- touch(shower);
609
-
610
- // maintains invariant: active slide always exists in `full` mode
611
- if (shower.isFullMode && !shower.activeSlide) {
612
- shower.first();
613
- }
614
- };
615
-
616
- class Shower extends EventTarget {
617
- /**
618
- * @param {object=} options
619
- */
620
- constructor(options) {
621
- super();
622
-
623
- defineReadOnly(this, {
624
- options: { ...defaultOptions, ...options },
625
- });
626
-
627
- this._mode = 'list';
628
- this._isStarted = false;
629
- this._container = null;
630
- }
631
-
632
- /**
633
- * @param {object=} options
634
- * @throws {ShowerError}
635
- */
636
- configure(options) {
637
- if (this._isStarted) {
638
- throw new ShowerError('Shower should be configured before it is started.');
639
- }
640
-
641
- Object.assign(this.options, options);
642
- }
643
-
644
- /**
645
- * @throws {ShowerError}
646
- * @emits Shower#start
647
- */
648
- start() {
649
- if (this._isStarted) return;
650
-
651
- const { containerSelector } = this.options;
652
- this._container = document.querySelector(containerSelector);
653
- if (!this._container) {
654
- throw new ShowerError(
655
- `Shower container with selector '${containerSelector}' was not found.`,
656
- );
657
- }
658
-
659
- this._initSlides();
660
- installModules(this);
661
-
662
- this._isStarted = true;
663
- this.dispatchEvent(new Event('start'));
664
- }
665
-
666
- _initSlides() {
667
- const visibleSlideSelector = `${this.options.slideSelector}:not([hidden])`;
668
- const visibleSlideElements = this._container.querySelectorAll(visibleSlideSelector);
669
-
670
- this.slides = Array.from(visibleSlideElements, (slideElement, index) => {
671
- if (!slideElement.id) {
672
- slideElement.id = index + 1;
673
- }
674
-
675
- return new Slide(this, slideElement);
676
- });
677
- }
678
-
679
- _setMode(mode) {
680
- if (mode === this._mode) return;
681
-
682
- this._mode = mode;
683
- this.dispatchEvent(new Event('modechange'));
684
- }
685
-
686
- /**
687
- * @param {Event} event
688
- */
689
- dispatchEvent(event) {
690
- if (!this._isStarted) return false;
691
-
692
- return super.dispatchEvent(event);
693
- }
694
-
695
- get container() {
696
- return this._container;
697
- }
698
-
699
- get isFullMode() {
700
- return this._mode === 'full';
701
- }
702
-
703
- get isListMode() {
704
- return this._mode === 'list';
705
- }
706
-
707
- get activeSlide() {
708
- return this.slides.find((slide) => slide.isActive);
709
- }
710
-
711
- get activeSlideIndex() {
712
- return this.slides.findIndex((slide) => slide.isActive);
713
- }
714
-
715
- /**
716
- * Slide fills the maximum area.
717
- * @emits Shower#modechange
718
- */
719
- enterFullMode() {
720
- this._setMode('full');
721
- }
722
-
723
- /**
724
- * Shower returns into list mode.
725
- * @emits Shower#modechange
726
- */
727
- exitFullMode() {
728
- this._setMode('list');
729
- }
730
-
731
- /**
732
- * @param {number} index
733
- */
734
- goTo(index) {
735
- const slide = this.slides[index];
736
- if (slide) {
737
- slide.activate();
738
- }
739
- }
740
-
741
- /**
742
- * @param {number} delta
743
- */
744
- goBy(delta) {
745
- this.goTo(this.activeSlideIndex + delta);
746
- }
747
-
748
- /**
749
- * @param {boolean} [isForce=false]
750
- * @emits Shower#prev
751
- */
752
- prev(isForce) {
753
- const prev = new Event('prev', { cancelable: !isForce });
754
- if (this.dispatchEvent(prev)) {
755
- this.goBy(-1);
756
- }
757
- }
758
-
759
- /**
760
- * @param {boolean} [isForce=false]
761
- * @emits Shower#next
762
- */
763
- next(isForce) {
764
- const next = new Event('next', { cancelable: !isForce });
765
- if (this.dispatchEvent(next)) {
766
- this.goBy(1);
767
- }
768
- }
769
-
770
- first() {
771
- this.goTo(0);
772
- }
773
-
774
- last() {
775
- this.goTo(this.slides.length - 1);
776
- }
777
- }
778
-
779
- const options = document.currentScript.dataset;
780
- const shower = new Shower(options);
781
-
782
- Object.defineProperty(window, 'shower', {
783
- value: shower,
784
- configurable: true,
785
- });
786
-
787
- contentLoaded(() => {
788
- shower.start();
789
- });
790
-
791
- }());