mirror of
https://github.com/supabase/supabase.git
synced 2026-09-07 02:20:52 +08: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 -->
190 lines
5.2 KiB
TypeScript
190 lines
5.2 KiB
TypeScript
import { ChevronLeft, Code } from 'lucide-react'
|
|
import { useMemo, useState, type PropsWithChildren, type ReactNode } from 'react'
|
|
import {
|
|
Alert,
|
|
AlertDescription,
|
|
AlertTitle,
|
|
Button,
|
|
cn,
|
|
Popover,
|
|
PopoverContent,
|
|
PopoverTrigger,
|
|
} from 'ui'
|
|
|
|
import { navigateToSection } from './Content/Content.utils'
|
|
import { DOCS_RESOURCE_CONTENT } from './ProjectAPIDocs.constants'
|
|
import { DocsButton } from '@/components/ui/DocsButton'
|
|
import { useAppStateSnapshot } from '@/state/app-state'
|
|
|
|
type DocsResourceContentItem = (typeof DOCS_RESOURCE_CONTENT)[keyof typeof DOCS_RESOURCE_CONTENT]
|
|
|
|
export type MenuItemFilter = (item: DocsResourceContentItem) => boolean
|
|
export type ResourcePickerRenderProps = {
|
|
selectedResource?: string
|
|
onSelect: (value: string) => void
|
|
closePopover: () => void
|
|
}
|
|
|
|
type SecondLevelNavLayoutProps = {
|
|
category: string
|
|
title: string
|
|
docsUrl: string
|
|
menuItemFilter?: MenuItemFilter
|
|
renderResourceList: (props: ResourcePickerRenderProps) => ReactNode
|
|
}
|
|
|
|
export const SecondLevelNavLayout = ({
|
|
category,
|
|
title,
|
|
docsUrl,
|
|
menuItemFilter,
|
|
renderResourceList,
|
|
}: SecondLevelNavLayoutProps) => {
|
|
const snap = useAppStateSnapshot()
|
|
const [, resource] = snap.activeDocsSection
|
|
|
|
return (
|
|
<SecondLevelNavOuterContainer>
|
|
<SecondLevelNavInnerContainer>
|
|
<NavTitle title={title} category={category} />
|
|
<ResourcePicker
|
|
category={category}
|
|
resource={resource}
|
|
renderResourceList={renderResourceList}
|
|
/>
|
|
<MenuItems category={category} menuItemFilter={menuItemFilter} />
|
|
</SecondLevelNavInnerContainer>
|
|
|
|
<SecondLevelNavInnerContainer className="py-4 border-t">
|
|
<MoreInformation docsUrl={docsUrl} />
|
|
</SecondLevelNavInnerContainer>
|
|
</SecondLevelNavOuterContainer>
|
|
)
|
|
}
|
|
|
|
const SecondLevelNavOuterContainer = ({ children }: PropsWithChildren) => {
|
|
return <div className="py-2">{children}</div>
|
|
}
|
|
|
|
type SecondLevelLevelNavInnerContainerProps = PropsWithChildren<{
|
|
className?: string
|
|
}>
|
|
|
|
const SecondLevelNavInnerContainer = ({
|
|
children,
|
|
className,
|
|
}: SecondLevelLevelNavInnerContainerProps) => {
|
|
return <div className={cn('px-4', className)}>{children}</div>
|
|
}
|
|
|
|
type ResourcePickerProps = {
|
|
category: string
|
|
resource?: string
|
|
renderResourceList: (props: ResourcePickerRenderProps) => ReactNode
|
|
}
|
|
|
|
type NavTitleProps = {
|
|
title: string
|
|
category: string
|
|
}
|
|
|
|
const NavTitle = ({ title, category }: NavTitleProps) => {
|
|
const snap = useAppStateSnapshot()
|
|
const handleBack = () => {
|
|
snap.setActiveDocsSection([category])
|
|
}
|
|
|
|
return (
|
|
<div className="flex items-center space-x-2 mb-2">
|
|
<Button variant="text" icon={<ChevronLeft />} className="px-1" onClick={handleBack} />
|
|
<p className="text-sm text-foreground-light capitalize">{title}</p>
|
|
</div>
|
|
)
|
|
}
|
|
|
|
const ResourcePicker = ({ category, resource, renderResourceList }: ResourcePickerProps) => {
|
|
const snap = useAppStateSnapshot()
|
|
|
|
const [open, setOpen] = useState(false)
|
|
|
|
const handleSelect = (value: string) => {
|
|
snap.setActiveDocsSection([category, value])
|
|
setOpen(false)
|
|
}
|
|
|
|
return (
|
|
<Popover open={open} onOpenChange={setOpen} modal={false}>
|
|
<PopoverTrigger asChild>
|
|
<Button
|
|
variant="default"
|
|
size="small"
|
|
className="w-full justify-between gap-2"
|
|
iconRight={<Code className="rotate-90" />}
|
|
>
|
|
<span className="truncate">{resource ?? 'Select a resource'}</span>
|
|
</Button>
|
|
</PopoverTrigger>
|
|
<PopoverContent className="p-0 w-64" side="bottom" align="center">
|
|
{renderResourceList({
|
|
selectedResource: resource,
|
|
onSelect: handleSelect,
|
|
closePopover: () => setOpen(false),
|
|
})}
|
|
</PopoverContent>
|
|
</Popover>
|
|
)
|
|
}
|
|
|
|
type MenuItemsProps = {
|
|
category: string
|
|
menuItemFilter?: MenuItemFilter
|
|
}
|
|
|
|
const MenuItems = ({ category, menuItemFilter }: MenuItemsProps) => {
|
|
const menuItems = useMemo(() => {
|
|
const items = Object.values(DOCS_RESOURCE_CONTENT).filter(
|
|
(content) => content.category === category
|
|
)
|
|
return menuItemFilter ? items.filter(menuItemFilter) : items
|
|
}, [category, menuItemFilter])
|
|
|
|
return (
|
|
<div className="py-4 space-y-2">
|
|
{menuItems.map((item) => (
|
|
<button
|
|
key={item.key}
|
|
tabIndex={0}
|
|
className="w-full text-left text-sm text-foreground-light px-4 hover:text-foreground"
|
|
onClick={() => navigateToSection(item.key)}
|
|
>
|
|
{item.title}
|
|
</button>
|
|
))}
|
|
</div>
|
|
)
|
|
}
|
|
|
|
type MoreInformationProps = {
|
|
docsUrl: string
|
|
}
|
|
|
|
const MoreInformation = ({ docsUrl }: MoreInformationProps) => {
|
|
return (
|
|
<Alert className="p-3">
|
|
<AlertTitle>
|
|
<p className="text-xs">Unable to find what you're looking for?</p>
|
|
</AlertTitle>
|
|
<AlertDescription className="space-y-1">
|
|
<p className="text-xs leading-normal!">
|
|
The API methods shown here are only the commonly used ones to get you started building
|
|
quickly.
|
|
</p>
|
|
<p className="text-xs leading-normal!">
|
|
Head over to our docs site for the full API documentation.
|
|
</p>
|
|
<DocsButton className="mt-2!" href={docsUrl} />
|
|
</AlertDescription>
|
|
</Alert>
|
|
)
|
|
}
|