mirror of
https://github.com/supabase/supabase.git
synced 2026-10-07 10:25:06 +03:00
## 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 -->
245 lines
8.2 KiB
TypeScript
245 lines
8.2 KiB
TypeScript
import { zodResolver } from '@hookform/resolvers/zod'
|
|
import { ChevronUp, MoreVertical, Trash } from 'lucide-react'
|
|
import { useEffect, useState } from 'react'
|
|
import { useForm, type SubmitHandler } from 'react-hook-form'
|
|
import { toast } from 'sonner'
|
|
import {
|
|
Button,
|
|
cn,
|
|
Collapsible,
|
|
CollapsibleContent,
|
|
CollapsibleTrigger,
|
|
DropdownMenu,
|
|
DropdownMenuContent,
|
|
DropdownMenuItem,
|
|
DropdownMenuTrigger,
|
|
Form,
|
|
FormControl,
|
|
FormField,
|
|
Switch,
|
|
Tooltip,
|
|
TooltipContent,
|
|
TooltipTrigger,
|
|
} from 'ui'
|
|
import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout'
|
|
import * as z from 'zod'
|
|
|
|
import { ROLE_PERMISSIONS } from './Roles.constants'
|
|
import { useDatabaseRoleUpdateMutation } from '@/data/database-roles/database-role-update-mutation'
|
|
import type { PgRole } from '@/data/database-roles/database-roles-query'
|
|
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
|
|
|
|
interface RoleRowProps {
|
|
role: PgRole
|
|
disabled?: boolean
|
|
onSelectDelete: (role: string) => void
|
|
}
|
|
|
|
const permissionSchema = z.boolean().optional()
|
|
const formSchema = z.object(
|
|
Object.keys(ROLE_PERMISSIONS).reduce(
|
|
(acc, key) => ({
|
|
...acc,
|
|
[key]: permissionSchema,
|
|
}),
|
|
{} as Record<keyof typeof ROLE_PERMISSIONS, z.ZodBoolean>
|
|
)
|
|
)
|
|
|
|
export const RoleRow = ({ role, disabled = false, onSelectDelete }: RoleRowProps) => {
|
|
const { data: project } = useSelectedProjectQuery()
|
|
const [isExpanded, setIsExpanded] = useState(false)
|
|
const { mutate: updateDatabaseRole, isPending: isUpdating } = useDatabaseRoleUpdateMutation()
|
|
const form = useForm<z.infer<typeof formSchema>>({
|
|
resolver: zodResolver(formSchema),
|
|
defaultValues: role,
|
|
})
|
|
|
|
const { reset, formState } = form
|
|
const { isDirty } = formState
|
|
|
|
useEffect(() => {
|
|
reset(role)
|
|
}, [role, reset])
|
|
|
|
const onSaveChanges: SubmitHandler<z.infer<typeof formSchema>> = async (values) => {
|
|
if (!project) return console.error('Project is required')
|
|
|
|
const changed = Object.fromEntries(
|
|
Object.entries(values).filter(([k, v]) => {
|
|
const key = k as keyof PgRole
|
|
return v !== role[key]
|
|
})
|
|
)
|
|
|
|
if (Object.keys(changed).length === 0) {
|
|
// No actual changes to persist; avoid sending an empty update payload
|
|
reset(role)
|
|
return
|
|
}
|
|
|
|
updateDatabaseRole(
|
|
{
|
|
projectRef: project.ref,
|
|
connectionString: project.connectionString,
|
|
id: role.id,
|
|
payload: changed,
|
|
},
|
|
{
|
|
onSuccess: () => {
|
|
toast.success(`Successfully updated role "${role.name}"`)
|
|
reset(values)
|
|
},
|
|
}
|
|
)
|
|
}
|
|
|
|
const formId = `role-update-form-${role.id}`
|
|
|
|
return (
|
|
<Collapsible
|
|
open={isExpanded}
|
|
className={cn(
|
|
'bg-surface-100',
|
|
'hover:bg-overlay-hover',
|
|
'data-open:bg-selection',
|
|
'border-default hover:border-strong',
|
|
'data-open:border-strong',
|
|
'data-open:pb-px col-span-12 mx-auto',
|
|
'-space-y-px overflow-hidden',
|
|
'border border-t-0 first:border-t first:mt-0! hover:border-t hover:-mt-px shadow-sm transition hover:z-50',
|
|
'first:rounded-tl first:rounded-tr',
|
|
'last:rounded-bl last:rounded-br'
|
|
)}
|
|
>
|
|
<div className={cn('flex items-center relative', !disabled && 'pr-(--card-padding-x)')}>
|
|
<CollapsibleTrigger asChild>
|
|
<button
|
|
id={`collapsible-trigger-${role.id}`}
|
|
type="button"
|
|
tabIndex={0}
|
|
className="group flex w-full items-center justify-between rounded-sm py-3 px-card text-foreground"
|
|
onClick={(event) => {
|
|
event.preventDefault()
|
|
event.stopPropagation()
|
|
setIsExpanded(!isExpanded)
|
|
}}
|
|
>
|
|
<div className="flex items-start space-x-3">
|
|
<ChevronUp
|
|
className="text-border-stronger transition data-open-parent:rotate-0 data-closed-parent:rotate-180"
|
|
strokeWidth={2}
|
|
width={14}
|
|
/>
|
|
<div className="space-x-2 flex items-center">
|
|
<p className="text-left text-sm">{role.name}</p>
|
|
<p className="text-left text-sm text-foreground-light">(ID: {role.id})</p>
|
|
</div>
|
|
</div>
|
|
<div className="flex items-center space-x-4">
|
|
{role.activeConnections > 0 && (
|
|
<div className="relative h-2 w-2">
|
|
<span className="flex h-2 w-2">
|
|
<span className="absolute inline-flex h-full w-full animate-ping rounded-full bg-brand opacity-75"></span>
|
|
<span className="relative inline-flex h-2 w-2 rounded-full bg-brand opacity-75"></span>
|
|
</span>
|
|
</div>
|
|
)}
|
|
<p
|
|
className={cn(
|
|
`text-sm`,
|
|
role.activeConnections > 0 ? 'text-foreground' : 'text-foreground-light'
|
|
)}
|
|
>
|
|
{role.activeConnections} connections
|
|
</p>
|
|
</div>
|
|
</button>
|
|
</CollapsibleTrigger>
|
|
{!disabled && (
|
|
<DropdownMenu>
|
|
<Tooltip>
|
|
<TooltipTrigger asChild>
|
|
<DropdownMenuTrigger asChild>
|
|
<Button
|
|
variant="default"
|
|
className="px-1"
|
|
icon={<MoreVertical />}
|
|
aria-label={`${role.name} actions`}
|
|
/>
|
|
</DropdownMenuTrigger>
|
|
</TooltipTrigger>
|
|
<TooltipContent side="bottom">More options</TooltipContent>
|
|
</Tooltip>
|
|
<DropdownMenuContent side="bottom" align="end" className="w-[120px]">
|
|
<DropdownMenuItem
|
|
className="space-x-2"
|
|
onClick={(event) => {
|
|
event.stopPropagation()
|
|
onSelectDelete(role.id.toString())
|
|
}}
|
|
>
|
|
<Trash className="text-red-800" size="14" strokeWidth={2} />
|
|
<p>Delete</p>
|
|
</DropdownMenuItem>
|
|
</DropdownMenuContent>
|
|
</DropdownMenu>
|
|
)}
|
|
</div>
|
|
<CollapsibleContent>
|
|
<Form {...form}>
|
|
<form
|
|
id={formId}
|
|
onSubmit={form.handleSubmit(onSaveChanges)}
|
|
className="group border-t border-default bg-surface-100 py-6 px-5 md:px-20 text-foreground"
|
|
>
|
|
<div className="py-4 space-y-[9px]">
|
|
{(Object.keys(ROLE_PERMISSIONS) as (keyof typeof ROLE_PERMISSIONS)[]).map(
|
|
(permission) => (
|
|
<FormField
|
|
key={permission}
|
|
control={form.control}
|
|
name={permission}
|
|
disabled={disabled || ROLE_PERMISSIONS[permission].disabled}
|
|
render={({ field }) => (
|
|
<FormItemLayout
|
|
id={`${role.id}-${permission}`}
|
|
layout="flex"
|
|
label={ROLE_PERMISSIONS[permission].description}
|
|
>
|
|
<FormControl>
|
|
<Switch
|
|
id={`${role.id}-${permission}`}
|
|
checked={field.value}
|
|
onCheckedChange={field.onChange}
|
|
disabled={disabled || ROLE_PERMISSIONS[permission].disabled}
|
|
/>
|
|
</FormControl>
|
|
</FormItemLayout>
|
|
)}
|
|
/>
|
|
)
|
|
)}
|
|
</div>
|
|
{!disabled && (
|
|
<div className="py-4 flex items-center space-x-2 justify-end">
|
|
<Button variant="default" disabled={!isDirty || isUpdating} onClick={() => reset()}>
|
|
Cancel
|
|
</Button>
|
|
<Button
|
|
variant="primary"
|
|
type="submit"
|
|
disabled={!isDirty || isUpdating}
|
|
loading={isUpdating}
|
|
>
|
|
Save
|
|
</Button>
|
|
</div>
|
|
)}
|
|
</form>
|
|
</Form>
|
|
</CollapsibleContent>
|
|
</Collapsible>
|
|
)
|
|
}
|