This repository was archived by the owner on Oct 21, 2026. It is now read-only.
Repository navigation
docs(site): correct stale playback and package guidance - #3076
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
✅ Deploy Preview for vjs-registry ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for vjs10-site ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
@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: |
Contributor
📦 Bundle Size Report🎨 @videojs/html — 21 small size changes
Presets (7)
Media (18)
Players (5)
Skins (29)
UI Components (62)
⚛️ @videojs/react — 13 small size changes
Presets (7)
Media (22)
Extensions (2)
Players (5)
Skins (18)
UI Components (39)
🧩 @videojs/core — 2 small size changes
Entries (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 — 1 small size change
Entries (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 |
mihar-22
marked this pull request as ready for review
September 30, 2026 20:51
This was referenced Sep 30, 2026
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Revalidated the stale-documentation hand-off against current main and fixed items 1–11. These changes correct engine lifecycle guidance, CSP origins, component anatomy and labels, generated API descriptions, and package examples so readers and agents can follow the current implementation.
This branch starts from
44c2b66cband avoids the files owned by #3074, #3075, and #3021. The media-sources edits precede the running-engine section proposed in #3062; no adapter source or demo changes are included.Finding status and source evidence
All items 1–11 were still stale; none were skipped as already fixed.
hlsjs-video/src/adapter.tsengine configuration key and load path;dash-video/src/adapter.tssource setter;shaka-video/src/adapter.tssource setter and configuration application. Removed an unsupported continuity guarantee and corrected the five-row table's “three tiers” heading.frame-src 'none'baseline, and instructions to allow only used origins. The original policy blocked external scripts but actually left frames unrestricted: it had no frame, child, or default directive. Origins verified in YouTube/Spotify iframe APIs, Vimeo adapter, TikTok/Cloudflare source handling, Twitch player API, and Cast utilities. Installed Wistia SDK 0.7.12 confirms bothfast.wistia.comand.netfor scripts and connections, plus a conditional iframe fallback; the hand-off's unconditional “no iframe” claim was inaccurate. Provider SDKs can request additional resources, so the table is explicitly limited to entry scripts and embed frames.idand an unclaimed trigger. Evidence: HTML popoversetPopupElement(this)andPositionController.findTrigger. React anatomy was already structurally correct. Updated both variants' CSS selectors to target the popup itself and aligned the React class with its anatomy.core/i18n/locales/en.tsandui/pip-button/core.ts. Removed the inaccurate shared native-button rendering claim.html/src/define/global.csssupplies the skin'sdisplay: contents.MenuCSSVarsmetadata. RuntimeMenuPositioningCSSVarsuses these offsets and anchor dimensions, with Menu-owned available-size outputs. Regenerated Menu JSON lists nine variables; builder behavior and generated JSON were not hand-edited.core/src/dom/store/features/text-track.ts; generated text-track action verified. Protected captions guide already agrees.dismissed. Audited every selector against its feature/state; also corrected source fields tocurrentSrc/canPlay, text-track visibility tosubtitlesShowing, and metadata totitle/posterwithout nonexistent writers. Generated selector references verified.skins/src/styles/themes/theme.cssscale calculation and fullscreen--media-scalerules. Existing customize-skins guide agrees; no site generator consumes this private metadata.vjsc/icon-names.tsnaming overrides.Review
Claude Work Opus 5.5 reviewed the prose and source claims at high effort. Validated and addressed its findings, including MSE blob URLs for DASH, CDN stylesheet origins, explicit selector field names, the already-showing subtitle case, positioning boundaries, and copying all CDN files.
Testing
pnpm installandpnpm build:packagespnpm exec vp check --fixon every changed filepnpm -F site api-docs: regenerated Menu, text-track, and selector output inspectedpnpm -F site test scripts/api-docs-builder: 226 tests passedpnpm -F site test: 909 tests passedpnpm typecheckpnpm build:sitepnpm -F site check:anchorsaria-expanded. This checks initialization, not every provider or playback mode.Note
Low Risk
Documentation and comment/metadata only; no playback, security, or adapter logic changes in this diff.
Overview
Brings stale docs and generated API metadata in line with the current player: media sources now document per-engine lifecycle (hls.js rebuild vs dash.js/Shaka in-place updates), add
engine.shaka, and rename the options layout section. The CSP guide broadens MSE/DASH guidance, addsframe-src 'none', CDNstyle-srcnotes, and a provider origin table for embeds and Cast.Component reference pages fix HTML popover wiring (
commandfor+ popupid), state styling on the popup element, PiP defaultaria-labelstrings, and controls CSS described as examples rather than built-in defaults. Package READMEs require an exact CDN version placeholder and list the full icons catalog.Source JSDoc updates feed regenerated site API output: store selector field names, subtitle toggle fallback order,
MenuCSSVarspopover positioning properties, and--media-scale-unitpurpose.Reviewed by Cursor Bugbot for commit 9abdf17. Bugbot is set up for automated code reviews on this repo. Configure here.