videojs/v10

Docs: Stale Docs from #1174

Open

#1204 aperta il 2 apr 2026

Vedi su GitHub
 (3 commenti) (0 reazioni) (1 assegnatario)TypeScript (67 fork)github user discovery
a11yagent:prcomponentsdocsgood first issuesite

Metriche repository

Star
 (804 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

[!NOTE] Triage estimate — cycle priority and story points were assigned during an AI-assisted planning pass and are rough first guesses. Confirm or adjust when you pick this up.

Summary

API changes in #1174 (fix(packages): make tooltips visual-only and auto-forward media button labels) may have made the following documentation stale.

Triggering PR

https://github.com/videojs/v10/pull/1174

API Changes

  • New label state property added to 7 button components: PlayButton, MuteButton, FullscreenButton, CaptionsButton, PipButton, SeekButton, PlaybackRateButton. This exposes the resolved/auto-forwarded label as readable state.
  • Tooltips are now visual-only — they no longer provide accessible names via aria-describedby. Instead, media button labels are auto-forwarded directly to the button's aria-label.

Stale Documentation Found

High Confidence

File Line(s) Issue API Change
site/src/content/docs/reference/tooltip.mdx 149 States "The trigger receives aria-describedby pointing to the popup when open" — this is no longer true if tooltips are visual-only Tooltips made visual-only; no longer set aria-describedby

Medium Confidence

File Line(s) Issue API Change
site/src/content/docs/reference/tooltip.mdx 73–78 HTML behavior section says tooltip "manages open/close state, ARIA attributes, and positioning" — "ARIA attributes" may be misleading if tooltips are now purely decorative Tooltips made visual-only
site/src/content/docs/concepts/accessibility.mdx 19 States "buttons update their aria-label based on player state" — still true but now incomplete; should mention that labels are auto-forwarded from tooltips/label prop rather than set independently Button labels now auto-forwarded

Low Confidence

File Line(s) Issue API Change
site/src/content/docs/reference/play-button.mdx 92 Accessibility section mentions label prop but doesn't mention the new label state (auto-generated table will show it, but prose may want updating) New label state added
site/src/content/docs/reference/mute-button.mdx 95 Same as above New label state added
site/src/content/docs/reference/fullscreen-button.mdx 86 Same as above New label state added
site/src/content/docs/reference/captions-button.mdx 63 Same as above New label state added
site/src/content/docs/reference/pip-button.mdx 86 Same as above New label state added
site/src/content/docs/reference/seek-button.mdx 44 Same as above New label state added
site/src/content/docs/reference/playback-rate-button.mdx 66 Same as above New label state added

Recommended Actions

  • Update the Tooltip accessibility section (tooltip.mdx:149) to reflect that tooltips are now visual-only and no longer set aria-describedby on triggers
  • Update the Tooltip HTML behavior section (tooltip.mdx:73-78) to clarify that ARIA attributes are no longer managed (or specify which attributes remain)
  • Consider updating the accessibility concepts page to mention that button labels are auto-forwarded from the label prop/state
  • Review whether button reference page prose sections should mention the new label state (the auto-generated ComponentReference tables will include it automatically)

Guida contributor