Skip to content

Add isRoot prop to PagesList for root header offset #3759

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
+21 −9
Open

Add isRoot prop to PagesList for root header offset #3759

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3d625fa
Scope root header offset by adding isRoot to PagesList
conico974 Oct 27, 2025
1fd18c6
linting
conico974 Oct 27, 2025
334eba8
Merge branch 'main' into conico/rnd-8502-group-toc
conico974 Oct 28, 2025
a27ad82
fix
conico974 Oct 28, 2025
88094fd
lint fix
conico974 Oct 28, 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
11 changes: 6 additions & 5 deletions packages/gitbook/src/components/TableOfContents/PageGroupItem.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ import { tcls } from '@/lib/tailwind';
import { PagesList } from './PagesList';
import { TOCPageIcon } from './TOCPageIcon';

export function PageGroupItem(props: { page: ClientTOCPageGroup }) {
const { page } = props;
export function PageGroupItem(props: { page: ClientTOCPageGroup; isFirst?: boolean }) {
const { page, isFirst } = props;

return (
<li className="group/page-group-item flex flex-col">
<li className="flex flex-col">
<div
className={tcls(
'-top-6 group-first/page-group-item:-mt-6 sticky z-1 flex items-center gap-3 px-3 pt-6',
'-top-6 sticky z-1 flex items-center gap-3 px-3 pt-6',
'font-semibold text-xs uppercase tracking-wide',
'pb-3', // Add extra padding to make the header fade a bit nicer
'-mb-1.5', // Then pull the page items a bit closer, effective bottom padding is 1.5 units / 6px.
Expand All @@ -26,7 +26,8 @@ export function PageGroupItem(props: { page: ClientTOCPageGroup }) {
'[html.sidebar-filled.theme-muted_&]:bg-tint-base',
'[html.sidebar-filled.theme-bold.tint_&]:bg-tint-base',
'[html.sidebar-default.theme-gradient_&]:bg-gradient-primary',
'[html.sidebar-default.theme-gradient.tint_&]:bg-gradient-tint'
'[html.sidebar-default.theme-gradient.tint_&]:bg-gradient-tint',
isFirst ? '-mt-6' : ''
)}
>
<TOCPageIcon page={page} />
Expand Down
18 changes: 14 additions & 4 deletions packages/gitbook/src/components/TableOfContents/PagesList.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,16 @@ import { PageDocumentItem } from './PageDocumentItem';
import { PageGroupItem } from './PageGroupItem';
import { PageLinkItem } from './PageLinkItem';

export function PagesList(props: { pages: ClientTOCPage[]; style?: ClassValue }) {
const { pages, style } = props;
export function PagesList(props: {
pages: ClientTOCPage[];
style?: ClassValue;
isRoot?: boolean;
}) {
const { pages, style, isRoot = false } = props;

return (
<ul className={tcls('flex flex-col gap-y-0.5', style)}>
{pages.map((page) => {
{pages.map((page, idx) => {
switch (page.type) {
case 'document':
return <PageDocumentItem key={page.id} page={page} />;
Expand All @@ -23,7 +27,13 @@ export function PagesList(props: { pages: ClientTOCPage[]; style?: ClassValue })
return <PageLinkItem key={page.id} page={page} />;

case 'group':
return <PageGroupItem key={page.id} page={page} />;
return (
<PageGroupItem
key={page.id}
page={page}
isFirst={isRoot && idx === 0}
/>
);

default:
assertNever(page);
Expand Down
1 change: 1 addition & 0 deletions packages/gitbook/src/components/TableOfContents/TableOfContents.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ export async function TableOfContents(props: {
>
<PagesList
pages={pages}
isRoot={true}
style="page-no-toc:hidden border-tint-subtle sidebar-list-line:border-l"
/>
{customization.trademark.enabled ? (
Expand Down