fix: move scroll margin for docs anchors to correct element #27
Conversation
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
Add scroll-mt-20 to section and div elements with anchor IDs to prevent headings from being obscured by the sticky header when navigating via anchor links. Also removes duplicate IDs from SectionHeader component since parent elements already have the IDs.
👷 Deploy request for opensyncsessions pending review.Visit the deploys page to approve it
|
joshuadavidthomas
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Problem
Anchor navigation on the docs pages (e.g.,
/docs#requirements) resulted in headings being obscured behind the sticky header.The existing
scroll-mt-20was on the wrong element. It was applied to the<h2>/<h3>tag, but theidattribute was on the parent<div>. Scroll margin only works on the element that has the anchor ID.Additionally, there were duplicate IDs - both the
<section>and inner<div>had the same ID - so the browser scrolled to the<section>which had no scroll margin at all.Fix
scroll-mt-20to the elements that actually have the anchor IDs (<section>and<div>elements withdata-section)SectionHeaderI considered consolidating the wrapper
<div>around all theSectionHeadercomponents, but went with the simple naive approach for the fix.