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

package/docs/concepts/accessibility.md

@@ -1,68 +0,0 @@
-# Accessibility
-
-How Video.js approaches accessibility, and what you should consider if you're deeply customizing your player
-
-Video.js is built with accessibility in mind so your player can reach the widest possible audience.
-
-Here are some of the accessibility aspects we consider. You should consider them too if you’re performing deeper customization.
-
-## Standards we target
-
-*   [**WAI-ARIA 1.2**](https://www.w3.org/TR/wai-aria-1.2/) defines roles, states, and properties that [assistive technologies](https://www.w3.org/WAI/people-use-web/tools-techniques/) use to understand controls.
-*   [**WCAG 2.2**](https://www.w3.org/TR/WCAG22/) provides success criteria for perceivable, operable, understandable, and robust web content.
-*   [**CVAA**](https://www.fcc.gov/consumers/guides/21st-century-communications-and-video-accessibility-act-cvaa) is a U.S. federal law requiring closed captioning and accessible controls for video content.
-*   [**ADA**](https://www.ada.gov/) is a U.S. civil rights law that prohibits disability discrimination. Courts increasingly apply it to websites, including video players.
-
-## ARIA roles and labels
-
-Components set ARIA roles and attributes automatically. For example, sliders render with `role="slider"` and value attributes, buttons update their `aria-label` based on player state, and decorative elements like time separators are hidden with `aria-hidden="true"`.
-
-Verify that labels are contextually correct for your content and language. Each component’s reference page documents the attributes it sets.
-
-## Keyboard interaction
-
-All interactive components support keyboard control. For example, buttons activate with Enter and Space, sliders respond to Arrow keys, Home, End, and Page Up/Page Down, and popovers close with Escape. Each component’s reference page lists its full keyboard support. We follow the patterns in the [WAI-ARIA Authoring Practices Guide](https://www.w3.org/WAI/ARIA/apg/).
-
-## Focus management
-
-Interactive elements are focusable when enabled and leave the [tab order](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) when disabled. Popover triggers link to their popups with `aria-controls` and `aria-expanded`.
-
-The player container is focusable and labeled: it takes `role="group"`, `tabindex="0"`, and an `aria-label` you can override. Keyboard users can tab to the player as a whole, and screen readers announce it as a named group.
-
-## Status announcements
-
-The player announces confirmed state changes through a visually hidden live region (`role="status"`), so screen reader users hear when playback starts or pauses, captions turn on or off, fullscreen, picture-in-picture, playback rate, or volume change, and where a seek lands.
-
-Announcements follow confirmed state from the player store rather than requested changes, so routine time updates never reach the live region. Rapid volume and seek changes are grouped into a single announcement, and the player stays quiet while one of its sliders has focus, since the slider already announces its own value. State the store tracks is covered for you; a custom control that tracks its own state needs its own live region.
-
-## Captions and subtitles
-
-The [text tracks feature](../reference/feature-text-tracks.md) supports captions and subtitles. Closed captions in the U.S. are governed by the [FCC](https://www.fcc.gov/) under the [CVAA](https://www.fcc.gov/consumers/guides/21st-century-communications-and-video-accessibility-act-cvaa), which requires both captioning and viewer control over caption appearance (font, size, color, opacity, and edge style). Non-compliance carries legal risk. The [WebKit Caption Display Settings explainer](https://github.com/WebKit/explainers/tree/main/CaptionDisplaySettings) tracks how browsers are bringing these customization preferences into the web platform natively.
-
-## Color contrast
-
-Skins respond to [`prefers-contrast: more`](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-contrast) by increasing background opacity on overlays and controls, and to [`prefers-reduced-transparency: reduce`](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-reduced-transparency) by raising baseline opacity so text stays readable over video.
-
-Video is harder than most UI for contrast because the background is always changing. A control that passes checks over a dark frame can disappear over a bright title card. Automated tools won’t catch this, so test your controls against light, dark, and mixed video content. Custom components should test against [WCAG 1.4.3 (contrast minimum)](https://www.w3.org/WAI/WCAG22/Understanding/contrast-minimum) and [1.4.11 (non-text contrast)](https://www.w3.org/WAI/WCAG22/Understanding/non-text-contrast).
-
-## Touch targets
-
-Controls use rem-based sizing so they scale with the user’s font size preference. All interactive elements set [`touch-action: manipulation`](https://developer.mozilla.org/en-US/docs/Web/CSS/touch-action) to eliminate tap delay on touch devices. Skins use [`pointer: fine` and `pointer: coarse`](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/pointer) to adapt transitions for mouse and touch input.
-
-If you build custom controls, target at least 24x24 CSS pixels per [WCAG 2.5.8 (target size minimum)](https://www.w3.org/WAI/WCAG22/Understanding/target-size-minimum). Larger is better on touch-first surfaces.
-
-## Color scheme
-
-Skins adapt to [`prefers-color-scheme`](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme). Borders, backgrounds, and text colors adjust through CSS custom properties. Custom components can use the same design tokens. See [Skins](./skins.md) for details.
-
-## Reduced motion
-
-Skins respect [`prefers-reduced-motion`](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-reduced-motion) by simplifying or removing animations and transitions. Follow the same pattern in custom components.
-
-## Test with assistive technology
-
-Automated tools catch markup issues but miss real usability problems. Test your player with a [screen reader](https://www.w3.org/WAI/people-use-web/tools-techniques/) ([VoiceOver](https://support.apple.com/guide/voiceover/welcome/mac) on macOS, [NVDA](https://www.nvaccess.org/about-nvda/) or [JAWS](https://www.freedomscientific.com/products/software/jaws/) on Windows) and keyboard-only navigation. Verify that every control is reachable, operable, and announces its purpose and state. The [WAI “Easy Checks”](https://www.w3.org/WAI/test-evaluate/preliminary/) are a good starting point.
-
-## Further reading
-
-The W3C WAI guides on [making audio and video media accessible](https://www.w3.org/WAI/media/av/) and [accessible media players](https://www.w3.org/WAI/media/av/player/) go deeper on everything covered here.

package/docs/concepts/browser-support.md

@@ -1,45 +0,0 @@
-# Browser support
-
-Browsers and rendering environments supported by Video.js 10
-
-Support starts with an evergreen browser baseline and extends to the rendering environments described below.
-
-## Browser baseline
-
-Video.js 10 currently targets **evergreen browsers**: the latest two stable versions of Chrome, Firefox, Safari, and Edge.
-
-Note
-
-Video.js 10 is in beta. The browser support matrix may expand as we approach GA based on community feedback and usage data.
-
-### Why evergreen?
-
-Video.js 10 builds directly on the web platform: custom elements, CSS custom properties, anchor positioning, and modern JavaScript APIs. Targeting evergreen browsers lets us:
-
-*   **Ship smaller bundles** by avoiding polyfills and transpilation for outdated syntax
-*   **Use platform-native features** like `popover` and anchor positioning instead of JavaScript equivalents
-*   **Keep the core slim** so platform-specific adapters (HTML, React) add only what they need
-
-### Progressive enhancement
-
-When we use a platform feature that hasn’t landed in all supported browsers yet, we provide a fallback. The player works either way; the experience may differ slightly in older browsers. For example, tooltips and popovers use CSS anchor positioning where available and fall back to JavaScript-computed positioning where it isn’t.
-
-## Rendering contexts
-
-### WebViews
-
-A [WebView](https://developer.mozilla.org/en-US/docs/Glossary/WebView) is a browser engine embedded inside a native app. WebViews on iOS (WKWebView) and Android (Android WebView) can behave differently from the full browser; autoplay policies, fullscreen APIs, and hardware acceleration can vary.
-
-Video.js 10 beta targets standard browser environments. If you embed a player inside a native app, test it on each platform and WebView version you support.
-
-### Progressive Web Apps
-
-Installed Progressive Web Apps (PWAs) use the browser engine, but their standalone display mode and platform policies can affect fullscreen, media sessions, and other browser integration. Test playback both in a browser tab and in the installed app.
-
-### Smart TVs and set-top boxes
-
-TV platforms run embedded browsers with limited standards support. Video.js 10’s core is not tied to any specific platform, which makes future TV adapters possible, but TV is not a supported target today.
-
-### Server-side rendering
-
-Video.js components render valid markup on the server. Interactivity — state management, media playback, and event handling — requires the browser and kicks in after hydration.

package/docs/concepts/bundlers.md

@@ -1,43 +0,0 @@
-# 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/react/live-video`.
-
-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 a current Vite release. Testing confirmed that Vite 5.4.19 can load Video.js JavaScript and CSS package exports. Vite 3.2.8 can load the JavaScript, but it cannot load an exported stylesheet 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
-
-```
-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`.

package/docs/concepts/cdn.md

@@ -1,119 +0,0 @@
-# CDN
-
-The files the Video.js CDN serves and the layout rules behind their URLs
-
-Video.js can run straight from `<script>` tags. Our CDN serves `@videojs/html` in prebuilt, browser-ready bundles which register custom elements. For many pages, it takes only one script tag:
-
-index.html
-
-```
-<script type="module" src="https://cdn.jsdelivr.net/npm/@videojs/cdn@10.0.0-rc.1/video.js"></script>
-
-<video-player>
-  <video-skin>
-    <video src="video.mp4"></video>
-  </video-skin>
-</video-player>
-```
-
-## URLs
-
-Every file the CDN serves follows one URL pattern:
-
-code
-
-```
-https://cdn.jsdelivr.net/npm/@videojs/cdn@<version>/<file>
-```
-
-Pin all your CDN URLs to the same version.
-
-Bundles share content-hashed chunks that change between releases. A tag like `@latest` re-resolves over time, so two files might come from different releases and load duplicate modules that no longer share state.
-
-## Player bundles
-
-Each installation [preset](./presets.md) ships its bundles at the package root: one per skin choice, plus a player-only bundle. For the video preset:
-
-File
-
-Registers
-
-`video.js`
-
-`<video-player>`, `<video-skin>`, and the UI elements the skin composes
-
-`video-minimal.js`
-
-`<video-player>`, `<video-minimal-skin>`, and the UI elements the minimal skin composes
-
-`video-player.js`
-
-`<video-player>` alone, for markup without a packaged skin
-
-The other presets follow the same pattern. Background video is the exception: one bundle, `background.js`, registers the player, the skin, and the `<background-video>` media element.
-
-A skin bundle registers every UI element its skin is built from. The CDN publishes no per-component bundles, though. If you have [ejected a skin](../how-to/customize-skins.md#eject-and-edit-a-skin) and need to add new components, install from npm instead of from the CDN.
-
-## Media bundles
-
-The default presets play through the browser’s own `<video>` and `<audio>`. Every other [media element](./media-sources.md) is its own bundle under `media/`, loaded beside the player bundle:
-
-html
-
-```
-<script type="module" src="https://cdn.jsdelivr.net/npm/@videojs/cdn@10.0.0-rc.1/video.js"></script>
-<script type="module" src="https://cdn.jsdelivr.net/npm/@videojs/cdn@10.0.0-rc.1/media/hlsjs-video.js"></script>
-```
-
-Each path mirrors its npm subpath. Elements with more than one playback engine keep the extra flavors in a directory named for the element, such as `media/mux-video/spf.js`. Load one flavor per page: every flavor claims the same tag name, and the first registration wins.
-
-## Extension bundles
-
-Each [extension](./overview.md) is its own bundle under `extensions/`, loaded beside the player and media bundles:
-
-html
-
-```
-<script type="module" src="https://cdn.jsdelivr.net/npm/@videojs/cdn@10.0.0-rc.1/video.js"></script>
-<script type="module" src="https://cdn.jsdelivr.net/npm/@videojs/cdn@10.0.0-rc.1/media/mux-video.js"></script>
-<script type="module" src="https://cdn.jsdelivr.net/npm/@videojs/cdn@10.0.0-rc.1/extensions/mux-data.js"></script>
-```
-
-As with media, each path mirrors its npm subpath: `extensions/mux-data.js` registers the element that `@videojs/html/extensions/mux-data` does.
-
-## Locales
-
-English ships inside the skin bundles. Each other locale is a bundle under `locales/` that registers its translations on import. Load it before the player script to avoid a flash of English:
-
-html
-
-```
-<script type="module" src="https://cdn.jsdelivr.net/npm/@videojs/cdn@10.0.0-rc.1/locales/es.js"></script>
-<script type="module" src="https://cdn.jsdelivr.net/npm/@videojs/cdn@10.0.0-rc.1/video.js"></script>
-```
-
-One bundle exists per locale pack, plus bare-language aliases such as `pt`. For custom strings, see [Internationalize the player](../how-to/internationalize-the-player.md).
-
-## Stylesheets
-
-The skin bundles inline their CSS, so no `<link>` is required to render. The separate `.css` files do the jobs a bundle cannot:
-
-*   `global.css` holds the light-DOM rules. Link it in `<head>` and the player reserves its space before the elements upgrade. The background preset uses `background.css` instead.
-*   The skin sheets, such as `video.css` beside `video.js`, style declaratively rendered skins.
-*   `shared.css` is the base that hand-written shadow skins build on.
-
-[Self-host the player](../how-to/self-host-the-player.md) shows both in use.
-
-## Development bundles
-
-Every JavaScript entry has a `.dev.js` sibling, such as `video.dev.js`, built with development warnings on. Swap the suffix while debugging; swap it back to ship.
-
-## Shared chunks
-
-Everything else at the root, like the content-hashed `default-*.js` files, is a shared chunk the entries import by relative path. Entries share these chunks, so loading several bundles stays cheap. Chunk names change every release: never link a chunk directly, and never copy a lone entry file. To mirror the CDN, copy the whole package directory and keep its layout; [Self-host the player](../how-to/self-host-the-player.md) covers it.
-
-## Related guides
-
-*   [Installation](../how-to/installation.md)
-*   [Self-host the player](../how-to/self-host-the-player.md)
-*   [Internationalize the player](../how-to/internationalize-the-player.md)

package/docs/concepts/custom-element-lifecycle.md

@@ -1,115 +0,0 @@
-# Custom element lifecycle
-
-Choose the right Video.js HTML base class and clean up custom elements when they leave the page.
-
-This guide is for developers creating custom elements with `@videojs/html`. If you only compose or style Video.js’s built-in elements, you do not need to manage this lifecycle yourself.
-
-For most custom controls, extend `UIElement`, clean up listeners and observers in `disconnectedCallback()`, and call the matching superclass callbacks. Read the advanced sections if you are building a player root or media element, or if an element must remain alive while detached.
-
-## Clean up when the element disconnects
-
-The browser can call `connectedCallback()` and `disconnectedCallback()` many times for the same element. Start listeners, observers, and other connection-scoped work when the element connects. Stop that work when it disconnects. Call the superclass lifecycle methods so reactive controllers and inherited cleanup also run:
-
-ts
-
-```
-import { UIElement } from '@videojs/html';
-
-class StatusElement extends UIElement {
-  #disconnect: AbortController | null = null;
-
-  connectedCallback() {
-    super.connectedCallback();
-    this.#disconnect = new AbortController();
-    window.addEventListener('resize', this.#onResize, {
-      signal: this.#disconnect.signal,
-    });
-  }
-
-  disconnectedCallback() {
-    super.disconnectedCallback();
-    this.#disconnect?.abort();
-    this.#disconnect = null;
-  }
-
-  #onResize = () => this.requestUpdate();
-}
-```
-
-This cleanup runs every time the element leaves the document, including when an application moves the same element and later reconnects it.
-
-## Advanced lifecycle details
-
-The rest of this page covers permanent destruction, longer detached periods, player roots, and custom media elements. Most custom controls only need the connection cleanup above.
-
-### Release resources permanently
-
-`UIElement` waits for two animation frames after disconnection before it calls `destroy()`. Synchronous moves and brief reparenting that reconnect before the second frame keep the element alive.
-
-Reserve `destroyCallback()` for resources that should survive a temporary disconnect, such as an owned store or imperative player API. Call `super.destroyCallback()` so registered controllers also release their resources.
-
-After destruction, the mixin’s connection path and update execution no-op. Repeated `destroy()` calls also no-op. Do not reinsert a destroyed instance; create a new element instead. Subclass lifecycle code should still call its superclass methods and can check the public `destroyed` flag when it needs an explicit guard.
-
-### Keep an element alive while detached
-
-Add `keep-alive` to disable automatic destruction for an element that intentionally remains detached longer than two frames. The attribute does not disable manual cleanup: calling `destroy()` still permanently destroys the element.
-
-Caution
-
-`keep-alive` makes your code responsible for calling `destroy()` when the element is no longer needed.
-
-### Choose a specialized base
-
-Choose the narrowest base that provides the lifecycle your element needs:
-
-Base
-
-Lifecycle behavior
-
-Typical use
-
-`HTMLElement`
-
-Browser custom element callbacks only
-
-Elements that manage their own state and cleanup
-
-`ReactiveElement`
-
-Reactive properties, batched updates, and reactive controller callbacks
-
-Reactive elements that do not need permanent destruction
-
-`UIElement`
-
-`ReactiveElement` plus delayed permanent destruction
-
-Custom player controls and other interactive player UI
-
-`CustomMediaElement(...)` with `MediaAttachMixin`
-
-A media adapter lifecycle plus player registration
-
-Custom playback engines and media elements
-
-`PlayerElement`
-
-The `UIElement` lifecycle plus store context and attachment ownership
-
-Player roots
-
-Use `UIElement` for most custom controls. Use the specialized bases when your element owns a player store or media provider.
-
-### Specialized resource owners
-
-`PlayerElement` follows the `UIElement` lifecycle. It detaches the store’s current media target immediately in `disconnectedCallback()`, but keeps the store so a brief move can reconnect with its state intact. It destroys the store only from `destroyCallback()`.
-
-Built-in custom media elements compose `CustomMediaElement(...)` with [`MediaAttachMixin`](../reference/media-attach-mixin.md). `CustomMediaElement` queues one microtask after disconnection and destroys its media adapter only if it remains disconnected. This protects a synchronous move, but not a longer detached period. Its `keep-alive` attribute skips that automatic media-adapter destruction.
-
-Player roots use the configured [`PlayerElement`](../reference/player.md) returned by `createPlayer`.
-
-## See also
-
-*   [Build your own UI component](../how-to/build-your-own-component.md)
-*   [`PlayerElement`](../reference/player.md)
-*   [`MediaAttachMixin`](../reference/media-attach-mixin.md)

package/docs/concepts/features.md

@@ -1,131 +0,0 @@
-# Features
-
-The state and actions each feature adds to the player
-
-Not every player needs to support every use case. To address this, Video.js has a concept of **features** — self-contained units of player functionality. Each one adds state properties and actions to the player. For example, “playback” adds `paused` and `play()`, “volume” adds `volume` and `setVolume()`, and so on.
-
-## Using features
-
-### Feature bundles and presets
-
-You probably don’t want to hand-pick every feature your player needs. A **feature bundle** groups the features needed for a specific use case into a single array.
-
-For example, if you import `<video-player>` from the `/video` path, you will have playback, volume, time, fullscreen, and more already enabled.
-
-html
-
-```
-<script type="module">
-  import '@videojs/html/video/player';
-  import '@videojs/html/video/skin';
-</script>
-<video-player>
-  <video-skin>
-    <video src="movie.mp4"></video>
-  </video-skin>
-</video-player>
-```
-
-Feature bundles are usually paired with specific skins and media elements in a **preset**. To learn more about this, and the available presets, you’ll want to check out the presets guide.
-
-- [Learn more about presets](./presets.md)
-
-### Create a player with individual features
-
-If you’re not using presets, you can create a player that has individual features.
-
-ts
-
-```
-import { controlsFeature, createPlayer, playbackFeature, timeFeature, volumeFeature } from '@videojs/html';
-
-const { PlayerElement: MyPlayer } = createPlayer({
-  features: [playbackFeature, volumeFeature, timeFeature, controlsFeature],
-});
-
-customElements.define('my-player', MyPlayer);
-```
-
-### Extending a feature bundle
-
-Since feature bundles are just an array of features under the hood, it doesn’t take much to extend one. For example, if you were using the `/background` preset and wanted a play button on your background video, you might add the playback feature.
-
-ts
-
-```
-import { createPlayer, playbackFeature } from '@videojs/html';
-import { backgroundFeatures } from '@videojs/html/background';
-
-const { PlayerElement: MyPlayer } = createPlayer({
-  features: [...backgroundFeatures, playbackFeature],
-});
-
-customElements.define('my-player', MyPlayer);
-```
-
-### Access features in components
-
-You can access feature state and actions through [`PlayerController`](../reference/player-controller.md) and pre-built feature selectors (e.g. [`selectPlayback`](../reference/feature-playback.md), [`selectVolume`](../reference/feature-volume.md)):
-
-ts
-
-```
-import { selectPlayback } from '@videojs/html';
-
-// Subscribe to feature state (triggers element updates on change)
-readonly #playback = new PlayerController(this, selectPlayback);
-
-// Read state and call actions
-const media = this.#playback.value;
-if (media?.paused) media.play();
-```
-
-### Checking for feature support
-
-Volume, fullscreen, and picture-in-picture expose availability properties because platform support varies. Volume has two independent properties: `volumeAvailability` for changing the volume level and `mutedAvailability` for toggling mute. For example, iOS Safari allows muting but doesn’t allow programmatic volume control.
-
-Value
-
-Meaning
-
-`'available'`
-
-Ready to use
-
-`'unavailable'`
-
-Could work, not ready yet
-
-`'unsupported'`
-
-Platform can never do this
-
-Components that depend on availability (like [`MuteButton`](../reference/mute-button.md), [`PiPButton`](../reference/pip-button.md), and [`FullscreenButton`](../reference/fullscreen-button.md)) handle the three states for you:
-
-*   **`unsupported`** — the HTML custom element receives the native `hidden` attribute (and `data-hidden`); React buttons return `null`. No CSS needed.
-*   **`unavailable`** — the presentation controls stay hidden while capability detection is unresolved. Cast remains visible but disabled when its API is supported and no device is reachable.
-*   **`disabled` prop** — an available button stays visible and focusable with `aria-disabled="true"` plus `data-disabled` for styling.
-*   **`available`** — fully interactive.
-
-Use `data-disabled` to style the non-interactive state:
-
-css
-
-```
-media-pip-button[data-disabled] {
-  opacity: 0.5;
-  cursor: not-allowed;
-}
-```
-
-You can also check availability in JS:
-
-ts
-
-```
-const media = this.#pip.value;
-
-if (media?.pipAvailability !== 'available') {
-  this.hidden = true;
-}
-```