@videojs/html 10.0.0-rc.2 → 10.0.0-rc.4

package/docs/reference/{volume-indicator.md → components/volume-indicator.md}

@@ -4,17 +4,15 @@ Display temporary visual feedback for keyboard and gesture volume actions
 
 ## Import
 
-ts
-
-```
+```ts
 import '@videojs/html/ui/volume-indicator';
+import '@videojs/html/ui/volume-indicator-fill';
+import '@videojs/html/ui/volume-indicator-value';
 ```
 
 ## Anatomy
 
-html
-
-```
+```html
 <media-volume-indicator>
   <media-volume-indicator-fill>
     <media-volume-indicator-value></media-volume-indicator-value>
@@ -24,83 +22,40 @@ html
 
 ## Behavior
 
-`VolumeIndicator` displays feedback for `toggleMuted` and `volumeStep` actions emitted by a [`Hotkey`](./hotkey.md) or [`Gesture`](./gesture.md) in the same player `Container`. It does not react to mute buttons, volume sliders, direct player-store changes, or volume changes on their own.
+`<media-volume-indicator>` displays feedback for `toggleMuted` and `volumeStep` actions emitted by a [`<media-hotkey>`](./hotkey.md) or [`<media-gesture>`](./gesture.md) in the same player `<media-container>`. It does not react to mute buttons, volume sliders, direct player-store changes, or volume changes on their own.
 
 The input event arrives before its action is resolved. The indicator uses the media snapshot from that moment to predict the next mute state and volume. `toggleMuted` predicts the opposite mute state. `volumeStep` adds its `value` to the snapshot volume and clamps the result from 0 to 1. A step whose clamped result is above 0 also predicts that mute will clear.
 
-The Root exposes the predicted level:
-
-`data-level`
-
-Predicted state
-
-`"off"`
-
-Muted or volume is 0
-
-`"low"`
-
-Unmuted volume is greater than 0 and at most 0.5
+The root exposes the predicted level:
 
-`"high"`
+| `data-level` | Predicted state |
+| --- | --- |
+| `"off"` | Muted or volume is 0 |
+| `"low"` | Unmuted volume is greater than 0 and at most 0.5 |
+| `"high"` | Unmuted volume is greater than 0.5 |
 
-Unmuted volume is greater than 0.5
+`<media-volume-indicator-value>` displays the rounded percentage from 0% through 100%. `<media-volume-indicator-fill>` receives the same percentage through `--media-volume-fill`. Nest the value inside the fill so the progress treatment and text form one visual unit.
 
-`Value` displays the rounded percentage from 0% through 100%. `Fill` receives the same percentage through `--media-volume-fill`. Nest `Value` inside `Fill` so the progress treatment and text form one visual unit.
+The indicator closes after `closeDelay`, which defaults to 800 milliseconds. Repeated handled actions update the current value and restart that close timer without replaying the entry transition. Each update uses the latest media snapshot; the component does not independently accumulate volume steps.
 
-The indicator closes after `closeDelay`, which defaults to 800 milliseconds. Repeated handled actions update the current value and restart that close timer without replaying the entry transition. Each update uses the latest media snapshot; the component does not independently accumulate volume steps. React stops rendering the Root after its close transition. The HTML custom element remains in the document with `hidden` until the next handled action.
+The element remains in the document with `hidden` until the next handled action.
 
 When a nonzero `volumeStep` cannot move past an already-clamped edge, `data-min` or `data-max` is present for 300 milliseconds. Hitting the same edge again briefly clears the attribute, then restores it on the next task so a CSS boundary animation can restart. Merely reaching 0% or 100% does not trigger the boundary attribute until another step tries to move farther.
 
 ## Styling
 
-Attribute
-
-Values
-
-Description
-
-`data-open`
-
-Present / absent
-
-Present while the indicator is open
-
-`data-level`
-
-`"off"`, `"low"`, or `"high"`
-
-Predicted volume level
-
-`data-min`
+| Attribute | Values | Description |
+| --- | --- | --- |
+| `data-open` | Present / absent | Present while the indicator is open |
+| `data-level` | `"off"`, `"low"`, or `"high"` | Predicted volume level |
+| `data-min` | Present / absent | Present briefly after a blocked downward step at minimum volume |
+| `data-max` | Present / absent | Present briefly after a blocked upward step at maximum volume |
+| `data-starting-style` | Present / absent | Present during the open transition |
+| `data-ending-style` | Present / absent | Present during the close transition |
 
-Present / absent
+`--media-volume-fill` is set on `<media-volume-indicator-fill>`, not `<media-volume-indicator>`. Read it from a fill selector when sizing a progress treatment.
 
-Present briefly after a blocked downward step at minimum volume
-
-`data-max`
-
-Present / absent
-
-Present briefly after a blocked upward step at maximum volume
-
-`data-starting-style`
-
-Present / absent
-
-Present during the open transition
-
-`data-ending-style`
-
-Present / absent
-
-Present during the close transition
-
-`--media-volume-fill` is set on the Fill part, not the Root. Read it from a Fill selector when sizing a progress treatment.
-
-css
-
-```
+```css
 media-volume-indicator-fill::before {
   width: var(--media-volume-fill, 0%);
 }
@@ -113,7 +68,7 @@ media-volume-indicator[data-ending-style] {
 
 ## Accessibility
 
-`VolumeIndicator` is visual feedback and does not create a live region. Keep volume and mute available through keyboard-operable controls, and pair the player with [`StatusAnnouncer`](./status-announcer.md) when state changes should be announced to screen readers. Do not make `VolumeIndicator.Value` a live region.
+`<media-volume-indicator>` is visual feedback and does not create a live region. Keep volume and mute available through keyboard-operable controls, and pair the player with [`<media-status-announcer>`](./status-announcer.md) when state changes should be announced to screen readers. Do not make `<media-volume-indicator-value>` a live region.
 
 ## Examples
 
@@ -121,15 +76,9 @@ media-volume-indicator[data-ending-style] {
 
 Focus the player, then press M to mute or unmute. Use Arrow Up and Arrow Down to adjust volume by 5%.
 
-Focus the player · M: mute · ↑/↓: volume ±5%
-
-index.html
+**index.html**
 
-index.css
-
-index.ts
-
-```
+```html
 <video-player>
   <media-container class="html-volume-indicator-basic" tabindex="0">
     <video src="https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM/highest.mp4" autoplay muted playsinline loop></video>
@@ -145,7 +94,10 @@ index.ts
   </media-container>
 </video-player>
 ```
