@videojs/html 10.0.0-rc.1 → 10.0.0-rc.3

package/docs/guides/build-your-own-component.md

@@ -0,0 +1,245 @@
+# Build your own UI component
+
+Create custom player controls that read state, dispatch actions, and stay accessible.
+
+Custom components subscribe to player state and dispatch actions, like built-in controls.
+
+## You might not need a custom component
+
+Before building from scratch, check if an existing approach covers your use case:
+
+- **Restyle a control**: use CSS custom properties and data attributes. See [UI components](./ui-components.md).
+- **Rearrange or remove controls**: add the skin source to your project, then modify it. See [Customize skins](./customize-skins.md#style-skin-source).
+
+Build a custom component when you need new behavior, a new state display, or integration with an external system.
+
+## Place your component in the player
+
+Your element needs to be inside [`<video-player>`](../reference/components/player.md) to access state. Place it inside [`<media-container>`](../reference/components/player-container.md) if it should also participate in fullscreen and respond to user activity. `<video-skin>` slots its children into `<media-container>`, so a child of the skin works:
+
+```html
+<video-player>
+  <video-skin>
+    <video slot="media" src="video.mp4"></video>
+    <skip-intro-button>Skip intro</skip-intro-button>
+  </video-skin>
+</video-player>
+```
+
+Extend `UIElement` from `@videojs/html` so `PlayerController` can schedule DOM updates when state changes:
+
+```ts
+import { UIElement, PlayerController, playerContext, selectTime, type PropertyValues } from '@videojs/html';
+
+class SkipIntroButtonElement extends UIElement {
+  #player = new PlayerController(this, playerContext, selectTime);
+
+  update(changed: PropertyValues) {
+    super.update(changed);
+    const time = this.#player.value;
+  }
+}
+```
+
+If your element starts listeners, observers, or other work, stop it in `disconnectedCallback()` and call the superclass lifecycle methods so inherited cleanup runs too. The browser can connect and disconnect the same element many times.
+
+## Full example
+
+A “skip intro” button that appears during the first 30 seconds of playback and seeks past the intro when clicked.
+
+**skip-intro-button.ts**
+
+```ts
+import {
+  UIElement,
+  PlayerController,
+  playerContext,
+  selectTime,
+  selectPlayback,
+  type PropertyValues,
+} from '@videojs/html';
+
+class SkipIntroButtonElement extends UIElement {
+  #time = new PlayerController(this, playerContext, selectTime);
+  #playback = new PlayerController(this, playerContext, selectPlayback);
+  #disconnect: AbortController | null = null;
+
+  connectedCallback() {
+    super.connectedCallback();
+    this.#disconnect?.abort();
+    this.#disconnect = new AbortController();
+    const { signal } = this.#disconnect;
+
+    this.setAttribute('role', 'button');
+    this.setAttribute('aria-label', 'Skip intro');
+    this.setAttribute('tabindex', '0');
+    this.addEventListener('click', this.#handleActivate, { signal });
+    this.addEventListener('keydown', this.#handleKeydown, { signal });
+    this.addEventListener('keyup', this.#handleKeyup, { signal });
+  }
+
+  disconnectedCallback() {
+    super.disconnectedCallback();
+    // Removes all listeners registered with this signal
+    this.#disconnect?.abort();
+    this.#disconnect = null;
+  }
+
+  update(changed: PropertyValues) {
+    super.update(changed);
+    const time = this.#time.value;
+    const playback = this.#playback.value;
+
+    // Features are configured per-player, so a feature may not be available
+    if (!time || !playback) return;
+
+    const visible = time.currentTime < 30 && !playback.paused;
+    this.toggleAttribute('data-visible', visible);
+    this.setAttribute('tabindex', visible ? '0' : '-1');
+  }
+
+  #handleActivate = () => {
+    this.#time.value?.seek(30);
+  };
+
+  #handleKeydown = (event: KeyboardEvent) => {
+    if (event.key === 'Enter') {
+      event.preventDefault();
+      this.#handleActivate();
+    } else if (event.key === ' ') {
+      // Prevent Space from scrolling the page
+      event.preventDefault();
+    }
+  };
+
+  // ARIA button pattern: Space activates on keyup, not keydown
+  #handleKeyup = (event: KeyboardEvent) => {
+    if (event.key === ' ') {
+      this.#handleActivate();
+    }
+  };
+}
+
+customElements.define('skip-intro-button', SkipIntroButtonElement);
+```
+
+**skip-intro-button.css**
+
+```css
+skip-intro-button {
+  position: absolute;
+  bottom: 5rem;
+  right: 1rem;
+  opacity: 0;
+  pointer-events: none;
+  transition: opacity 200ms;
+}
+
+skip-intro-button[data-visible] {
+  opacity: 1;
+  pointer-events: auto;
+}
+```
+
+Your element needs to be inside [`<video-player>`](../reference/components/player.md) to access state. Place it inside [`<media-container>`](../reference/components/player-container.md) if it should also participate in fullscreen and respond to user activity. `<video-skin>` slots its children into `<media-container>`, so a child of the skin works:
+
+```html
+<video-player>
+  <video-skin>
+    <video src="video.mp4"></video>
+    <skip-intro-button>Skip intro</skip-intro-button>
+  </video-skin>
+</video-player>
+<script type="module">
+  import '@videojs/html/video/skin';
+  import './skip-intro-button.js';
+</script>
+```
+
+## How it works
+
+Custom components read player state and dispatch actions through [features](./features.md). Each feature exposes a set. Here are some features you might reach for first:
+
+| State | Actions | Feature |
+| --- | --- | --- |
+| `paused`, `ended` | `play()`, `pause()` | [Playback](../reference/api/feature-playback.md) |
+| `currentTime`, `duration` | `seek()` | [Time](../reference/api/feature-time.md) |
+| `volume`, `muted` | `setVolume()`, `toggleMuted()` | [Volume](../reference/api/feature-volume.md) |
+| `fullscreen` | `requestFullscreen()`, `exitFullscreen()` | [Fullscreen](../reference/api/feature-fullscreen.md) |
+
+The API reference lists every feature with the state and actions it adds.
+
+Extend `UIElement` from `@videojs/html` so [`PlayerController`](../reference/api/player-controller.md) can schedule DOM updates when state changes, and access state and actions with a feature selector:
+
+```ts
+import { PlayerController, playerContext, selectPlayback } from '@videojs/html';
+
+// Subscribe to a feature — triggers update() when its state changes
+#playback = new PlayerController(this, playerContext, selectPlayback);
+
+// In update():
+const playback = this.#playback.value;
+if (playback?.paused) {
+  playback.play();
+}
+```
+
+Each selector returns both state and actions for that feature. Use separate controllers when you need multiple features (the [full example](#full-example) demonstrates this).
+
+Without a selector, `PlayerController` returns the full store without subscribing to changes. Create the controller with the typed context that [`createPlayer`](../reference/api/html-create-player.md) returns — the shared `playerContext` types the store’s members as `unknown` — and guard the value, which stays `undefined` until a player provides the store:
+
+```ts
+import { createPlayer, PlayerController } from '@videojs/html';
+import { videoFeatures } from '@videojs/html/video';
+
+const { context } = createPlayer({ features: videoFeatures });
+
+#store = new PlayerController(this, context);
+
+// Call any action
+this.#store.value?.play();
+this.#store.value?.setVolume(0.5);
+```
+
+Custom controls also need real button semantics — the examples above set the accessible name, keyboard focus, and (because a custom element is not a native `<button>`) the ARIA button pattern by hand.
+
+- [Learn more about accessibility in video players](./accessibility.md)
+
+## Availability and constraints
+
+- Features are configured per player, so a feature your component asks for may not be present. Selectors return `undefined` for a missing feature; guard the value before using it, as the example does.
+- Volume, fullscreen, picture-in-picture, and remote playback also expose an `*Availability` property (`'available'`, `'unavailable'`, or `'unsupported'`) for hiding controls the platform does not support. See [Features](./features.md) for details.
+
+## Common variations
+
+Before building from scratch, check if an existing approach covers your use case. Build a custom component when you need new behavior, a new state display, or integration with an external system.
+
+### Restyle a control
+
+Use CSS custom properties and data attributes. See [UI components](./ui-components.md).
+
+### Rearrange or remove controls
+
+Add the skin source to your project and modify it. See [Customize skins](./customize-skins.md#style-skin-source).
+
+## Troubleshooting
+
+### State and actions are typed as `unknown`
+
+You’re using the shared `playerContext`, which doesn’t know which features your player has. Use the typed `context` returned by `createPlayer`.
+
+### The component renders but never updates
+
+The element sits outside `<video-player>`, or the class doesn’t extend `UIElement`, so `PlayerController` has nothing to schedule updates on.
+
+## Related pages
+
+### API
+
+- [PlayerController](../reference/api/player-controller.md): Reactive controller for accessing player store state in HTML custom elements
+- [createPlayer](../reference/api/html-create-player.md): Factory function that creates a typed player element and controller for HTML custom elements
+- [media-container](../reference/components/player-container.md): The player's visual and interaction surface for layout, fullscreen, focus, and user activity.
+
+### Guides
+
+- [Customize skins](./customize-skins.md): Style a packaged Video.js skin or add its source to change controls, layout, styles, and interactions

package/docs/guides/bundlers.md

@@ -0,0 +1,51 @@
+# Bundlers
+
+Bundler requirements for Video.js package exports, CSS, and wrapper libraries
+
+Before the browser runs your application, a bundler such as Vite combines its imports into files the browser can load. Your bundler must understand the import paths published by Video.js packages.
+
+## Package exports
+
+Each Video.js package has an `exports` field in its `package.json`. This field lists the import paths that applications and libraries can use, such as `@videojs/html/video/player` and `@videojs/html/video/skin`.
+
+If an older bundler reports that one of these paths is missing or not exported, upgrade the bundler before adding an alias that bypasses the package’s public API.
+
+## Vite compatibility
+
+Use Vite 4.1 or later; Video.js has been tested through Vite 8. Earlier versions can’t resolve exported stylesheets such as `@videojs/html/video/skin.css`.
+
+Packaged HTML skins import their own styles, so an HTML application using `@videojs/html/video/skin` doesn’t need to import `skin.css` separately. The CSS limitation matters only when your application imports that stylesheet directly.
+
+## Externalize Video.js in a wrapper library
+
+You can skip this section when building an application.
+
+If you publish a library that expects its users to install Video.js separately, leave Video.js out of your library’s bundle. Rollup calls a dependency left out of the bundle **external**.
+
+Rollup’s array form matches only the exact package name, so `external: ['@videojs/html']` misses imports such as `@videojs/html/video/player`.
+
+Match the package name and everything below it instead:
+
+**rollup.config.js**
+
+```js
+const videojsPeers = ['@videojs/html'];
+
+export default {
+  external(id) {
+    return videojsPeers.some(
+      (packageName) => id === packageName || id.startsWith(`${packageName}/`)
+    );
+  }
+};
+```
+
+Add every `@videojs/*` package your library imports directly to `videojsPeers` and list it in `peerDependencies`.
+
+## Related pages
+
+### Guides
+
+- [Installation](./installation.md): Install Video.js packages and build an accessible, customizable video player with composable controls
+- [TypeScript](./typescript.md): TypeScript version and module resolution requirements for Video.js packages
+- [Self-host the player](./self-hosting.md): Serve the Video.js HTML player from your own origin for offline, air-gapped, or restricted-network deployments

package/docs/guides/captions.md

@@ -0,0 +1,140 @@
+# Show captions and subtitles
+
+Show captions and subtitles, and let users turn them on and pick a language.
+
+> **Note**
+>
+> Using a pre-built [skin](./skins.md)? It already includes the controls shown here. You may still need the media or player setup in this guide. The component examples are for building your own player UI from individual [components](./ui-components.md).
+
+## Recommended approach
+
+Add WebVTT tracks as `<track>` children of the media element, and give users a [`<media-captions-button>`](../reference/components/captions-button.md) to toggle them.
+
+**index.html**
+
+```html
+<video-player class="video-player">
+  <media-container>
+    <video src="https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM/highest.mp4" autoplay muted playsinline loop>
+      <track kind="captions" src="/docs/demos/text-tracks/captions.vtt" srclang="en" label="English" default />
+    </video>
+    <media-captions-button class="media-captions-button">
+      <span class="active">Captions Off</span>
+      <span class="inactive">Captions On</span>
+    </media-captions-button>
+  </media-container>
+</video-player>
+```
+
+**index.css**
+
+```css
+.video-player {
+  position: relative;
+}
+
+.video-player video {
+  width: 100%;
+  aspect-ratio: 16 / 9;
+}
+
+.media-captions-button {
+  position: absolute;
+  bottom: 10px;
+  left: 10px;
+  padding-block: 8px;
+  padding-inline: 20px;
+  color: black;
+  cursor: pointer;
+  background: rgba(255, 255, 255, 0.7);
+  border: 1px solid rgba(255, 255, 255, 0.3);
+  border-radius: 9999px;
+  backdrop-filter: blur(10px);
+}
+
+.media-captions-button .active {
+  display: none;
+}
+.media-captions-button .inactive {
+  display: none;
+}
+.media-captions-button[data-active] .active {
+  display: inline;
+}
+.media-captions-button:not([data-active]) .inactive {
+  display: inline;
+}
+```
+
+**index.ts**
+
+```ts
+import '@videojs/html/video/player';
+import '@videojs/html/ui/container';
+import '@videojs/html/ui/captions-button';
+```
+
+## How it works
+
+The [text track feature](../reference/api/feature-text-tracks.md) mirrors the media element’s `textTracks` into player state:
+
+- `textTrackList` holds every track with its `id`, `kind`, `label`, `language`, and `mode`.
+- `subtitlesShowing` is `true` when any caption or subtitle track is showing.
+- `toggleSubtitles(forceShow?)` shows or hides all caption and subtitle tracks.
+- `selectSubtitlesTrack(id)` shows one track and disables the rest; pass `'off'` to disable all.
+
+Tracks don’t have to come from `<track>` elements: tracks that streaming media exposes (for example in-manifest HLS captions) appear in `textTrackList` the same way.
+
+The browser renders the cues. Style them with the `::cue` pseudo-element.
+
+## Availability and constraints
+
+- Captions availability is `'unavailable'` until the media has at least one caption or subtitle track; caption controls render nothing in that case.
+- Cues load asynchronously. A track appears in `textTrackList` before its cues are parsed, so cue-driven UI fills in when the track finishes loading.
+- Cross-origin track files require CORS: serve the VTT with CORS headers and set `crossorigin` on the media element.
+- Track selection UIs identify tracks by `label` and `language`; give every track both.
+- `default` on a `<track>` makes the browser show it initially.
+
+## Common variations
+
+### Language selection menu
+
+For multiple languages, render a menu instead of a toggle.
+
+Use [`<media-captions-radio-group>`](../reference/components/captions-radio-group.md) inside a menu or popover for explicit track selection.
+
+## Troubleshooting
+
+### Captions don’t appear
+
+Confirm that:
+
+- The track `kind` is `captions` or `subtitles`.
+- The VTT file loads (check the network panel for the track request).
+- The track is enabled: `default` on the track element, a `<media-captions-button>` toggle, or `toggleSubtitles(true)`.
+
+### Captions work locally but not in production
+
+The track file is served from another origin without CORS headers. Serve it with `Access-Control-Allow-Origin` and set `crossorigin` on the media element.
+
+### The selection menu is empty
+
+The media has no caption or subtitle tracks, so captions availability is `'unavailable'`. For streaming sources, confirm the manifest actually declares text tracks.
+
+## Related pages
+
+### Components
+
+- [media-captions-button](../reference/components/captions-button.md): Accessible captions toggle button with availability detection and state reflection
+- [media-captions-radio-group](../reference/components/captions-radio-group.md): A menu radio group for selecting caption and subtitle tracks
+- [media-menu](../reference/components/menu.md): A composable menu component for settings, option selection, and actions
+
+### API
+
+- [Text tracks](../reference/api/feature-text-tracks.md): Subtitles, captions, and chapter track state for the player store
+
+### Guides
+
+- [Show timeline thumbnail previews](./thumbnails.md): Preview frames along the timeline while the user scrubs, powered by a storyboard track.
+- [Media sources](./media-sources.md): Set what a media element plays and how its engine plays it with the structured source property
+- [Accessibility](./accessibility.md): How Video.js approaches accessibility, and what you should consider if you're deeply customizing your player

package/docs/guides/casting.md

@@ -0,0 +1,180 @@
+# Cast to AirPlay and Chromecast
+
+Send playback to AirPlay and Google Cast devices, with availability detection and connection state.
+
+Send playback to an Apple TV over AirPlay or a Chromecast over Google Cast while the browser stays in control.
+
+> **Note**
+>
+> Using a pre-built [skin](./skins.md)? It already includes the controls shown here. You may still need the media or player setup in this guide. The component examples are for building your own player UI from individual [components](./ui-components.md).
+
+## Recommended approach
+
+Use the [`<google-cast>` extension](../reference/components/google-cast.md) with a [`<media-cast-button>`](../reference/components/cast-button.md), and add an [`<media-airplay-button>`](../reference/components/airplay-button.md) for Safari. The prebuilt skins already include both buttons; add `<google-cast>` next to a streaming media component to enable the configurable Cast route.
+
+**index.html**
+
+```html
+<video-player class="video-player">
+  <media-container>
+    <hlsjs-video src="https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM.m3u8" autoplay muted playsinline loop></hlsjs-video>
+    <google-cast></google-cast>
+    <div class="media-remote-buttons">
+      <media-airplay-button class="media-airplay-button">
+        <span class="connected">Stop AirPlay</span>
+        <span class="not-connected">Start AirPlay</span>
+      </media-airplay-button>
+      <media-cast-button class="media-cast-button">
+        <span class="connected">Stop casting</span>
+        <span class="disconnected">Start casting</span>
+      </media-cast-button>
+    </div>
+  </media-container>
+</video-player>
+```
+
+**index.css**
+
+```css
+.video-player {
+  position: relative;
+  display: block;
+}
+
+.video-player video {
+  width: 100%;
+}
+
+.media-remote-buttons {
+  position: absolute;
+  right: 10px;
+  bottom: 10px;
+  display: flex;
+  gap: 8px;
+}
+
+.media-airplay-button,
+.media-cast-button {
+  padding-block: 8px;
+  padding-inline: 20px;
+  color: black;
+  cursor: pointer;
+  background: rgba(255, 255, 255, 0.7);
+  border: 1px solid rgba(255, 255, 255, 0.3);
+  border-radius: 9999px;
+  backdrop-filter: blur(10px);
+}
+
+.media-airplay-button .connected,
+.media-airplay-button .not-connected,
+.media-cast-button .connected,
+.media-cast-button .disconnected {
+  display: none;
+}
+
+/* AirPlay: swap label on connection state */
+.media-airplay-button[data-airplay-state="connected"] .connected {
+  display: inline;
+}
+.media-airplay-button:not([data-airplay-state="connected"]) .not-connected {
+  display: inline;
+}
+
+/* Cast: swap label on connection state */
+.media-cast-button[data-cast-state="connected"] .connected {
+  display: inline;
+}
+.media-cast-button:not([data-cast-state="connected"]) .disconnected {
+  display: inline;
+}
+
+/* Explicitly disabled while the route is unavailable. */
+.media-airplay-button[data-disabled],
+.media-cast-button[data-disabled] {
+  cursor: not-allowed;
+  opacity: 0.5;
+  filter: grayscale(1);
+}
+```
+
+**index.ts**
+
+```ts
+import '@videojs/html/video/player';
+import '@videojs/html/ui/container';
+import '@videojs/html/extensions/google-cast';
+import '@videojs/html/media/hlsjs-video';
+import '@videojs/html/ui/airplay-button';
+import '@videojs/html/ui/cast-button';
+```
+
+The demo pairs the streaming media element with the `<google-cast>` extension. Without that extension, `<media-cast-button>` drives the browser’s native Remote Playback API instead, which does not provide Video.js receiver or load-request configuration.
+
+## How it works
+
+The [remote playback feature](../reference/api/feature-remote-playback.md) gives AirPlay and Google Cast one state shape:
+
+- `remotePlaybackAvailability` is `'available'` when a remote device can be reached, `'unavailable'` when the API exists but no device is reachable, and `'unsupported'` when the browser has no remote playback route.
+- `remotePlaybackState` is `'disconnected'`, `'connecting'`, or `'connected'`.
+- `toggleRemotePlayback()` opens the browser’s device picker, or disconnects an active session.
+
+AirPlay uses WebKit’s presentation APIs. Google Cast uses a sender and receiver: the browser sends the receiver a media URL and then controls playback. Your UI reads the same Video.js state for either route.
+
+While connected, playback actions — play, pause, seek, volume — proxy to the remote device, and player state keeps reflecting the remote session. Local playback is suspended.
+
+The Google Cast SDK loads only when the `<google-cast>` extension is present in a Chromium browser. Players without that extension and browsers that cannot cast do not load it.
+
+## Availability and constraints
+
+- Remote playback is asynchronous and can fail mid-session when a device or network disappears. React to `remotePlaybackState` rather than assuming a request succeeds.
+- Google Cast works only in Chromium-based browsers; elsewhere its route reports `'unsupported'`.
+- AirPlay works only in Safari; availability requires an AirPlay device reachable on the network.
+- The remote device fetches the source and tracks itself. Localhost, VPN-only, expired, or cross-origin URLs without the necessary CORS headers will fail on the receiver even if they play in the browser.
+- Set the `disableremoteplayback` attribute on the media element to opt out entirely.
+
+## Common variations
+
+### Custom Cast receiver
+
+By default, Video.js sends the current source to Google’s Default Media Receiver. Set `receiver` when you have your own receiver application:
+
+```html
+<google-cast receiver="YOUR_APP_ID"></google-cast>
+```
+
+Use `src` and `contentType` when the receiver should load a different source than the browser. `streamType` and `customData` let you describe that source and attach application-specific data. See the [`<google-cast>` reference](../reference/components/google-cast.md) for the exact option types and attribute-to-property mapping.
+
+### Read connection state
+
+Use `remotePlaybackAvailability` to decide whether to offer a route and `remotePlaybackState` to show whether it is disconnected, connecting, or connected. `<media-cast-button>` and `<media-airplay-button>` already apply these states to their presentation; read them directly only when another part of your app needs them.
+
+## Troubleshooting
+
+### The cast button doesn’t render, or renders disabled
+
+The Cast button hides when the route is unsupported. In Chromium with no Cast device reachable, it stays visible but disabled. The AirPlay button hides unless Safari reports an AirPlay device.
+
+### Casting starts but the device shows an error
+
+The receiver cannot fetch the media. Confirm the source URL is reachable from the device and served with CORS headers, including caption tracks.
+
+### The UI freezes on “connecting”
+
+The user dismissed the picker or the device disconnected. `remotePlaybackState` returns to `'disconnected'`; drive your UI from that state.
+
+## Related pages
+
+### Components
+
+- [media-cast-button](../reference/components/cast-button.md): Accessible Cast toggle button with state reflection and keyboard support
+- [media-airplay-button](../reference/components/airplay-button.md): Accessible AirPlay toggle button that opens the WebKit playback target picker and reflects session state
+- [google-cast](../reference/components/google-cast.md): Options for the Google Cast extension that configures the receiver and load request
+
+### API
+
+- [Remote Playback](../reference/api/feature-remote-playback.md): Remote playback state and actions for the player store
+- [hlsjs-video](../reference/components/hlsjs-video.md): HLS video element powered by hls.js for adaptive bitrate streaming
+
+### Guides
+
+- [Media sources](./media-sources.md): Set what a media element plays and how its engine plays it with the structured source property