Files
supabase/apps/studio/components/ui/DevToolbar/ProjectStatusTab.tsx
Danny White e3d7267845 fix(studio): chip away explicit-tabindex ratchet debt (#48040)
## What kind of change does this PR introduce?

A11y cleanup follow-up to #47984 /
[DEPR-626](https://linear.app/supabase/issue/DEPR-626).

## What is the current behavior?

Studio had 82 ratcheted `supabase/require-explicit-tabindex` violations
(raw `<button>` / `role="button"` without explicit `tabIndex`).

## What is the new behavior?

- Explicit `tabIndex={0}` (or disabled → `-1`) on those Studio call
sites across nav, `components/ui`, Database, Storage, and the remainder
- Ratchet baseline cleared (**82 → 0**) and the rule **removed from the
Studio ratchet** (debt is gone; ratchet is temporary)
- Rule remains a shared **`warn`** for now — promoting to `error` (and
sweeping www/docs/design-system) is a follow-up
- Also fixed the learn/ui-library call sites that surfaced while
experimenting with error promotion
- Small follow-ups where making controls focusable exposed gaps:
accessible names, disabled/focus consistency, focus-ring polish on
To-test surfaces, home section `KeyboardSensor`, and an E2E locator
tightened after `aria-label="Remove column"`

Prefer migrating to `Button` from `ui` in future touch-ups; this PR
takes the minimal path so Studio debt can stay at zero.

## Additional context

Batches landed together so baseline conflicts stayed simple while
chipping away:

- Hotspots / nav (FirstLevelNav, Marketplace, AttachmentUpload, Column,
Tabs, …)
- `components/ui` shared
- Database + Storage
- Remainder

**Out of scope / intentional deferrals**

- Promoting `supabase/require-explicit-tabindex` to a lint **error**
(follow-up after www/docs/design-system sweeps)
- Tabs/Radio roving, tooltips, context menus, in-menu items
- Full keyboard-accessible tab-close UX (close stays hover +
`tabIndex={-1}`; context menu still closes tabs)
- Data API docs links (`/project/<ref>/api` redirect)

**Reviewer notes**

- Rule only flags raw `<button>` / `role="button"` without a `tabIndex`
prop. `Button` from `ui` already bakes this in
- `tabIndex={-1}` is intentional for disabled controls, in-menu /
roving-focus children, and hover-only tab close
- For dnd-kit grips, put `tabIndex` **after** `{...attributes}` so it
isn’t overwritten (TS2783)

### To test

Use **Safari** with macOS Keyboard navigation **off** (System Settings →
Keyboard). Chrome once for a sanity pass. For each surface below: Tab
until the control is focused, then activate with Enter/Space where
relevant.

1. **API Docs side panel** (Table Editor → open a table → **API docs**)
- Floating API Docs panel — **not** `/project/<ref>/api` (that redirects
to Data API docs; language ToggleGroup uses arrow keys; links are out of
scope)
- Left nav buttons — Tab through several and activate one; active
highlight / navigation still works

2. **Integrations → Marketplace**
- Enable **Integrations layout** feature preview first (avatar menu →
Feature previews)
   - `/org/<slug>/integrations` or project integrations marketplace
   - “Clear all”, grid/list toggles — Tab + activate

3. **Table Editor → create a table → Columns**
- Drag handles only appear while **creating** (not when editing an
existing table)
   - Tab to grip / remove (X) / sensitive-data eye if shown

4. **Project Home** — section drag handles
   - Tab to a grip (visible focus ring)
- Optional: Space to pick up, arrows to move, Space/Esc to drop
(KeyboardSensor added)
   - Mouse dnd still works

5. **Storage → Policies** — expand/collapse bucket list chevron
(design-system focus ring, no stuck grey open bg)

6. **Support form** (Help → Support) — attachment remove (×) and
add-attachment control when visible

Disabled controls should be **skipped** by Tab.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Accessibility Improvements**
* Improved keyboard navigation throughout Studio by explicitly managing
focus (`tabIndex`) across many interactive controls (menus, tabs,
tables, charts, dialogs, navigation, and form actions).
* Disabled or non-interactive controls are now removed from the tab
order (or made unfocusable), while available actions remain reachable.
* Ensured `type="button"` on relevant controls to prevent unintended
submissions, and refined keyboard focus behavior for various toggles and
copy/remove actions.
* **Chores**
* Updated the ESLint rule baseline configuration to match the new focus
behavior.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-07-21 08:22:43 +10:00

186 lines
6.5 KiB
TypeScript

'use client'
import { useQueryClient } from '@tanstack/react-query'
import { useParams } from 'common'
import { useEffect, useState } from 'react'
import { cn, Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from 'ui'
import { projectKeys } from '@/data/projects/keys'
import { useSetProjectStatus, type Project } from '@/data/projects/project-detail-query'
import {
clearPauseStatusOverride,
getPauseStatusOverride,
setPauseStatusOverride,
type PauseStateOverride,
} from '@/data/projects/project-pause-status-override'
import {
clearProjectStatusOverride,
getProjectStatusOverride,
setProjectStatusOverride,
} from '@/data/projects/project-status-override'
import { useSelectedOrganizationQuery } from '@/hooks/misc/useSelectedOrganization'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
import { PROJECT_STATUS } from '@/lib/constants'
type ProjectStatus = Project['status']
const STATUS_LABELS: Record<ProjectStatus, string> = {
INACTIVE: 'Paused',
ACTIVE_HEALTHY: 'Active (healthy)',
ACTIVE_UNHEALTHY: 'Active (unhealthy)',
COMING_UP: 'Coming up',
UNKNOWN: 'Unknown',
GOING_DOWN: 'Going down',
INIT_FAILED: 'Init failed',
REMOVED: 'Removed',
RESTARTING: 'Restarting',
RESTORING: 'Restoring',
RESTORE_FAILED: 'Restore failed',
UPGRADING: 'Upgrading',
PAUSING: 'Pausing',
PAUSE_FAILED: 'Pause failed',
RESIZING: 'Resizing',
}
const STATUS_OPTIONS = Object.values(PROJECT_STATUS)
const PAUSE_STATE_VALUE_REAL = 'real'
const PAUSE_STATE_OPTIONS: {
value: PauseStateOverride | typeof PAUSE_STATE_VALUE_REAL
label: string
}[] = [
{ value: PAUSE_STATE_VALUE_REAL, label: 'Real data' },
{ value: 'restorable', label: 'Restorable (can resume)' },
{ value: 'restore-disabled', label: 'Restore disabled (90+ days)' },
]
export const ProjectStatusTab = () => {
const { ref } = useParams()
const queryClient = useQueryClient()
const { setProjectStatus } = useSetProjectStatus()
const { data: project } = useSelectedProjectQuery()
const { data: selectedOrg } = useSelectedOrganizationQuery()
const orgSlug = selectedOrg?.slug
const [statusOverride, setStatusOverride] = useState<ProjectStatus | undefined>(undefined)
const [pauseOverride, setPauseOverride] = useState<PauseStateOverride | undefined>(undefined)
useEffect(() => {
setStatusOverride(getProjectStatusOverride(ref))
setPauseOverride(getPauseStatusOverride(ref))
}, [ref])
const currentStatus = statusOverride ?? project?.status
const isPaused = currentStatus === PROJECT_STATUS.INACTIVE
const hasOverride = statusOverride !== undefined || pauseOverride !== undefined
const refetchProjectStatus = () => {
queryClient.invalidateQueries({ queryKey: projectKeys.detail(ref) })
queryClient.invalidateQueries({ queryKey: projectKeys.infiniteList() })
if (orgSlug) {
queryClient.invalidateQueries({ queryKey: projectKeys.infiniteListByOrg(orgSlug) })
}
}
const handleStatusChange = (status: ProjectStatus) => {
if (!ref) return
setProjectStatusOverride(ref, status)
setStatusOverride(status)
setProjectStatus({ ref, slug: orgSlug, status })
}
const handlePauseStateChange = (value: PauseStateOverride | typeof PAUSE_STATE_VALUE_REAL) => {
if (!ref) return
if (value === PAUSE_STATE_VALUE_REAL) {
clearPauseStatusOverride(ref)
setPauseOverride(undefined)
} else {
setPauseStatusOverride(ref, value)
setPauseOverride(value)
}
queryClient.invalidateQueries({ queryKey: projectKeys.pauseStatus(ref) })
}
const handleReset = () => {
if (ref) {
clearProjectStatusOverride(ref)
clearPauseStatusOverride(ref)
}
setStatusOverride(undefined)
setPauseOverride(undefined)
refetchProjectStatus()
queryClient.invalidateQueries({ queryKey: projectKeys.pauseStatus(ref) })
}
const isDisabled = !ref
return (
<div className="p-6 space-y-4">
<div className="flex items-center justify-between">
<p className="text-sm text-foreground-light">
Override the status of the current project. Overrides persist across refetches until
reset.
</p>
<button
onClick={handleReset}
disabled={isDisabled || !hasOverride}
tabIndex={isDisabled || !hasOverride ? -1 : 0}
className="text-xs text-foreground-lighter hover:text-foreground transition underline disabled:opacity-50 disabled:cursor-not-allowed"
>
Reset to real data
</button>
</div>
{isDisabled && (
<p className="text-xs text-foreground-muted">Navigate to a project page to use this tab.</p>
)}
<div className={cn('space-y-3', isDisabled && 'opacity-50 pointer-events-none')}>
<div className="flex items-center justify-between">
<span className="text-sm text-foreground-light">Status</span>
<Select
value={currentStatus}
onValueChange={(value) => handleStatusChange(value as ProjectStatus)}
>
<SelectTrigger className="w-64 text-xs">
<SelectValue placeholder="Select a status" />
</SelectTrigger>
<SelectContent>
{STATUS_OPTIONS.map((status) => (
<SelectItem key={status} value={status} className="text-xs">
{STATUS_LABELS[status]}
<span className="ml-1.5 font-mono text-foreground-lighter">{status}</span>
</SelectItem>
))}
</SelectContent>
</Select>
</div>
<div className={cn('flex items-center justify-between', !isPaused && 'opacity-50')}>
<div className="flex flex-col">
<span className="text-sm text-foreground-light">Pause state</span>
<span className="text-xs text-foreground-muted">Applies when status is Paused</span>
</div>
<Select
value={pauseOverride ?? PAUSE_STATE_VALUE_REAL}
onValueChange={(value) =>
handlePauseStateChange(value as PauseStateOverride | typeof PAUSE_STATE_VALUE_REAL)
}
>
<SelectTrigger className="w-64 text-xs">
<SelectValue placeholder="Select a pause state" />
</SelectTrigger>
<SelectContent>
{PAUSE_STATE_OPTIONS.map((option) => (
<SelectItem key={option.value} value={option.value} className="text-xs">
{option.label}
</SelectItem>
))}
</SelectContent>
</Select>
</div>
</div>
</div>
)
}