docs: add TOC minimap + mobile nav and heading anchors - #21
Closed
phh235 wants to merge 1 commit into
Closed
Conversation
Owner
|
I'm sorry but I'm not a big fan of this kind of docs feature, I think it only adds complexity to a perfectly simple page, which isn't really needed, because there's not that much to scroll. Please open issues before implementing such design choices, I don't want to waste your time. |
Contributor
Author
I got it sir! |
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
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.
What does this PR do?
Adds a TOC minimap (desktop hover card) and mobile accordion for on-page section navigation across all component doc pages. The TOC is lifted out of
component-docinto the shell layout withposition: fixed, so demo wrappers likeClothDemono longer squeeze or affect its positioning. Introduces aTOCContextto share TOC items from the server-sidecomponent-docto the client-side layout components without prop drilling.Also adds a reusable
HeadingAnchorcomponent for scrollable heading links, ademoSectionprop for including "Demo" in the TOC, and fixes the hover card'spositionMethodto"fixed"to prevent floating-UI repositioning during programmatic smooth scroll.Additionally, updates the previous/next navigation button layout to improve visual balance and consistency with the new documentation navigation experience.
Demo
2026-07-26.21-50-58.mp4
Updated navigation buttons
Type of change
Checklist
npx tsc --noEmitpassesnpm run lintpassesnpm run buildpasses