Skip to content

Optimise page outline #3813

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.

Sign up for GitHub

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 2 commits into from
Nov 19, 2025
+16 −63
Merged

Optimise page outline #3813

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a550bcc
Optimise page outline
zenoachtig Nov 17, 2025
5de4045
Delete AsideSectionHighlight.tsx
zenoachtig Nov 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 0 additions & 41 deletions packages/gitbook/src/components/PageAside/AsideSectionHighlight.tsx
View file
Open in desktop

This file was deleted.

6 changes: 5 additions & 1 deletion packages/gitbook/src/components/PageAside/PageAside.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,11 @@ async function PageAsideSections(props: { document: JSONDocument; context: GitBo

const sections = await getDocumentSections(context, document);

return sections.length > 1 ? <ScrollSectionsList sections={sections} /> : null;
return sections.length > 1 ? (
<div className="overflow-y-auto">
<ScrollSectionsList sections={sections} />
</div>
) : null;
}

function PageAsideActions(props: {
Expand Down
32 changes: 11 additions & 21 deletions packages/gitbook/src/components/PageAside/ScrollSectionsList.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import { tcls } from '@/lib/tailwind';

import { useBodyLoaded } from '@/components/primitives';
import { HEADER_HEIGHT_DESKTOP } from '../layout';
import { AsideSectionHighlight } from './AsideSectionHighlight';

/**
* The threshold at which we consider a section as intersecting the viewport.
Expand Down Expand Up @@ -44,7 +43,7 @@ export function ScrollSectionsList({ sections }: { sections: DocumentSection[] }

return (
<ul
className="relative flex flex-col overflow-y-auto border-tint-subtle sidebar-list-line:border-l pb-5 xl:max-2xl:page-api-block:mt-0 xl:max-2xl:page-api-block:p-2"
className="relative flex flex-col border-tint-subtle sidebar-list-line:border-l pb-5 xl:max-2xl:page-api-block:mt-0 xl:max-2xl:page-api-block:p-2"
ref={scrollContainerRef}
>
{sections.map((section) => (
Expand All @@ -62,22 +61,6 @@ export function ScrollSectionsList({ sections }: { sections: DocumentSection[] }
)}
ref={activeId === section.id ? activeItemRef : null}
>
{activeId === section.id && (
<AsideSectionHighlight
className={tcls(
'sidebar-list-default:hidden',
section?.depth > 1
? [
'sidebar-list-default:rounded-l-none',
'sidebar-list-line:rounded-l-none',
]
: [
'sidebar-list-default:ml-3',
'contrast-more:sidebar-list-default:ml-0',
]
)}
/>
)}
<a
href={`#${section.id}`}
className={tcls(
Expand All @@ -104,6 +87,10 @@ export function ScrollSectionsList({ sections }: { sections: DocumentSection[] }
'contrast-more:hover:ring-inset',
'contrast-more:hover:ring-current',

'sidebar-list-line:border-l-2',
'border-transparent',
'sidebar-list-line:-left-px',

section.depth > 1 && [
'subitem',
'sidebar-list-line:pl-6',
Expand All @@ -120,17 +107,20 @@ export function ScrollSectionsList({ sections }: { sections: DocumentSection[] }
'hover:text-primary',
'contrast-more:text-primary',
'contrast-more:hover:text-primary-strong',
'sidebar-list-line:ml-px',

'hover:bg-primary-hover',

'theme-muted:hover:bg-primary-active',
'[html.sidebar-filled.theme-bold.tint_&]:hover:bg-primary-active',
'theme-gradient:hover:bg-primary-active',

'tint:font-semibold',
'contrast-more:font-semibold',

'sidebar-list-line:border-primary-9',
'sidebar-list-default:border-tint',

'sidebar-list-pill:bg-primary',
'[html.theme-muted.sidebar-list-pill_&]:bg-primary-hover',
'[html.theme-gradient.sidebar-list-pill_&]:bg-primary-active',
]
)}
>
Expand Down