Skip to content

docs(mux-player): fix --media-object-size typo to --media-object-fit - #1355

Open
davekiss wants to merge 1 commit into
mainfrom
cursor/fix-media-object-fit-css-var-0e08
Open

davekiss wants to merge 1 commit into
mainfrom
cursor/fix-media-object-fit-css-var-0e08

Conversation

@davekiss

@davekiss davekiss commented Sep 10, 2026 •

Copy link
Copy Markdown
Contributor

Docs feedback

Under "Other CSS Variables" you're showing --media-object-size: cover; when it should be --media-object-fit: cover;

Also (duplicate submission):

--media-object-size: cover;

I think has been renamed to

    '--media-object-fit': 'cover',

Summary

Docs feedback: the Mux Player CSS variables section documented --media-object-size, but the correct Media Chrome / Mux Player variable is --media-object-fit (maps to object-fit).

mux.com fetches packages/mux-player/REFERENCE.md as the player API source of truth, so the live player API reference still showed the wrong name. A prior mux.com PR (#2334) only added a render-time rewrite; this fixes it at the source instead.

Change

  • In packages/mux-player/REFERENCE.md under CSS variables / “Other CSS variables”, replace --media-object-size: cover; with --media-object-fit: cover;.
  • Leave --media-object-position unchanged.

This matches the variable already used in package code (e.g. mux-player-react).

QA

  • Date: 2026-09-24 ET
  • Verified: Live https://www.mux.com/docs/guides/player-api-reference/html (HTTP 200). Main source packages/mux-player/REFERENCE.md still has --media-object-size: cover;; PR branch replaces with --media-object-fit: cover; and keeps --media-object-position. Identifier matches Media Chrome object-fit naming (not size). Single-line docs typo fix.
  • Credential QA: N/A (css-docs)
  • Verdict: SHIPPABLE
  • Process note: behind main (process only)

Test plan

  • Confirm REFERENCE.md uses --media-object-fit and still documents --media-object-position.
  • Confirm no other --media-object-size occurrences remain in packages/mux-player docs.
Open in Web Open in Cursor 

The documented CSS variable was a typo. Media Chrome / Mux Player
exposes --media-object-fit (maps to object-fit). mux.com fetches this
REFERENCE.md as the player API source of truth, so the live docs still
showed the wrong name.

Co-authored-by: Dave Kiss <davekiss@users.noreply.github.com>
@davekiss
davekiss marked this pull request as ready for review September 10, 2026 10:48
@vercel

vercel Bot commented Sep 10, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
elements-demo-astro Ready Ready Preview Sep 10, 2026 10:52am UTC
elements-demo-nextjs Ready Ready Preview Sep 10, 2026 10:52am UTC
elements-demo-svelte-kit Ready Ready Preview Sep 10, 2026 10:52am UTC
elements-demo-vanilla Ready Ready Preview Sep 10, 2026 10:52am UTC
elements-demo-vue Ready Ready Preview Sep 10, 2026 10:52am UTC

Request Review

@davekiss
davekiss requested a review from a team as a code owner September 10, 2026 10:48
@snyk-io

snyk-io Bot commented Sep 10, 2026 •

Copy link
Copy Markdown

✅ Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
✅ Open Source Security 0 0 0 0 0 issues
✅ Licenses 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

This branch was successfully deployed

5 active deployments
Preview – elements-demo-vue — e347f1ad Deployed Sep 10, 2026 by vercel[bot]
Preview – elements-demo-astro — e347f1ad Deployed Sep 10, 2026 by vercel[bot]
Preview – elements-demo-svelte-kit — e347f1ad Deployed Sep 10, 2026 by vercel[bot]
Preview – elements-demo-nextjs — e347f1ad Deployed Sep 10, 2026 by vercel[bot]
Preview – elements-demo-vanilla — e347f1ad Deployed Sep 10, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants