-
Notifications
You must be signed in to change notification settings - Fork 4k
Dynamic TOC height #3233
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Dynamic TOC height #3233
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
7ee55eb
Initial
zenoachtig 467a976
Add a very dirty way of setting the height correctly
zenoachtig 0a7e111
New version of adaptive TOC
zenoachtig e3a7223
Simplify script and components
zenoachtig 64539a7
Add back in scroll offset (oops)
zenoachtig d61db35
Changeset
zenoachtig b851dad
Don't use `computedStyleMap`
zenoachtig File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "gitbook": patch | ||
| --- | ||
|
|
||
| Make TOC height dynamic based on visible header and footer elements |
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
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
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
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
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
73 changes: 73 additions & 0 deletions
73
packages/gitbook/src/components/TableOfContents/TableOfContentsScript.tsx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| 'use client'; | ||
|
|
||
| import { useEffect } from 'react'; | ||
|
|
||
| /** | ||
| * Adjusts TableOfContents height based on visible elements | ||
| */ | ||
| export function TableOfContentsScript() { | ||
| useEffect(() => { | ||
| const root = document.documentElement; | ||
|
|
||
| // Calculate and set TOC dimensions | ||
| const updateTocLayout = () => { | ||
| // Get key elements | ||
| const header = document.getElementById('site-header'); | ||
| const banner = document.getElementById('announcement-banner'); | ||
| const footer = document.getElementById('site-footer'); | ||
|
|
||
| // Set sticky top position based on header | ||
| const headerHeight = header?.offsetHeight ?? 0; | ||
| root.style.setProperty('--toc-top-offset', `${headerHeight}px`); | ||
|
|
||
| // Start with full viewport height minus header | ||
| let height = window.innerHeight - headerHeight; | ||
|
|
||
| // Subtract visible banner (if any) | ||
| if (banner && banner?.computedStyleMap().get('display') !== 'none') { | ||
| const bannerRect = banner.getBoundingClientRect(); | ||
| if (bannerRect.height > 0 && bannerRect.bottom > 0) { | ||
| height -= Math.min(bannerRect.height, bannerRect.bottom); | ||
| } | ||
| } | ||
|
|
||
| // Subtract visible footer (if any) | ||
| if (footer) { | ||
| const footerRect = footer.getBoundingClientRect(); | ||
| if (footerRect.top < window.innerHeight) { | ||
| height -= Math.min(footerRect.height, window.innerHeight - footerRect.top); | ||
| } | ||
| } | ||
|
|
||
| // Update height | ||
| root.style.setProperty('--toc-height', `${height}px`); | ||
| }; | ||
|
|
||
| // Initial update | ||
| updateTocLayout(); | ||
|
|
||
| // Let the browser handle scroll throttling naturally | ||
| window.addEventListener('scroll', updateTocLayout, { passive: true }); | ||
| window.addEventListener('resize', updateTocLayout, { passive: true }); | ||
|
|
||
| // Use MutationObserver for DOM changes | ||
| const observer = new MutationObserver(() => { | ||
| requestAnimationFrame(updateTocLayout); | ||
| }); | ||
|
|
||
| // Only observe what matters | ||
| observer.observe(document.documentElement, { | ||
| subtree: true, | ||
| attributes: true, | ||
| attributeFilter: ['style', 'class'], | ||
| }); | ||
|
|
||
| return () => { | ||
| observer.disconnect(); | ||
| window.removeEventListener('scroll', updateTocLayout); | ||
| window.removeEventListener('resize', updateTocLayout); | ||
| }; | ||
| }, []); | ||
|
|
||
| return null; | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,4 @@ | ||
| export * from './TableOfContents'; | ||
| export { TableOfContents } from './TableOfContents'; | ||
| export { PagesList } from './PagesList'; | ||
| export { TOCScrollContainer } from './TOCScroller'; | ||
| export { Trademark } from './Trademark'; |
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 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.
Uh oh!
There was an error while loading. Please reload this page.