-```
+
+**index.css**
+
+```css
 .html-volume-indicator-basic {
   position: relative;
 }
@@ -267,240 +219,75 @@ index.ts
   }
 }
 ```
-```
+
+**index.ts**
+
+```ts
 import '@videojs/html/video/player';
+import '@videojs/html/ui/container';
 import '@videojs/html/ui/hotkey';
 import '@videojs/html/ui/volume-indicator';
+import '@videojs/html/ui/volume-indicator-fill';
+import '@videojs/html/ui/volume-indicator-value';
 
-const video = document.querySelector<HTMLVideoElement>('.html-volume-indicator-basic video');
+const initializedVideos = new WeakSet<HTMLVideoElement>();
 
-if (video) video.volume = 0.5;
+function initializeDemos(): void {
+  document.querySelectorAll<HTMLVideoElement>('.html-volume-indicator-basic video').forEach((video) => {
+    if (initializedVideos.has(video)) return;
+
+    initializedVideos.add(video);
+    video.volume = 0.5;
+  });
+}
+
+initializeDemos();
+document.addEventListener('astro:page-load', initializeDemos);
 ```
 
 ## API Reference
 
-### 
-
-media-volume-indicator
+### media-volume-indicator
 
 #### Props
 
-Prop
-
-Type
-
-Default
-
-Details
-
-`closeDelay`
-
-`number`
-
-`—`
-
-▸
-
-Attribute
-
-`close-delay`
-
-Description
-
-Delay in milliseconds before the indicator closes.
-
-`labels`
-
-`Partial<InputIndicatorLabels>`
-
-`—`
-
-▸
-
-Attribute
-
-`labels`
-
-Description
-
-Internal translated label overrides supplied by framework adapters.
+| Prop | Type | Default | Description |
+| --- | --- | --- | --- |
+| `closeDelay` (attribute `close-delay`) | `number` | — | Delay in milliseconds before the indicator closes. |
 
 #### State
 
 State is reflected as data attributes for CSS styling.
 
