Files
supabase/apps/studio/components/ui/ProductMenu/ProductMenuItem.tsx
Danny White c8aca8d3a0 chore(design-system): standardise keyboard focus rings (#41575)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

## What kind of change does this PR introduce?

UI / design-system consistency (accessibility).

## What is the current behavior?

Keyboard focus rings are inconsistent across Studio and `packages/ui`:

- Custom Button uses thick `outline` with per-variant colours (brand /
grey / destructive / warning)
- Form controls use muted grey rings (`ring-background-control`)
- Tabs / NavMenu / Radio use soft brand `ring-ring`
- Studio `.inset-focus` uses dark green `outline-brand-600`

Related: [DEPR-354](https://linear.app/supabase/issue/DEPR-354).

## What is the new behavior?

One shared focus recipe, exposed as Tailwind `@utility` classes in
`packages/config/css/utilities.css`:

| Utility | Use when |
| --- | --- |
| `focus-ring` | Buttons, inputs, most controls (offset ring) |
| `focus-inset` | Dense/flush surfaces such as interactive table rows
(renamed from `inset-focus`) |

```txt
# focus-ring
outline-hidden
focus-visible:ring-2
focus-visible:ring-ring
focus-visible:ring-offset-2
focus-visible:ring-offset-background
```

Applied on Button, shadcn form controls, Menu/NavMenu, Command palette
trigger, Studio table rows, and related call sites. Documented in the
design-system accessibility docs. Variants do not change focus ring
colour.

When the ring must appear on a different element than the focused one
(e.g. Menu + ProductMenu `Link` via `group-focus-visible`, or InputGroup
via `:has()`), keep an explicit ring stack. The utilities bake in
`:focus-visible` on the same element.

## Additional context

**Out of scope**

- Full `packages/ui` / Studio / www sweep
- Legacy Studio form-group green box-shadow cleanup
- ESLint rule for bare `outline-none`

## Test plan

Prefer Safari (“hard mode” for `tabIndex`). Expect one soft brand ring
everywhere: not grey, not solid green outline.

### Design system

- [ ]
[Accessibility](https://design-system-git-dnywh-choreimprove-tab-focus-styles-supabase.vercel.app/design-system/docs/accessibility):
recipe docs match what you see
- [ ]
[Button](https://design-system-git-dnywh-choreimprove-tab-focus-styles-supabase.vercel.app/design-system/docs/components/button):
Tab primary / default / danger; same ring colour
- [ ] [Table → Row-level
navigation](https://design-system-git-dnywh-choreimprove-tab-focus-styles-supabase.vercel.app/design-system/docs/components/table#row-level-navigation):
Tab an interactive row; inset outline (`focus-inset`) sits inside the
row

### Studio

- [ ] **Org home → table view** (`/organizations/_` or org projects):
switch to the table layout, Tab onto a project row; inset outline sits
inside the row (list/card view uses CardButton, not `focus-inset`)
- [ ] **Project sidebar** (Database, Auth, Storage, …): Tab the main
product nav links; ring follows the focused item (not the nested section
menus like Tables / Roles)
- [ ] **Storage → Files**: Tab a bucket row; same inset outline as org
table rows
- [ ] **Project Settings → General** (or Compute and Disk): Tab through
inputs, checkboxes, switches, selects; same offset ring, no ring on
mouse click
- [ ] **Header ⌘K** (desktop width): Tab to the search control after
Feedback; same soft brand `focus-ring` (was a thicker
`ring-border-strong` before)
- [ ] **Table Editor or SQL Editor tabs**: focus a tab, Tab to × if
active; close shows a ring
- [ ] **Light + dark**: ring stays visible against both backgrounds
2026-07-22 12:10:07 -04:00

104 lines
2.5 KiB
TypeScript

import Link from 'next/link'
import { Badge, Button, Menu } from 'ui'
import { ProductMenuGroupItem } from './ProductMenu.types'
import { ShortcutTooltip } from '@/components/ui/ShortcutTooltip'
interface ProductMenuItemProps {
item: ProductMenuGroupItem
isActive: boolean
target?: '_blank' | '_self'
hoverText?: string
onClick?: () => void
}
export const ProductMenuItem = ({
item,
isActive,
target = '_self',
hoverText = '',
onClick,
}: ProductMenuItemProps) => {
const {
name = '',
url = '',
icon,
rightIcon,
isExternal,
label,
disabled,
shortcutId,
isLoading,
} = item
const menuItem = (
<Menu.Item icon={icon} active={isActive} onClick={onClick}>
<div className="flex w-full items-center justify-between gap-1">
<div
className="flex items-center gap-1 min-w-0 flex-1"
title={
shortcutId ? undefined : hoverText ? hoverText : typeof name === 'string' ? name : ''
}
>
<span className="truncate flex-1 min-w-0">{name}</span>
{label !== undefined && (
<Badge
className="shrink-0"
variant={label.toLowerCase() === 'new' ? 'success' : 'warning'}
>
{label}
</Badge>
)}
</div>
{rightIcon && <div>{rightIcon}</div>}
</div>
</Menu.Item>
)
// When data necessary to check whether an item should be disabled is not yet available, override the styles to avoid
// showing the disabled state just for a moment
if (isLoading) {
return <div className="pointer-events-none">{menuItem}</div>
}
if (disabled) {
return <div className="opacity-50 pointer-events-none">{menuItem}</div>
}
if (url) {
if (isExternal) {
const externalLink = (
<Button asChild block className="justify-start!" variant="text" size="small" icon={icon}>
<Link href={url} target="_blank" rel="noreferrer">
{name}
</Link>
</Button>
)
return shortcutId ? (
<ShortcutTooltip shortcutId={shortcutId} side="right" delayDuration={1000}>
{externalLink}
</ShortcutTooltip>
) : (
externalLink
)
}
const link = (
<Link href={url} className="group block" target={target} onClick={onClick}>
{menuItem}
</Link>
)
return shortcutId ? (
<ShortcutTooltip shortcutId={shortcutId} side="right" delayDuration={1000}>
{link}
</ShortcutTooltip>
) : (
link
)
}
return menuItem
}