Skip to content

Docs category headings#2034

Open
SEEKilian wants to merge 13 commits intomasterfrom
docs-category-headings
Open

Docs category headings#2034
SEEKilian wants to merge 13 commits intomasterfrom
docs-category-headings

Conversation

@SEEKilian
Copy link
Copy Markdown
Contributor

Migrated DocDetails and SideNavigation to use new <CategoryHeading> component.

This kicked off a minor cascade of changes in support, primary of which is the creation of a new <TitleLink> component - a hash-linked anchor with an optional copyable prop that enables copying the URL to clipboard.

Other changes are minor refactors, elevation of <CategoryHeading> into docs-ui, etc.

@SEEKilian SEEKilian requested a review from a team as a code owner April 23, 2026 01:23
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 23, 2026

🦋 Changeset detected

Latest commit: 5f01f43

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
@braid-design-system/docs-ui Minor
braid-design-system Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Comment thread .changeset/legal-pigs-tan.md Outdated
Comment thread packages/docs-ui/src/components/CategoryHeading/CategoryHeading.tsx Outdated
Comment thread packages/docs-ui/src/components/TitleLink/TitleLink.css.ts
Comment thread packages/docs-ui/src/components/TitleLink/TitleLink.tsx Outdated
Comment thread site/src/App/DocNavigation/DocSection.tsx Outdated
{section.label ? (
<Heading
level="3"
aria-describedby={
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As above, i dont believe this is passed through (TS doesnt validate aria- so no errors, but also it doesnt apply).

We could do with a lap of whitelisting and opening some aria props i think.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a little hairy with a programatic aria-describedby as part of TitleLink. I'll push up a solution and you can give me your thoughts

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.

2 participants