Skip to content

feat(docs): open a component's sidebar group from its name, without navigating - #70

Merged
alexgrozav merged 1 commit into
component-sub-pages-uxf-421from
sidebar-group-toggle-uxf-421
Oct 23, 2026
Merged

alexgrozav merged 1 commit into
component-sub-pages-uxf-421from
sidebar-group-toggle-uxf-421

Conversation

@alexgrozav

Copy link
Copy Markdown
Contributor

What changed

In the sidebar and the header's menu, a component's name used to take you to its Overview and open its group, with a chevron beside it that opened and closed the group. Now the name and the chevron are one button that opens and closes the group without navigating, so you go to a page by choosing it from the group: the Overview or one of its layers. The group still opens on any of its pages and closes once you leave them.

The button keeps Nuxt UI's look for a group, with aria-expanded and aria-controls on it. The change is in DocsNavigationList.vue, with its comments, the sidebar's paragraph in .github/CONTRIBUTING.md and a line in this stack's changelog entry to match.

Checklist

  • The title follows Conventional Commits, as in feat(docs): add the focus guideline.
  • pnpm check-types passes.
  • Docs changes: the pages read well on pnpm dev. (Checked on the built site with wrangler dev in Chrome, the sidebar at 1440px and the menu at 390px.)
  • Homepage changes: pnpm build, then pnpm lighthouse, still scores 100 in every category. (No homepage changes.)

…avigating

The name of a split component page in the sidebar and the header's menu now opens and closes its group, rather than linking to its Overview, so readers choose the page they want from the group.

Co-authored-by: multica-agent <github@multica.ai>
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 23, 2026 •

Copy link
Copy Markdown

🚀 Deploying Preview to Cloudflare 🚀

Preview URL: https://sidebar-group-toggle-uxf-421-opencomponents.blue-water-0397.workers.dev (commit 8f659cb)

This URL reflects your latest Preview deployment

Preview Deployments by commit

Status Deployment URL Commit Updated (UTC) See this deployment's details
  • Build: Success ✅
  • Deployment: Success ✅

View logs ↗
https://e42e91f5-opencomponents.blue-water-0397.workers.dev 8f659cb 2026-10-23T09:29:24.788Z Visit the dashboard ↗

@alexgrozav
alexgrozav merged commit a813218 into component-sub-pages-uxf-421 Oct 23, 2026
5 checks passed
@alexgrozav
alexgrozav deleted the sidebar-group-toggle-uxf-421 branch October 23, 2026 09:34
alexgrozav added a commit that referenced this pull request Oct 23, 2026
… layer (#69)

## What changed

The other ten component pages now have the shape the Button's got in
#54: the Card, Checkbox, Checkbox Group, Dialog, Input, Radio Group,
Spinner, Switch, Textarea and Tooltip each become a folder in
`content/docs/3.components/`. Each folder holds an Overview and a page
per layer: User Interface (UI), User Experience (UX), Developer
Experience (DX) and Agentic Experience (AX). The text moves as it is.
The only changes are the ones the Button's split made: the cards in
place of the intro's list of layers, At a glance starting before the
paragraph on examples, the four Checklist links, each part's rules under
"UI Checklist" and so on, its questions under its own FAQ, and link
targets.

Once the Checkbox was a folder, Nuxt Content would have listed Checkbox
Group before it, since it sorts by file path and `-` comes before `/`.
`app/lib/navigation.ts` keeps the component pages in name order in the
sidebar, the header's menu and the links to the previous and next pages.
`app/components/UContentSurround.vue` replaces Nuxt UI's to read that
order. The tests that covered the Button's split, and the Button-only
checks in `scripts/check-mcp.mjs`, now run once for every split
component. Links between components go straight to the section's new
page. Links from before the split, like `/docs/components/input#sizes`,
still land on the right page through the redirect map.

In the sidebar and the header's menu, a component's name opens and
closes the list of its pages, the Overview and its layers, without
navigating, so you pick the page you want. The group still opens on any
of its pages and closes once you leave them.

Agents see no difference. `/raw/docs/components/<component>.md` and
`.yaml`, and the MCP server, serve each component as one page with the
outline and contract it has on `main`. The FAQ comes back grouped by
layer. A changelog entry announces the change, and `AGENTS.md` and
`.github/CONTRIBUTING.md` now say every component page is split like the
Button's.

It collects these PRs, each reviewed on its own: #56 (component order),
#57 (split tests), #58 to #67 (one per component), #68 (links between
components, changelog, guides) and #70 (the name opens the group,
without navigating).

To try it, run `pnpm dev` and open `/docs/components/checkbox`.

## Checklist

- [x] The title follows [Conventional
Commits](https://www.conventionalcommits.org), as in `feat(docs): add
the focus guideline`.
- [x] `pnpm check-types` passes.
- [x] Docs changes: the pages read well on `pnpm dev`. (Checked on a
`pnpm build` served with `wrangler dev`.)
- [x] Homepage changes: `pnpm build`, then `pnpm lighthouse`, still
scores 100 in every category. (No homepage changes, but the redirect map
now covers eleven components and loads on every page, so it ran: 100 in
every category on all three runs.)

---------

Co-authored-by: multica-agent <github@multica.ai>
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.

1 participant