mirror of
https://github.com/supabase/supabase.git
synced 2026-09-22 13:37:53 +08:00
a31ca2bad0
## 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>
270 lines
8.5 KiB
TypeScript
270 lines
8.5 KiB
TypeScript
import {
|
|
NavSectionCaret,
|
|
NavSectionContent,
|
|
NavSectionList,
|
|
} from '~/components/Navigation/NavSection'
|
|
import { useTheme } from 'next-themes'
|
|
import Image from 'next/legacy/image'
|
|
import Link from 'next/link'
|
|
import { usePathname } from 'next/navigation'
|
|
import { Accordion } from 'radix-ui'
|
|
import React, { useEffect, useRef } from 'react'
|
|
|
|
import MenuIconPicker from './MenuIconPicker'
|
|
|
|
type NavAccordionItem = {
|
|
url?: string
|
|
enabled?: boolean
|
|
items?: NavAccordionItem[]
|
|
}
|
|
|
|
function hasActiveDescendant(item: NavAccordionItem, pathname: string): boolean {
|
|
if (item.enabled === false) return false
|
|
if (item.url === pathname) return true
|
|
return item.items?.some((child) => hasActiveDescendant(child, pathname)) ?? false
|
|
}
|
|
|
|
function isRenderable(item: NavAccordionItem): boolean {
|
|
if (item.enabled === false) return false
|
|
if (item.url) return true
|
|
|
|
return item.items?.some(isRenderable) ?? false
|
|
}
|
|
|
|
const HeaderLink = React.memo(function HeaderLink(props: {
|
|
title: string
|
|
id: string
|
|
url: string
|
|
}) {
|
|
const pathname = usePathname()
|
|
|
|
return (
|
|
<span
|
|
className={[
|
|
' ',
|
|
!props.title && 'capitalize',
|
|
props.url === pathname ? 'text-brand' : 'hover:text-brand text-foreground',
|
|
].join(' ')}
|
|
>
|
|
{props.title ?? props.id}
|
|
</span>
|
|
)
|
|
})
|
|
|
|
const ContentAccordionLink = React.memo(function ContentAccordionLink(props: any) {
|
|
const pathname = usePathname()
|
|
const { resolvedTheme } = useTheme()
|
|
const childItems = props.subItem.items ?? []
|
|
const activeItem =
|
|
props.subItem.url === pathname &&
|
|
!childItems.some((child: NavAccordionItem) => child.url === pathname)
|
|
const activeItemRef = useRef<HTMLLIElement>(null)
|
|
const enabledChildren = childItems.filter(isRenderable)
|
|
const hasChildren = enabledChildren.length > 0
|
|
|
|
const isChildActive = enabledChildren.some((child: NavAccordionItem) =>
|
|
hasActiveDescendant(child, pathname)
|
|
)
|
|
|
|
const accordionValue = props.subItem.url || props.subItem.name
|
|
|
|
const LinkContainer = (props) => {
|
|
const isExternal = props.url.startsWith('https://')
|
|
|
|
return (
|
|
<Link
|
|
href={props.url}
|
|
className={props.className}
|
|
target={isExternal ? '_blank' : undefined}
|
|
rel={isExternal ? 'noopener noreferrer' : undefined}
|
|
>
|
|
{props.children}
|
|
</Link>
|
|
)
|
|
}
|
|
|
|
useEffect(() => {
|
|
// scroll to active item
|
|
if (activeItem && activeItemRef.current) {
|
|
// this is a hack, but seems a common one on Stackoverflow
|
|
setTimeout(() => {
|
|
activeItemRef.current?.scrollIntoView({ behavior: 'smooth', block: 'nearest' })
|
|
}, 0)
|
|
}
|
|
})
|
|
|
|
if (!hasChildren && !props.subItem.url) return null
|
|
|
|
return (
|
|
<li ref={!hasChildren && activeItem ? activeItemRef : null}>
|
|
{hasChildren ? (
|
|
<Accordion.Root
|
|
collapsible
|
|
type="single"
|
|
className="space-y-0.5"
|
|
defaultValue={isChildActive ? accordionValue : undefined}
|
|
>
|
|
<Accordion.Item key={accordionValue} value={accordionValue}>
|
|
<Accordion.Trigger
|
|
className={[
|
|
'flex items-center gap-2 w-full',
|
|
'cursor-pointer transition text-sm',
|
|
'focus-inset rounded-md',
|
|
activeItem
|
|
? 'text-brand font-medium'
|
|
: 'hover:text-foreground text-foreground-lighter',
|
|
].join(' ')}
|
|
>
|
|
<span className="flex items-center justify-between w-full">
|
|
<div className="flex items-center gap-2">
|
|
{props.subItem.icon && (
|
|
<Image
|
|
alt={props.subItem.name}
|
|
src={`${props.subItem.icon}${!resolvedTheme?.includes('dark') ? '-light' : ''}.svg`}
|
|
width={15}
|
|
height={15}
|
|
/>
|
|
)}
|
|
{props.subItem.name}
|
|
</div>
|
|
<NavSectionCaret />
|
|
</span>
|
|
</Accordion.Trigger>
|
|
<Accordion.Content asChild>
|
|
<NavSectionContent>
|
|
<NavSectionList>
|
|
{enabledChildren.map((child) => {
|
|
if (child.items && child.items.length > 0) {
|
|
return <ContentAccordionLink key={child.name} subItem={child} />
|
|
}
|
|
|
|
return (
|
|
<li key={`${props.subItem.name}-${child.url}`}>
|
|
<Link
|
|
href={child.url}
|
|
className={[
|
|
'relative block py-1.25 pl-1 -ml-1 cursor-pointer transition text-sm',
|
|
'focus-inset rounded-md',
|
|
child.url === pathname
|
|
? 'text-brand'
|
|
: 'hover:text-brand text-foreground-lighter',
|
|
].join(' ')}
|
|
>
|
|
{child.url === pathname && (
|
|
<span
|
|
aria-hidden
|
|
className="absolute left-[-13px] top-1/2 h-[1em] w-px -translate-y-1/2 bg-current"
|
|
/>
|
|
)}
|
|
{child.name}
|
|
</Link>
|
|
</li>
|
|
)
|
|
})}
|
|
</NavSectionList>
|
|
</NavSectionContent>
|
|
</Accordion.Content>
|
|
</Accordion.Item>
|
|
</Accordion.Root>
|
|
) : (
|
|
<LinkContainer
|
|
url={props.subItem.url}
|
|
className={[
|
|
'flex items-center gap-2',
|
|
'cursor-pointer transition text-sm',
|
|
'focus-inset rounded-md',
|
|
activeItem ? 'text-brand font-medium' : 'hover:text-foreground text-foreground-lighter',
|
|
].join(' ')}
|
|
parent={props.subItem.parent}
|
|
>
|
|
<div className="flex items-center gap-2">
|
|
{props.subItem.icon && (
|
|
<Image
|
|
alt={props.subItem.name}
|
|
src={`${props.subItem.icon}${!resolvedTheme?.includes('dark') ? '-light' : ''}.svg`}
|
|
width={15}
|
|
height={15}
|
|
/>
|
|
)}
|
|
{props.subItem.name}
|
|
</div>
|
|
</LinkContainer>
|
|
)}
|
|
</li>
|
|
)
|
|
})
|
|
|
|
const ContentLink = React.memo(function ContentLink(props: any) {
|
|
const pathname = usePathname()
|
|
|
|
return (
|
|
<li className="mb-1.5">
|
|
<Link
|
|
href={props.url}
|
|
className={[
|
|
'cursor-pointer transition text-sm',
|
|
'focus-inset rounded-md',
|
|
props.url === pathname ? 'text-brand' : 'hover:text-foreground text-foreground-lighter',
|
|
].join(' ')}
|
|
>
|
|
{props.icon && (
|
|
<Image alt={props.icon} width={12} height={12} src={`${pathname}${props.icon}`} />
|
|
)}
|
|
{props.name}
|
|
</Link>
|
|
</li>
|
|
)
|
|
})
|
|
|
|
const Content = (props) => {
|
|
const { menu, id } = props
|
|
|
|
if (menu.enabled === false) {
|
|
return null
|
|
}
|
|
|
|
return (
|
|
<div className="relative w-full flex flex-col gap-0 pb-5">
|
|
<Link href={menu.url ?? ''}>
|
|
<div className="flex items-center gap-3 my-3 text-brand">
|
|
<MenuIconPicker icon={menu.icon} />
|
|
<HeaderLink title={menu.title} url={menu.url} id={id} />
|
|
</div>
|
|
</Link>
|
|
|
|
<ul data-testid="docs-guide-navigation-list" className="flex flex-col gap-0">
|
|
{menu.items.map((entry) => {
|
|
if (entry.enabled === false) return null
|
|
|
|
if (entry.items && entry.items.length > 0) {
|
|
const enabledItems = entry.items.filter(isRenderable)
|
|
if (enabledItems.length === 0) return null
|
|
|
|
return (
|
|
<li key={entry.name}>
|
|
<div className="flex flex-col gap-2.5">
|
|
<div className="h-px w-full bg-border my-3"></div>
|
|
<span className="font-mono text-xs uppercase text-foreground font-medium tracking-wider">
|
|
{entry.name}
|
|
</span>
|
|
<ul className="flex flex-col gap-2.5">
|
|
{enabledItems.map((subItem) => (
|
|
<ContentAccordionLink key={subItem.name} subItem={subItem} />
|
|
))}
|
|
</ul>
|
|
</div>
|
|
</li>
|
|
)
|
|
}
|
|
|
|
return entry.url ? (
|
|
<ContentLink url={entry.url} icon={entry.icon} name={entry.name} key={entry.name} />
|
|
) : null
|
|
})}
|
|
</ul>
|
|
</div>
|
|
)
|
|
}
|
|
|
|
export default React.memo(Content)
|