-Property
-
-Type
-
-Details
-
-`transitionStarting`
-
-`boolean`
-
-▸
-
-Description
-
-Whether the open transition is in progress.
-
-`transitionEnding`
-
-`boolean`
-
-▸
-
-Description
-
-Whether the close transition is in progress.
-
-`open`
-
-`boolean`
-
-▸
-
-Description
-
-Whether the indicator is open.
-
-`generation`
-
-`number`
-
-▸
-
-Description
-
-Increments each time a volume input action updates the indicator.
-
-`level`
-
-`'off' | 'low' | 'high' | null`
-
-▸
-
-Description
-
-Predicted volume level after the input action.
-
-`value`
-
-`string | null`
-
-▸
-
-Description
-
-Predicted volume formatted as a percentage.
-
-`fill`
-
-`string | null`
-
-▸
-
-Description
-
-Predicted volume percentage used by the Fill part.
-
-`min`
-
-`boolean`
-
-▸
-
-Description
-
-Whether a downward step tried to move past minimum volume.
-
-`max`
-
-`boolean`
-
-▸
-
-Description
-
-Whether an upward step tried to move past maximum volume.
+| 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 indicator is open. |
+| `generation` | `number` | Increments each time a volume input action updates the indicator. |
+| `level` | `'off' \| 'low' \| 'high' \| null` | Predicted volume level after the input action. |
+| `value` | `string \| null` | Predicted volume formatted as a percentage. |
+| `fill` | `string \| null` | Predicted volume percentage used by the Fill part. |
+| `min` | `boolean` | Whether a downward step tried to move past minimum volume. |
+| `max` | `boolean` | Whether an upward step tried to move past maximum volume. |
 
 #### Data attributes
 
-Attribute
-
-Type
-
-Details
-
-`data-open`
-
-▸
-
-Description
-
-Present while the indicator is open.
-
-`data-level`
-
-`'off' | 'low' | 'high' | null`
-
-▸
-
-Description
-
-Predicted volume level as `"off"`, `"low"`, or `"high"`.
-
-`data-min`
-
-▸
-
-Description
-
-Present briefly when a downward step cannot lower the volume further.
-
-`data-max`
-
-▸
-
-Description
-
-Present briefly when an upward step cannot raise the volume further.
-
-`data-starting-style`
-
-▸
-
-Description
-
-Present during the open transition.
-
-`data-ending-style`
-
-▸
-
-Description
-
-Present during the close transition.
+| Attribute | Type | Description |
+| --- | --- | --- |
+| `data-open` | — | Present while the indicator is open. |
+| `data-level` | `'off' \| 'low' \| 'high' \| null` | Predicted volume level as `"off"`, `"low"`, or `"high"`. |
+| `data-min` | — | Present briefly when a downward step cannot lower the volume further. |
+| `data-max` | — | Present briefly when an upward step cannot raise the volume further. |
+| `data-starting-style` | — | Present during the open transition. |
+| `data-ending-style` | — | Present during the close transition. |
 
 #### CSS custom properties
 
-Variable
-
-Details
-
-`--media-volume-fill`
-
-▸
-
-Description
-
-Current predicted volume percentage, set on the Fill part.
-
-### 
-
-media-volume-indicator-fill
+| Variable | Description |
+| --- | --- |
+| `--media-volume-fill` | Current predicted volume percentage, set on the Fill part. |
 
-### 
+### media-volume-indicator-fill
 
-media-volume-indicator-value
+### media-volume-indicator-value

package/docs/reference/components/volume-popover.md

