fix(theme): Fix CSS scroll-margin-top when clicking footnote items, factorize code
#11466
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
7 tasks
|
Size Change: +34.4 kB (+0.29%) Total Size: 11.8 MB
ℹ️ View Unchanged
|
⚡️ Lighthouse report for the deploy preview of this PR
|
✅ [V2]
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Size Change: +34.5 kB (+0.28%) Total Size: 12.2 MB
ℹ️ View Unchanged
|
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
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.
Motivation
Fix the footnote anchor target appearing under the sticky navbar
Problem reported here: #11232 (comment)
I thought it was fixed in #11289, but figured out that we can't apply this logic only to
<a>tags. Footnotes creates 2 kind of anchor targets,<a id>tags in the text itself, and<li id>at the bottom for the footnote list (unfortunately, the id is on<li>, not<a>, so my solution didn't work entirely).This PR factorizes the logic to apply the same
scroll-margin-topCSS consistently to all items that need it: headings, li, a tags. And we could eventually use it in other places later too, and users can eventually use it in their own code if they create anchors.Test Plan
Tested with sticky header locally.
On the deploy preview, we should still see a little extra margin (
scroll-margin-top: 0.5rem;)Test links
https://deploy-preview-11466--docusaurus-2.netlify.app/tests/docs/tests/footnotes