Skip to content
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

Increase search bar size on sites with few header links #2766

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
+87 −42
Open

Increase search bar size on sites with few header links #2766

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
41cba63
Grow search bar conditionally if <5 header links are present
zenoachtig Jan 21, 2025
0562796
Changeset
zenoachtig Jan 21, 2025
ece3f20
Update Header.tsx
zenoachtig Jan 21, 2025
71141d7
Styling tweaks
zenoachtig Jan 21, 2025
3c21a5e
Header links and search button styling
zenoachtig Jan 22, 2025
a65654e
Balance links with search bar and variant dropdown
zenoachtig Jan 22, 2025
e0f7190
Format & lint
zenoachtig Jan 22, 2025
c924e29
Clean up
zenoachtig Jan 22, 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/selfish-rivers-approve.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'gitbook': patch
---

Grow search bar conditionally if <5 header links are present
76 changes: 52 additions & 24 deletions packages/gitbook/src/components/Header/Header.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ import { SearchButton } from '../Search';
import { SiteSectionTabs } from '../SiteSections';
import { HeaderMobileMenu } from './HeaderMobileMenu';

const MAX_HEADER_LINKS_FOR_BIG_SEARCHBAR = 4;

/**
* Render the header for the space.
*/
Expand Down Expand Up @@ -73,7 +75,7 @@ export function Header(props: {
<div
className={tcls(
'gap-4',
'lg:gap-8',
'lg:gap-6',
'flex',
'items-center',
'justify-between',
Expand All @@ -90,6 +92,11 @@ export function Header(props: {
'flex max-w-full',
isMultiVariants && 'page-no-toc:max-[400px]:w-full',
'shrink min-w-0 gap-2 lg:gap-4 justify-start items-center',
customization.header.links.length <=
MAX_HEADER_LINKS_FOR_BIG_SEARCHBAR
? 'lg:basis-72'
: '',
isMultiVariants && 'page-no-toc:lg:basis-auto',
)}
>
<HeaderMobileMenu
Expand Down Expand Up @@ -130,33 +137,29 @@ export function Header(props: {
</div>
)}

{customization.header.links.length > 0 && (
<HeaderLinks>
{customization.header.links.map((link, index) => {
return (
<HeaderLink
key={index}
link={link}
context={context}
customization={customization}
/>
);
})}
<HeaderLinkMore
label={t(getSpaceLanguage(customization), 'more')}
links={customization.header.links}
context={context}
customization={customization}
/>
</HeaderLinks>
)}
<div
className={tcls(
'flex',
'gap-4',
'md:min-w-56',
'grow-0',
'shrink-0',
'justify-self-end',
'items-center',
'grow-0 shrink-0',
customization.header.links.length <=
MAX_HEADER_LINKS_FOR_BIG_SEARCHBAR
? [
'lg:grow',
'lg:min-w-40',
'max-w-lg',
'lg:ml-[max(calc((100%-18rem-48rem-3rem)/2),1.5rem)]',
'xl:ml-[max(calc((100%-18rem-48rem-14rem-3rem)/2),1.5rem)]',
'lg:mr-auto',
'page-no-toc:xl:ml-[max(calc((100%-18rem-48rem-18rem-3rem)/2),1.5rem)]',
isMultiVariants &&
'page-no-toc:lg:ml-0 page-no-toc:xl:ml-0',
'order-last',
'lg:order-[unset]',
]
: ['order-last'],
)}
>
<Suspense fallback={null}>
Expand All @@ -172,7 +175,9 @@ export function Header(props: {
'text-header-link/8',
'dark:text-header-link/8',
'hover:text-header-link',
'focus:text-header-link',
'dark:hover:text-header-link',
'dark:focus:text-header-link',

'ring-header-link/4',
'dark:ring-header-link/4',
Expand All @@ -182,7 +187,9 @@ export function Header(props: {
'[&_svg]:text-header-link/10',
'dark:[&_svg]:text-header-link/10',
'[&_.shortcut]:text-header-link/8',
'[&_.shortcut_kbd]:border-header-link/2',
'dark:[&_.shortcut]:text-header-link/8',
'dark:[&_.shortcut_kbd]:border-header-link/2',

'contrast-more:bg-header-background',
'contrast-more:text-header-link',
Expand Down Expand Up @@ -218,6 +225,27 @@ export function Header(props: {
</SearchButton>
</Suspense>
</div>

{customization.header.links.length > 0 && (
<HeaderLinks>
{customization.header.links.map((link, index) => {
return (
<HeaderLink
key={index}
link={link}
context={context}
customization={customization}
/>
);
})}
<HeaderLinkMore
label={t(getSpaceLanguage(customization), 'more')}
links={customization.header.links}
context={context}
customization={customization}
/>
</HeaderLinks>
)}
</div>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions packages/gitbook/src/components/Header/HeaderLink.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export async function HeaderLink(props: {
if (link.links && link.links.length > 0) {
return (
<Dropdown
className="shrink"
className="shrink left-auto right-0"
button={(buttonProps) => {
if (!target || !link.to) {
return (
Expand Down Expand Up @@ -159,7 +159,7 @@ function getHeaderLinkClassName(props: { headerPreset: CustomizationHeaderPreset
return tcls(
'flex items-center shrink',
'hover:text-header-link-400 dark:hover:text-light',
'min-w-0',
'min-w-0 hover:min-w-max',
'contrast-more:underline',

props.headerPreset === CustomizationHeaderPreset.Default
Expand Down
2 changes: 1 addition & 1 deletion packages/gitbook/src/components/Header/HeaderLinkMore.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ export function HeaderLinkMore(props: {

return (
<div className={`${styles.linkEllipsis} items-center z-20`}>
<Dropdown button={renderButton} className="-translate-x-48 md:translate-x-0">
<Dropdown button={renderButton} className="left-auto right-0 md:right-auto md:left-0">
<DropdownMenu>
{links.map((link, index) => (
<MoreMenuLink key={index} link={link} context={context} />
Expand Down
2 changes: 1 addition & 1 deletion packages/gitbook/src/components/Header/HeaderLinks.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export async function HeaderLinks({ children }: HeaderLinksProps) {
<div
className={tcls(
styles.containerHeaderlinks,
'grow shrink flex justify-end items-center gap-x-4 lg:gap-x-6 min-w-9 z-20 lg:[&>.button+.button]:-ml-2',
'grow-[2.5] shrink flex justify-end items-center gap-x-4 lg:gap-x-6 min-w-9 z-20 lg:[&>.button+.button]:-ml-2',
)}
>
{children}
Expand Down
2 changes: 1 addition & 1 deletion packages/gitbook/src/components/Header/HeaderLogo.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ function LogoFallback(props: HeaderLogoProps) {
<div
className={tcls(
'text-pretty',
'line-clamp-3',
'line-clamp-2',
'tracking-tight',
'max-w-[18ch]',
'lg:max-w-[24ch]',
Expand Down
2 changes: 1 addition & 1 deletion packages/gitbook/src/components/Header/SpacesDropdown.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ export function SpacesDropdown(props: { space: Space; spaces: Space[]; className
className,
)}
>
<span className={tcls('line-clamp-2', 'grow')}>{space.title}</span>
<span className={tcls('line-clamp-1', 'grow')}>{space.title}</span>
<DropdownChevron />
</div>
)}
Expand Down
16 changes: 8 additions & 8 deletions packages/gitbook/src/components/Header/headerLinks.module.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
.containerHeaderlinks {
container-type: inline-size;
container-name: headerlinks;
}

.linkEllipsis {
display: none;
& div > a {
display: none;
}
}

.containerHeaderlinks {
container-type: inline-size;
container-name: headerlinks;
}

@container headerlinks ( width < 150px ) {
.containerHeaderlinks > :nth-child(n + 1) {
display: none;
Expand Down Expand Up @@ -43,7 +43,7 @@
}
}
}
@container headerlinks ( width < 600px ) {
@container headerlinks ( width < 550px ) {
.containerHeaderlinks > :nth-child(n + 4) {
display: none;
}
Expand All @@ -54,7 +54,7 @@
}
}
}
@container headerlinks ( width < 750px ) {
@container headerlinks ( width < 650px ) {
.containerHeaderlinks > :nth-child(n + 5) {
display: none;
}
Expand All @@ -65,7 +65,7 @@
}
}
}
@container headerlinks ( width < 850px ) {
@container headerlinks ( width < 750px ) {
.containerHeaderlinks > :nth-child(n + 6) {
display: none;
}
Expand Down
20 changes: 16 additions & 4 deletions packages/gitbook/src/components/Search/SearchButton.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ export function SearchButton(props: { children?: React.ReactNode; style?: ClassV
'transition-all',
'hover:shadow-md',
'hover:scale-102',
'hover:ring-dark/2',
'hover:ring-dark/4',
'hover:text-dark/10',
'focus:shadow-md',
'focus:scale-102',
Expand All @@ -93,7 +93,7 @@ export function SearchButton(props: { children?: React.ReactNode; style?: ClassV
'dark:contrast-more:focus:ring-light',

'active:shadow-sm',
'active:scale-98',
'active:scale-100',

'md:justify-start',
'md:w-full',
Expand Down Expand Up @@ -131,18 +131,30 @@ const Shortcut = () => {
className={tcls(
'shortcut',
'hidden',
'md:inline',
'md:flex',
'justify-end',
'text-xs',
'font-mono',
'text-dark/7',
'leading-none',
'contrast-more:text-dark',
'dark:text-light-4/7',
'contrast-more:dark:text-light',
'whitespace-nowrap',
`[font-feature-settings:"calt",_"case"]`,
'gap-0.5',
'shrink-0',
'-mr-1',
)}
>
{operatingSystem === 'mac' ? '⌘' : 'Ctrl +'} K
<kbd
className={`rounded border border-dark/2 dark:border-light/2 px-1 min-w-5 h-5 flex justify-center items-center ${operatingSystem === 'mac' ? 'text-sm' : ''}`}
>
{operatingSystem === 'mac' ? '⌘' : 'Ctrl'}
</kbd>
<kbd className="rounded border border-dark/2 dark:border-light/2 size-5 flex justify-center items-center">
K
</kbd>
</div>
);
};
Loading