@videojs/react 10.0.0-beta.8 → 10.0.0-rc.1

package/docs/concepts/typescript.md

@@ -0,0 +1,34 @@
+# TypeScript
+
+TypeScript version and module resolution requirements for Video.js packages
+
+Video.js packages require **TypeScript 5.0 or newer**. TypeScript must also follow the import paths that each package publishes.
+
+## TypeScript version
+
+Video.js type files use syntax introduced in TypeScript 5.0. Older versions cannot read that syntax. The `skipLibCheck` option does not help because TypeScript must read a type file before it can skip checking it.
+
+## Module resolution
+
+Video.js packages define their supported import paths using [package exports](./bundlers.md). Most web applications should use the following configuration. It makes TypeScript follow the same package rules as the bundler that builds the application:
+
+tsconfig.json
+
+```
+{
+  "compilerOptions": {
+    "module": "ESNext",
+    "moduleResolution": "bundler"
+  }
+}
+```
+
+If Node.js runs files emitted directly by TypeScript, use `node16` for both `module` and `moduleResolution`, or use `nodenext` for both.
+
+Do not use the older `node` setting, now called `node10`. It does not understand package exports and can report valid Video.js imports or types as missing.
+
+## Errors from other dependencies
+
+The older `node` setting allowed applications to import almost any file inside a dependency. Modern settings allow only the paths that dependency publishes. Changing the setting can therefore reveal an existing import into another package’s private files.
+
+If the error names a package outside `@videojs/*`, update that dependency or use one of its supported import paths. A TypeScript `paths` override can be a temporary bridge when no supported replacement exists. Do not switch back to the older resolver because that also breaks Video.js type resolution.

package/docs/concepts/ui-components.md

@@ -0,0 +1,90 @@
+# UI components
+
+How Video.js UI components use focused elements, data attributes for state, and compound composition.
+
+UI components are controls like buttons, sliders, and time displays.
+
+Visible UI components render at most one HTML element, taking inspiration from projects like [shadcn/ui](https://ui.shadcn.com/) and [Base UI](https://base-ui.com/). This approach gives you control over styling and behavior while handling the complex interactions for you. State-only components render no markup, and controls can skip rendering when their feature is unavailable.
+
+Individual controls provide interaction, accessible names, and state. You add their visible text or icons and CSS. Sliders also need the child elements and styles shown on their reference pages.
+
+## Where to put your components
+
+UI components can go anywhere inside a [`<Player>`](../reference/player.md).
+
+However, you should consider placing your components in `<Container>`. Components in `<Container>` will go fullscreen with the player, respond to user activity, and more.
+
+- [Read more about <Container>](../reference/player-container.md)
+
+## Styling and customization
+
+For components you add yourself, use the documented props, state `data-*` attributes, and CSS custom properties. Add your own `className` when you need a selector.
+
+### The `render` prop
+
+The `render` prop is the primary customization mechanism. It accepts a function that receives `props` and `state`, and returns your element. The `props` object includes event handlers, ARIA attributes, data attributes, and a ref — always spread `{...props}` to keep everything working:
+
+tsx
+
+```
+import { PlayButton } from '@videojs/react';
+import { PauseIcon, PlayIcon } from '@videojs/react/icons';
+
+<PlayButton
+  render={(props, state) => (
+    <button {...props}>
+      {state.paused ? <PlayIcon /> : <PauseIcon />}
+    </button>
+  )}
+/>
+```
+
+`className` and `style` also accept functions of state for dynamic styling without a full render prop:
+
+tsx
+
+```
+<PlayButton
+  className={(state) =>
+    state.paused ? 'btn btn--paused' : 'btn btn--playing'
+  }
+/>
+```
+
+### Data attributes and CSS custom properties
+
+Components reflect player state as `data-*` attributes on their element. For example, `data-paused` or `data-volume-level="high"`.
+
+This lets you style state changes in pure CSS:
+
+css
+
+```
+/* Show/hide icons based on play state */
+.play-icon  { display: none; }
+.pause-icon { display: none; }
+
+button[data-paused] .play-icon        { display: inline; }
+button:not([data-paused]) .pause-icon { display: inline; }
+```
+
+Each component’s reference page documents its full set of data attributes.
+
+Some components also expose **CSS custom properties** for continuous values like fill percentage and pointer position. Sliders, for example, set `--media-slider-fill` and `--media-slider-pointer`. See individual component reference pages for specifics.
+
+## Compound components
+
+Complex interactions are split into composable parts. A parent manages shared state while children consume it. Each visible part owns at most one element.
+
+Compound components use dot notation off a shared namespace:
+
+tsx
+
+```
+<VolumeSlider.Root orientation="vertical">
+  <VolumeSlider.Track>
+    <VolumeSlider.Fill />
+  </VolumeSlider.Track>
+  <VolumeSlider.Thumb />
+</VolumeSlider.Root>
+```

package/docs/concepts/v10-roadmap.md

@@ -0,0 +1,75 @@
+# v10 Roadmap
+
+Timeline and milestones for Video.js v10 rebuild and the future of v8
+
+Video.js v10 is a complete rebuild from the ground up, designed to be more modular, framework-flexible, and aligned with modern web development practices.
+
+## Current versions
+
+### Version 8
+
+*   Maintained with bug fixes and critical security patches only
+*   No new features will be planned
+*   Community contributions still welcome
+*   Documentation available at [legacy.videojs.org](https://legacy.videojs.org)
+
+### Version 9
+
+*   Reserved only for urgent API-breaking changes that cannot be avoided
+
+## March 2026: v10 Beta Release
+
+Wider testing release to the community.
+
+### Core feature parity target
+
+*   Basic control set (play, pause, seek, volume, fullscreen)
+*   Adaptive streaming support via existing community engines
+*   No plugin migrations yet, without plugin author contribution
+
+### What to expect
+
+*   Close to stable, but API changes are still possible
+*   Intended for experimental adoption in real-world projects
+*   Developers encouraged to follow the [installation guide](../how-to/installation.md), try it out, and report issues
+
+## Mid-2026: v10 GA Release
+
+**Stable release** of Video.js v10
+
+### Feature targets
+
+*   Core feature parity with v8 in terms of fundamentals
+*   Feature parity with Media Chrome, Vidstack, Plyr, and Mux Player
+*   Community encouraged to begin full reintegration projects, following the migration guides for [Video.js 8](../how-to/migrate-from-video-js-8.md), [Mux Player](../how-to/migrate-from-mux-player.md), [Plyr](../how-to/migrate-from-plyr.md), and [Media Chrome](../how-to/migrate-from-media-chrome.md)
+*   Plugin ecosystem migration begins in earnest
+
+### Engine development focus
+
+*   Lightweight adaptive streaming
+*   MoQ (Media over QUIC) support
+
+## Late-2026: Feature parity with v8 Contrib
+
+**Extended feature parity** with Video.js “contrib” plugins:
+
+*   Ads integration
+*   Analytics support
+*   Further community plugin migration dependent on contributions
+
+## End-of-life plan for Video.js v8
+
+### Mid-2026
+
+*   v8/v9 moved to “video.js-legacy” repository and package
+*   Documentation preserved at [legacy.videojs.org](https://legacy.videojs.org)
+*   Hosted CDN copies will remain available
+
+### 2027 and beyond
+
+*   Security patches only
+*   Community contributions de-prioritized
+
+* * *
+
+**Want to contribute?** Check out the [v10 repository on GitHub](https://github.com/videojs/v10) to get involved in the rebuild

package/docs/concepts/why-videojs.md

@@ -0,0 +1,119 @@
+# Why Video.js?
+
+The open-source video player for React and HTML. Lightweight, accessible components built for performance and streaming.
+
+Video.js is the open-source video player for the web. It makes web video easy, performant, accessible, and customizable.
+
+Let’s dig into when you’d want to use Video.js, starting with the question we hear most…
+
+## Why not `<video>`?
+
+The native `<video>` tag is great if you can describe your video as an image with a play button. Past that, the gaps show up quickly.
+
+### Cross-browser inconsistency
+
+Chrome, Safari, and Firefox each render the default `<video>` controls differently. You can hide them, but you can’t deeply style or rearrange them. Building UI that matches your product means starting from scratch.
+
+![Chrome's default video controls](/_astro/chrome-default-controls.D2ybhMTL.png)
+
+Chrome
+
+![Safari's default video controls](/_astro/safari-default-controls.CPUt6ekS.png)
+
+Safari
+
+![Firefox's default video controls](/_astro/firefox-default-controls.CYiJeU98.png)
+
+Firefox
+
+### Video interactions
+
+Video often involves more than an MP4 in `src`. Features like thumbnail previews, adaptive bitrate, quality selection, chapters, audio track switching, localized controls, error UI, live-streaming UI, AirPlay, and DRM are *possible* with the video element, but require complex wiring and careful work on maintainability and [accessibility](./accessibility.md).
+
+Video.js provides accessible, composable building blocks for these common playback and streaming features. Other integrations, including ads and emerging media formats, remain under development as version 10 matures.
+
+### Streaming formats and sources
+
+Behind features like adaptive bitrate and quality selection are streaming formats such as HLS and DASH. They split video into segments that a playback engine can select based on bandwidth and preferences. Choose the matching Video.js media component to play these formats across browsers while keeping the surrounding player state and UI consistent.
+
+Of course, your video might not be coming from a `src` like that. It might be provided by a service. However, services like YouTube, Vimeo, and Mux each speak their own API. Video.js gives their media components a consistent interface, so changing providers doesn’t require rebuilding the player around them.
+
+That boundary also gives us a path to future sources such as canvas-based MoQ playback and use cases such as animated GIF replacement without rebuilding the controls around them.
+
+## Why Video.js?
+
+Video.js is built at Mux by the teams behind Video.js, Plyr, Vidstack, and Media Chrome, with contributions from engineers across other player projects. Between us, our projects have served tens of billions of monthly video plays. Most of the choices on this page came from things we got wrong the first time, then the second, then the fifth. We’ve been supporting your edge cases for over a decade. Now we’re shipping the player we always wanted to build.
+
+Let’s dig into some of the design principles that help explain why we built Video.js and why it may be the best choice for your project or team.
+
+### Add only what you need
+
+Most player libraries ship every feature in one bundle, so you carry code you don’t run. If your video doesn’t need a feature like DRM, why ship that code? Video.js turns features into independent, *composable* modules. You hand `createPlayer` the array you actually want, and what you don’t import doesn’t ship.
+
+tsx
+
+```
+import { createPlayer, playbackFeature, timeFeature } from '@videojs/react';
+
+const { Player } = createPlayer({
+  features: [playbackFeature, timeFeature],
+});
+```
+
+- [Learn more about features](./features.md)
+
+Of course, you don’t have to think about every feature you’re going to need if you don’t want to. Pre-built feature bundles are still there if you’d rather not assemble the list by hand.
+
+- [Learn more about presets](./presets.md)
+
+### Framework-native
+
+Many player libraries wrap a single web component for every framework. That works, until you reach the seams: refs you can’t pass through, state that doesn’t reconcile, prop names that aren’t quite React or HTML. Video.js ships idiomatic APIs for its supported frameworks: React components and hooks for React, and custom elements and controllers for HTML.
+
+The player feels like the rest of your app.
+
+React
+
+HTML
+
+```
+import { VideoPlayer, Video, VideoSkin } from '@videojs/react/video';
+import '@videojs/react/video/skin.css';
+
+function MyPlayer() {
+  return (
+    <VideoPlayer>
+      <VideoSkin>
+        <Video src="movie.mp4" />
+      </VideoSkin>
+    </VideoPlayer>
+  );
+}
+```
+
+```
+<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>
+```
+
+### Eject and own
+
+Most player libraries draw a line between “configurable through props” and “fork the source.” Cross the line and you’re on your own. Video.js lets you eject any skin and walk away with the source: components in your framework’s language that you can read and change. The skin you ship is yours; the rest of the player keeps working underneath it.
+
+We don’t want to cram every possible player into one configuration API. Packaged skins cover common visual changes. For everything else, eject early and compose the UI you need.
+
+- [Customize skins](../how-to/customize-skins.md#eject-and-edit-a-skin)
+
+### AI-native DX
+
+Documentation aimed at human readers usually doesn’t help an agent. Video.js publishes an `llms.txt` index, ships every docs page as both HTML and Markdown, and has a dedicated guide for building with AI assistants. Drop the player into a Claude or Cursor session and the docs come along for the ride.
+
+- [Build with AI](../how-to/build-with-ai.md)

package/docs/how-to/add-a-background-video.md

@@ -0,0 +1,218 @@
+# Add a background video
+
+Add an accessible background video from an MP4, WebM, HLS, or Mux source
+
+Add a decorative video behind your page content. Start with an MP4 or WebM file, which browsers can play directly. If your video is delivered as HLS, use the HLS or Mux option below.
+
+## Recommended approach
+
+Use [BackgroundVideo](../reference/background-video.md) with an MP4 or WebM URL. Put the video and poster inside a wrapper with `aria-hidden="true"` because both are decorative. Keep the heading, links, and other page content outside that wrapper.
+
+![](https://image.mux.com/601n4w1fq88NJiVpzvrQQeQfNnnjjfKMIN7dCGAEarTs/thumbnail.webp)
+
+### Build the next great video experience
+
+[Compare source options](#common-variations)
+
+App.tsx
+
+App.css
+
+```
+import { BackgroundVideo } from '@videojs/react/media/background-video';
+
+export default function BasicUsage() {
+  return (
+    <section className="add-background-video-react-demo">
+      <div className="add-background-video-react-demo__visual" aria-hidden="true">
+        <img className="add-background-video-react-demo__poster" src="https://image.mux.com/601n4w1fq88NJiVpzvrQQeQfNnnjjfKMIN7dCGAEarTs/thumbnail.webp" alt="" />
+        <BackgroundVideo className="add-background-video-react-demo__media" src="https://stream.mux.com/601n4w1fq88NJiVpzvrQQeQfNnnjjfKMIN7dCGAEarTs/highest.mp4" />
+      </div>
+      <div className="add-background-video-react-demo__content">
+        <h3>Build the next great video experience</h3>
+        <a href="#common-variations">Compare source options</a>
+      </div>
+    </section>
+  );
+}
+```
+```
+.add-background-video-react-demo {
+  position: relative;
+  display: grid;
+  min-height: 18rem;
+  overflow: hidden;
+  color: white;
+  background: black;
+  border-radius: 0.5rem;
+  isolation: isolate;
+}
+
+.add-background-video-react-demo__visual,
+.add-background-video-react-demo__poster,
+.add-background-video-react-demo__media {
+  position: absolute;
+  inset: 0;
+  width: 100%;
+  height: 100%;
+}
+
+.add-background-video-react-demo__visual {
+  pointer-events: none;
+}
+
+.add-background-video-react-demo__visual::after {
+  position: absolute;
+  inset: 0;
+  content: "";
+  background: linear-gradient(90deg, rgb(0 0 0 / 85%), rgb(0 0 0 / 55%));
+}
+
+.add-background-video-react-demo__poster,
+.add-background-video-react-demo__media {
+  display: block;
+  object-fit: cover;
+}
+
+.add-background-video-react-demo__media {
+  --media-object-fit: cover;
+  --media-object-position: center;
+}
+
+.add-background-video-react-demo__content {
+  position: relative;
+  z-index: 1;
+  display: grid;
+  gap: 1rem;
+  place-content: end start;
+  max-width: 28rem;
+  padding: 2rem;
+}
+
+.add-background-video-react-demo__content h3 {
+  margin: 0;
+  font-size: 1.75rem;
+  line-height: 1.1;
+}
+
+.add-background-video-react-demo__content a {
+  width: fit-content;
+  padding: 0.625rem 1rem;
+  color: black;
+  text-decoration: none;
+  background: white;
+  border-radius: 0.25rem;
+}
+
+.add-background-video-react-demo__content a:focus-visible {
+  outline: 0.2rem solid white;
+  outline-offset: 0.2rem;
+}
+
+@media (prefers-reduced-motion: reduce) {
+  .add-background-video-react-demo__media {
+    display: none;
+  }
+}
+```
+
+## How it works
+
+BackgroundVideo renders the browser’s `<video>` element and starts it muted, looped, autoplaying, and inline. The example puts that video and an empty-alt poster in the `.hero-visual` wrapper. The wrapper is hidden from assistive technology and ignores pointer input, so it does not act like a media player.
+
+The page defines the hero’s size. The video fills that space with `--media-object-fit: cover`, while the poster remains visible until the video paints a frame. The reduced-motion rule hides the video and leaves the poster in place.
+
+Set the size, position, and transforms on the `.hero-visual` wrapper so the poster and video stay together.
+
+## Availability and constraints
+
+*   Use a source the browser can play directly, such as MP4 or WebM.
+*   Safari can play HLS URLs directly. Other browsers cannot do so reliably, so use an HLS variation below when the same `.m3u8` URL must work across browsers.
+*   BackgroundVideo does not create a poster or report analytics. Keep the poster in your page and add analytics only when you need them.
+*   Video.js does not apply a reduced-motion policy for you. The example stops the decoration with `prefers-reduced-motion`.
+*   If the video communicates information, remove `aria-hidden`, give it an accessible name and controls, and use a regular video player.
+
+## Common variations
+
+Choose a variation based on the source you already have:
+
+Need
+
+Use
+
+Cross-browser HLS with a small background-only player
+
+[HlsBackgroundVideo](../reference/hls-background-video.md)
+
+The same background-only player for a Mux HLS URL
+
+[MuxBackgroundVideo](../reference/mux-background-video.md)
+
+### Play an HLS video
+
+HlsBackgroundVideo plays an HLS video without adding controls, audio, or captions. Pass a complete HLS URL through `src`:
+
+bash
+
+```
+pnpm add @videojs/react @videojs/spf
+```
+
+tsx
+
+```
+import { HlsBackgroundVideo } from '@videojs/react/media/hls-background-video';
+
+<HlsBackgroundVideo
+  className="hero-media"
+  src="https://media.example.com/hero.m3u8"
+  crossOrigin="anonymous"
+  onError={() => console.error('The background stream could not play')}
+/>
+```
+
+Your HLS stream must be unencrypted and use fragmented MP4 video segments, also called fMP4 or CMAF. The component chooses one video size when playback starts and does not switch sizes later. It cannot play older MPEG-TS segments.
+
+### Play a Mux HLS URL
+
+MuxBackgroundVideo is a Mux-named alias for HlsBackgroundVideo. Pass a complete Mux HLS URL, not a bare playback ID or `source` object:
+
+It uses the same `@videojs/spf` installation shown for HlsBackgroundVideo above.
+
+tsx
+
+```
+import { MuxBackgroundVideo } from '@videojs/react/media/mux-background-video';
+
+<MuxBackgroundVideo
+  className="hero-media"
+  src="https://stream.mux.com/PLAYBACK_ID.m3u8?max_resolution=720p"
+  crossOrigin="anonymous"
+/>
+```
+
+This component does not create a Mux poster, preview thumbnails, or analytics session. Keep the poster in your page and add analytics separately when you need them.
+
+## Troubleshooting
+
+### An HLS URL works in Safari but not another browser
+
+BackgroundVideo hands its `src` to the browser’s `<video>` element. Use HlsBackgroundVideo for a supported fMP4 HLS source, or MuxBackgroundVideo for a Mux HLS URL.
+
+### The video does not fill or follow transforms
+
+Set the size, transforms, and measurements on the wrapper that contains the video and poster. Size the background-video component to fill that wrapper.
+
+### No poster or Mux analytics appear
+
+The background-video components do not provide them. Render an empty-alt poster in the same wrapper as the video, and add analytics separately.
+
+## Related components
+
+*   [BackgroundVideo](../reference/background-video.md)
+*   [HlsBackgroundVideo](../reference/hls-background-video.md)
+*   [MuxBackgroundVideo](../reference/mux-background-video.md)
+
+## Related guides
+
+*   [Add a poster and loading placeholder](./add-a-poster-and-loading-placeholder.md)