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

package/docs/guides/build-your-own-component.md

@@ -0,0 +1,182 @@
+# Build your own UI component
+
+Create custom player controls that read state, dispatch actions, and stay accessible.
+
+Custom components subscribe to player state and dispatch actions, like built-in controls.
+
+## You might not need a custom component
+
+Before building from scratch, check if an existing approach covers your use case:
+
+- **Change what a control renders**: use the `render` prop on any built-in component. See [UI components](./ui-components.md).
+- **Restyle a control**: use CSS custom properties and data attributes. See [UI components](./ui-components.md).
+- **Rearrange or remove controls**: add the skin source to your project, then modify it. See [Customize skins](./customize-skins.md#style-skin-source).
+
+Build a custom component when you need new behavior, a new state display, or integration with an external system.
+
+## Place your component in the player
+
+Your component needs to be inside [`<Player>`](../reference/components/player.md) to access state. Place it inside [`<Container>`](../reference/components/player-container.md) if it should also participate in fullscreen and respond to user activity:
+
+```tsx
+import { Container } from '@videojs/react';
+
+<Player>
+  <Container>
+    <VideoSkin>
+      <Video src="video.mp4" />
+    </VideoSkin>
+    <SkipIntroButton />
+  </Container>
+</Player>
+```
+
+## Full example
+
+A “skip intro” button that appears during the first 30 seconds of playback and seeks past the intro when clicked.
+
+**SkipIntroButton.tsx**
+
+```tsx
+// The preset's usePlayer is typed for its feature bundle
+import { usePlayer } from '@videojs/react/video';
+
+export function SkipIntroButton() {
+  const store = usePlayer();
+  const currentTime = usePlayer((s) => s.currentTime);
+  const paused = usePlayer((s) => s.paused);
+
+  const visible = currentTime < 30 && !paused;
+
+  return (
+    <button
+      className="skip-intro-button"
+      onClick={() => store.seek(30)}
+      aria-label="Skip intro"
+      // `undefined` removes the attribute; `false` would render data-visible="false"
+      data-visible={visible || undefined}
+      tabIndex={visible ? 0 : -1}
+    >
+      Skip intro
+    </button>
+  );
+}
+```
+
+**SkipIntroButton.css**
+
+```css
+.skip-intro-button {
+  position: absolute;
+  bottom: 5rem;
+  right: 1rem;
+  opacity: 0;
+  pointer-events: none;
+  transition: opacity 200ms;
+}
+
+.skip-intro-button[data-visible] {
+  opacity: 1;
+  pointer-events: auto;
+}
+```
+
+Your component needs to be inside a player, such as [`<VideoPlayer>`](../reference/components/player.md), to access state. Place it inside [`<Container>`](../reference/components/player-container.md) if it should also participate in fullscreen and respond to user activity:
+
+```tsx
+import { Container } from '@videojs/react';
+import { Video, VideoPlayer, VideoSkin } from '@videojs/react/video';
+import '@videojs/react/video/skin.css';
+
+import { SkipIntroButton } from './SkipIntroButton';
+
+export default function App() {
+  return (
+    <VideoPlayer>
+      <Container>
+        <VideoSkin>
+          <Video src="video.mp4" />
+        </VideoSkin>
+        <SkipIntroButton />
+      </Container>
+    </VideoPlayer>
+  );
+}
+```
+
+## How it works
+
+Custom components read player state and dispatch actions through [features](./features.md). Each feature exposes a set. Here are some features you might reach for first:
+
+| State | Actions | Feature |
+| --- | --- | --- |
+| `paused`, `ended` | `play()`, `pause()` | [Playback](../reference/api/feature-playback.md) |
+| `currentTime`, `duration` | `seek()` | [Time](../reference/api/feature-time.md) |
+| `volume`, `muted` | `setVolume()`, `toggleMuted()` | [Volume](../reference/api/feature-volume.md) |
+| `fullscreen` | `requestFullscreen()`, `exitFullscreen()` | [Fullscreen](../reference/api/feature-fullscreen.md) |
+
+The API reference lists every feature with the state and actions it adds.
+
+Access state and actions with the [`usePlayer`](../reference/api/use-player.md) hook from your player’s preset. It knows which features that preset has, so state and actions are typed. (The standalone `usePlayer` export from `@videojs/react` returns an untyped store, so its values are `unknown` in TypeScript.) If you built the player with a custom feature set through [`createPlayer`](../reference/api/create-player.md) — the escape hatch for custom feature sets — use the `usePlayer` it returns instead.
+
+```tsx
+import { usePlayer } from '@videojs/react/video';
+
+// Subscribe to state — re-renders only when selected values change
+const paused = usePlayer((s) => s.paused);
+const currentTime = usePlayer((s) => s.currentTime);
+
+// Get the store for dispatching actions (does not subscribe)
+const store = usePlayer();
+
+await store.play();
+store.setVolume(0.5);
+store.seek(30);
+```
+
+Custom controls also need real button semantics — the examples above set the accessible name and keyboard focus by hand.
+
+- [Learn more about accessibility in video players](./accessibility.md)
+
+## Availability and constraints
+
+- Features are configured per player, so a feature your component asks for may not be present. Selectors return `undefined` for a missing feature; guard the value before using it, as the example does.
+- Volume, fullscreen, picture-in-picture, and remote playback also expose an `*Availability` property (`'available'`, `'unavailable'`, or `'unsupported'`) for hiding controls the platform does not support. See [Features](./features.md) for details.
+
+## Common variations
+
+Before building from scratch, check if an existing approach covers your use case. Build a custom component when you need new behavior, a new state display, or integration with an external system.
+
+### Change what a built-in control renders
+
+Use the `render` prop on any built-in component. See [UI components](./ui-components.md).
+
+### Restyle a control
+
+Use CSS custom properties and data attributes. See [UI components](./ui-components.md).
+
+### Rearrange or remove controls
+
+Add the skin source to your project and modify it. See [Customize skins](./customize-skins.md#style-skin-source).
+
+## Troubleshooting
+
+### State and actions are typed as `unknown`
+
+You’re using the standalone `usePlayer` export, which doesn’t know which features your player has. Import `usePlayer` from your player’s preset (for example `@videojs/react/video`), or use the hook returned by `createPlayer` if you built the player with a custom feature set.
+
+### The component renders but never updates
+
+The component sits outside the player (such as `<VideoPlayer>`), so `usePlayer` has no store to subscribe to.
+
+## Related pages
+
+### API
+
+- [usePlayer](../reference/api/use-player.md): Hook to access the player store from within a Player
+- [createPlayer](../reference/api/create-player.md): Factory function that creates a typed Player component and hooks
+- [Container](../reference/components/player-container.md): The player's visual and interaction surface for layout, fullscreen, focus, and user activity.
+
+### Guides
+
+- [Customize skins](./customize-skins.md): Style a packaged Video.js skin or add its source to change controls, layout, styles, and interactions

package/docs/guides/bundlers.md

@@ -0,0 +1,50 @@
+# 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/react/video` 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 Vite 4.1 or later; Video.js has been tested through Vite 8. Earlier versions can’t resolve exported stylesheets such as `@videojs/react/video/skin.css`.
+
+React skins ship their stylesheet as a separate export: an application that renders `VideoSkin` from `@videojs/react/video` also imports `@videojs/react/video/skin.css`, so this limitation applies to every React application that uses a packaged skin.
+
+## 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/react']` misses imports such as `@videojs/react/video`.
+
+Match the package name and everything below it instead:
+
+**rollup.config.js**
+
+```js
+const videojsPeers = ['@videojs/react'];
+
+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`.
+
+## Related pages
+
+### Guides
+
+- [Installation](./installation.md): Install Video.js packages and build an accessible, customizable video player with composable controls
+- [TypeScript](./typescript.md): TypeScript version and module resolution requirements for Video.js packages

package/docs/guides/captions.md

@@ -0,0 +1,155 @@
+# Show captions and subtitles
+
+Show captions and subtitles, and let users turn them on and pick a language.
+
+> **Note**
+>
+> Using a pre-built [skin](./skins.md)? It already includes the controls shown here. You may still need the media or player setup in this guide. The component examples are for building your own player UI from individual [components](./ui-components.md).
+
+## Recommended approach
+
+Add WebVTT tracks as `<track>` children of the media element, and give users a [CaptionsButton](../reference/components/captions-button.md) to toggle them.
+
+**App.tsx**
+
+```tsx
+import { CaptionsButton, Container } 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 loop>
+          <track kind="captions" src="/docs/demos/text-tracks/captions.vtt" srcLang="en" label="English" default />
+        </Video>
+        <CaptionsButton
+          className="media-captions-button"
+          render={(props, state) => (
+            <button {...props}>{state.subtitlesShowing ? 'Captions Off' : 'Captions On'}</button>
+          )}
+        />
+      </Container>
+    </VideoPlayer>
+  );
+}
+```
+
+**App.css**
+
+```css
+.media-container {
+  position: relative;
+}
+
+.media-container video {
+  width: 100%;
+  aspect-ratio: 16 / 9;
+}
+
+.media-captions-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 [text track feature](../reference/api/feature-text-tracks.md) mirrors the media element’s `textTracks` into player state:
+
+- `textTrackList` holds every track with its `id`, `kind`, `label`, `language`, and `mode`.
+- `subtitlesShowing` is `true` when any caption or subtitle track is showing.
+- `toggleSubtitles(forceShow?)` shows or hides all caption and subtitle tracks.
+- `selectSubtitlesTrack(id)` shows one track and disables the rest; pass `'off'` to disable all.
+
+Tracks don’t have to come from `<track>` elements: tracks that streaming media exposes (for example in-manifest HLS captions) appear in `textTrackList` the same way.
+
+The browser renders the cues. Style them with the `::cue` pseudo-element.
+
+## Availability and constraints
+
+- Captions availability is `'unavailable'` until the media has at least one caption or subtitle track; caption controls render nothing in that case.
+- Cues load asynchronously. A track appears in `textTrackList` before its cues are parsed, so cue-driven UI fills in when the track finishes loading.
+- Cross-origin track files require CORS: serve the VTT with CORS headers and set `crossOrigin` on the media element.
+- Track selection UIs identify tracks by `label` and `language`; give every track both.
+- `default` on a `<track>` makes the browser show it initially.
+
+## Common variations
+
+### Language selection menu
+
+For multiple languages, render a menu instead of a toggle.
+
+`useCaptionsOptions` provides the option list (including “Off”), the selected value, and availability:
+
+```tsx
+import { Menu, useCaptionsOptions } from '@videojs/react';
+
+function CaptionsMenu() {
+  const captions = useCaptionsOptions();
+  if (captions?.state.availability !== 'available') return null;
+
+  return (
+    <Menu.Root side="top" align="end">
+      <Menu.Trigger render={<button type="button" />}>Captions</Menu.Trigger>
+      <Menu.Content>
+        <Menu.RadioGroup value={captions.value} onValueChange={captions.setValue} aria-label="Captions">
+          {captions.options.map((option) => (
+            <Menu.RadioItem key={option.value} value={option.value} disabled={option.disabled}>
+              {option.label}
+            </Menu.RadioItem>
+          ))}
+        </Menu.RadioGroup>
+      </Menu.Content>
+    </Menu.Root>
+  );
+}
+```
+
+See the [CaptionsRadioGroup](../reference/components/captions-radio-group.md) reference for the complete pattern.
+
+## Troubleshooting
+
+### Captions don’t appear
+
+Confirm that:
+
+- The track `kind` is `captions` or `subtitles`.
+- The VTT file loads (check the network panel for the track request).
+- The track is enabled: `default` on the track element, a CaptionsButton toggle, or `toggleSubtitles(true)`.
+
+### Captions work locally but not in production
+
+The track file is served from another origin without CORS headers. Serve it with `Access-Control-Allow-Origin` and set `crossOrigin` on the media element.
+
+### The selection menu is empty
+
+The media has no caption or subtitle tracks, so captions availability is `'unavailable'`. For streaming sources, confirm the manifest actually declares text tracks.
+
+## Related pages
+
+### Components
+
+- [CaptionsButton](../reference/components/captions-button.md): Accessible captions toggle button with availability detection and state reflection
+- [CaptionsRadioGroup](../reference/components/captions-radio-group.md): A menu radio group for selecting caption and subtitle tracks
+- [Menu](../reference/components/menu.md): A composable menu component for settings, option selection, and actions
+
+### API
+
+- [Text tracks](../reference/api/feature-text-tracks.md): Subtitles, captions, and chapter track state for the player store
+- [useCaptionsOptions](../reference/api/use-captions-options.md): Hook to build captions menu options from the player text track state
+
+### Guides
+
+- [Show timeline thumbnail previews](./thumbnails.md): Preview frames along the timeline while the user scrubs, powered by a storyboard track.
+- [Media sources](./media-sources.md): Set what a media element plays and how its engine plays it with the structured source property
+- [Accessibility](./accessibility.md): How Video.js approaches accessibility, and what you should consider if you're deeply customizing your player

package/docs/guides/casting.md

@@ -0,0 +1,159 @@
+# Cast to AirPlay and Chromecast
+
+Send playback to AirPlay and Google Cast devices, with availability detection and connection state.
+
+Send playback to an Apple TV over AirPlay or a Chromecast over Google Cast while the browser stays in control.
+
+> **Note**
+>
+> Using a pre-built [skin](./skins.md)? It already includes the controls shown here. You may still need the media or player setup in this guide. The component examples are for building your own player UI from individual [components](./ui-components.md).
+
+## Recommended approach
+
+Use the [GoogleCast extension](../reference/components/google-cast.md) with a [CastButton](../reference/components/cast-button.md), and add an [AirPlayButton](../reference/components/airplay-button.md) for Safari. The prebuilt skins already include both buttons; add `GoogleCast` next to a streaming media component to enable the configurable Cast route.
+
+**App.tsx**
+
+```tsx
+import { AirPlayButton, CastButton, Container, createPlayer } from '@videojs/react';
+import { GoogleCast } from '@videojs/react/extensions/google-cast';
+import { HlsJsVideo } from '@videojs/react/media/hlsjs-video';
+import { videoFeatures } from '@videojs/react/video';
+
+const { Player } = createPlayer({ features: videoFeatures });
+
+export default function BasicUsage() {
+  return (
+    <Player>
+      <Container className="media-container">
+        <HlsJsVideo src="https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM.m3u8" autoPlay muted playsInline loop />
+        <GoogleCast />
+        <div className="media-remote-buttons">
+          <AirPlayButton
+            className="media-airplay-button"
+            render={(props, state) => (
+              <button {...props}>{state.state === 'connected' ? 'Stop AirPlay' : 'Start AirPlay'}</button>
+            )}
+          />
+          <CastButton
+            className="media-cast-button"
+            render={(props, state) => (
+              <button {...props}>{state.connection === 'connected' ? 'Stop casting' : 'Start casting'}</button>
+            )}
+          />
+        </div>
+      </Container>
+    </Player>
+  );
+}
+```
+
+**App.css**
+
+```css
+.media-container {
+  position: relative;
+}
+
+.media-container video {
+  width: 100%;
+}
+
+.media-remote-buttons {
+  position: absolute;
+  right: 10px;
+  bottom: 10px;
+  display: flex;
+  gap: 8px;
+}
+
+.media-airplay-button,
+.media-cast-button {
+  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);
+}
+
+.media-airplay-button[data-disabled],
+.media-cast-button[data-disabled] {
+  cursor: not-allowed;
+  opacity: 0.5;
+  filter: grayscale(1);
+}
+```
+
+The demo pairs the streaming media component with the `GoogleCast` extension. Without that extension, `CastButton` drives the browser’s native Remote Playback API instead, which does not provide Video.js receiver or load-request configuration.
+
+## How it works
+
+The [remote playback feature](../reference/api/feature-remote-playback.md) gives AirPlay and Google Cast one state shape:
+
+- `remotePlaybackAvailability` is `'available'` when a remote device can be reached, `'unavailable'` when the API exists but no device is reachable, and `'unsupported'` when the browser has no remote playback route.
+- `remotePlaybackState` is `'disconnected'`, `'connecting'`, or `'connected'`.
+- `toggleRemotePlayback()` opens the browser’s device picker, or disconnects an active session.
+
+AirPlay uses WebKit’s presentation APIs. Google Cast uses a sender and receiver: the browser sends the receiver a media URL and then controls playback. Your UI reads the same Video.js state for either route.
+
+While connected, playback actions — play, pause, seek, volume — proxy to the remote device, and player state keeps reflecting the remote session. Local playback is suspended.
+
+The Google Cast SDK loads only when the `GoogleCast` extension is present in a Chromium browser. Players without that extension and browsers that cannot cast do not load it.
+
+## Availability and constraints
+
+- Remote playback is asynchronous and can fail mid-session when a device or network disappears. React to `remotePlaybackState` rather than assuming a request succeeds.
+- Google Cast works only in Chromium-based browsers; elsewhere its route reports `'unsupported'`.
+- AirPlay works only in Safari; availability requires an AirPlay device reachable on the network.
+- The remote device fetches the source and tracks itself. Localhost, VPN-only, expired, or cross-origin URLs without the necessary CORS headers will fail on the receiver even if they play in the browser.
+- Set `disableRemotePlayback` on the media element to opt out entirely.
+
+## Common variations
+
+### Custom Cast receiver
+
+By default, Video.js sends the current source to Google’s Default Media Receiver. Set `receiver` when you have your own receiver application:
+
+```tsx
+<GoogleCast receiver="YOUR_APP_ID" />
+```
+
+Use `src` and `contentType` when the receiver should load a different source than the browser. `streamType` and `customData` let you describe that source and attach application-specific data. See the [GoogleCast reference](../reference/components/google-cast.md) for the exact option types.
+
+### Read connection state
+
+Use `remotePlaybackAvailability` to decide whether to offer a route and `remotePlaybackState` to show whether it is disconnected, connecting, or connected. `CastButton` and `AirPlayButton` already apply these states to their presentation; read them directly only when another part of your app needs them.
+
+## Troubleshooting
+
+### The cast button doesn’t render, or renders disabled
+
+The Cast button hides when the route is unsupported. In Chromium with no Cast device reachable, it stays visible but disabled. The AirPlay button hides unless Safari reports an AirPlay device.
+
+### Casting starts but the device shows an error
+
+The receiver cannot fetch the media. Confirm the source URL is reachable from the device and served with CORS headers, including caption tracks.
+
+### The UI freezes on “connecting”
+
+The user dismissed the picker or the device disconnected. `remotePlaybackState` returns to `'disconnected'`; drive your UI from that state.
+
+## Related pages
+
+### Components
+
+- [CastButton](../reference/components/cast-button.md): Accessible Cast toggle button with state reflection and keyboard support
+- [AirPlayButton](../reference/components/airplay-button.md): Accessible AirPlay toggle button that opens the WebKit playback target picker and reflects session state
+- [GoogleCast](../reference/components/google-cast.md): Options for the Google Cast extension that configures the receiver and load request
+
+### API
+
+- [Remote Playback](../reference/api/feature-remote-playback.md): Remote playback state and actions for the player store
+- [HlsJsVideo](../reference/components/hlsjs-video.md): HLS video element powered by hls.js for adaptive bitrate streaming
+
+### Guides
+
+- [Media sources](./media-sources.md): Set what a media element plays and how its engine plays it with the structured source property

package/docs/guides/content-security-policy.md

@@ -0,0 +1,36 @@
+# Content Security Policy
+
+Allow the media, images, workers, and styles a Video.js player needs when your page enforces a Content Security Policy
+
+Content Security Policy (CSP) limits which resources a page can load. Video.js uses the URLs you configure for media, posters, thumbnails, and captions. Some HLS renderers also create blob URLs or web workers, so your policy must allow those resources too.
+
+## Allow player resources
+
+- `media-src` must allow your media URLs.
+- `img-src` must allow any poster or thumbnail image URLs.
+- `connect-src` must allow HLS manifests, playlists, captions, and segment requests when using HLS playback.
+- `media-src blob:` is required when using the HLS player variants, which use MSE-backed playback.
+- `worker-src blob:` is required when using the `hls.js` player variants.
+- `style-src 'unsafe-inline'` is required for some player UI.
+
+## Recommended policy
+
+```http
+Content-Security-Policy:
+  script-src 'self';
+  style-src 'self' 'unsafe-inline';
+  img-src 'self' https: data: blob:;
+  media-src 'self' https: blob:;
+  connect-src 'self' https:;
+  worker-src 'self' blob:;
+```
+
+This policy assumes you bundle Video.js with your application or serve it from your own origin. If you load the player from a CDN, add that CDN’s origin to `script-src`.
+
+Replace broad sources such as `https:` with the exact origins your player uses. Remove sources your deployment does not need, and keep `blob:` only where your selected HLS renderer requires it.
+
+## Related pages
+
+### Guides
+
+- [Installation](./installation.md): Install Video.js packages and build an accessible, customizable video player with composable controls