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

package/docs/reference/components/alert-dialog.md

@@ -0,0 +1,270 @@
+# media-alert-dialog
+
+A modal alert dialog for urgent messages that require acknowledgement
+
+## Import
+
+```ts
+import '@videojs/html/ui/alert-dialog';
+import '@videojs/html/ui/dialog-backdrop';
+import '@videojs/html/ui/dialog-popup';
+import '@videojs/html/ui/dialog-title';
+import '@videojs/html/ui/dialog-description';
+import '@videojs/html/ui/dialog-close';
+```
+
+## Anatomy
+
+```html
+<media-alert-dialog>
+  <media-dialog-backdrop></media-dialog-backdrop>
+  <media-dialog-popup>
+    <media-dialog-title></media-dialog-title>
+    <media-dialog-description></media-dialog-description>
+    <media-dialog-close></media-dialog-close>
+  </media-dialog-popup>
+</media-alert-dialog>
+```
+
+## Behavior
+
+Use an alert dialog for an urgent message that interrupts the user and requires acknowledgement. Your application controls when it opens and supplies its content.
+
+`<media-alert-dialog>` adds alert semantics, while the other parts are the same elements [`<media-dialog>`](./dialog.md) uses. For general modal content, including a player opened from a thumbnail, use `<media-dialog>` instead.
+
+Set the root’s `open` property to show the dialog. The root supplies alert state while the shared `media-dialog-backdrop` and `media-dialog-popup` siblings render the visual surfaces and semantics. The root updates the property and dispatches `open-change` when the dialog closes.
+
+The close part and Escape close the dialog. The dialog stays rendered during a closing transition, then restores focus to the element that was focused before it opened.
+
+## Styling
+
+Use the open and transition data attributes to style visibility and animations:
+
+| Attribute | Description |
+| --- | --- |
+| `data-open` | Present while the dialog is open, including its closing transition |
+| `data-starting-style` | Present at the start of the opening transition |
+| `data-ending-style` | Present during the closing transition |
+
+```css
+media-dialog-backdrop:not([data-open]),
+media-dialog-popup:not([data-open]) {
+  display: none;
+}
+
+media-dialog-backdrop[data-starting-style],
+media-dialog-backdrop[data-ending-style],
+media-dialog-popup[data-starting-style],
+media-dialog-popup[data-ending-style] {
+  opacity: 0;
+}
+```
+
+## Accessibility
+
+The dialog uses `role="alertdialog"` and `aria-modal="true"`. The title and description receive generated IDs that are connected with `aria-labelledby` and `aria-describedby`. Focus moves into the dialog when it opens, stays within it while open, and returns to the previously focused element when it closes. Content outside the dialog is inert while it is open. Pressing Escape closes the dialog.
+
+## Examples
+
+### Basic usage
+
+**index.html**
+
+```html
+<div class="html-alert-dialog-basic">
+  <button class="html-alert-dialog-basic__trigger" type="button">Open alert dialog</button>
+  <media-alert-dialog>
+    <media-dialog-backdrop class="html-alert-dialog-basic__backdrop"></media-dialog-backdrop>
+    <media-dialog-popup class="html-alert-dialog-basic__dialog">
+      <media-dialog-title class="html-alert-dialog-basic__title">Stop playback?</media-dialog-title>
+      <media-dialog-description class="html-alert-dialog-basic__description">
+        Your current playback position will be lost.
+      </media-dialog-description>
+      <media-dialog-close class="html-alert-dialog-basic__close">Continue</media-dialog-close>
+    </media-dialog-popup>
+  </media-alert-dialog>
+</div>
+```
+
+**index.css**
+
+```css
+.html-alert-dialog-basic {
+  position: relative;
+  display: grid;
+  place-items: center;
+  min-height: 240px;
+  overflow: hidden;
+  background: #111827;
+  border-radius: 12px;
+}
+
+.html-alert-dialog-basic__trigger,
+.html-alert-dialog-basic__close {
+  padding: 8px 16px;
+  color: #111827;
+  cursor: pointer;
+  background: #fff;
+  border: 0;
+  border-radius: 9999px;
+}
+
+.html-alert-dialog-basic__backdrop {
+  position: absolute;
+  inset: 0;
+  background: rgb(3 7 18 / 92%);
+  transition: opacity 150ms ease;
+}
+
+.html-alert-dialog-basic__dialog {
+  position: absolute;
+  inset: 0;
+  z-index: 1;
+  display: grid;
+  gap: 12px;
+  place-content: center;
+  padding: 32px;
+  color: #fff;
+  text-align: center;
+  transition: opacity 150ms ease;
+}
+
+.html-alert-dialog-basic__backdrop:not([data-open]),
+.html-alert-dialog-basic__dialog:not([data-open]) {
+  display: none;
+}
+
+.html-alert-dialog-basic__backdrop[data-starting-style],
+.html-alert-dialog-basic__backdrop[data-ending-style],
+.html-alert-dialog-basic__dialog[data-starting-style],
+.html-alert-dialog-basic__dialog[data-ending-style] {
+  opacity: 0;
+}
+
+.html-alert-dialog-basic__title,
+.html-alert-dialog-basic__description {
+  display: block;
+}
+
+.html-alert-dialog-basic__title {
+  font-size: 20px;
+  font-weight: 600;
+}
+
+.html-alert-dialog-basic__description {
+  color: #d1d5db;
+}
+
+.html-alert-dialog-basic__close {
+  justify-self: center;
+}
+```
+
+**index.ts**
+
+```ts
+import '@videojs/html/ui/alert-dialog';
+import '@videojs/html/ui/dialog-backdrop';
+import '@videojs/html/ui/dialog-popup';
+import '@videojs/html/ui/dialog-title';
+import '@videojs/html/ui/dialog-description';
+import '@videojs/html/ui/dialog-close';
+
+const initializedDemos = new WeakSet<HTMLElement>();
+
+function initializeDemos(): void {
+  document.querySelectorAll<HTMLElement>('.html-alert-dialog-basic').forEach((demo) => {
+    if (initializedDemos.has(demo)) return;
+
+    initializedDemos.add(demo);
+
+    const trigger = demo.querySelector<HTMLButtonElement>('.html-alert-dialog-basic__trigger');
+    const dialog = demo.querySelector('media-alert-dialog');
+
+    trigger?.addEventListener('click', () => {
+      if (dialog) dialog.open = true;
+    });
+  });
+}
+
+initializeDemos();
+document.addEventListener('astro:page-load', initializeDemos);
+```
+
+## API Reference
+
+### media-alert-dialog
+
+A modal dialog with alert semantics.
+
+#### Props
+
+| Prop | Type | Default | Description |
+| --- | --- | --- | --- |
+| `closeOnEscape` (attribute `close-on-escape`) | `boolean` | — | Whether pressing Escape closes the dialog. |
+| `defaultOpen` (attribute `default-open`) | `boolean` | — | Initial open state for uncontrolled usage. |
+| `open` | `boolean` | — | Controlled open state. When set, the consumer is responsible for toggling. |
+
+#### State
+
+State is reflected as data attributes for CSS styling.
+
+| Property | Type | Description |
+| --- | --- | --- |
+| `transitionStarting` | `boolean` | Whether the open transition is in progress. |
+| `transitionEnding` | `boolean` | Whether the close transition is in progress. |
+| `open` | `boolean` | Whether the dialog is currently open. |
+| `status` | `'idle' \| 'starting' \| 'ending'` | Current phase of the transition lifecycle. |
+| `titleId` | `string \| undefined` | Element ID of the dialog title, used for `aria-labelledby`. |
+| `descriptionId` | `string \| undefined` | Element ID of the dialog description, used for `aria-describedby`. |
+
+#### Events
+
+| Event | Description |
+| --- | --- |
+| `open-change` | Fired when the dialog's open state changes. |
+| `open-change-complete` | |
+
+### media-dialog-backdrop
+
+Presentational backdrop that reflects its owning dialog's state.
+
+#### Data attributes
+
+| Attribute | Description |
+| --- | --- |
+| `data-open` | Present when the dialog is open. |
+| `data-starting-style` | Present during the open transition. |
+| `data-ending-style` | Present during the close transition. |
+
+### media-dialog-close
+
+Button that closes its owning dialog; the element itself takes `role="button"` and keyboard focus.
+
+#### Data attributes
+
+| Attribute | Description |
+| --- | --- |
+| `data-open` | Present when the dialog is open. |
+| `data-starting-style` | Present during the open transition. |
+| `data-ending-style` | Present during the close transition. |
+
+### media-dialog-description
+
+Text announced as its owning dialog's description. The element takes the `id` that the popup's `aria-describedby` points to.
+
+### media-dialog-popup
+
+Semantic popup that owns focus management and dialog transition completion.
+
+#### Data attributes
+
+| Attribute | Description |
+| --- | --- |
+| `data-open` | Present when the dialog is open. |
+| `data-starting-style` | Present during the open transition. |
+| `data-ending-style` | Present during the close transition. |
+
+### media-dialog-title
+
+Text that labels its owning dialog. The element takes the `id` that the popup's `aria-labelledby` points to.

