feat(theme): add id attributes to group headings for linking#3072
Open
wotan-allfather wants to merge 2 commits into
Open
feat(theme): add id attributes to group headings for linking#3072wotan-allfather wants to merge 2 commits into
wotan-allfather wants to merge 2 commits into
Conversation
Add id attributes and anchor icons to group headings in the default theme, allowing users to link directly to specific groups in the documentation. This includes: - h2 group headings in members.tsx (member groups) - h2 group headings in moduleReflection.tsx (module groups) - h3 group headings in index.tsx (index sections) Example: modules.html#Runtime_Guards now links directly to that group. Closes TypeStrong#3029
Collaborator
|
Thank you! Unfortunately this appears to have broken some things: 
The caret icon for collapsed/expanded is no longer in place, and I don't see the anchor icon when hovering over the header, like I do when hovering over a header in the README: 
|
The anchor icons weren't visible on hover because the headings were missing the tsd-anchor-link class that enables the CSS hover behavior. - Add tsd-anchor-link class to h2 in members.tsx - Add tsd-anchor-link class to h2 in moduleReflection.tsx - Add tsd-anchor-link class to h3 in index.tsx
Metbcy
added a commit
to Metbcy/typedoc
that referenced
this pull request
May 3, 2026
Mirrors the anchor-icon treatment introduced in TypeStrong#3072 so the new heading IDs added in this PR are actually discoverable by users. - members.tsx h2: add tsd-anchor-link class + anchorIcon - moduleReflection.tsx h2: same treatment - index.tsx h3: slug each section title via context.slugger and attach id + tsd-anchor-link class + anchorIcon (None sections remain unanchored) Snapshots regenerated. Slug collisions between the index h3 and the later members h2 are handled naturally by the per-page slugger (e.g. #methods on the index entry, #methods-1 on the section heading). Addresses review feedback on TypeStrong#3100.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add id attributes and anchor icons to group headings in the default theme, allowing users to link directly to specific groups in the documentation.
This includes:
Example: modules.html#Runtime_Guards now links directly to that group.
Closes #3029