Repository navigation
docs(site): stop using internal APIs in examples - #3066
Conversation
Examples now import only public API from @videojs/html and @videojs/react: - The Video.js 8 migration guide points to platform APIs instead of @videojs/utils. - The createPlayer and PlayerController demos use plain listeners and attributes instead of createButton, applyElementProps, and applyStateDataAttrs. - The i18n demos list their locales instead of importing LOCALES. - build-your-own-component writes out the PropertyValues type, and create-i18n imports ReactiveElement from @videojs/html. - use-container no longer names usePlayerContext. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WLkDiofiR86hzNgRopBotH
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
@videojs/cdn
@videojs/cli
@videojs/core
@videojs/element
@videojs/html
@videojs/media
@videojs/react
@videojs/spf
@videojs/store
@videojs/utils
@videojs/cloudflare-video
@videojs/dash-video
@videojs/hlsjs-video
@videojs/mux-audio
@videojs/mux-video
@videojs/native-hls-video
@videojs/shaka-video
@videojs/spotify-audio
@videojs/tiktok-video
@videojs/twitch-video
@videojs/vimeo-video
@videojs/wistia-video
@videojs/youtube-video
@videojs/google-cast
@videojs/mux-data
commit: |
📦 Bundle Size Report🎨 @videojs/html — no changesPresets (7)
Media (18)
Players (5)
Skins (41)
UI Components (62)
⚛️ @videojs/react — no changesPresets (7)
Media (22)
Extensions (2)
Players (5)
Skins (26)
UI Components (39)
🧩 @videojs/core — no changesEntries (76)
🏷️ @videojs/element — no changesEntries (2)
📦 @videojs/store — no changesEntries (3)
🔧 @videojs/utils — no changesEntries (13)
📦 @videojs/cdn — no changes📦 @videojs/cloudflare-video — no changes📦 @videojs/dash-video — no changes📦 @videojs/google-cast — no changes📦 @videojs/hlsjs-video — no changes📦 @videojs/media — no changesEntries (3)
📦 @videojs/mux — no changes📦 @videojs/mux-audio — no changesEntries (2)
📦 @videojs/mux-data — no changes📦 @videojs/mux-video — no changesEntries (2)
📦 @videojs/native-hls-video — no changes📦 @videojs/shaka-video — no changes📦 @videojs/spf — no changesEntries (7)
📦 @videojs/spotify-audio — no changes📦 @videojs/tiktok-video — no changes📦 @videojs/twitch-video — no changes📦 @videojs/other — no changesEntries (3)
📦 @videojs/vimeo-video — no changes📦 @videojs/wistia-video — no changesEntries (2)
📦 @videojs/youtube-video — no changesℹ️ How to interpretEach entry is independently bundled, minified, and brotli-compressed. Initial size includes its static import graph; lazy dynamic chunks are reported separately. Entries are not additive because their dependency graphs overlap. Preset rows represent realistic combined bundles. Changes of 300 B or less across initial, lazy, and total size are collapsed, not discarded. Run |
…text name The migration guides and createI18n examples now extend UIElement, the documented base class, instead of ReactiveElement, which is internal. build-your-own-component destructured `context` from createPlayer, but the field is `playerContext`. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WLkDiofiR86hzNgRopBotH
✅ Deploy Preview for vjs10-site ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for vjs-registry ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Guard the migration guide's formatTime helper against NaN, Infinity, and negative input, pass an empty target to lodash merge, and rename the utilities section. Correct what HTML createPlayer returns in the migration and live-stream guides, and name the typed context in the custom-component troubleshooting note. Drop the unused VJS10_UTILS_CDN_BASE placeholder. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WLkDiofiR86hzNgRopBotH
…7ams8m-docs # Conflicts: # site/src/content/docs/guides/live-streams.mdx # site/src/content/docs/guides/migrate-from-video-js-8.mdx
|
This PR only changes site docs, a site constant and its test. It doesn't touch the packages or e2e pages those browsers load, so this is a BrowserStack connection problem, not a regression from this PR. No fix is needed here, so I've re-run the failed job once. Generated by Claude Code |
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 0de6a70. Configure here.
…tton Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WLkDiofiR86hzNgRopBotH
|
The Website Tests
All three came in with #3087 and fail with
Generated by Claude Code |
…7ams8m-docs # Conflicts: # site/src/utils/satteriCdnVersion.ts # site/src/utils/tests/satteriCdnVersion.test.ts

Part 3 of the API stability stack: #3073 → #3063 → this PR → #3067 → #3082 → #3068 → #3083.
Summary
After this change, docs examples import only public API from
@videojs/htmland@videojs/react.@videojs/utils, which is internal. It now suggests platform APIs, lodash, or a shortformatTimehelper, and the utils install step is gone.html-create-playerandplayer-controllerdemos: they use plain listeners, a native<button>, andtoggleAttributeinstead ofcreateButton,applyElementProps, andapplyStateDataAttrs.LOCALES.build-your-own-component: the HTML examples pass the contextcreatePlayerreturns instead of the sharedplayerContext.PropertyValuesstays, since feat(site): check that undocumented public exports are tagged internal #3063 now treats it as stable.create-i18n:ReactiveElementis imported from@videojs/html, not@videojs/element.use-container: the page no longer names the internalusePlayerContexthook.Preview pages
Demos (worth clicking through):
html-create-player: HTMLplayer-controller: HTMLProse and code examples:
createI18n: React · HTMLuseContainer: ReactReviewer notes
html-create-playerkeyboard handling: the demo used to make the custom element itself behave like a button withrole="button"andtabindex="0". A native<button>inside it now handles focus and keyboard activation. Worth a quick look in the browser.html-create-playerstyling:data-pausedanddata-endedare now set on the host element, so the demo CSS selectors changed to match.Intl.DurationFormatis mentioned only as "in browsers that support it".🤖 Generated with Claude Code
https://claude.ai/code/session_01WLkDiofiR86hzNgRopBotH
Note
Low Risk
Documentation and demo-only changes with no runtime product behavior; reviewers may want a quick pass on the html-create-player demo (native button vs former custom-element button semantics).
Overview
Docs and demos now stick to public
@videojs/html/@videojs/reactAPIs so examples match the API stability story (part 3 of the stack).HTML demos (
html-create-player,player-controller): dropcreateButton,applyElementProps, andapplyStateDataAttrsin favor of a native<button>,clicklisteners, andtoggleAttributefor play/pause state; play-toggle CSS targetsdemo-play-toggleon the host withdata-paused.i18n demos: hard-code locale lists instead of importing internal
LOCALES.Guides & reference: migration snippets use
UIElement(notReactiveElement); build-your-own-component showsplayerContextfromcreatePlayer; migrate-from-video-js-8 renames “Moved utilities” to Replace v8 utilities and removes@videojs/utils/ CDN install—recommends platform APIs, lodash, or an inlineformatTime; use-container no longer namesusePlayerContext; create-i18n importsUIElementfrom@videojs/html.Site tooling: remove
VJS10_UTILS_CDN_BASEfromconsts, the satteri placeholder, and the related test.Reviewed by Cursor Bugbot for commit 3055287. Bugbot is set up for automated code reviews on this repo. Configure here.