docsgood first issuesite
仓库指标
- 星标
- (804 个星标)
- PR 合并指标
- (平均合并 14天 19小时) (30 天内合并 55 个 PR)
描述
[!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 #1527 (feat(packages): add playback rate menu) may have made the following documentation stale.
Triggering PR
https://github.com/videojs/v10/pull/1527
API Changes
Popover.Popup— new CSS custom property--media-popover-boundary-offset(minimum distance between the popup and the positioning boundary).Tooltip.Popup— new CSS custom property--media-tooltip-boundary-offset(minimum distance between the popup and the positioning boundary).usePlayerContext—PlayerContextValuereturn type gained a newpopupGroup: PopupGroupfield (used by Menu/Popover to coordinate popup groups across the player).
Stale Documentation Found
High Confidence
| File | Line(s) | Issue | API Change |
|---|---|---|---|
| None found |
Medium Confidence
| File | Line(s) | Issue | API Change |
|---|---|---|---|
site/src/content/docs/reference/popover.mdx |
71-89 | "Styling" code snippets list --media-popover-side-offset and --media-popover-align-offset but omit the newly-added --media-popover-boundary-offset. The auto-generated ComponentReference table picks it up, but the hand-authored example is now incomplete. |
New --media-popover-boundary-offset CSS var |
site/src/content/docs/reference/tooltip.mdx |
85-103 | "Styling" code snippets list --media-tooltip-side-offset and --media-tooltip-align-offset but omit the newly-added --media-tooltip-boundary-offset. Same situation as popover.mdx — the example is now incomplete. |
New --media-tooltip-boundary-offset CSS var |
site/src/content/docs/reference/use-player-context.mdx |
3, 9 | Frontmatter description ("Hook to access the full player context including store, media element, and media setter") and the intro paragraph ("returns the full PlayerContextValue object, which includes the store, the current media element, and the media setter") no longer enumerate every field — the value now also exposes container, setContainer, and the newly-added popupGroup. |
New popupGroup field on PlayerContextValue |
Low Confidence
| File | Line(s) | Issue | API Change |
|---|---|---|---|
site/src/content/docs/reference/use-player-context.mdx |
14-15 | Example destructures { store, media, setMedia }. Not strictly stale, but a small mention of popupGroup (and/or container) would keep the example aligned with the new context shape. |
New popupGroup field |
Recommended Actions
- Update the Popover "Styling" CSS examples in
popover.mdxto include--media-popover-boundary-offsetalongside the existing side/align offset vars. - Update the Tooltip "Styling" CSS examples in
tooltip.mdxto include--media-tooltip-boundary-offset. - Update the
use-player-context.mdxfrontmatterdescriptionand the intro sentence so the enumerated fields match the currentPlayerContextValueshape (store, media, setMedia, container, setContainer, popupGroup), or rephrase to avoid the explicit list. - Optional: extend the
DebugPanelexample inuse-player-context.mdxto surfacepopupGroup(orcontainer) so readers see the new field in practice.