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

package/docs/guides/accessibility.md

@@ -0,0 +1,93 @@
+# 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.
+- [**European Accessibility Act**](https://eur-lex.europa.eu/eli/dir/2019/882/oj) applies across the EU from June 28, 2025, and covers services such as e-commerce and audiovisual media. [**EN 301 549**](https://www.etsi.org/human-factors-accessibility/en-301-549-v3-the-harmonized-european-standard-for-ict-accessibility) is the European standard for meeting it, and it incorporates WCAG.
+
+These standards and laws are listed for context, not as legal advice. Check which ones apply to your product.
+
+## 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"`.
+
+Built-in labels are translated. See [Internationalize the player](./internationalization.md) to add or switch locales, and verify that labels are contextually correct for your content. Each component’s reference page documents the attributes it sets.
+
+Tooltips are visual only. They are not linked to their trigger with `aria-describedby`, so a custom trigger needs its own accessible name. Built-in media buttons already have one.
+
+## 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/).
+
+Player-wide shortcuts, such as Space to play or M to mute, and tap gestures come from hotkey and gesture components. The skins ship a full set, and custom UI declares its own. See [Add keyboard shortcuts and gestures](./keyboard-shortcuts.md).
+
+## 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`. Menus and popovers close when focus moves away.
+
+Dialogs move focus inside when they open, keep Tab within the dialog, and make the content behind them inert. Closing a dialog returns focus to its trigger, or to the element that had focus before it opened.
+
+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. The skins include the [status announcer](../reference/components/status-announcer.md). A custom layout needs to add it. State the store tracks is covered once it’s there; a custom control that tracks its own state needs its own live region.
+
+## Captions and subtitles
+
+The [text tracks feature](../reference/api/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.
+
+Video.js leaves caption rendering to the browser, and you style cues with the `::cue` pseudo-element. It doesn’t include a menu for caption appearance, so viewers rely on the caption preferences their browser and operating system provide. The [WebKit Caption Display Settings explainer](https://github.com/WebKit/explainers/tree/main/CaptionDisplaySettings) tracks how browsers are bringing these preferences into the web platform. See [Show captions and subtitles](./captions.md) to add tracks and a captions control.
+
+## Transcripts and audio description
+
+Captions don’t cover every viewer. [WCAG 2.2](https://www.w3.org/WAI/WCAG22/Understanding/audio-description-or-media-alternative-prerecorded) also expects audio description or a text alternative for prerecorded video. A transcript can live inside the [player](../reference/components/player.md) but outside its container, so it reads player state without going fullscreen with the video. When a stream includes a described audio track, an [audio track menu](../reference/components/audio-track-radio-group.md) lets viewers choose it.
+
+## 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
+
+Skin controls size from `--media-scale-unit`, which defaults to `16px`, so they don’t grow with the user’s font size preference. Set it to `1rem` to scale with the document root font size. See [Customize skins](./customize-skins.md#scale-from-the-document-font-size).
+
+Skin buttons set [`touch-action: manipulation`](https://developer.mozilla.org/en-US/docs/Web/CSS/touch-action) to remove tap delay on touch devices, and sliders set `touch-action: none` so dragging doesn’t scroll the page. 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
+
+The audio skins switch their palette for light and dark mode with [`light-dark()`](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/light-dark), which follows the inherited [`color-scheme`](https://developer.mozilla.org/en-US/docs/Web/CSS/color-scheme), not the user’s preference directly. Set `color-scheme: light dark` on the page or the player to follow the user’s setting. The video skins keep dark controls in both schemes; only their border follows it. See [Customize skins](./customize-skins.md#set-the-color-scheme).
+
+## 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.
+
+That covers the controls, not the video. Video.js doesn’t pause or hide autoplaying video for reduced-motion users; your page decides that.
+
+## Autoplay and moving video
+
+[WCAG 2.2.2](https://www.w3.org/WAI/WCAG22/Understanding/pause-stop-hide) requires a way to pause, stop, or hide motion that starts automatically and lasts more than five seconds. A muted, looping hero video counts. Give it a pause control, or keep it short.
+
+A purely decorative video should be hidden from assistive technology with `aria-hidden="true"` on its wrapper. If the video carries information, give it an accessible name and controls, and use a regular player. See [Add a background video](./background-video.md) and [Autoplay](./autoplay.md).
+
+## 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/guides/architecture.md

@@ -0,0 +1,118 @@
+# Architecture
+
+How Video.js players are structured — state, UI, media, and extensions
+
+Video.js v10 separates player responsibilities into parts that work independently or together, so you can use as much or as little of Video.js as you need.
+
+For the reasoning behind this design, see [Why Video.js?](./why-videojs.md).
+
+## State management
+
+State is handled by a preset player component, which creates a central state store that all components can access. When you wrap your player in `VideoPlayer`, the components automatically connect to the state.
+
+```tsx
+{/* All components inside automatically connect to state */}
+<VideoPlayer>
+  <VideoSkin>
+    <Video src="video.mp4" />
+  </VideoSkin>
+</VideoPlayer>
+```
+
+You can access state and actions from anywhere within `VideoPlayer` with the [`usePlayer` hook](../reference/api/use-player.md).
+
+- [Learn more about state and actions](./features.md)
+
+## User interface
+
+Use a prebuilt **skin** or build your own from the individual **UI components**.
+
+### Skins
+
+Skins are complete, pre-designed player UIs that package components and styles together. They give you a polished starting point, with a small set of CSS custom properties for common visual changes. They don’t try to cover every player with options.
+
+```tsx
+<VideoPlayer>
+  <VideoSkin>
+    <Video src="video.mp4" />
+  </VideoSkin>
+</VideoPlayer>
+```
+
+- [Learn more about skins](./skins.md)
+
+### UI components
+
+If you want more control than a packaged skin offers, build your own UI from our components. Add, remove, and rearrange them to build the player you need.
+
+```tsx
+<VideoPlayer>
+  <Container>
+    <Video src="video.mp4" />
+    <Controls.Root>
+      <Controls.Content>
+        <PlayButton />
+        {/* ... */}
+      </Controls.Content>
+    </Controls.Root>
+  </Container>
+</VideoPlayer>
+```
+
+Skin source is a practical foundation for custom UI because it provides the same styled components as the packaged version. See [Customize skins](./customize-skins.md#style-skin-source) to add it to your project.
+
+- [Learn more about UI components](./ui-components.md)
+- [Build your own component](./build-your-own-component.md)
+
+## Media
+
+Media components are the components that actually display your media. They’re essentially “players with no UI”. They handle the video/audio rendering and expose a consistent API.
+
+Media components can be format specific (HLS, DASH), service specific (YouTube, Vimeo, Mux), or use case specific (background video).
+
+```tsx
+<VideoPlayer>
+  <VideoSkin>
+    <HlsJsVideo src="https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM.m3u8" />
+  </VideoSkin>
+</VideoPlayer>
+```
+
+- [Learn more about media](./media-sources.md)
+
+## Extensions
+
+Extensions add behavior to a player without rendering UI or playing media themselves.
+
+```tsx
+<VideoPlayer>
+  <VideoSkin>
+    <MuxVideo source={{ playbackId: 'PLAYBACK_ID' }} />
+    <MuxData />
+    <GoogleCast />
+  </VideoSkin>
+</VideoPlayer>
+```
+
+An extension can provide behavior that a UI component controls: GoogleCast supplies the configurable Cast route, and [CastButton](../reference/components/cast-button.md) renders the control that starts and ends a session.
+
+## Presets
+
+**Presets** preconfigure the state, UI, and media for a specific use case. Extensions stay opt-in, so add them to a preset player when you need them.
+
+The default presets are `@videojs/react/video` and `@videojs/react/audio`, covering the baseline set of controls you’d expect from the HTML `<video>` and `<audio>` tags.
+
+Beyond the defaults, presets target more specific use cases. The `/background` preset combines a media element with autoplay, mute, and loop built in, a skin with no controls, and only the features needed to power it.
+
+You can use it from `@videojs/react/background`.
+
+- [Learn more about presets](./presets.md)
+
+## Related pages
+
+### Guides
+
+- [Installation](./installation.md): Install Video.js packages and build an accessible, customizable video player with composable controls
+- [Features](./features.md): The state and actions each feature adds to the player
+- [Skins](./skins.md): Packaged player designs that include both UI components and their styles.
+- [Presets](./presets.md): Pre-packaged player configurations that bundle state management, skins, and media elements for specific use cases.

package/docs/guides/autoplay.md

@@ -0,0 +1,173 @@
+# Autoplay
+
+Start playback automatically and handle browser autoplay restrictions.
+
+For the best chance of autoplay succeeding, start playback muted and enable inline playback. Autoplay is a request, not a guarantee: browsers can block it based on audio state, prior interaction with your site, browser settings, and platform policy.
+
+## Recommended approach
+
+Set autoplay, muted, and inline playback on the media element, and keep a manual play control available for when autoplay is blocked.
+
+**App.tsx**
+
+```tsx
+import { Container, PlayButton } from '@videojs/react';
+import { Video, VideoPlayer } from '@videojs/react/video';
+
+export default function BasicUsage() {
+  return (
+    <VideoPlayer>
+      <Container className="media-container">
+        <Video src="https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM/highest.mp4" autoPlay muted playsInline />
+        <PlayButton
+          className="media-play-button"
+          render={(props, state) => (
+            <button {...props}>{state.ended ? 'Replay' : state.paused ? 'Play' : 'Pause'}</button>
+          )}
+        />
+      </Container>
+    </VideoPlayer>
+  );
+}
+```
+
+**App.css**
+
+```css
+.media-container {
+  position: relative;
+}
+
+.media-container video {
+  width: 100%;
+  aspect-ratio: 16 / 9;
+}
+
+.media-play-button {
+  position: absolute;
+  bottom: 10px;
+  left: 10px;
+  padding-block: 8px;
+  padding-inline: 20px;
+  color: black;
+  cursor: pointer;
+  background: rgba(255, 255, 255, 0.7);
+  border: 1px solid rgba(255, 255, 255, 0.3);
+  border-radius: 9999px;
+  backdrop-filter: blur(10px);
+}
+```
+
+## How it works
+
+The `autoPlay`, `muted`, and `playsInline` props on [`Video`](../reference/api/create-player.md) and similar media components pass through to the underlying media element. When the media element supports them, they’re applied, and playback is requested as soon as the media has enough data.
+
+The [playback feature](../reference/api/feature-playback.md) reflects the result in player state. When autoplay succeeds, `paused` becomes `false` and `started` becomes `true`. When the browser blocks autoplay, the player stays `paused: true` with `started: false`, and the [Play button](../reference/components/play-button.md) renders its play state. There is no separate autoplay failure event: a blocked autoplay looks like media that never started.
+
+Calling `play()` from player state returns the native promise from the media element. When the browser blocks playback, that promise rejects with a `NotAllowedError`.
+
+## Availability and constraints
+
+- Autoplay can fail. Browsers decide per page load based on audio state, whether the user has interacted with your site before, browser settings, and platform policy.
+- Muted autoplay is broadly allowed. Unmuted autoplay is blocked on first visit in most browsers; do not rely on it.
+- Without inline playback, iPhone Safari opens the video in fullscreen when playback starts.
+- Low-power mode and data-saver settings can block even muted autoplay. This is why the recommended approach keeps a manual play control.
+- Programmatic volume control is unsupported on some platforms. The [volume feature](../reference/api/feature-volume.md) exposes this as `volumeAvailability: 'available' | 'unavailable' | 'unsupported'`; iOS Safari reports `'unsupported'`, and `'unavailable'` means the feature hasn’t attached to a media element yet.
+- This guide applies to media components that render a video element (Video, HlsJsVideo, DashVideo, MuxVideo, and the like). Embed components (YouTube, Vimeo, TikTok, Twitch) forward autoplay to the third-party player, which applies its own autoplay rules; muted and inline behavior varies by provider.
+
+## Common variations
+
+### Background video
+
+Background video autoplays, loops, stays muted, and omits interactive controls. Use `HlsBackgroundVideo` instead of configuring these behaviors yourself: it applies them by default and streams an HLS source, picking one rendition that fits the screen for the whole session.
+
+Install the SPF adapter with the React façade:
+
+```bash
+pnpm add @videojs/react @videojs/spf
+```
+
+```tsx
+import { HlsBackgroundVideo } from '@videojs/react/media/hls-background-video';
+
+export default function Hero() {
+  return <HlsBackgroundVideo src="https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM.m3u8" />;
+}
+```
+
+If you have a progressive MP4 or WebM file instead of an HLS stream, `BackgroundVideo` is the same component without the streaming engine. See [BackgroundVideo](../reference/components/background-video.md) for opt-out props and sizing.
+
+### Autoplay with sound
+
+Do not rely on unmuted autoplay for a user’s first visit. Start playback from an explicit user action instead.
+
+Call `play()` from the player store returned by [`usePlayer`](../reference/api/use-player.md):
+
+```tsx
+import { Container } from '@videojs/react';
+import { usePlayer, Video, VideoPlayer } from '@videojs/react/video';
+
+function StartPlaybackButton() {
+  const store = usePlayer();
+
+  return (
+    <button type="button" onClick={() => store.play()}>
+      Play video
+    </button>
+  );
+}
+
+export default function App() {
+  return (
+    <VideoPlayer>
+      <Container>
+        <Video src="https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM/highest.mp4" playsInline />
+        <StartPlaybackButton />
+      </Container>
+    </VideoPlayer>
+  );
+}
+```
+
+Because playback starts from a user gesture, the browser allows it unmuted.
+
+## Troubleshooting
+
+### Playback does not start
+
+Confirm that:
+
+- The media is muted.
+- Inline playback is enabled.
+- The source loads (check the network panel).
+- A manual play control is available as a fallback.
+
+If autoplay is blocked, the player stays paused and the Play button remains in its play state; there is no error state to handle.
+
+### The video opens fullscreen on iPhone
+
+Enable inline playback with the `playsInline` prop on the media component.
+
+### The video starts without sound
+
+Expected with muted autoplay. Let the user unmute through a [Mute button](../reference/components/mute-button.md) or [Volume slider](../reference/components/volume-slider.md) rather than unmuting programmatically; programmatic volume changes are unsupported on some platforms.
+
+## Related pages
+
+### Components
+
+- [PlayButton](../reference/components/play-button.md): Accessible play/pause button with keyboard support and customizable rendering
+- [MuteButton](../reference/components/mute-button.md): Accessible mute/unmute button with keyboard support and volume state reflection
+- [BackgroundVideo](../reference/components/background-video.md): Decorative background video element with automatic muting and looping
+- [Controls](../reference/components/controls.md): Container component for composing and auto-hiding video player controls on user interaction
+
+### API
+
+- [Playback](../reference/api/feature-playback.md): Play/pause state and actions for the player store
+- [Volume](../reference/api/feature-volume.md): Volume level and mute state for the player store
+- [usePlayer](../reference/api/use-player.md): Hook to access the player store from within a Player
+
+### Guides
+
+- [Features](./features.md): The state and actions each feature adds to the player
+- [Browser support](./browser-support.md): Browsers and rendering environments supported by Video.js 10, and what the stylesheets need from them

package/docs/guides/background-video.md

@@ -0,0 +1,202 @@
+# 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/components/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.
+
+**App.tsx**
+
+```tsx
+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>
+  );
+}
+```
+
+**App.css**
+
+```css
+.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/components/hls-background-video.md) |
+| The same background-only player for a Mux HLS URL | [MuxBackgroundVideo](../reference/components/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 pages
+
+### Components
+
+- [BackgroundVideo](../reference/components/background-video.md): Decorative background video element with automatic muting and looping
+- [HlsBackgroundVideo](../reference/components/hls-background-video.md): HLS background video without controls, audio, captions, or adaptive quality
+- [MuxBackgroundVideo](../reference/components/mux-background-video.md): Mux-specific name for the HLS background video component
+
+### Guides
+
+- [Add a poster and loading placeholder](./poster.md): Set the image shown before playback, then add a lightweight placeholder while it loads