Files
supabase/apps/studio/components/ui/Charts/ChartHighlightActions.tsx
T
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

152 lines
5.3 KiB
TypeScript

import dayjs from 'dayjs'
import { ArrowRight, SearchIcon } from 'lucide-react'
import { ReactNode, useEffect, useMemo, useState } from 'react'
import {
cn,
DropdownMenu,
DropdownMenuContent,
DropdownMenuItem,
DropdownMenuLabel,
DropdownMenuSeparator,
DropdownMenuTrigger,
} from 'ui'
import { ChartHighlight } from './useChartHighlight'
import { useFormatDateTime } from '@/lib/datetime'
const toFormattableDate = (value: string): string | number => {
const asNumber = Number(value)
return value !== '' && Number.isFinite(asNumber) ? asNumber : value
}
export type UpdateDateRange = (from: string, to: string) => void
export type ChartHighlightActionContext = {
start: string
end: string
clear: () => void
chartId?: string
}
export type ChartHighlightAction = {
id: string
label: string | ((ctx: ChartHighlightActionContext) => string)
icon?: ReactNode
isDisabled?: (ctx: ChartHighlightActionContext) => boolean
rightSlot?: ReactNode | ((ctx: ChartHighlightActionContext) => ReactNode)
onSelect: (ctx: ChartHighlightActionContext) => void
}
export const ChartHighlightActions = ({
chartHighlight,
updateDateRange,
actions,
chartId,
}: {
chartHighlight?: ChartHighlight
updateDateRange?: UpdateDateRange
actions?: ChartHighlightAction[]
chartId?: string
}) => {
const { left: selectedRangeStart, right: selectedRangeEnd, clearHighlight } = chartHighlight ?? {}
const [isOpen, setIsOpen] = useState(!!chartHighlight?.popoverPosition)
const formatChartDate = useFormatDateTime()
useEffect(() => {
setIsOpen(!!chartHighlight?.popoverPosition)
}, [chartHighlight?.popoverPosition])
const ctx: ChartHighlightActionContext | undefined =
selectedRangeStart && selectedRangeEnd && clearHighlight
? { start: selectedRangeStart, end: selectedRangeEnd, clear: clearHighlight, chartId }
: undefined
const defaultActions: ChartHighlightAction[] = useMemo(() => {
if (!updateDateRange || !ctx) return []
const isDisabled = dayjs(ctx.end).diff(dayjs(ctx.start), 'minutes') < 10
return [
{
id: 'zoom-in',
label: 'Zoom in',
icon: <SearchIcon className="text-foreground-lighter" size={12} />,
rightSlot: isDisabled ? <span className="text-xs">Min. 10 minutes</span> : null,
isDisabled: () => isDisabled,
onSelect: ({ start, end, clear }) => {
if (isDisabled) return
updateDateRange(start, end)
clear()
},
},
]
}, [ctx, updateDateRange])
const allActions: ChartHighlightAction[] = useMemo(() => {
const provided = actions ?? []
return [...defaultActions, ...provided]
}, [defaultActions, actions])
const positionKey = chartHighlight?.popoverPosition
? `${chartHighlight.popoverPosition.x}-${chartHighlight.popoverPosition.y}`
: 'closed'
return (
<DropdownMenu key={positionKey} open={isOpen} onOpenChange={setIsOpen}>
<DropdownMenuTrigger
className="w-auto p-0"
style={{
position: 'absolute',
left: chartHighlight?.popoverPosition?.x + 'px' || 0,
top: chartHighlight?.popoverPosition?.y + 'px' || 0,
}}
/>
<DropdownMenuContent
className="flex flex-col gap-1 p-1 w-fit text-left data-[state=open]:animate-none! data-[state=closed]:animate-none!"
onEscapeKeyDown={() => clearHighlight?.()}
onInteractOutside={(e) => {
const target = e.target as Element | null
// If the user clicked on a chart, handleMouseDown will manage the new selection.
// Calling clearHighlight here would race with it and clobber the new state.
if (target?.closest('.recharts-wrapper')) return
clearHighlight?.()
}}
>
<DropdownMenuLabel className="flex items-center justify-center text-foreground-light font-mono gap-x-2 text-xs">
<span>{formatChartDate(toFormattableDate(selectedRangeStart!), 'MMM D, H:mm')}</span>
<ArrowRight size={10} />
<span>{formatChartDate(toFormattableDate(selectedRangeEnd!), 'MMM D, H:mm')}</span>
</DropdownMenuLabel>
<DropdownMenuSeparator className="my-0" />
{allActions.map((action) => {
const disabled = ctx && action.isDisabled ? action.isDisabled(ctx) : false
let labelNode: ReactNode = null
if (typeof action.label === 'function') {
labelNode = ctx ? action.label(ctx) : null
} else {
labelNode = action.label
}
let rightNode: ReactNode = null
if (typeof action.rightSlot === 'function') {
rightNode = ctx ? action.rightSlot(ctx) : null
} else {
rightNode = action.rightSlot ?? null
}
return (
<DropdownMenuItem asChild key={action.id} disabled={disabled} className={cn('group')}>
<button
disabled={disabled}
tabIndex={-1}
onClick={() => ctx && action.onSelect({ ...ctx })}
className="w-full flex items-center gap-1.5"
>
{action.icon}
<span className="grow text-left">{labelNode}</span>
{rightNode}
</button>
</DropdownMenuItem>
)
})}
</DropdownMenuContent>
</DropdownMenu>
)
}