Docs: Playback Feature Reference Example Calls a Non-Existent toggle() Method

[R-Delfino95]

Which documentation could use some work?

• React (@videojs/react)

Is this a discrepancy or an improvement?

• discrepancy

🖊 Describe what you'd like to see change in the documentation

The React example on the feature-playback reference page calls playback.toggle:

return <button onClick={playback.toggle}>{playback.paused ? 'Play' : 'Pause'}</button>;

But the playback feature has no toggle() method. The actual API is togglePaused() (defined in packages/core/src/dom/store/features/playback.ts). The auto-generated reference table on the same page already lists togglePaused() correctly — the example just contradicts it. Anyone copy-pasting the snippet gets playback.toggle is undefined at runtime.

💡 Describe how you think this change will help the documentation

Update the example to use playback.togglePaused so it actually works when copied, and matches the API reference table directly above it.

[github-actions]

Confirmed. The MDX source at site/src/content/docs/reference/feature-playback.mdx calls playback.toggle in the React example, but the playback feature state exposes togglePaused() — not toggle(). The auto-generated reference table on the same page lists togglePaused() correctly, so the example directly contradicts it.

Fix: change the one-liner in the React example:

- return <button onClick={playback.toggle}>{playback.paused ? 'Play' : 'Pause'}</button>;
+ return <button onClick={playback.togglePaused}>{playback.paused ? 'Play' : 'Pause'}</button>;

---

Planning notes:

• Milestone: Fits the GA milestone (due 2026-07-31) — small, self-contained doc fix.
• Priority: P2 — no runtime breakage for library consumers, but copy-paste produces an immediate undefined error for anyone following the docs.
• Related issues worth grouping: Docs: <Controls /> Shown as JSX Component but Is a Namespace — Should Use <Controls.Root> #1482 (Controls namespace example is wrong), Docs: Individual Feature Named Imports From @videojs/react Don't Resolve #1481 (named imports don't resolve), Docs: Ejected Skin Sample Causes Fast Refresh Warning in React #1484 (Fast Refresh warning in ejected skin sample), Docs: Skins Reference Should List the Required CSS Import for Each Skin #1519 (skins reference missing required CSS import) — all small React doc accuracy fixes that could be batched.
• No epics, roadmap additions, or blocked-by relationships recommended — straightforward fix, no dependencies.