mirror of
https://github.com/supabase/supabase.git
synced 2026-10-09 19:35:06 +03:00
## What kind of change does this PR introduce? Minor update ## What is the current behavior? Our design system’s breadcrumbs: 1. Are not interactive 2. ~~Repeat the page title, which is directly below~~ ## What is the new behavior? These breadcrumbs: - Are hyperlinked - Show all parents, if nested - ~~Don’t repeat the page title~~ | Before | After | | --- | --- | | <img width="1024" height="756" alt="Forms-FBDF180F-F101-407C-A8EB-A06BBDB3509A" src="https://github.com/user-attachments/assets/f2592b8b-b5d4-415f-af2e-28b99d5de0a0" /> | <img width="1024" height="794" alt="Forms-95348190-C8B2-4A3A-AE55-A4A5A16CD4B4" src="https://github.com/user-attachments/assets/7b296c20-b12a-48ff-9479-6547cda73cd5" /> | ## Additional context I wonder if we should either drop the `/docs/` subdirectory or rename it. The latter would make sense if we split, say, `/product/` from `/icons/` and/or `/brand`. [Primer](https://primer.style/octicons/design-guidelines/) does this well.
98 lines
3.1 KiB
TypeScript
98 lines
3.1 KiB
TypeScript
import { Doc } from 'contentlayer/generated'
|
|
import { ChevronLeft, ChevronRight } from 'lucide-react'
|
|
import Link from 'next/link'
|
|
|
|
import { docsConfig } from '@/config/docs'
|
|
import { cn } from '@/lib/utils'
|
|
import { NavItem, NavItemWithChildren } from '@/types/nav'
|
|
|
|
interface DocsPagerProps {
|
|
doc: Doc
|
|
}
|
|
|
|
export function DocsPager({ doc }: DocsPagerProps) {
|
|
const pager = getPagerForDoc(doc)
|
|
|
|
if (!pager) {
|
|
return null
|
|
}
|
|
|
|
const hasBoth = pager?.prev?.href && pager?.next?.href
|
|
|
|
return (
|
|
<div className={cn('flex flex-row items-center', hasBoth ? 'justify-between' : 'justify-end')}>
|
|
{pager?.prev?.href && (
|
|
<Link
|
|
href={pager.prev.href}
|
|
className="flex gap-3 text-foreground-light hover:text-foreground group"
|
|
>
|
|
<ChevronLeft className="mr-2 h-4 w-4 self-end mb-1 text-foreground-muted group-hover:text-foreground-lighter" />
|
|
<div className="flex flex-col gap-1">
|
|
<span className="text-xs font-mono uppercase tracking-wider text-foreground-muted group-hover:text-foreground-lighter">
|
|
Previous
|
|
</span>
|
|
{pager.prev.title}
|
|
</div>
|
|
</Link>
|
|
)}
|
|
{pager?.next?.href && (
|
|
<Link
|
|
href={pager.next.href}
|
|
className="flex gap-3 text-foreground-light hover:text-foreground group"
|
|
>
|
|
<div className="flex flex-col gap-1">
|
|
<span className="text-xs font-mono uppercase tracking-wider text-foreground-muted group-hover:text-foreground-lighter">
|
|
Next
|
|
</span>
|
|
{pager.next.title}
|
|
</div>
|
|
<ChevronRight className="ml-2 h-4 w-4 self-end mb-1 text-foreground-muted group-hover:text-foreground-lighter" />
|
|
</Link>
|
|
)}
|
|
</div>
|
|
)
|
|
}
|
|
|
|
export function getPagerForDoc(doc: Doc) {
|
|
const flattenedLinks = [null, ...flatten(docsConfig.sidebarNav), null]
|
|
const activeIndex = flattenedLinks.findIndex((link) => doc.slug === link?.href)
|
|
const prev = activeIndex !== 0 ? flattenedLinks[activeIndex - 1] : null
|
|
const next = activeIndex !== flattenedLinks.length - 1 ? flattenedLinks[activeIndex + 1] : null
|
|
return {
|
|
prev,
|
|
next,
|
|
}
|
|
}
|
|
|
|
export function flatten(links: NavItemWithChildren[]): NavItem[] {
|
|
return links
|
|
.reduce<NavItem[]>((flat, link) => {
|
|
return flat.concat(link.items?.length ? flatten(link.items) : link)
|
|
}, [])
|
|
.filter((link) => !link?.disabled)
|
|
}
|
|
|
|
export interface BreadcrumbSegment {
|
|
title: string
|
|
href?: string
|
|
}
|
|
|
|
export function getBreadcrumbSegments(doc: Doc): BreadcrumbSegment[] {
|
|
const segments: BreadcrumbSegment[] = [{ title: 'Docs', href: '/docs' }]
|
|
|
|
for (const section of docsConfig.sidebarNav) {
|
|
const flatItems = flatten(section.items ?? [])
|
|
const inSection = flatItems.some((item) => item.href === doc.slug)
|
|
if (!inSection || !section.title) continue
|
|
|
|
const sectionLanding = flatItems.find((item) => item.priority) ?? flatItems[0]
|
|
const isOnLanding = sectionLanding?.href === doc.slug
|
|
if (sectionLanding?.href && !isOnLanding) {
|
|
segments.push({ title: section.title, href: sectionLanding.href })
|
|
}
|
|
break
|
|
}
|
|
|
|
return segments
|
|
}
|