package/docs/reference/components/audio-minimal-skin.md

@@ -0,0 +1,39 @@
+# audio-minimal-skin
+
+The audio preset's visually lighter skin, closer to a classic control bar
+
+The minimal skin of the audio preset: the same player and the same controls in a visually lighter design, closer to a classic control bar. [AudioSkin](./audio-skin.md) is the same preset’s other variant. See [Skins](../../guides/skins.md) for how packaged skins work and [Presets](../../guides/presets.md) for what the audio preset ships.
+
+## Import
+
+```ts
+import '@videojs/html/audio/minimal-skin';
+```
+
+The import registers the skin and every UI element it composes. The [CDN](../../guides/cdn.md) player bundle registers this skin together with its player:
+
+```html
+<script type="module" src="https://cdn.jsdelivr.net/npm/@videojs/cdn@10.0.0-rc.3/audio-minimal.js"></script>
+```
+
+## Usage
+
+The skin goes between the player and the media element. It renders its controls around the media.
+
+```html
+<audio-player>
+  <audio-minimal-skin>
+    <audio src="audio.mp3"></audio>
+  </audio-minimal-skin>
+</audio-player>
+```
+
+## Styling
+
+Packaged skins style themselves and expose a small set of public CSS custom properties. Everything else inside the skin is private and may change between releases. [Customize skins](../../guides/customize-skins.md#style-a-packaged-skin) documents the properties. For deeper changes, the Video.js registry provides the skin files.
+
+## Own the UI
+
+Packaged skins keep their controls and layout inside Video.js. When you need to add, remove, rearrange, or deeply restyle controls, use Shadcn to add the skin source to your project. Its components, layout, styles, and interactions become local files you can change.
+
+- [Install Video.js with Shadcn](../../guides/installation-shadcn.md): Add editable skin source and build a working React or HTML player

package/docs/reference/components/audio-skin.md

@@ -0,0 +1,39 @@
+# audio-skin
+
+The audio preset's default skin with the modern, frosted look
+
+The default skin of the audio preset: the control layout for on-demand audio with the modern, frosted look. [MinimalAudioSkin](./audio-minimal-skin.md) is the same preset’s other variant. See [Skins](../../guides/skins.md) for how packaged skins work and [Presets](../../guides/presets.md) for what the audio preset ships.
+
+## Import
+
+```ts
+import '@videojs/html/audio/skin';
+```
+
+The import registers the skin and every UI element it composes. The [CDN](../../guides/cdn.md) player bundle registers this skin together with its player:
+
+```html
+<script type="module" src="https://cdn.jsdelivr.net/npm/@videojs/cdn@10.0.0-rc.3/audio.js"></script>
+```
+
+## Usage
+
+The skin goes between the player and the media element. It renders its controls around the media.
+
+```html
+<audio-player>
+  <audio-skin>
+    <audio src="audio.mp3"></audio>
+  </audio-skin>
+</audio-player>
+```
+
+## Styling
+
+Packaged skins style themselves and expose a small set of public CSS custom properties. Everything else inside the skin is private and may change between releases. [Customize skins](../../guides/customize-skins.md#style-a-packaged-skin) documents the properties. For deeper changes, the Video.js registry provides the skin files.
+
+## Own the UI
+
+Packaged skins keep their controls and layout inside Video.js. When you need to add, remove, rearrange, or deeply restyle controls, use Shadcn to add the skin source to your project. Its components, layout, styles, and interactions become local files you can change.
+
+- [Install Video.js with Shadcn](../../guides/installation-shadcn.md): Add editable skin source and build a working React or HTML player

package/docs/reference/components/audio-track-radio-group.md

@@ -0,0 +1,222 @@
+# media-audio-track-radio-group
+
+A menu radio group for selecting an audio track
+
+Creates radio items from the player audio track state and selects the enabled track.
+
+## Import
+
+```ts
+import '@videojs/html/ui/audio-track-radio-group';
+import '@videojs/html/ui/menu-radio-item';
+import '@videojs/html/ui/menu-item-indicator';
+```
+
+## Anatomy
+
+```html
+<media-audio-track-radio-group>
+  <template>
+    <media-menu-radio-item>
+      <span data-part="label"></span>
+      <media-menu-item-indicator></media-menu-item-indicator>
+    </media-menu-radio-item>
+  </template>
+</media-audio-track-radio-group>
+```
+
+## Behavior
+
+The group is available when the configured media exposes more than one audio track. Labels use the track label, then language, then kind. Pass `formatTrack` to customize the visible labels.
+
+`<media-audio-track-radio-group>` generates `<media-menu-radio-item>` children. Add an optional `<template>` with a single `<media-menu-radio-item>` to customize each generated item.
+
+## Styling
+
+| Attribute | Values | Description |
+| --- | --- | --- |
+| `data-audio-track` | `string` | Current audio track value. |
+| `data-disabled` | Present / absent | Present when audio track selection is disabled. |
+| `data-hidden` | Present / absent | Present when multiple audio tracks are unavailable. |
+| `data-availability` | `"available"` / `"unavailable"` | Whether multiple audio tracks are available. |
+
+Unavailable groups receive the native `hidden` attribute.
+
+## Accessibility
+
+The group uses the menu radio group pattern.
+
+The element receives an accessible label from the `label` property or defaults to `Audio`.
+
+## Examples
+
+### Basic usage
+
+**index.html**
+
+```html
+<video-player class="video-player">
+  <media-container>
+    <hlsjs-video
+      class="video-media"
+      src="https://stream.mux.com/s41JYeqIpBMBzE4OzxDyGR2yrp2hD1CQ6gJN9SlVGDQ.m3u8"
+      autoplay
+      crossorigin="anonymous"
+      muted
+      playsinline
+      loop
+    ></hlsjs-video>
+    <div class="menu-bar">
+      <button type="button" commandfor="audio-menu" class="settings-trigger">Audio</button>
+      <media-menu id="audio-menu" side="top" align="end" class="menu">
+        <media-menu-content>
+          <media-audio-track-radio-group class="menu-group" label="Audio tracks">
+            <template>
+              <media-menu-radio-item class="menu-item">
+                <span data-part="label"></span>
+                <media-menu-item-indicator force-mount class="menu-indicator">✓</media-menu-item-indicator>
+              </media-menu-radio-item>
+            </template>
+          </media-audio-track-radio-group>
+        </media-menu-content>
+      </media-menu>
+    </div>
+  </media-container>
+</video-player>
+```
+
+**index.css**
+
+```css
+.video-player media-container {
+  position: relative;
+  display: block;
+}
+
+.video-media {
+  width: 100%;
+}
+
+.menu-bar {
+  position: absolute;
+  right: 10px;
+  bottom: 10px;
+}
+
+.menu-bar:has([data-availability="unavailable"]) {
+  display: none;
+}
+
+.settings-trigger {
+  padding: 6px 16px;
+  color: black;
+  cursor: pointer;
+  background: rgba(255, 255, 255, 0.75);
+  border: 1px solid rgba(255, 255, 255, 0.35);
+  border-radius: 9999px;
+  backdrop-filter: blur(10px);
+}
+
+.menu {
+  --media-menu-side-offset: 8px;
+  box-sizing: border-box;
+  min-width: 180px;
+  max-width: var(--media-menu-available-width, var(--media-popover-available-width, none));
+  max-height: var(--media-menu-available-height, var(--media-popover-available-height, none));
+  padding: 6px;
+  overflow: auto;
+  overscroll-behavior: none;
+  font-size: 14px;
+  color: white;
+  background: rgba(0, 0, 0, 0.88);
+  border-radius: 8px;
+  backdrop-filter: blur(10px);
+}
+
+.menu-group {
+  display: grid;
+  gap: 2px;
+}
+
+.menu-item {
+  display: flex;
+  gap: 8px;
+  align-items: center;
+  justify-content: space-between;
+  min-height: 32px;
+  padding: 0 10px;
+  font: inherit;
+  color: inherit;
+  cursor: pointer;
+  background: none;
+  border: 0;
+  border-radius: 6px;
+}
+
+.menu-item[data-highlighted] {
+  background: rgba(255, 255, 255, 0.16);
+}
+
+.menu-indicator {
+  opacity: 0;
+}
+
+media-menu-radio-item[aria-checked="true"] .menu-indicator {
+  opacity: 1;
+}
+```
+
+**index.ts**
+
+```ts
+import '@videojs/html/video/player';
+import '@videojs/html/ui/container';
+import '@videojs/html/media/hlsjs-video';
+import '@videojs/html/ui/menu';
+import '@videojs/html/ui/menu-content';
+import '@videojs/html/ui/menu-radio-item';
+import '@videojs/html/ui/menu-item-indicator';
+import '@videojs/html/ui/audio-track-radio-group';
+```
+
+## API Reference
+
+### media-audio-track-radio-group
+
+Menu radio group that generates a `<media-menu-radio-item>` per available audio track and shares the selected label and availability with an enclosing menu. An optional `<template>` holding one `<media-menu-radio-item>` customizes each generated item.
+
+#### Props
+
+| Prop | Type | Default | Description |
+| --- | --- | --- | --- |
+| `disabled` | `boolean` | `false` | Whether audio track selection is disabled. |
+| `formatTrack` (attribute `format-track`) | `((track: MediaAudioTrack) => Text \| string)` | `formatTrackLabel` | Custom formatter for visible track labels. |
+| `label` | `{ key: string; text: string } \| string \| ((state: AudioTrackRadioGroupState) => Text \| string)` | `''` | Custom label for the options group. |
+
+#### State
+
+State is reflected as data attributes for CSS styling.
+
+| Property | Type | Description |
+| --- | --- | --- |
+| `label` | `{ key: string; text: string } \| string` | |
+| `value` | `string` | Current radio-group value. |
+| `options` | `readonly Option[]` | Ordered options displayed by platform adapters. |
+| `disabled` | `boolean` | Whether the entire option group is disabled. |
+| `hidden` | `boolean` | Whether the option group is hidden because no meaningful selection is available. |
+| `availability` | `'available' \| 'unavailable'` | Whether the media exposes a meaningful selection. |
+
+#### Data attributes
+
+| Attribute | Type | Description |
+| --- | --- | --- |
+| `data-audio-track` | `string` | Current audio track value. |
+| `data-disabled` | — | Present when audio track selection is disabled. |
+| `data-hidden` | — | Present when audio track selection is unavailable. |
+| `data-availability` | `'available' \| 'unavailable'` | Indicates audio track availability (`available` or `unavailable`). |
+
+#### Events
+
+| Event | Description |
+| --- | --- |
+| `value-change` | Fired when the selected value changes. |

package/docs/reference/components/audio.md

@@ -0,0 +1,73 @@
+# audio
+
+Native audio playback that can provide media to a Video.js player
+
+## Import
+
+The media element is the browser’s native `<audio>`. Import the audio player registration when it should provide media to Video.js:
+
+```ts
+import '@videojs/html/audio/player';
+```
+
+## Anatomy
+
+```html
+<audio>
+  <source />
+</audio>
+```
+
+## Use with a player
+
+Place a native `<audio>` anywhere inside `<audio-player>`. It becomes that player’s media provider automatically.
+
+## Native behavior
+
+Video.js does not replace the native audio API. Use `src` for one URL or add child [`<source>` elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/source) when the browser should choose between candidates. See [Media sources](../../guides/media-sources.md) when you need an HLS, Mux, Spotify, or other playback adapter.
+
+`<audio>` is the native element itself. Set its attributes and properties, listen for native media events, and access it through an `HTMLAudioElement` reference.
+
+See MDN for the complete [`<audio>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/audio), [`HTMLAudioElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLAudioElement), and shared [`HTMLMediaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement) APIs.
+
+## Examples
+
+### Basic Usage
+
+This native audio element uses a child source and browser controls while providing media to the surrounding Video.js player.
+
+**index.html**
+
+```html
+<audio-player>
+  <media-container class="html-audio-basic">
+    <audio class="html-audio-basic__media" controls preload="metadata">
+      <source src="https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM/audio.m4a" />
+    </audio>
+  </media-container>
+</audio-player>
+```
+
+**index.css**
+
+```css
+.html-audio-basic {
+  display: grid;
+  width: 100%;
+  padding: 24px;
+  background: #e5e7eb;
+  border-radius: 8px;
+  place-items: center;
+}
+
+.html-audio-basic__media {
+  width: 100%;
+}
+```
+
+**index.ts**
+
+```ts
+import '@videojs/html/audio/player';
+import '@videojs/html/ui/container';
+```

package/docs/reference/components/background-video-skin.md

@@ -0,0 +1,37 @@
+# background-video-skin
+
+The background preset's chrome-less skin for ambient video
+
+The only skin of the background preset: a chrome-less surface that sizes ambient video with no visible controls. See [Skins](../../guides/skins.md) for how packaged skins work and [Presets](../../guides/presets.md) for what the background preset ships.
+
+## Import
+
+```ts
+import '@videojs/html/background/skin';
+```
+
+The import registers the skin and every UI element it composes. The [CDN](../../guides/cdn.md) player bundle registers this skin together with its player:
+
+```html
+<script type="module" src="https://cdn.jsdelivr.net/npm/@videojs/cdn@10.0.0-rc.3/background.js"></script>
+```
+
+## Usage
+
+The skin goes between the player and the media element. It sizes the ambient video and renders no visible controls.
+
+```html
+<background-video-player>
+  <background-video-skin>
+    <background-video src="video.mp4"></background-video>
+  </background-video-skin>
+</background-video-player>
+```
+
+## Styling
+
+Packaged skins style themselves and expose a small set of public CSS custom properties. Everything else inside the skin is private and may change between releases. [Customize skins](../../guides/customize-skins.md#style-a-packaged-skin) documents the properties.
+
+## Own the UI
+
+Owning the UI means keeping its components, layout, styles, and interactions as local files you can change. The [Shadcn installation guide](../../guides/installation-shadcn.md) adds that source for supported skins. The registry does not provide background video skin source because it has no control UI. Follow [Add a background video](../../guides/background-video.md) to compose the media directly, then add only the UI your use case needs.