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

package/docs/reference/{quality-radio-group.md → components/quality-radio-group.md}

@@ -6,17 +6,15 @@ Creates radio items from the player video rendition state and selects automatic
 
 ## Import
 
-ts
-
-```
+```ts
 import '@videojs/html/ui/quality-radio-group';
+import '@videojs/html/ui/menu-radio-item';
+import '@videojs/html/ui/menu-item-indicator';
 ```
 
 ## Anatomy
 
-html
-
-```
+```html
 <media-quality-radio-group>
   <template>
     <media-menu-radio-item>
@@ -37,35 +35,12 @@ The group is available when the configured media exposes more than one video ren
 
 ## Styling
 
-Attribute
-
-Values
-
-Description
-
-`data-quality`
-
-`string`
-
-Current quality value.
-
-`data-disabled`
-
-Present / absent
-
-Present when quality selection is disabled.
-
-`data-hidden`
-
-Present / absent
-
-Present when multiple renditions are unavailable.
-
-`data-availability`
-
-`"available"` / `"unavailable"`
-
-Whether multiple renditions are available.
+| Attribute | Values | Description |
+| --- | --- | --- |
+| `data-quality` | `string` | Current quality value. |
+| `data-disabled` | Present / absent | Present when quality selection is disabled. |
+| `data-hidden` | Present / absent | Present when multiple renditions are unavailable. |
+| `data-availability` | `"available"` / `"unavailable"` | Whether multiple renditions are available. |
 
 Unavailable groups receive the native `hidden` attribute.
 
@@ -79,15 +54,9 @@ The element receives an accessible label from the `label` property or defaults t
 
 ### Basic usage
 
-Quality
-
-index.html
-
-index.css
-
-index.ts
+**index.html**
 
-```
+```html
 <video-player class="video-player">
   <media-container>
     <hlsjs-video
@@ -121,7 +90,10 @@ index.ts
   </media-container>
 </video-player>
 ```
-```
+
+**index.css**
+
+```css
 .video-player media-container {
   position: relative;
   display: block;
@@ -209,202 +181,58 @@ 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/quality-radio-group';
 ```
 
 ## API Reference
 
-### 
+### media-quality-radio-group
 
-media-quality-radio-group
-
-Owns quality option state and shares it with an enclosing menu. Does not render a DOM element.
+Menu radio group that generates an Auto `<media-menu-radio-item>` plus one per video rendition, and shares the selected label and availability with an enclosing menu. An optional `<template>` holding one `<media-menu-radio-item>` customizes each generated item; its `data-part` `label`, `tier`, and `badge` descendants receive the rendition's text.
 
 #### Props
 
-Prop
-
-Type
-
-Default
-
-Details
-
-`disabled`
-
-`boolean`
-
-`false`
-
-▸
-
-Attribute
-
-`disabled`
-
-Description
-
-Whether quality selection is disabled.
-
-`formatRendition`
-
-`string) | function`
-
-`formatRenditionLabel`
-
-▸
-
-Attribute
-
-`format-rendition`
-
-Description
-
-Custom formatter for visible rendition labels.
-
-Type
-
-`((rendition: MediaVideoRendition) => Text | string)`
-
-`label`
-
-`object`
-
-`''`
-
-▸
-
-Attribute
-
-`label`
-
-Description
-
-Custom label for the options group.
-
-Type
-
-`{ key: string; text: string } | string | ((state: QualityRadioGroupState) => Text | string)`
+| Prop | Type | Default | Description |
+| --- | --- | --- | --- |
+| `disabled` | `boolean` | `false` | Whether quality selection is disabled. |
+| `formatRendition` (attribute `format-rendition`) | `((rendition: MediaVideoRendition) => Text \| string)` | `formatRenditionLabel` | Custom formatter for visible rendition labels. |
+| `label` | `{ key: string; text: string } \| string \| ((state: QualityRadioGroupState) => Text \| string)` | `''` | Custom label for the options group. |
 
 #### State
 
 State is reflected as data attributes for CSS styling.
 
-Property
-
-Type
-
-Details
-
-`label`
-
-`{ key: string; text: string } | string`
-
-`value`
-
-`string`
-
-▸
-
-Description
-
-Current radio-group value.
-
-`options`
-
-`readonly Option[]`
-
-▸
-
-Description
-
-Ordered options displayed by platform adapters.
-
-`disabled`
-
-`boolean`
-
-▸
-
-Description
-
-Whether the entire option group is disabled.
-
-`hidden`
-
-`boolean`
-
-▸
-
-Description
-
-Whether the option group is hidden because no meaningful selection is available.
-
-`availability`
-
-`'available' | 'unavailable'`
-
-▸
-
-Description
-
-Whether the media exposes a meaningful selection.
+| 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
-
-Details
-
-`data-quality`
-
-`string`
-
-▸
-
-Description
-
-Current quality value.
-
-`data-disabled`
-
-▸
-
-Description
-
-Present when quality selection is disabled.
-
-`data-hidden`
-
-▸
-
-Description
-
-Present when quality selection is unavailable.
-
-`data-availability`
-
-`'available' | 'unavailable'`
-
-▸
-
-Description
-
-Indicates quality availability (`available` or `unavailable`).
+| Attribute | Type | Description |
+| --- | --- | --- |
+| `data-quality` | `string` | Current quality value. |
+| `data-disabled` | — | Present when quality selection is disabled. |
+| `data-hidden` | — | Present when quality selection is unavailable. |
+| `data-availability` | `'available' \| 'unavailable'` | Indicates quality availability (`available` or `unavailable`). |
 
 #### Events
 
-Event
-
-Description
-
-`value-change`
-
-Fired when the selected value changes.
+| Event | Description |
+| --- | --- |
+| `value-change` | Fired when the selected value changes. |

package/docs/reference/{seek-button.md → components/seek-button.md}

@@ -4,17 +4,13 @@ Accessible seek button for skipping forward or backward by a configurable number
 
 ## Import
 
-ts
-
-```
+```ts
 import '@videojs/html/ui/seek-button';
 ```
 
 ## Anatomy
 
