Repository navigation
docs(site): add skin choice guidance - #9474
Conversation
Add a Choose a skin section to the Skins guide that compares Default, Neutral, Compat, and Scaffold on features, styling, and browser compatibility, and link to it from every skin reference, Customize skins, Browser support, and the migration guides. Describe Compat from its source: it keeps the core controls in a simpler layout and avoids newer visual effects, but it shares the browser targets of the other skins. Describe Scaffold as Compat's controls with minimal styling, a foundation to restyle rather than a finished design. Teach the installation guidance when to choose Compat and Scaffold, and restore the starter page wording that the starter-to-compat rename replaced. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@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/playerjs-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 (19)
Players (5)
Skins (53)
UI Components (62)
⚛️ @videojs/react — no changesPresets (7)
Media (23)
Extensions (2)
Players (5)
Skins (34)
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/playerjs-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 |
✅ 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. |
Preset references, the presets and CDN guides, the skins README, and the Video-React migration guide still described two or three skins. Compat skin pages also hid the CDN bundle that registers them. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Preview pages to review for this PR. The deploy preview includes a7388fa. Follow-up commit (a7388fa)
Original changes (77df1ad)
The 🤖 Generated with Claude Code |
|
Claude review: no high-confidence bugs found. |
Supersedes videojs/v10#3110. Refs videojs/v10#3026, #9251
Summary
Help readers and agents choose between the Default, Neutral, Compat, and Scaffold skins. The Skins guide now compares them on features, styling, and browser compatibility. The Compat copy now matches what the skin ships: it keeps the core controls and avoids newer visual effects, but it supports the same browsers as the other skins. Scaffold, which landed in #9251 after videojs/v10#3110 was opened, is included as the unbranded foundation for readers who want their own design.
Changes
metadescriptions per preset, replacing "designed for broader browser compatibility" with the layout and controls each preset actually has--media-border-colordoesn't change itHTMLUsageCodeBlock, which the starter-to-compat rename had replacedWhy the Compat copy differs from the taxonomy
Compat has no browser targets of its own. The skins build and
browser-support.test.tsaudit every stylesheet, Compat and Scaffold included, against the root browserslist, and the BrowserStack probes load only the Default video, Neutral video, and audio pages. Compat still depends on:has(),@container,@layer, andoklch()from the shared base styles. What it does avoid is backdrop blur, CSS anchor positioning,corner-shape, and Tailwindcolor-mix()opacity, so it looks the same across supported browsers.Its controls are also close to Default's: it keeps the settings menu (quality, audio track, speed, captions), PiP, fullscreen, Cast, AirPlay, chapters, and thumbnails. It drops the play/pause flash, the audio buffering spinner, and remaining time, and it adds center play and seek buttons and, on audio, captions and AirPlay buttons.
If Compat should become a reduced-feature skin with a lower browser baseline, the skin and its targets need to change first; this copy follows the current source.
How the Scaffold copy was checked
packages/skins/src/skins/scaffold/is a fork of Compat: the same control components per preset, with the title moved into the top bar and the buffering indicator moved beside the controls. Its theme sets every radius to0, turns off surface shadows and backdrop filters, and usesfont-family: var(--media-font-family, inherit)instead of the Inter stack, and its styles drop every transition. That matches the taxonomy's "unbranded foundation you restyle". Its feature set matches Compat's controls rather than a separate "feature complete" tier, so the table says "Same as Compat".Open question
Upstream's Skins intro called Compat a skin for broader browser compatibility, which is what the taxonomy says. The code doesn't support that yet, as described above, so this PR removes the claim again. We should agree whether to change the copy (this PR) or the skin and its targets.
Visual Evidence
Open the deploy preview at
/docs/framework/react/guides/skins#choose-a-skinand/docs/framework/html/guides/skins#choose-a-skin.Testing
pnpm -F @videojs/installation testpnpm -F @videojs/skins testpnpm -F site test diataxispnpm -F site astro checkpnpm lint🤖 Generated with Claude Code