Get heading/TOC offset without walking up the DOM tree #6397
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
IHIutch
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.
Summary
Rather than recursively walking up the DOM tree which could be quite deep,
el.getBoundingClientRect().top + window.scrollYprovides the position of the element on the page immediately.Related issue
Related pull requests
Updates the work on this PR: #5878
Preview link
Preview link
Problem statement
The current implementation walks up the DOM tree which could be extremely deep and expensive to do
Solution
Uses a more optimal method to detect the vertical position of an element on a page
Major changes
n/a
Testing and review
Updates tests to match the fact that JSDOM cannot get
window.scrollYorel.getBoundingClientRect().top. By usinggetBoundingClientRect()we cannot simply add up theoffsetTopvalues of elements to verify the scroll position.