@@ -0,0 +1,232 @@
+# media-volume-popover
+
+A volume-aware popover that keeps mute available when volume level controls are unavailable
+
+## Import
+
+```ts
+import '@videojs/html/ui/volume-popover';
+import '@videojs/html/ui/mute-button';
+import '@videojs/html/ui/volume-slider';
+import '@videojs/html/ui/slider-track';
+import '@videojs/html/ui/slider-fill';
+import '@videojs/html/ui/slider-thumb';
+```
+
+## Anatomy
+
+```html
+<media-mute-button commandfor="volume-popup"></media-mute-button>
+<media-volume-popover id="volume-popup">
+  <media-volume-slider></media-volume-slider>
+</media-volume-popover>
+```
+
+## Behavior
+
+`<media-volume-popover>` combines [popover behavior](./popover.md) with volume availability. When volume level controls are unavailable, it closes and omits the popup while keeping the mute trigger rendered. This lets media with fixed volume keep mute control without exposing a nonfunctional slider.
+
+The trigger can target the popup with `commandfor`. An immediately adjacent trigger is linked automatically when neither element has an authored ID.
+
+## Styling
+
+The popup reflects `data-availability="available"` while it can render volume controls.
+
+When it cannot, the element also receives native `hidden` and `data-hidden`.
+
+```css
+media-volume-popover[data-open] {
+  opacity: 1;
+}
+```
+
+## Accessibility
+
+The trigger receives `aria-haspopup`, `aria-expanded`, and `aria-controls` while the volume popup is available. When only mute is available, the trigger keeps the mute button’s own accessible name and behavior without popup ARIA.
+
+## Examples
+
+### Basic usage
+
+**index.html**
+
+```html
+<video-player class="html-volume-popover-basic">
+  <media-container>
+    <video src="https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM/highest.mp4" autoplay muted playsinline loop></video>
+    <div class="html-volume-popover-basic__controls">
+      <media-mute-button commandfor="volume-popover-demo" class="html-volume-popover-basic__trigger">
+        <span class="muted">Unmute</span>
+        <span class="unmuted">Mute</span>
+      </media-mute-button>
+      <media-volume-popover id="volume-popover-demo" open-on-hover side="top" class="html-volume-popover-basic__popup">
+        <media-volume-slider orientation="vertical" class="html-volume-popover-basic__slider">
+          <media-slider-track class="html-volume-popover-basic__track">
+            <media-slider-fill class="html-volume-popover-basic__fill"></media-slider-fill>
+          </media-slider-track>
+          <media-slider-thumb class="html-volume-popover-basic__thumb"></media-slider-thumb>
+        </media-volume-slider>
+      </media-volume-popover>
+    </div>
+  </media-container>
+</video-player>
+```
+
+**index.css**
+
+```css
+.html-volume-popover-basic media-container {
+  position: relative;
+  display: block;
+}
+
+.html-volume-popover-basic video {
+  width: 100%;
+}
+
+.html-volume-popover-basic__controls {
+  position: absolute;
+  bottom: 10px;
+  left: 10px;
+}
+
+.html-volume-popover-basic__trigger {
+  padding: 8px 20px;
+  color: black;
+  cursor: pointer;
+  background: rgb(255 255 255 / 70%);
+  border: 1px solid rgb(255 255 255 / 30%);
+  border-radius: 9999px;
+  backdrop-filter: blur(10px);
+}
+
+.html-volume-popover-basic__trigger .muted,
+.html-volume-popover-basic__trigger .unmuted {
+  display: none;
+}
+
+.html-volume-popover-basic__trigger[data-muted] .muted,
+.html-volume-popover-basic__trigger:not([data-muted]) .unmuted {
+  display: inline;
+}
+
+.html-volume-popover-basic__popup {
+  --media-popover-side-offset: 8px;
+  width: 40px;
+  height: 120px;
+  padding: 12px;
+  margin: 0;
+  background: rgb(0 0 0 / 85%);
+  border: 0;
+  border-radius: 8px;
+}
+
+.html-volume-popover-basic__slider {
+  position: relative;
+  display: block;
+  width: 16px;
+  height: 96px;
+  margin: auto;
+  cursor: pointer;
+}
+
+.html-volume-popover-basic__track {
+  position: absolute;
+  top: 0;
+  bottom: 0;
+  left: 6px;
+  width: 4px;
+  background: rgb(255 255 255 / 30%);
+  border-radius: 9999px;
+}
+
+.html-volume-popover-basic__fill {
+  position: absolute;
+  right: 0;
+  bottom: 0;
+  left: 0;
+  height: var(--media-slider-fill);
+  background: white;
+  border-radius: inherit;
+}
+
+.html-volume-popover-basic__thumb {
+  position: absolute;
+  bottom: var(--media-slider-fill);
+  left: 1px;
+  width: 14px;
+  height: 14px;
+  background: white;
+  border-radius: 50%;
+  transform: translateY(50%);
+}
+```
+
+**index.ts**
+
+```ts
+import '@videojs/html/video/player';
+import '@videojs/html/ui/container';
+import '@videojs/html/ui/mute-button';
+import '@videojs/html/ui/volume-popover';
+import '@videojs/html/ui/volume-slider';
+import '@videojs/html/ui/slider-track';
+import '@videojs/html/ui/slider-fill';
+import '@videojs/html/ui/slider-thumb';
+```
+
+## API Reference
+
+### media-volume-popover
+
+A volume-aware popover that keeps its adjacent mute trigger available as a fallback.
+
+#### Props
+
+| Prop | Type | Default | Description |
+| --- | --- | --- | --- |
+| `align` | `'start' \| 'center' \| 'end'` | — | Alignment of the popup along the trigger's edge. |
+| `boundary` | `'viewport' \| 'container' \| string & {}` | — | Boundary used to constrain the popup position. |
+| `closeDelay` (attribute `close-delay`) | `number` | — | Delay in ms before closing after pointer leaves. |
+| `closeOnEscape` (attribute `close-on-escape`) | `boolean` | — | Close the popup when the Escape key is pressed. |
+| `closeOnOutsideClick` (attribute `close-on-outside-click`) | `boolean` | — | Close the popup when clicking outside the trigger and popup. |
+| `defaultOpen` (attribute `default-open`) | `boolean` | — | Initial open state for uncontrolled usage. |
+| `delay` | `number` | — | Delay in ms before opening on hover. |
+| `modal` | `boolean \| 'trap-focus'` | — | - `false` (default): non-modal; background content remains interactive.<br>- `true`: modal; sets `aria-modal="true"` on the popup.<br>- `'trap-focus'`: reserved for future focus-trapping behavior. |
+| `open` | `boolean` | — | Controlled open state. When set, the consumer is responsible for toggling. |
+| `openOnHover` (attribute `open-on-hover`) | `boolean` | — | Open the popup on pointer hover instead of click. |
+| `side` | `'top' \| 'bottom' \| 'left' \| 'right'` | — | Preferred side of the trigger for the popup. |
+
+#### 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` | |
+| `status` | `'idle' \| 'starting' \| 'ending'` | |
+| `side` | `'top' \| 'bottom' \| 'left' \| 'right'` | Preferred side of the trigger for the popup. |
+| `align` | `'start' \| 'center' \| 'end'` | |
+| `modal` | `boolean \| 'trap-focus'` | |
+| `availability` | `'available' \| 'unavailable' \| 'unsupported'` | Whether volume level controls are available. |
+| `hidden` | `boolean` | Whether the popup is hidden because volume level controls are unavailable. |
+
+#### Data attributes
+
+| Attribute | Type | Description |
+| --- | --- | --- |
+| `data-open` | — | Present when the popover is open. |
+| `data-side` | `'top' \| 'bottom' \| 'left' \| 'right'` | Indicates the rendered side after collision handling. |
+| `data-align` | `'start' \| 'center' \| 'end'` | Indicates how the popup is aligned relative to its side. |
+| `data-starting-style` | — | Present during the open transition. |
+| `data-ending-style` | — | Present during the close transition. |
+| `data-availability` | `'available' \| 'unavailable' \| 'unsupported'` | Indicates volume control availability (`available`, `unavailable`, or `unsupported`). |
+| `data-hidden` | — | Present when volume level controls are unavailable. |
+
+#### Events
+
+| Event | Description |
+| --- | --- |
+| `open-change` | Fired when the popover's open state changes. |