Skip to content

feat(#3676): show subcomponent APIs on parent component pages#3677

Open
twjeffery wants to merge 1 commit intodevfrom
tom/subcomponent-props-on-parent
Open

feat(#3676): show subcomponent APIs on parent component pages#3677
twjeffery wants to merge 1 commit intodevfrom
tom/subcomponent-props-on-parent

Conversation

@twjeffery
Copy link
Collaborator

@twjeffery twjeffery commented Mar 24, 2026

Summary

  • Subcomponent props, events, and slots now appear on parent component pages in the Properties tab
  • Each section heading is prefixed with the subcomponent name (e.g., "Tab Props") and has a "Subcomponent" badge
  • New subcomponent: true field in MDX frontmatter, discovered via parent's relatedComponents
  • New MDX scaffolds and API JSON for work-side-menu-group and work-side-menu-item

Closes #3676

Test plan

  • Visit Tabs page, verify Tab Props and Tab Slots appear with Subcomponent badges
  • Visit Footer page, verify Footer Meta Section and Footer Nav Section APIs appear
  • Visit Work Side Menu page, verify Work Side Menu Group and Work Side Menu Item APIs appear
  • Visit Side Menu page, verify Side Menu Group and Side Menu Heading APIs appear
  • Verify TOC sidebar shows prefixed headings (e.g., "Tab Props", "Tab Slots")
  • Verify components without subcomponents (e.g., Button) are unaffected
  • Run npm run build from docs/ to confirm clean build

Before

image

After

image

@twjeffery twjeffery marked this pull request as draft March 24, 2026 22:26
Subcomponent props, events, and slots now appear on their parent's
Properties tab with prefixed headings and a "Subcomponent" badge.
Adds subcomponent field to schema, getSubcomponents() query helper,
and MDX scaffolds for work-side-menu-group and work-side-menu-item.
@twjeffery twjeffery force-pushed the tom/subcomponent-props-on-parent branch from 0908ad0 to 524971c Compare March 24, 2026 22:42
@twjeffery twjeffery marked this pull request as ready for review March 24, 2026 22:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: show subcomponent APIs on parent component pages

1 participant