Skip to content

Docs: Stale Docs from #1615 #1672

Description

@github-actions

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 #1615 (feat(core): add captions radio group and harden popover triggers) may have made the following documentation stale.

Triggering PR

#1615

API Changes

  • CaptionsButton — added menuTrigger boolean prop (default false). When true with multiple tracks, pointer activation opens a menu instead of toggling. React sets this automatically inside Menu.Trigger.
  • PlaybackRateButton — added menuTrigger boolean prop (default false). When true, pointer activation opens a menu instead of cycling.
  • MenuMenu.Item and Menu.Trigger gained a type prop (MenuItemSettingType, e.g. playback-rate / captions); new ItemValue part added (media-menu-item-value); Menu.Trigger's disabled description was simplified.
  • PlaybackRateMenu — component removed entirely (media-playback-rate-menu, media-playback-rate-menu-trigger, usePlaybackRateMenu). No documentation currently references it (verified via search), so nothing appears to need removal — flagged here only for awareness.

Stale Documentation Found

High Confidence

File Line(s) Issue API Change
None found

Medium Confidence

File Line(s) Issue API Change
None found

Low Confidence

File Line(s) Issue API Change
site/src/content/docs/reference/captions-button.mdx 38–42, 61–63 Behavior/Accessibility prose describes only the default toggle interaction. The new menuTrigger mode opens a menu instead of toggling. The prop table auto-generates via <ComponentReference>, but the prose may want a note about menu-trigger behavior. Added menuTrigger prop
site/src/content/docs/reference/playback-rate-button.mdx 38–40, 64–66 Behavior/Accessibility prose describes only the default cycle-on-click interaction. The new menuTrigger mode opens a menu instead of cycling. Prop table auto-generates; prose may want a note. Added menuTrigger prop

Recommended Actions

  • Review the Behavior and Accessibility sections of reference/captions-button.mdx and reference/playback-rate-button.mdx; consider adding a brief note about the menuTrigger mode (auto-enabled inside Menu.Trigger). The auto-generated prop tables already pick up the new prop, so this is prose-only.
  • Confirm whether a Menu reference page or settings-menu guide should document the new ItemValue part (media-menu-item-value) and the type prop on Menu.Item / Menu.Trigger — no such page exists today, so there is nothing currently stale, but the new surface is undocumented.
  • Confirm the removal of PlaybackRateMenu leaves no dangling references — a repo-wide docs search found none.

Metadata

Metadata

Assignees

Type

No type
No fields configured for issues without a type.

Projects

Status
Ready for review

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions