mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 09:25:06 +03:00
## What kind of change does this PR introduce? Bug fix and design-system update. Resolves DEPR-316. Follow-up rename (`text-brand` → `text-primary`) is in a dedicated PR (https://github.com/supabase/supabase/pull/50564) stacked on this one. ## What is the current behavior? `text-brand` resolves to the canonical bright brand green in places that need readable text, which fails WCAG AA on light surfaces. A separate `text-brand-display` token adds another green for large type. ## What is the new behavior? - `text-brand` maps to accessible `--primary` (light mode darkened to meet ~4.5:1 AA) - `--hue` / `--primary-hue` aligned to 157.5 - `text-brand-display` removed; former display callsites use `text-brand` - Bright fills/borders stay on `brand-default` - Design-system colour and typography docs updated | Before | After | | --- | --- | | <img width="514" height="112" alt="CleanShot 2026-09-02 at 11 13 09@2x" src="https://github.com/user-attachments/assets/4e0138a9-a32d-4e4c-a426-90736706e1e7" /> | <img width="512" height="138" alt="CleanShot 2026-09-21 at 11 42 05@2x" src="https://github.com/user-attachments/assets/164cc5b1-a0c5-4e93-95f1-80016641a114" /> | | <img width="864" height="266" alt="CleanShot 2026-09-02 at 11 13 53@2x" src="https://github.com/user-attachments/assets/3c1ca53f-bf9e-431e-bc15-816b4a275b8e" /> | <img width="882" height="248" alt="CleanShot 2026-09-21 at 11 41 37@2x" src="https://github.com/user-attachments/assets/24828e7b-ed6b-44cb-b9dc-becc3398bdfc" /> | | <img width="782" height="692" alt="CleanShot 2026-09-02 at 11 16 30@2x" src="https://github.com/user-attachments/assets/fc871977-77bc-47fb-9e0e-9284e0ecd5cc" /> | <img width="730" height="690" alt="CleanShot 2026-09-21 at 11 42 52@2x" src="https://github.com/user-attachments/assets/bf479515-d5f9-471e-b82d-f097c0f4b56c" /> | | <img width="480" height="306" alt="CleanShot 2026-09-02 at 11 18 53@2x" src="https://github.com/user-attachments/assets/03f341f4-f02e-44f8-a2b2-8c31670d0427" /> | <img width="470" height="300" alt="CleanShot 2026-09-21 at 11 43 19@2x" src="https://github.com/user-attachments/assets/9df18217-d5e6-48b8-ba0b-579d2664b94b" /> | | <img width="960" height="300" alt="CleanShot 2026-09-02 at 11 32 04@2x" src="https://github.com/user-attachments/assets/6b1d9373-7a71-4247-81ff-26441604b09d" /> | <img width="980" height="306" alt="CleanShot 2026-09-21 at 11 44 13@2x" src="https://github.com/user-attachments/assets/41ad4784-02ec-4b29-b860-32af9fa79aa8" /> | | <img width="924" height="214" alt="CleanShot 2026-09-02 at 11 34 44@2x" src="https://github.com/user-attachments/assets/1de661fe-c7b6-499b-a94f-e4737436ec79" /> | <img width="752" height="162" alt="CleanShot 2026-09-21 at 11 44 56@2x" src="https://github.com/user-attachments/assets/1811890f-0660-4445-84e9-447720954fa1" /> | ## To test Test each callsite **in light mode** (dark mode is largely unchanged). ### WWW - [Homepage](https://zone-www-dot-com-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/): “Scale to millions” uses readable brand text (display token is gone) - [Careers](https://zone-www-dot-com-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/careers): small “Careers” eyebrow readable; green dividers stay bright `brand-default` - [Contact](https://zone-www-dot-com-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/contact-us): email / policy links use readable brand text - [Regions](https://zone-www-dot-com-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/regions): “Ask about early access to BYOC” readable ### Docs - [Docs homepage](https://docs-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/docs): “DOCS” wordmark and resource links readable - [Database overview](https://docs-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/docs/guides/database/overview): nav / footer brand links readable - [JavaScript reference](https://docs-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/docs/reference/javascript/introduction): active sidebar treatment readable ### Design system - [Typography](https://design-system-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/docs/typography): documents `text-brand` only (no display) - [Colour usage](https://design-system-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/docs/color-usage): `text-brand` vs `bg-brand-default` - [Design-system homepage](https://design-system-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/): brand text examples across themes ### Studio - [Auth providers](https://studio-staging-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/dashboard/project/_/auth/providers): enabled provider badge text readable; status dot stays bright - [Database policies](https://studio-staging-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/dashboard/project/_/database/policies?new=true): template hover text more legible - [Database connections](https://studio-staging-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/dashboard/project/_/observability/connections): “Live” status readable; animated dot stays bright green --------- Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
185 lines
7.2 KiB
TypeScript
185 lines
7.2 KiB
TypeScript
import { REFERENCES } from '~/content/navigation.references'
|
|
import { ArrowLeft, ChevronRight } from 'lucide-react'
|
|
import Image from 'next/legacy/image'
|
|
import Link from 'next/link'
|
|
import { usePathname } from 'next/navigation'
|
|
import { Accordion } from 'radix-ui'
|
|
|
|
import { NavMenuGroup, NavMenuSection } from './Navigation.types'
|
|
|
|
const SideBar = ({ menuItems = [] }: { menuItems: any }) => {
|
|
const pathname = usePathname()
|
|
const pathSegments = pathname.split('/')
|
|
|
|
const isInReferencePages = pathSegments.includes('reference') && pathSegments.length >= 3
|
|
const referenceMeta = pathSegments.length >= 3 ? REFERENCES[pathSegments[2]] : undefined
|
|
|
|
const currentSection: NavMenuGroup = menuItems.find((group) => {
|
|
const foundItem = group.items.find((section) => {
|
|
if (section.items.length > 0) {
|
|
const foundSubItem = section.items.find((item) => {
|
|
if (item.url === pathname) return item
|
|
})
|
|
if (foundSubItem) return section
|
|
} else {
|
|
if (section.url === pathname) return section
|
|
}
|
|
})
|
|
if (foundItem) return group
|
|
})
|
|
|
|
const currentSubSection: NavMenuSection | undefined =
|
|
currentSection !== undefined
|
|
? currentSection.items.find((section) => {
|
|
if (section.items.length === 0) {
|
|
return undefined
|
|
} else {
|
|
return section.items.find((item) => {
|
|
if (item.url === pathname) return item
|
|
})
|
|
}
|
|
})
|
|
: undefined
|
|
|
|
return (
|
|
<div
|
|
className="bg-background border-muted sidebar-width sticky top-44
|
|
h-screen overflow-y-scroll border-r py-8 px-6 sidebar-menu-container hidden lg:block"
|
|
>
|
|
{isInReferencePages && (
|
|
<>
|
|
<Link href="/reference">
|
|
<div className="flex items-center space-x-4 opacity-75 hover:opacity-100 transition">
|
|
<ArrowLeft size={16} strokeWidth={2} className="text-foreground" />
|
|
<span className="text-sm text-foreground">All Reference Docs</span>
|
|
</div>
|
|
</Link>
|
|
{referenceMeta !== undefined && (
|
|
<div className="my-5 flex items-center space-x-4">
|
|
<div className="h-10 w-10 rounded-sm bg-surface-100 flex items-center justify-center">
|
|
<Image
|
|
className="rounded-sm"
|
|
width={24}
|
|
height={24}
|
|
alt={referenceMeta.name}
|
|
src={referenceMeta.icon}
|
|
/>
|
|
</div>
|
|
<p className="text-foreground font-bold">{referenceMeta.name}</p>
|
|
</div>
|
|
)}
|
|
</>
|
|
)}
|
|
{menuItems.length === 1 ? (
|
|
<div className="my-2">
|
|
{menuItems[0].items.map((item) => (
|
|
<Link key={item.name} href={item.url}>
|
|
<div
|
|
key={item.name}
|
|
className={[
|
|
'py-1.5 px-5 rounded-sm text-sm transition',
|
|
`${
|
|
item.url === pathname
|
|
? 'bg-background text-brand'
|
|
: 'text-foreground-light hover:text-foreground'
|
|
}`,
|
|
].join(' ')}
|
|
>
|
|
{item.name}
|
|
</div>
|
|
</Link>
|
|
))}
|
|
</div>
|
|
) : (
|
|
<Accordion.Root
|
|
collapsible
|
|
type="single"
|
|
defaultValue={currentSection?.label}
|
|
className="w-full space-y-0.5"
|
|
>
|
|
{menuItems.map((group: NavMenuGroup) => (
|
|
<Accordion.Item key={group.label} value={group.label}>
|
|
<Accordion.Trigger className="w-full flex items-center space-x-2 py-1.5">
|
|
<ChevronRight
|
|
className="transition text-foreground-lighter data-open-parent:rotate-90"
|
|
size={14}
|
|
strokeWidth={2}
|
|
/>
|
|
<span className="text-foreground text-sm group-hover:text-brand transition">
|
|
{group.label}
|
|
</span>
|
|
</Accordion.Trigger>
|
|
<Accordion.Content className="transition my-2 data-open:animate-slide-down data-closed:animate-slide-up">
|
|
{group.items.map((section: NavMenuSection) => {
|
|
if (section.items.length === 0) {
|
|
return (
|
|
<Link href={section.url || '#'} key={section.name}>
|
|
<div
|
|
className={[
|
|
'py-1.5 px-5 rounded-sm text-sm transition',
|
|
`${
|
|
section.url === pathname
|
|
? 'bg-background text-brand'
|
|
: 'text-foreground-light hover:text-foreground'
|
|
}`,
|
|
].join(' ')}
|
|
>
|
|
{section.name}
|
|
</div>
|
|
</Link>
|
|
)
|
|
} else {
|
|
return (
|
|
<Accordion.Root
|
|
collapsible
|
|
key={section.name}
|
|
type="single"
|
|
className="space-y-0.5"
|
|
defaultValue={currentSubSection?.name}
|
|
>
|
|
<Accordion.Item value={section.name}>
|
|
<Accordion.Trigger className="flex items-center space-x-2 px-4 py-1.5">
|
|
<ChevronRight
|
|
className="transition text-foreground-lighter data-open-parent:rotate-90"
|
|
size={14}
|
|
strokeWidth={2}
|
|
/>
|
|
<span className="text-foreground text-sm group-hover:text-brand transition">
|
|
{section.name}
|
|
</span>
|
|
</Accordion.Trigger>
|
|
<Accordion.Content className="my-2 data-open:animate-slide-down data-closed:animate-slide-up">
|
|
{section.items.map((item: NavMenuSection) => (
|
|
<Link key={item.name} href={item.url || '#'}>
|
|
<div
|
|
key={item.name}
|
|
className={[
|
|
'py-1.5 ml-4 px-5 rounded-sm text-sm transition',
|
|
`${
|
|
item.url === pathname
|
|
? 'bg-background text-brand'
|
|
: 'text-foreground-light hover:text-foreground'
|
|
}`,
|
|
].join(' ')}
|
|
>
|
|
{item.name}
|
|
</div>
|
|
</Link>
|
|
))}
|
|
</Accordion.Content>
|
|
</Accordion.Item>
|
|
</Accordion.Root>
|
|
)
|
|
}
|
|
})}
|
|
</Accordion.Content>
|
|
</Accordion.Item>
|
|
))}
|
|
</Accordion.Root>
|
|
)}
|
|
</div>
|
|
)
|
|
}
|
|
|
|
export default SideBar
|