Add 'offset' option to useScrollSpy hook #8209
Merged
+21
−4
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.
This PR adds an 'offset' option to the useScrollSpy hook, used when calculating the active heading with respect to the top of the viewport.
offset
- offset from the top of the viewport to use when determining the active heading, by default0
is usedThis allows the hook to accommodate pages with floating headers or other elements that obscures the top of the viewport.
Example usage:
This fixes an issue where the Table of Contents may display an unexpected heading as active when using the AppShell header.
https://codesandbox.io/p/sandbox/mantine-react-template-forked-wlrnk8
Without offset:
("Title 3" is the topmost visible title in the user's window, but TableOfContents shows "Title 2" as active)
With offset:
TableOfContents shows the expected Title 3 as active, accommodating for the header.