mirror of
https://github.com/supabase/supabase.git
synced 2026-09-06 18:11:51 +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 -->
221 lines
7.9 KiB
TypeScript
221 lines
7.9 KiB
TypeScript
import { ChevronDown } from 'lucide-react'
|
|
import { useMemo, useState, type ReactNode } from 'react'
|
|
import { cn, Collapsible, CollapsibleContent, CollapsibleTrigger, SuccessCheck } from 'ui'
|
|
|
|
import {
|
|
CreateOrganizationCard,
|
|
OrganizationCard,
|
|
} from '@/components/interfaces/Organization/OrganizationCard'
|
|
import { useLastVisitedOrganization } from '@/hooks/misc/useLastVisitedOrganization'
|
|
import type { Organization } from '@/types'
|
|
|
|
const VISIBLE_ORGANIZATIONS_LIMIT = 3
|
|
const CONNECT_DISCLOSURE_TRIGGER_CLASSNAME = cn(
|
|
'mx-auto flex h-7 cursor-pointer items-center justify-center gap-1.5 rounded-md px-2',
|
|
'text-xs text-foreground-lighter transition-colors',
|
|
'hover:bg-surface-200 hover:text-foreground',
|
|
'[&[data-state=open]>svg]:-rotate-180!'
|
|
)
|
|
|
|
export const OrganizationSelector = ({
|
|
organizations,
|
|
unavailableOrganizations = [],
|
|
selectedSlug,
|
|
disabled = false,
|
|
description,
|
|
createLabel,
|
|
createHrefParams,
|
|
onCreate,
|
|
onSelect,
|
|
getOrganizationDescription,
|
|
getUnavailableOrganizationDescription,
|
|
unavailableReason,
|
|
}: {
|
|
organizations: Organization[]
|
|
unavailableOrganizations?: Organization[]
|
|
selectedSlug?: string | null
|
|
disabled?: boolean
|
|
description?: ReactNode
|
|
createLabel?: string
|
|
createHrefParams?: { [key: string]: string }
|
|
onCreate?: () => void
|
|
onSelect: (slug: string) => void
|
|
getOrganizationDescription?: (organization: Organization) => ReactNode
|
|
getUnavailableOrganizationDescription?: (organization: Organization) => ReactNode
|
|
unavailableReason?: ReactNode
|
|
}) => {
|
|
const [showMore, setShowMore] = useState(false)
|
|
const { lastVisitedOrganization } = useLastVisitedOrganization()
|
|
|
|
const { visibleOrganizations, overflowOrganizations } = useMemo(() => {
|
|
const lastVisitedOrg = organizations.find(({ slug }) => slug === lastVisitedOrganization)
|
|
const selectedIndex = organizations.findIndex(({ slug }) => slug === selectedSlug)
|
|
const selectedInOverflow = selectedIndex >= VISIBLE_ORGANIZATIONS_LIMIT
|
|
|
|
if (!!lastVisitedOrg) {
|
|
const withoutLastVisited = organizations.filter(
|
|
({ slug }) => slug !== lastVisitedOrganization
|
|
)
|
|
return {
|
|
visibleOrganizations: [
|
|
lastVisitedOrg,
|
|
...withoutLastVisited.slice(0, VISIBLE_ORGANIZATIONS_LIMIT - 1),
|
|
],
|
|
overflowOrganizations: withoutLastVisited.slice(VISIBLE_ORGANIZATIONS_LIMIT - 1),
|
|
}
|
|
}
|
|
|
|
if (!selectedInOverflow || !selectedSlug) {
|
|
return {
|
|
visibleOrganizations: organizations.slice(0, VISIBLE_ORGANIZATIONS_LIMIT),
|
|
overflowOrganizations: organizations.slice(VISIBLE_ORGANIZATIONS_LIMIT),
|
|
}
|
|
}
|
|
|
|
const selected = organizations[selectedIndex]
|
|
const withoutSelected = organizations.filter(({ slug }) => slug !== selectedSlug)
|
|
|
|
return {
|
|
visibleOrganizations: [
|
|
...withoutSelected.slice(0, VISIBLE_ORGANIZATIONS_LIMIT - 1),
|
|
selected,
|
|
],
|
|
overflowOrganizations: withoutSelected.slice(VISIBLE_ORGANIZATIONS_LIMIT - 1),
|
|
}
|
|
}, [lastVisitedOrganization, organizations, selectedSlug])
|
|
|
|
const hasOverflow = overflowOrganizations.length > 0
|
|
const hasUnavailableOrganizations = unavailableOrganizations.length > 0
|
|
|
|
return (
|
|
<section className="space-y-2" aria-label="Organizations">
|
|
<div className="space-y-1">
|
|
<p className="text-xs font-medium uppercase tracking-wider text-foreground-light">
|
|
Organization
|
|
</p>
|
|
{description && <p className="text-xs text-foreground-lighter pr-4">{description}</p>}
|
|
</div>
|
|
<div className="space-y-2">
|
|
{visibleOrganizations.map((organization) => (
|
|
<ConnectOrganizationButton
|
|
key={organization.slug}
|
|
organization={organization}
|
|
selected={selectedSlug === organization.slug}
|
|
disabled={disabled}
|
|
onClick={() => onSelect(organization.slug)}
|
|
description={
|
|
getOrganizationDescription?.(organization) ?? getPlanDescription(organization)
|
|
}
|
|
/>
|
|
))}
|
|
|
|
{!!createLabel && (!!createHrefParams || !!onCreate) && (
|
|
<CreateOrganizationCard
|
|
params={createHrefParams}
|
|
label={createLabel}
|
|
disabled={disabled}
|
|
onClick={onCreate}
|
|
/>
|
|
)}
|
|
|
|
{hasOverflow && (
|
|
<Collapsible open={showMore} onOpenChange={setShowMore}>
|
|
<CollapsibleTrigger className={CONNECT_DISCLOSURE_TRIGGER_CLASSNAME}>
|
|
<span>{showMore ? 'Show fewer' : `Show ${overflowOrganizations.length} more`}</span>
|
|
<ChevronDown className="size-3.5 transition-transform" />
|
|
</CollapsibleTrigger>
|
|
<CollapsibleContent className="data-closed:animate-collapsible-up data-open:animate-collapsible-down overflow-hidden">
|
|
<div className="space-y-2 pt-1">
|
|
{overflowOrganizations.map((organization) => (
|
|
<ConnectOrganizationButton
|
|
key={organization.slug}
|
|
organization={organization}
|
|
selected={selectedSlug === organization.slug}
|
|
disabled={disabled}
|
|
onClick={() => onSelect(organization.slug)}
|
|
description={
|
|
getOrganizationDescription?.(organization) ?? getPlanDescription(organization)
|
|
}
|
|
/>
|
|
))}
|
|
</div>
|
|
</CollapsibleContent>
|
|
</Collapsible>
|
|
)}
|
|
|
|
{hasUnavailableOrganizations && (
|
|
<Collapsible>
|
|
<CollapsibleTrigger className={CONNECT_DISCLOSURE_TRIGGER_CLASSNAME}>
|
|
<span>Organizations that can't be linked</span>
|
|
<ChevronDown className="size-3.5 transition-transform" />
|
|
</CollapsibleTrigger>
|
|
<CollapsibleContent className="data-closed:animate-collapsible-up data-open:animate-collapsible-down overflow-hidden">
|
|
<div className="space-y-2 pt-1">
|
|
{unavailableOrganizations.map((organization) => (
|
|
<ConnectOrganizationButton
|
|
key={organization.slug}
|
|
organization={organization}
|
|
disabled
|
|
description={
|
|
getUnavailableOrganizationDescription?.(organization) ??
|
|
getPlanDescription(organization)
|
|
}
|
|
/>
|
|
))}
|
|
{unavailableReason && (
|
|
<p className="mx-auto max-w-xs text-center text-xs text-foreground-lighter text-balance">
|
|
{unavailableReason}
|
|
</p>
|
|
)}
|
|
</div>
|
|
</CollapsibleContent>
|
|
</Collapsible>
|
|
)}
|
|
</div>
|
|
</section>
|
|
)
|
|
}
|
|
|
|
const getPlanDescription = (organization: Organization) => `${organization.plan.name} Plan`
|
|
|
|
const ConnectOrganizationButton = ({
|
|
organization,
|
|
selected,
|
|
disabled,
|
|
onClick,
|
|
description,
|
|
}: {
|
|
organization: Organization
|
|
selected?: boolean
|
|
disabled?: boolean
|
|
onClick?: () => void
|
|
description?: ReactNode
|
|
}) => (
|
|
<button
|
|
type="button"
|
|
tabIndex={disabled ? -1 : 0}
|
|
disabled={disabled}
|
|
onClick={onClick}
|
|
aria-pressed={selected}
|
|
className={cn(
|
|
'group relative block w-full cursor-pointer text-left disabled:cursor-not-allowed disabled:opacity-50',
|
|
disabled && 'pointer-events-none'
|
|
)}
|
|
>
|
|
<OrganizationCard
|
|
isLink={false}
|
|
organization={organization}
|
|
description={description}
|
|
className={cn(
|
|
'pointer-events-none shadow-none transition-colors',
|
|
!disabled && !selected && 'group-hover:border-default group-hover:bg-surface-200',
|
|
selected &&
|
|
'border-brand bg-brand-200/20 dark:bg-brand-300 pr-10 group-hover:border-brand group-hover:bg-brand-200/20'
|
|
)}
|
|
/>
|
|
{selected && (
|
|
<SuccessCheck className="pointer-events-none absolute right-3 top-1/2 -translate-y-1/2" />
|
|
)}
|
|
</button>
|
|
)
|