API Reference

API Reference

Scaffold a complete API reference page for a Video.js 10 component or utility API.

Usage

/api-reference [name]

• name (optional): kebab-case component name (e.g., play-button) or util name (e.g., use-player). If omitted, will prompt.

Arguments

$ARGUMENTS

Reference Material

Load these files based on task:

Component Reference Workflow

Step 1: Gather context

Accept component name as argument (kebab-case).

1. Read the core file at packages/core/src/core/ui/{name}/{name}-core.ts — extract Props, State, behavior
2. Read data-attrs file at packages/core/src/core/ui/{name}/{name}-data-attrs.ts — extract data attributes
3. Check packages/react/src/ui/{name}/index.parts.ts — detect if multi-part
4. Search internal/design/ for matching design doc: internal/design/**/*{name}*. If no design doc is found, proceed — the core file is the primary source of truth; design docs are supplementary context.
5. Read the HTML element file(s) for tag names at packages/html/src/ui/{name}/
6. (Optional) Use git log --oneline --all -- packages/core/src/core/ui/{name} to find the commit that added the component, then check linked PRs via gh pr list --search for additional context. This enriches understanding but steps 1-3 and 5 are sufficient to build the reference page.

Step 2: Validate api-docs-builder compatibility

1. Run pnpm -F site api-docs and check for errors
2. Read the generated JSON at site/src/content/generated-component-reference/{name}.json
3. Verify the JSON has expected sections (props, state, dataAttributes, platforms.html.tagName)
4. For multi-part: verify each part appears in parts with correct names

If JSON is missing or incomplete, diagnose which convention isn't met. Load references/builder-conventions.md for the full list of naming requirements and common failures. Propose fixes: either adjust the component to match conventions, or add a name override — prefer aligning with conventions unless there's good reason not to.

Step 3: Determine relevant prose sections

Based on design docs, core logic, and component complexity, decide which sections to include between ## Anatomy and ## Examples. Not all are required — include only what adds value:

• Behavior — include when the component has state transitions, timing, interaction logic, or non-obvious behavior (e.g., Controls auto-hide, BufferingIndicator delay, Time formatting). Skip for trivial components.
• Styling — include when the component has data attributes for CSS targeting. Show CSS selector patterns. Always include for components with 2+ data attributes.
• Accessibility — include when the component has ARIA attributes, keyboard interactions, or screen reader considerations. Always include for interactive components (buttons, sliders).
• Other sections may be relevant depending on the component (e.g., "Platform Support" for features with availability detection).

Step 4: Create demos

Create at least a BasicUsage demo in both HTML and React. Load references/demo-patterns.md for the full file structure and conventions.

• HTML demo: 4 files (.astro, .html, .css, .ts)
• React demo: 2 files (.tsx, .css)
• Follow BEM naming: {framework}-{component}-{variant}__{element}
• CSS uses data-attribute selectors for state-based styling
• React uses render prop for state-based rendering
• Video source: https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM/highest.mp4
• Poster image: https://image.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM/thumbnail.jpg
• Consider additional demos for features not covered by BasicUsage

Step 5: Create MDX reference page

Load references/mdx-structure.md for the full structure template.

1. Create site/src/content/docs/reference/{name}.mdx
2. Add to sidebar in site/src/docs.config.ts (alphabetically within Components section)
3. Structure: frontmatter → imports → Anatomy → prose sections → Examples → <ComponentReference />
4. Run pnpm dev from root and verify the page renders in both HTML and React framework modes

Util Reference Workflow

For hooks, controllers, mixins, factories, and utilities. Load references/util-conventions.md for full details.

Step 1: Ensure auto-discovery can find the util

1. The util must be exported from one of the scanned package index files (packages/react/src/index.ts, packages/html/src/index.ts, or the store subpath indexes)
2. Add JSDoc with a description to the source export
3. If the export doesn't match a naming convention (use*, *Controller, create*), add @public to its JSDoc

Load references/util-conventions.md for the full inclusion and classification rules.

Step 2: Generate and validate JSON

1. Run pnpm -F site api-docs and check for errors
2. Read the generated JSON at site/src/content/generated-util-reference/{slug}.json
3. Verify it has the expected overloads, parameters, and return value

Step 3: Create MDX page

1. Create site/src/content/docs/reference/{slug}.mdx
2. Structure: frontmatter → import UtilReference → ## Import → ## Usage → <UtilReference util="..." />
3. Add to sidebar in site/src/docs.config.ts:
   • React utils → "Hooks & Utilities" section (frameworks: ['react'])
   • HTML utils → "Controllers & Mixins" section (frameworks: ['html'])
4. Run pnpm dev and verify the page renders correctly

Related Skills