-html
-
-```
+```html
 <media-seek-button></media-seek-button>
 ```
 
@@ -30,15 +26,9 @@ Renders a `<button>` with an automatic `aria-label` describing the action, e.g.
 
 ### Basic Usage
 
-⏪ 5s 10s ⏩
-
-index.html
+**index.html**
 
-index.css
-
-index.ts
-
-```
+```html
 <video-player class="video-player">
   <media-container>
     <video src="https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM/highest.mp4" autoplay muted playsinline loop></video>
@@ -53,7 +43,10 @@ index.ts
   </media-container>
 </video-player>
 ```
-```
+
+**index.css**
+
+```css
 .video-player media-container {
   position: relative;
 }
@@ -95,7 +88,10 @@ index.ts
   display: inline;
 }
 ```
-```
+
+**index.ts**
+
+```ts
 import '@videojs/html/video/player';
 import '@videojs/html/ui/container';
 import '@videojs/html/ui/seek-button';
@@ -105,122 +101,25 @@ import '@videojs/html/ui/seek-button';
 
 ### Props
 
-Prop
-
-Type
-
-Default
-
-Details
-
-`disabled`
-
-`boolean`
-
-`false`
-
-▸
-
-Attribute
-
-`disabled`
-
-Description
-
-Whether the button is disabled.
-
-`label`
-
-`object`
-
-`''`
-
-▸
-
-Attribute
-
-`label`
-
-Description
-
-Custom label for the button.
-
-Type
-
-`{ key: string; text: string } | string | ((state: SeekButtonState) => Text | string)`
-
-`seconds`
-
-`number`
-
-`30`
-
-▸
-
-Attribute
-
-`seconds`
-
-Description
-
-Seconds to seek. Positive = forward, negative = backward. Default `30`.
+| Prop | Type | Default | Description |
+| --- | --- | --- | --- |
+| `disabled` | `boolean` | `false` | Whether the button is disabled. |
+| `label` | `{ key: string; text: string } \| string \| ((state: SeekButtonState) => Text \| string)` | `''` | Custom label for the button. |
+| `seconds` | `number` | `30` | Seconds to seek. Positive = forward, negative = backward. Default `30`. |
 
 ### State
 
 State is reflected as data attributes for CSS styling.
 
-Property
-
-Type
-
-Details
-
-`label`
-
-`{ key: string; text: string } | string`
-
-`seeking`
-
-`boolean`
-
-▸
-
-Description
-
-Whether a seek is in progress.
-
-`direction`
-
-`'forward' | 'backward'`
-
-▸
-
-Description
-
-Whether the button seeks forward or backward.
+| Property | Type | Description |
+| --- | --- | --- |
+| `label` | `{ key: string; text: string } \| string` | |
+| `seeking` | `boolean` | Whether a seek is in progress. |
+| `direction` | `'forward' \| 'backward'` | Whether the button seeks forward or backward. |
 
 ### Data attributes
 
-Attribute
-
-Type
-
-Details
-
-`data-seeking`
-
-▸
-
-Description
-
-Present when a seek is in progress.
-
-`data-direction`
-
-`'forward' | 'backward'`
-
-▸
-
-Description
-
-Indicates the seek direction: `"forward"` or `"backward"`.
+| Attribute | Type | Description |
+| --- | --- | --- |
+| `data-seeking` | — | Present when a seek is in progress. |
+| `data-direction` | `'forward' \| 'backward'` | Indicates the seek direction: `"forward"` or `"backward"`. |