From 4cf69561c2bb2d28bb397648b956f5bf02d728f2 Mon Sep 17 00:00:00 2001 From: rahim Date: Tue, 10 Mar 2026 02:11:02 -0700 Subject: [PATCH] docs: use framework exports in player API examples (#821) --- packages/html/src/player/create-player.ts | 2 +- .../content/docs/reference/create-player.mdx | 8 ++++ .../docs/reference/html-create-player.mdx | 47 +++++++++---------- .../content/docs/reference/player-mixin.mdx | 36 -------------- .../content/docs/reference/select-buffer.mdx | 8 ++-- .../docs/reference/select-controls.mdx | 8 ++-- .../docs/reference/select-fullscreen.mdx | 8 ++-- .../src/content/docs/reference/select-pip.mdx | 8 ++-- .../docs/reference/select-playback-rate.mdx | 8 ++-- .../docs/reference/select-playback.mdx | 8 ++-- .../content/docs/reference/select-source.mdx | 8 ++-- .../content/docs/reference/select-time.mdx | 8 ++-- .../content/docs/reference/select-volume.mdx | 8 ++-- 13 files changed, 57 insertions(+), 108 deletions(-) delete mode 100644 site/src/content/docs/reference/player-mixin.mdx diff --git a/packages/html/src/player/create-player.ts b/packages/html/src/player/create-player.ts index 8b1bf8a8..933e25c9 100644 --- a/packages/html/src/player/create-player.ts +++ b/packages/html/src/player/create-player.ts @@ -40,7 +40,7 @@ export interface CreatePlayerResult { * * @example * ```ts - * import { createPlayer, MediaElement } from '@videojs/html'; + * import { createPlayer, MediaElement, selectPlayback } from '@videojs/html'; * import { videoFeatures } from '@videojs/html/video'; * * const { ProviderMixin, ContainerMixin, PlayerController, context } = createPlayer({ diff --git a/site/src/content/docs/reference/create-player.mdx b/site/src/content/docs/reference/create-player.mdx index f37e8171..ae1b69c9 100644 --- a/site/src/content/docs/reference/create-player.mdx +++ b/site/src/content/docs/reference/create-player.mdx @@ -15,6 +15,14 @@ import basicUsageReactCss from "@/components/docs/demos/create-player/react/css/ The hook is typed according to the provided features, giving you full type safety for state selectors and actions. +```tsx +import { createPlayer } from '@videojs/react'; +import { videoFeatures } from '@videojs/react/video'; + +const player = createPlayer({ features: videoFeatures }); +const { Provider, Container, usePlayer, useMedia } = player; +``` + ## Examples ### Basic Usage diff --git a/site/src/content/docs/reference/html-create-player.mdx b/site/src/content/docs/reference/html-create-player.mdx index c2441b0a..4bda2e32 100644 --- a/site/src/content/docs/reference/html-create-player.mdx +++ b/site/src/content/docs/reference/html-create-player.mdx @@ -15,53 +15,48 @@ import basicUsageHtmlTs from "@/components/docs/demos/html-create-player/html/cs `createPlayer` is the entry point for setting up a Video.js player with HTML custom elements. It accepts a configuration object with a `features` array and returns a typed `PlayerController`, `context`, `ProviderMixin`, `ContainerMixin`, and a `create` store factory. ```ts -import { createPlayer, MediaElement } from '@videojs/html'; +import { createPlayer, MediaElement, selectPlayback } from '@videojs/html'; import { videoFeatures } from '@videojs/html/video'; -const { - PlayerController, - context, - ProviderMixin, - ContainerMixin, - create, -} = createPlayer({ features: videoFeatures }); +const { ProviderMixin, ContainerMixin, PlayerController, context } = createPlayer({ + features: videoFeatures, +}); -// Provider element: owns and publishes the store +// Provider element: owns the store, provides context to descendants class VideoPlayer extends ProviderMixin(MediaElement) {} - -// Container element: discovers