Skip to content

New design for tabs block #3312

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 11 commits into
base: main
Choose a base branch
from
+140 −100
Open

New design for tabs block #3312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
8e75e3b
First iteration
zenoachtig Jun 11, 2025
8e3e514
Second iteration, ready
zenoachtig Jun 12, 2025
60015f5
Changeset
zenoachtig Jun 12, 2025
da67711
Fix crash on Vercel (#3311)
SamyPesse Jun 12, 2025
315717f
Disable the background fetch of getRevisionPageDocument (#3313)
SamyPesse Jun 13, 2025
50e8b2e
Don't use next/server after (#3314)
SamyPesse Jun 13, 2025
28a9ee7
Add paypal.gitbook.com to ADAPTIVE_CONTENT_HOSTS list (#3315)
spastorelli Jun 13, 2025
34a11d3
First iteration
zenoachtig Jun 11, 2025
17df1be
Second iteration, ready
zenoachtig Jun 12, 2025
e2dd8a9
Changeset
zenoachtig Jun 12, 2025
b475655
Merge branch 'redesign-tabs' of https://github.com/GitbookIO/gitbook …
zenoachtig Jun 18, 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
5 changes: 5 additions & 0 deletions .changeset/tough-lobsters-perform.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"gitbook": minor
---

New design for tab blocks
23 changes: 13 additions & 10 deletions packages/gitbook-v2/src/lib/data/pages.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,19 @@ export async function getPageDocument(
}

// Pre-fetch the document to start filling the cache before we migrate to this API.
if (isInPercentRollout(space.id, 10)) {
await waitUntil(
getDataOrNull(
dataFetcher.getRevisionPageDocument({
spaceId: space.id,
revisionId: space.revision,
pageId: page.id,
})
)
);
if (process.env.NODE_ENV === 'development') {
// Disable for now to investigate side-effects
if (isInPercentRollout(space.id, 10) || process.env.VERCEL_ENV === 'preview') {
await waitUntil(
getDataOrNull(
dataFetcher.getRevisionPageDocument({
spaceId: space.id,
revisionId: space.revision,
pageId: page.id,
})
)
);
}
}

return null;
Expand Down
1 change: 1 addition & 0 deletions packages/gitbook-v2/src/middleware.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ type URLWithMode = { url: URL; mode: 'url' | 'url-host' };
*/
const ADAPTIVE_CONTENT_HOSTS = [
'docs.gitbook.com',
'paypal.gitbook.com',
'adaptive-docs.gitbook-staging.com',
'enriched-content-playground.gitbook-staging.io',
'docs.testgitbook.com',
Expand Down
183 changes: 104 additions & 79 deletions packages/gitbook/src/components/DocumentView/Tabs/DynamicTabs.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,9 @@ export function DynamicTabs(
);
}, [id, tabs, tabsState]);

const position: string = 'top'; // TODO: Get position from tab block options
const description = null; // TODO: Get description from tabs

// To avoid issue with hydration, we only use the state from localStorage
// once the component has been mounted.
// Otherwise because of the streaming/suspense approach, tabs can be first-rendered at different time
Expand Down Expand Up @@ -143,110 +146,121 @@ export function DynamicTabs(
return (
<div
className={tcls(
'rounded-lg',
'straight-corners:rounded-sm',
'ring-1',
'ring-inset',
'ring-tint-subtle',
'flex',
'flex-col',
position === 'left' && 'gap-4 md:flex-row',
position === 'right' && 'gap-4 md:flex-row-reverse',
'overflow-hidden',
style

style,
// We need to inset the tabs container to make edge-to-edge scrolling work, since this container has overflow:hidden
// Also important to put this after the `style` to override those.
'-mx-4',
'px-4',
'sm:-mx-6',
'sm:px-6',
'md:mx-auto',
'md:px-0',
'w-auto',
'md:w-full'
)}
>
<div
role="tablist"
className={tcls(
'group/tabs',
'inline-flex',
'flex',
tabs.length > 3 ? 'md:flex-wrap' : '',

'overflow-x-auto',
'md:overflow-hidden',

'gap-1',
'pb-2',
'flex-row',
'self-stretch',
'after:flex-[1]',
'after:bg-tint-12/1',
// if last tab is selected, apply rounded to :after element
'[&:has(button.active-tab:last-of-type):after]:rounded-bl-md'

position === 'left' || position === 'right'
? 'gap-2 md:max-w-[40%] md:flex-col'
: '',
'snap-x',
'snap-mandatory',

// We need to inset the tablist to make edge-to-edge scrolling work.
'-mx-4',
'px-4',
'scroll-px-4',
'sm:-mx-6',
'sm:px-6',
'sm:scroll-px-6',
'md:mx-0',
'md:px-0',
'md:scroll-px-0'
)}
>
{tabs.map((tab) => (
<div
<button
key={tab.id}
type="button"
role="tab"
aria-selected={active.id === tab.id}
aria-controls={getTabPanelId(tab.id)}
id={getTabButtonId(tab.id)}
onClick={() => {
onSelectTab(tab);
}}
className={tcls(
hashLinkButtonWrapperStyles,
description
? 'px-4 py-4 max-md:min-w-64 max-md:max-w-[calc(50%-0.25rem)] '
: 'px-4 py-1',
description && position === 'top'
? 'max-w-[calc(50%-0.25rem)] max-md:min-w-64'
: 'max-w-full ',

'max-md:shrink-0',
'transition-colors',
'text-left',
'flex',
'items-center',
'gap-3.5',

//prev from active-tab
'[&:has(+_.active-tab)]:rounded-br-md',
'flex-col',
'gap-1',

//next from active-tab
'[.active-tab_+_&]:rounded-bl-md',

//next from active-tab
'[.active-tab_+_:after]:rounded-br-md',

'after:transition-colors',
'after:border-r',
'after:absolute',
'after:left-[unset]',
'after:right-0',
'after:border-tint',
'after:top-[15%]',
'after:h-[70%]',
'after:w-[1px]',

'px-3.5',
'py-2',

'last:after:border-transparent',
'rounded-md',
'straight-corners:rounded-none',
'circular-corners:rounded-2xl',
'focus:outline-none',
'focus-visible:ring-2',
'ring-inset',

'text-tint',
'bg-tint-12/1',
'hover:text-tint-strong',
'max-w-full',
'truncate',

'snap-start',
active.id === tab.id
? [
'shrink-0',
'active-tab',
'text-tint-strong',
'bg-transparent',
'after:[&.active-tab]:border-transparent',
'after:[:has(+_&.active-tab)]:border-transparent',
'after:[:has(&_+)]:border-transparent',
]
: null
? 'active-tab bg-primary-active text-primary-strong focus-visible:ring-primary-hover'
: 'hover:bg-tint-hover hover:text-tint-strong focus-visible:bg-tint-hover focus-visible:text-tint-strong focus-visible:ring-tint-hover'
)}
>
<button
type="button"
role="tab"
aria-selected={active.id === tab.id}
aria-controls={getTabPanelId(tab.id)}
id={getTabButtonId(tab.id)}
onClick={() => {
onSelectTab(tab);
}}
<div
className={tcls(
'inline-block',
'text-sm',
'transition-[color]',
'font-[500]',
'relative',
'max-w-full',
'truncate'
'flex flex-row items-center gap-1',
description ? 'font-semibold text-base' : 'font-medium text-sm'
)}
>
{tab.title}
</button>

<HashLinkButton
id={getTabButtonId(tab.id)}
block={block}
label="Direct link to tab"
/>
</div>
<div className="line-clamp-2">{tab.title}</div>
<HashLinkButton
id={getTabButtonId(tab.id)}
block={block}
label="Direct link to tab"
className={tcls(
'-mt-px ml-auto',
position === 'left' || position === 'right' || description
? 'max-md:-mr-3'
: '-mr-3'
)}
/>
</div>
{description ? (
<span className="line-clamp-5 text-sm">{description}</span>
) : null}
</button>
))}
</div>
{tabs.map((tab, index) => (
Expand All @@ -255,7 +269,18 @@ export function DynamicTabs(
role="tabpanel"
id={getTabPanelId(tab.id)}
aria-labelledby={getTabButtonId(tab.id)}
className={tcls('p-4', tab.id !== active.id ? 'hidden' : null)}
className={tcls(
'p-4',
'rounded-lg',
'flex-1',
'straight-corners:rounded-none',
'circular-corners:rounded-2xl',
'grow',
'ring-1',
'ring-inset',
'ring-tint-subtle',
tab.id !== active.id ? 'hidden' : null
)}
>
{tabsBody[index]}
</div>
Expand Down
28 changes: 17 additions & 11 deletions packages/gitbook/src/lib/waitUntil.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import type { ExecutionContext, IncomingRequestCfProperties } from '@cloudflare/workers-types';
import { getCloudflareContext as getCloudflareContextV2 } from '@v2/lib/data/cloudflare';
import { GITBOOK_RUNTIME } from '@v2/lib/env';
import { isV2 } from './v2';

let pendings: Array<Promise<unknown>> = [];
Expand Down Expand Up @@ -49,20 +50,25 @@ export async function waitUntil(promise: Promise<unknown>) {
return;
}

if (isV2()) {
const context = getCloudflareContextV2();
if (context) {
context.ctx.waitUntil(promise);
return;
if (GITBOOK_RUNTIME === 'cloudflare') {
if (isV2()) {
const context = getCloudflareContextV2();
if (context) {
context.ctx.waitUntil(promise);
return;
}
} else {
const cloudflareContext = await getGlobalContext();
if ('waitUntil' in cloudflareContext) {
cloudflareContext.waitUntil(promise);
return;
}
}
}

const cloudflareContext = await getGlobalContext();
if ('waitUntil' in cloudflareContext) {
cloudflareContext.waitUntil(promise);
} else {
await promise;
}
await promise.catch((error) => {
console.error('Ignored error in waitUntil', error);
});
}

/**
Expand Down
Loading