@arraypress/waveform-player 1.20.0 → 1.22.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.
- package/dist/waveform-player.cjs +206 -26
- package/dist/waveform-player.cjs.map +2 -2
- package/dist/waveform-player.css +1 -1
- package/dist/waveform-player.esm.js +14 -13
- package/dist/waveform-player.esm.js.map +3 -3
- package/dist/waveform-player.js +206 -26
- package/dist/waveform-player.min.js +14 -13
- package/dist/waveform-player.min.js.map +3 -3
- package/index.d.ts +20 -0
- package/package.json +1 -1
- package/src/css/waveform-player.css +69 -4
- package/src/js/core.js +220 -26
- package/src/js/themes.js +17 -0
- package/src/js/utils.js +27 -6
package/index.d.ts
CHANGED
|
@@ -145,8 +145,28 @@ export interface WaveformPlayerOptions {
|
|
|
145
145
|
* @default null
|
|
146
146
|
*/
|
|
147
147
|
buttonSize?: number | string | null;
|
|
148
|
+
/**
|
|
149
|
+
* Play/pause button corner radius. A number is treated as px; a string (e.g.
|
|
150
|
+
* `'8px'`) is used verbatim. Set `0` for a square button. Sets the
|
|
151
|
+
* `--wfp-btn-radius` CSS variable, shaping the `circle` style's box — the
|
|
152
|
+
* bare `minimal` glyph has no box to round.
|
|
153
|
+
* @default null
|
|
154
|
+
*/
|
|
155
|
+
buttonRadius?: number | string | null;
|
|
148
156
|
/** Show transport controls. @default true */
|
|
149
157
|
showControls?: boolean;
|
|
158
|
+
/**
|
|
159
|
+
* Where the `artwork` image renders. `'info'` places it in the info row
|
|
160
|
+
* beside the title (requires `showInfo`); `'button'` makes the cover the
|
|
161
|
+
* play/pause button, which still works when the info row is hidden. Only one
|
|
162
|
+
* placement ever renders, so the cover cannot appear twice.
|
|
163
|
+
*
|
|
164
|
+
* `'button'` needs no other options: it drops the button's ring and uses
|
|
165
|
+
* cover-sized defaults (64px, 8px rounding) rather than the transport
|
|
166
|
+
* button's 36px circle. Set `buttonSize` / `buttonRadius` to override.
|
|
167
|
+
* @default 'info'
|
|
168
|
+
*/
|
|
169
|
+
artworkPosition?: 'info' | 'button';
|
|
150
170
|
/** Show the info (title/artist) block. @default true */
|
|
151
171
|
showInfo?: boolean;
|
|
152
172
|
/** Show current/total time. @default true */
|
package/package.json
CHANGED
|
@@ -12,6 +12,17 @@
|
|
|
12
12
|
--wfp-button-color: rgba(255, 255, 255, 0.9);
|
|
13
13
|
--wfp-text-color: #ffffff;
|
|
14
14
|
--wfp-text-secondary-color: rgba(255, 255, 255, 0.6);
|
|
15
|
+
|
|
16
|
+
/* Play-button artwork (artworkPosition: 'button'). Deliberately NOT
|
|
17
|
+
re-themed for light pages below: the cover underneath is an arbitrary
|
|
18
|
+
image, so a light page tells us nothing about it — flipping the glyph
|
|
19
|
+
dark is exactly the unreadable case. This surface is always dark, so it
|
|
20
|
+
always takes the dark treatment (same value as --wfp-button-color's dark
|
|
21
|
+
form). The scrim earns its keep: at 0.5 a 0.9-white glyph clears 3:1
|
|
22
|
+
(WCAG 1.4.11) against even a pure-white cover; any darker cover is
|
|
23
|
+
better. Re-theme both together or the contrast guarantee goes with it. */
|
|
24
|
+
--wfp-btn-artwork-color: rgba(255, 255, 255, 0.9);
|
|
25
|
+
--wfp-btn-artwork-scrim: rgba(0, 0, 0, 0.5);
|
|
15
26
|
}
|
|
16
27
|
|
|
17
28
|
/* Light theme — the player adds .waveform-theme-light when it detects a light
|
|
@@ -50,7 +61,7 @@
|
|
|
50
61
|
width: var(--wfp-btn-size, 36px);
|
|
51
62
|
height: var(--wfp-btn-size, 36px);
|
|
52
63
|
min-width: var(--wfp-btn-size, 36px);
|
|
53
|
-
border-radius: 50
|
|
64
|
+
border-radius: var(--wfp-btn-radius, 50%);
|
|
54
65
|
border: 2px solid currentColor;
|
|
55
66
|
background: transparent;
|
|
56
67
|
color: var(--wfp-button-color, inherit);
|
|
@@ -121,6 +132,56 @@
|
|
|
121
132
|
display: block;
|
|
122
133
|
}
|
|
123
134
|
|
|
135
|
+
/* Play-button artwork — in cover mode the artwork IS the control, so the
|
|
136
|
+
button's own chrome gets out of its way: no ring, and cover-sized defaults.
|
|
137
|
+
The transport button's defaults are wrong for a cover in both directions —
|
|
138
|
+
36px shrinks album art to a smudge, and 50% rounding crops a square cover
|
|
139
|
+
into a circle — and neither is a look worth making anyone opt out of.
|
|
140
|
+
|
|
141
|
+
These are declared as var DEFAULTS, not fixed values: `buttonSize` and
|
|
142
|
+
`buttonRadius` land as inline custom properties on the element, and inline
|
|
143
|
+
beats a stylesheet rule, so an explicit option still wins. `overflow: hidden`
|
|
144
|
+
clips the cover to the radius (an outline paints outside the border box, so
|
|
145
|
+
the focus ring survives the clip). */
|
|
146
|
+
.waveform-btn-has-artwork {
|
|
147
|
+
--wfp-btn-size: 64px;
|
|
148
|
+
--wfp-btn-radius: 8px;
|
|
149
|
+
position: relative;
|
|
150
|
+
overflow: hidden;
|
|
151
|
+
border: none;
|
|
152
|
+
color: var(--wfp-btn-artwork-color);
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
/* NOTE: must out-specify `.waveform-btn > * { display: flex; … }` above, which
|
|
156
|
+
ties on specificity and would otherwise flex the image. The compound
|
|
157
|
+
`.waveform-btn > .waveform-btn-artwork` wins outright. */
|
|
158
|
+
.waveform-btn > .waveform-btn-artwork {
|
|
159
|
+
display: block;
|
|
160
|
+
position: absolute;
|
|
161
|
+
inset: 0;
|
|
162
|
+
width: 100%;
|
|
163
|
+
height: 100%;
|
|
164
|
+
object-fit: cover;
|
|
165
|
+
pointer-events: none;
|
|
166
|
+
z-index: 0;
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
/* The scrim. Generated content paints after the element's children, so without
|
|
170
|
+
the z-index ladder here it would bury the glyph it exists to make readable. */
|
|
171
|
+
.waveform-btn-has-artwork::after {
|
|
172
|
+
content: "";
|
|
173
|
+
position: absolute;
|
|
174
|
+
inset: 0;
|
|
175
|
+
background: var(--wfp-btn-artwork-scrim);
|
|
176
|
+
pointer-events: none;
|
|
177
|
+
z-index: 1;
|
|
178
|
+
}
|
|
179
|
+
|
|
180
|
+
.waveform-btn-has-artwork > :not(.waveform-btn-artwork) {
|
|
181
|
+
position: relative;
|
|
182
|
+
z-index: 2;
|
|
183
|
+
}
|
|
184
|
+
|
|
124
185
|
.waveform-icon-play svg {
|
|
125
186
|
margin-left: 1px;
|
|
126
187
|
}
|
|
@@ -480,10 +541,14 @@
|
|
|
480
541
|
|
|
481
542
|
/* Responsive adjustments */
|
|
482
543
|
@media (max-width: 480px) {
|
|
544
|
+
/* Narrow-screen default only — must stay var-driven. Hardcoding the width
|
|
545
|
+
here silently beat `buttonSize` (equal specificity, later source order),
|
|
546
|
+
so a 64px button collapsed to 32px on a phone; a cover tile would have
|
|
547
|
+
collapsed with it. The fallback still gives an unset button its 32px. */
|
|
483
548
|
.waveform-btn {
|
|
484
|
-
width: 32px;
|
|
485
|
-
height: 32px;
|
|
486
|
-
min-width: 32px;
|
|
549
|
+
width: var(--wfp-btn-size, 32px);
|
|
550
|
+
height: var(--wfp-btn-size, 32px);
|
|
551
|
+
min-width: var(--wfp-btn-size, 32px);
|
|
487
552
|
}
|
|
488
553
|
|
|
489
554
|
.waveform-container {
|
package/src/js/core.js
CHANGED
|
@@ -15,6 +15,7 @@ import {
|
|
|
15
15
|
debounce,
|
|
16
16
|
clamp,
|
|
17
17
|
escapeHtml,
|
|
18
|
+
formatCssLength,
|
|
18
19
|
DEFAULT_SAMPLES
|
|
19
20
|
} from './utils.js';
|
|
20
21
|
|
|
@@ -264,9 +265,30 @@ export class WaveformPlayer {
|
|
|
264
265
|
}
|
|
265
266
|
this.container.classList.toggle('waveform-theme-light', this._scheme === 'light');
|
|
266
267
|
|
|
268
|
+
// Button sizing/shape ride in on CSS vars so the stylesheet keeps the
|
|
269
|
+
// fallbacks (36px, 50%) — an unset option emits no var at all.
|
|
270
|
+
const buttonVars = [];
|
|
271
|
+
if (this.options.buttonSize != null) {
|
|
272
|
+
buttonVars.push(`--wfp-btn-size: ${formatCssLength(this.options.buttonSize)}`);
|
|
273
|
+
}
|
|
274
|
+
if (this.options.buttonRadius != null) {
|
|
275
|
+
buttonVars.push(`--wfp-btn-radius: ${formatCssLength(this.options.buttonRadius)}`);
|
|
276
|
+
}
|
|
277
|
+
const buttonStyleAttr = buttonVars.length ? ` style="${buttonVars.join('; ')};"` : '';
|
|
278
|
+
|
|
279
|
+
// Artwork renders in exactly one place — the button or the info row —
|
|
280
|
+
// so the same cover can never appear twice. Button artwork is
|
|
281
|
+
// decorative: the button already carries its own aria-label, so a
|
|
282
|
+
// second accessible name here would just be noise.
|
|
283
|
+
const artworkOnButton = this.options.artworkPosition === 'button' && this.options.artwork;
|
|
284
|
+
const buttonArtworkHTML = artworkOnButton
|
|
285
|
+
? `<img class="waveform-btn-artwork" src="${escapeHtml(this.options.artwork)}" alt="" aria-hidden="true">`
|
|
286
|
+
: '';
|
|
287
|
+
|
|
267
288
|
// Build play button HTML (conditional)
|
|
268
289
|
const buttonHTML = this.options.showControls ? `
|
|
269
|
-
<button class="waveform-btn${this.options.buttonStyle === 'minimal' ? ' waveform-btn-minimal' : ''}" aria-label="${escapeHtml(this.options.playPauseLabel)}"${
|
|
290
|
+
<button class="waveform-btn${this.options.buttonStyle === 'minimal' ? ' waveform-btn-minimal' : ''}${artworkOnButton ? ' waveform-btn-has-artwork' : ''}" aria-label="${escapeHtml(this.options.playPauseLabel)}"${buttonStyleAttr}>
|
|
291
|
+
${buttonArtworkHTML}
|
|
270
292
|
<span class="waveform-icon-play">${this.options.playIcon}</span>
|
|
271
293
|
<span class="waveform-icon-pause" style="display:none;">${this.options.pauseIcon}</span>
|
|
272
294
|
</button>
|
|
@@ -275,8 +297,8 @@ export class WaveformPlayer {
|
|
|
275
297
|
// Build info section HTML (conditional)
|
|
276
298
|
const infoHTML = this.options.showInfo ? `
|
|
277
299
|
<div class="waveform-info">
|
|
278
|
-
${this.options.artwork ? `
|
|
279
|
-
<img class="waveform-artwork" src="${this.options.artwork}" alt="${escapeHtml(this.options.artworkAlt)}" style="
|
|
300
|
+
${this.options.artworkPosition !== 'button' && this.options.artwork ? `
|
|
301
|
+
<img class="waveform-artwork" src="${escapeHtml(this.options.artwork)}" alt="${escapeHtml(this.options.artworkAlt)}" style="
|
|
280
302
|
width: 40px;
|
|
281
303
|
height: 40px;
|
|
282
304
|
border-radius: 4px;
|
|
@@ -286,7 +308,7 @@ export class WaveformPlayer {
|
|
|
286
308
|
` : ''}
|
|
287
309
|
<div class="waveform-text">
|
|
288
310
|
<span class="waveform-title"></span>
|
|
289
|
-
${this.options.artist ? `<span class="waveform-artist">${this.options.artist}</span>` : ''}
|
|
311
|
+
${this.options.artist ? `<span class="waveform-artist">${escapeHtml(this.options.artist)}</span>` : ''}
|
|
290
312
|
</div>
|
|
291
313
|
<div class="waveform-meta" style="display: flex; align-items: center; gap: 1rem;">
|
|
292
314
|
${this.options.showBPM ? `
|
|
@@ -343,13 +365,11 @@ export class WaveformPlayer {
|
|
|
343
365
|
this.ctx = this.canvas.getContext('2d');
|
|
344
366
|
this.titleEl = this.container.querySelector('.waveform-title');
|
|
345
367
|
this.artistEl = this.container.querySelector('.waveform-artist');
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
});
|
|
352
|
-
}
|
|
368
|
+
// One reference for either placement — artworkPosition is structural
|
|
369
|
+
// (like showInfo/buttonStyle) and fixed for the player's lifetime, so
|
|
370
|
+
// the image only ever has one home.
|
|
371
|
+
this.artworkEl = this.container.querySelector('.waveform-artwork, .waveform-btn-artwork');
|
|
372
|
+
this.bindArtworkFallback(this.artworkEl);
|
|
353
373
|
this.currentTimeEl = this.container.querySelector('.time-current');
|
|
354
374
|
this.totalTimeEl = this.container.querySelector('.time-total');
|
|
355
375
|
this.bpmEl = this.container.querySelector('.waveform-bpm');
|
|
@@ -367,6 +387,169 @@ export class WaveformPlayer {
|
|
|
367
387
|
this.updateBPMDisplay();
|
|
368
388
|
}
|
|
369
389
|
|
|
390
|
+
/**
|
|
391
|
+
* Bind the artwork error fallback to an image element.
|
|
392
|
+
*
|
|
393
|
+
* @param {HTMLImageElement|null} img - Artwork image element.
|
|
394
|
+
* @private
|
|
395
|
+
*/
|
|
396
|
+
bindArtworkFallback(img) {
|
|
397
|
+
if (!img) return;
|
|
398
|
+
|
|
399
|
+
// Fall back to the placeholder tile if the cover URL fails to load.
|
|
400
|
+
img.addEventListener('error', () => {
|
|
401
|
+
if (!img.src.startsWith('data:')) img.src = ARTWORK_FALLBACK;
|
|
402
|
+
}, {signal: this._ac.signal});
|
|
403
|
+
}
|
|
404
|
+
|
|
405
|
+
/**
|
|
406
|
+
* Create an artwork image element matching the initial player markup.
|
|
407
|
+
*
|
|
408
|
+
* @returns {HTMLImageElement} Artwork image element.
|
|
409
|
+
* @private
|
|
410
|
+
*/
|
|
411
|
+
createArtworkElement() {
|
|
412
|
+
const img = document.createElement('img');
|
|
413
|
+
img.className = 'waveform-artwork';
|
|
414
|
+
img.style.width = '40px';
|
|
415
|
+
img.style.height = '40px';
|
|
416
|
+
img.style.borderRadius = '4px';
|
|
417
|
+
img.style.objectFit = 'cover';
|
|
418
|
+
img.style.flexShrink = '0';
|
|
419
|
+
this.bindArtworkFallback(img);
|
|
420
|
+
return img;
|
|
421
|
+
}
|
|
422
|
+
|
|
423
|
+
/**
|
|
424
|
+
* Create a play-button artwork image matching the initial player markup.
|
|
425
|
+
*
|
|
426
|
+
* Decorative by design — the button already has an accessible name from its
|
|
427
|
+
* `aria-label`, so the cover is hidden from assistive tech rather than
|
|
428
|
+
* given a competing one. Sizing and clipping are the stylesheet's job.
|
|
429
|
+
*
|
|
430
|
+
* @returns {HTMLImageElement} Play-button artwork image element.
|
|
431
|
+
* @private
|
|
432
|
+
*/
|
|
433
|
+
createButtonArtworkElement() {
|
|
434
|
+
const img = document.createElement('img');
|
|
435
|
+
img.className = 'waveform-btn-artwork';
|
|
436
|
+
img.alt = '';
|
|
437
|
+
img.setAttribute('aria-hidden', 'true');
|
|
438
|
+
this.bindArtworkFallback(img);
|
|
439
|
+
return img;
|
|
440
|
+
}
|
|
441
|
+
|
|
442
|
+
/**
|
|
443
|
+
* Create an artist text element matching the initial player markup.
|
|
444
|
+
*
|
|
445
|
+
* @returns {HTMLSpanElement} Artist text element.
|
|
446
|
+
* @private
|
|
447
|
+
*/
|
|
448
|
+
createArtistElement() {
|
|
449
|
+
const span = document.createElement('span');
|
|
450
|
+
span.className = 'waveform-artist';
|
|
451
|
+
return span;
|
|
452
|
+
}
|
|
453
|
+
|
|
454
|
+
/**
|
|
455
|
+
* Reconcile artist metadata and markup for the current track.
|
|
456
|
+
*
|
|
457
|
+
* @param {string|null} artist - Artist text, or a falsy value to remove it.
|
|
458
|
+
* @private
|
|
459
|
+
*/
|
|
460
|
+
syncArtist(artist) {
|
|
461
|
+
this.options.artist = artist || null;
|
|
462
|
+
|
|
463
|
+
if (!this.options.showInfo) return;
|
|
464
|
+
|
|
465
|
+
if (!artist) {
|
|
466
|
+
this.artistEl?.remove();
|
|
467
|
+
this.artistEl = null;
|
|
468
|
+
return;
|
|
469
|
+
}
|
|
470
|
+
|
|
471
|
+
if (!this.artistEl) {
|
|
472
|
+
const titleEl = this.container.querySelector('.waveform-title');
|
|
473
|
+
if (!titleEl) return;
|
|
474
|
+
this.artistEl = this.createArtistElement();
|
|
475
|
+
titleEl.after(this.artistEl);
|
|
476
|
+
}
|
|
477
|
+
|
|
478
|
+
this.artistEl.textContent = artist;
|
|
479
|
+
this.artistEl.style.display = '';
|
|
480
|
+
}
|
|
481
|
+
|
|
482
|
+
/**
|
|
483
|
+
* Reconcile the play button's artwork image (`artworkPosition: 'button'`).
|
|
484
|
+
*
|
|
485
|
+
* Shares {@link bindArtworkFallback} with the info-row image, so a broken
|
|
486
|
+
* cover degrades to the same placeholder tile in either placement. The
|
|
487
|
+
* `waveform-btn-has-artwork` class is what turns on the scrim + glyph
|
|
488
|
+
* treatment, so it tracks the image's presence exactly.
|
|
489
|
+
*
|
|
490
|
+
* @param {string|null} artwork - Artwork image URL, or a falsy value to remove it.
|
|
491
|
+
* @private
|
|
492
|
+
*/
|
|
493
|
+
syncButtonArtwork(artwork) {
|
|
494
|
+
// Nothing to hang the cover on when the transport is hidden.
|
|
495
|
+
if (!this.playBtn) return;
|
|
496
|
+
|
|
497
|
+
if (!artwork) {
|
|
498
|
+
this.artworkEl?.remove();
|
|
499
|
+
this.artworkEl = null;
|
|
500
|
+
this.playBtn.classList.remove('waveform-btn-has-artwork');
|
|
501
|
+
return;
|
|
502
|
+
}
|
|
503
|
+
|
|
504
|
+
if (!this.artworkEl) {
|
|
505
|
+
this.artworkEl = this.createButtonArtworkElement();
|
|
506
|
+
this.playBtn.prepend(this.artworkEl);
|
|
507
|
+
}
|
|
508
|
+
|
|
509
|
+
this.artworkEl.src = artwork;
|
|
510
|
+
this.playBtn.classList.add('waveform-btn-has-artwork');
|
|
511
|
+
}
|
|
512
|
+
|
|
513
|
+
/**
|
|
514
|
+
* Reconcile artwork metadata and markup for the current track.
|
|
515
|
+
*
|
|
516
|
+
* The image lives in one of two homes depending on `artworkPosition` — the
|
|
517
|
+
* info row (default) or the play button — and only ever one of them, so a
|
|
518
|
+
* cover can't render twice.
|
|
519
|
+
*
|
|
520
|
+
* @param {string|null} artwork - Artwork image URL, or a falsy value to remove artwork.
|
|
521
|
+
* @param {string} artworkAlt - Artwork alt text. Info-row placement only:
|
|
522
|
+
* button artwork is decorative and defers to the button's own label.
|
|
523
|
+
* @private
|
|
524
|
+
*/
|
|
525
|
+
syncArtwork(artwork, artworkAlt = '') {
|
|
526
|
+
this.options.artwork = artwork || null;
|
|
527
|
+
this.options.artworkAlt = artworkAlt || '';
|
|
528
|
+
|
|
529
|
+
if (this.options.artworkPosition === 'button') {
|
|
530
|
+
this.syncButtonArtwork(this.options.artwork);
|
|
531
|
+
return;
|
|
532
|
+
}
|
|
533
|
+
|
|
534
|
+
if (!this.options.showInfo) return;
|
|
535
|
+
|
|
536
|
+
if (!artwork) {
|
|
537
|
+
this.artworkEl?.remove();
|
|
538
|
+
this.artworkEl = null;
|
|
539
|
+
return;
|
|
540
|
+
}
|
|
541
|
+
|
|
542
|
+
if (!this.artworkEl) {
|
|
543
|
+
const textEl = this.container.querySelector('.waveform-text');
|
|
544
|
+
if (!textEl) return;
|
|
545
|
+
this.artworkEl = this.createArtworkElement();
|
|
546
|
+
textEl.before(this.artworkEl);
|
|
547
|
+
}
|
|
548
|
+
|
|
549
|
+
this.artworkEl.src = artwork;
|
|
550
|
+
this.artworkEl.alt = artworkAlt || '';
|
|
551
|
+
}
|
|
552
|
+
|
|
370
553
|
/**
|
|
371
554
|
* Create audio element
|
|
372
555
|
* @private
|
|
@@ -1045,10 +1228,13 @@ export class WaveformPlayer {
|
|
|
1045
1228
|
* @param {string|null} [artist=null] - Track artist; pass `''` to hide
|
|
1046
1229
|
* the artist row, or null to keep the existing one.
|
|
1047
1230
|
* @param {Object} [options={}] - Additional options to merge (e.g.
|
|
1048
|
-
* `preload`, `artwork`, `markers`, `autoplay`).
|
|
1231
|
+
* `preload`, `artwork`, `artworkAlt`, `markers`, `autoplay`).
|
|
1049
1232
|
* @returns {Promise<void>}
|
|
1050
1233
|
*/
|
|
1051
1234
|
async loadTrack(url, title = null, artist = null, options = {}) {
|
|
1235
|
+
const hasArtworkOption = Object.prototype.hasOwnProperty.call(options, 'artwork');
|
|
1236
|
+
const hasArtworkAltOption = Object.prototype.hasOwnProperty.call(options, 'artworkAlt');
|
|
1237
|
+
|
|
1052
1238
|
// Stop current playback and clear state
|
|
1053
1239
|
if (this.isPlaying) {
|
|
1054
1240
|
this.pause();
|
|
@@ -1079,29 +1265,37 @@ export class WaveformPlayer {
|
|
|
1079
1265
|
// Update options (including preload if specified)
|
|
1080
1266
|
this.options = mergeOptions(this.options, {
|
|
1081
1267
|
url,
|
|
1082
|
-
title: title
|
|
1083
|
-
artist: artist
|
|
1268
|
+
title: title === null ? this.options.title : title,
|
|
1269
|
+
artist: artist === null ? this.options.artist : artist,
|
|
1084
1270
|
...options
|
|
1085
1271
|
});
|
|
1272
|
+
if (hasArtworkOption) {
|
|
1273
|
+
this.options.artwork = options.artwork || null;
|
|
1274
|
+
}
|
|
1275
|
+
if (hasArtworkAltOption) {
|
|
1276
|
+
this.options.artworkAlt = options.artworkAlt || '';
|
|
1277
|
+
} else if (hasArtworkOption) {
|
|
1278
|
+
this.options.artworkAlt = this.options.artwork ? DEFAULT_OPTIONS.artworkAlt : '';
|
|
1279
|
+
}
|
|
1086
1280
|
|
|
1087
1281
|
// Apply preload setting if it was changed
|
|
1088
1282
|
if (options.preload && this.audio) {
|
|
1089
1283
|
this.audio.preload = options.preload;
|
|
1090
1284
|
}
|
|
1091
1285
|
|
|
1092
|
-
// Update
|
|
1093
|
-
|
|
1094
|
-
|
|
1095
|
-
|
|
1096
|
-
this.artistEl.style.display = '';
|
|
1097
|
-
} else if (artist === '') {
|
|
1098
|
-
this.artistEl.style.display = 'none';
|
|
1099
|
-
}
|
|
1286
|
+
// Update artist only when explicitly provided. A null artist keeps the
|
|
1287
|
+
// existing artist, while an empty string removes it.
|
|
1288
|
+
if (artist !== null) {
|
|
1289
|
+
this.syncArtist(artist);
|
|
1100
1290
|
}
|
|
1101
1291
|
|
|
1102
|
-
// Update artwork
|
|
1103
|
-
|
|
1104
|
-
|
|
1292
|
+
// Update artwork when explicitly provided. The caller can pass an empty
|
|
1293
|
+
// value to remove existing artwork from the in-place player.
|
|
1294
|
+
if (hasArtworkOption || hasArtworkAltOption) {
|
|
1295
|
+
this.syncArtwork(
|
|
1296
|
+
hasArtworkOption ? options.artwork : this.options.artwork,
|
|
1297
|
+
hasArtworkAltOption ? options.artworkAlt : this.options.artworkAlt
|
|
1298
|
+
);
|
|
1105
1299
|
}
|
|
1106
1300
|
|
|
1107
1301
|
// Clear or update markers
|
|
@@ -2266,4 +2460,4 @@ export class WaveformPlayer {
|
|
|
2266
2460
|
return swapped === audioUrl ? undefined : swapped;
|
|
2267
2461
|
}
|
|
2268
2462
|
|
|
2269
|
-
}
|
|
2463
|
+
}
|
package/src/js/themes.js
CHANGED
|
@@ -176,6 +176,12 @@ export const DEFAULT_OPTIONS = {
|
|
|
176
176
|
// is used verbatim. Sets the `--wfp-btn-size` CSS var, which scales BOTH
|
|
177
177
|
// styles — box and glyph — proportionally.
|
|
178
178
|
buttonSize: null,
|
|
179
|
+
// Play/pause button corner radius. null = the stylesheet default (50%, a
|
|
180
|
+
// circle). A number is treated as px; a string (e.g. '8px') is used
|
|
181
|
+
// verbatim. Set 0 for a square button. Sets the `--wfp-btn-radius` CSS var,
|
|
182
|
+
// which shapes the 'circle' style's box — the bare 'minimal' glyph has no
|
|
183
|
+
// box to round, so this is a no-op there.
|
|
184
|
+
buttonRadius: null,
|
|
179
185
|
|
|
180
186
|
// Default waveform style
|
|
181
187
|
waveformStyle: 'mirror',
|
|
@@ -238,6 +244,17 @@ export const DEFAULT_OPTIONS = {
|
|
|
238
244
|
title: null,
|
|
239
245
|
artist: null,
|
|
240
246
|
artwork: null,
|
|
247
|
+
// Where the `artwork` image renders. 'info' = the info row beside the title
|
|
248
|
+
// (needs showInfo). 'button' = the cover becomes the play/pause button,
|
|
249
|
+
// which still works with the info row hidden. Only ONE placement ever
|
|
250
|
+
// renders, so the same cover can't appear twice.
|
|
251
|
+
//
|
|
252
|
+
// 'button' is self-contained: the stylesheet drops the button's ring and
|
|
253
|
+
// swaps its defaults for cover-sized ones (64px, 8px rounding), because the
|
|
254
|
+
// transport defaults are wrong for artwork in both directions — 36px
|
|
255
|
+
// smudges a cover, and 50% crops square art into a circle. buttonSize /
|
|
256
|
+
// buttonRadius still override it if you want a different tile.
|
|
257
|
+
artworkPosition: 'info',
|
|
241
258
|
album: '',
|
|
242
259
|
|
|
243
260
|
// Message shown in the error state when audio fails to load.
|
package/src/js/utils.js
CHANGED
|
@@ -42,6 +42,22 @@ export function escapeHtml(str) {
|
|
|
42
42
|
.replace(/'/g, ''');
|
|
43
43
|
}
|
|
44
44
|
|
|
45
|
+
/**
|
|
46
|
+
* Format a CSS length option (`buttonSize`, `buttonRadius`) for interpolation
|
|
47
|
+
* into an inline `style` attribute. A number is treated as px; a string (e.g.
|
|
48
|
+
* `'4rem'`) is used verbatim.
|
|
49
|
+
*
|
|
50
|
+
* The result is HTML-escaped: these values reach the markup from author-supplied
|
|
51
|
+
* `data-*` attributes, so an unescaped quote would otherwise close the `style`
|
|
52
|
+
* attribute and let arbitrary markup in.
|
|
53
|
+
*
|
|
54
|
+
* @param {number|string} value - Length option value.
|
|
55
|
+
* @returns {string} Escaped CSS length, e.g. `36px` or `4rem`.
|
|
56
|
+
*/
|
|
57
|
+
export function formatCssLength(value) {
|
|
58
|
+
return escapeHtml(typeof value === 'number' ? `${value}px` : value);
|
|
59
|
+
}
|
|
60
|
+
|
|
45
61
|
/**
|
|
46
62
|
* Whether a URL is safe to navigate to (assign to `location.href`): allows only
|
|
47
63
|
* `http`/`https` and relative URLs, rejecting `javascript:`, `data:`, `blob:`,
|
|
@@ -134,6 +150,14 @@ export function parseDataAttributes(element) {
|
|
|
134
150
|
if (raw) options[optKey] = float ? parseFloat(raw) : parseInt(raw, 10);
|
|
135
151
|
};
|
|
136
152
|
|
|
153
|
+
// Read a CSS length attribute: a bare number is px (data-button-size="64"),
|
|
154
|
+
// a unit string (e.g. "4rem") is kept verbatim for the stylesheet to resolve.
|
|
155
|
+
const setLength = (optKey, dataKey = optKey) => {
|
|
156
|
+
const raw = element.dataset[dataKey];
|
|
157
|
+
if (!raw) return;
|
|
158
|
+
options[optKey] = /^\d+(\.\d+)?$/.test(raw.trim()) ? parseFloat(raw) : raw;
|
|
159
|
+
};
|
|
160
|
+
|
|
137
161
|
// Parse a JSON-valued attribute defensively — warn and skip on bad JSON.
|
|
138
162
|
const setJson = (optKey, dataKey = optKey) => {
|
|
139
163
|
const raw = element.dataset[dataKey];
|
|
@@ -164,12 +188,8 @@ export function parseDataAttributes(element) {
|
|
|
164
188
|
if (element.dataset.buttonAlign) options.buttonAlign = element.dataset.buttonAlign;
|
|
165
189
|
if (element.dataset.layout) options.layout = element.dataset.layout;
|
|
166
190
|
if (element.dataset.buttonStyle) options.buttonStyle = element.dataset.buttonStyle;
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
if (element.dataset.buttonSize) {
|
|
170
|
-
const bs = element.dataset.buttonSize;
|
|
171
|
-
options.buttonSize = /^\d+(\.\d+)?$/.test(bs.trim()) ? parseFloat(bs) : bs;
|
|
172
|
-
}
|
|
191
|
+
setLength('buttonSize');
|
|
192
|
+
setLength('buttonRadius');
|
|
173
193
|
|
|
174
194
|
// Color preset
|
|
175
195
|
if (element.dataset.colorPreset) options.colorPreset = element.dataset.colorPreset;
|
|
@@ -199,6 +219,7 @@ export function parseDataAttributes(element) {
|
|
|
199
219
|
if (element.dataset.artist) options.artist = element.dataset.artist;
|
|
200
220
|
if (element.dataset.album) options.album = element.dataset.album;
|
|
201
221
|
if (element.dataset.artwork) options.artwork = element.dataset.artwork;
|
|
222
|
+
if (element.dataset.artworkPosition) options.artworkPosition = element.dataset.artworkPosition;
|
|
202
223
|
|
|
203
224
|
// Waveform data
|
|
204
225
|
if (element.dataset.waveform) options.waveform = element.dataset.waveform;
|