Files
supabase/apps/studio/styles/grid.css
T
Ali Waseem 42b431a270 feat(studio): add keyboard shortcuts to the table editor (#45178)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

## What kind of change does this PR introduce?

Feature — a set of new keyboard shortcuts for the table editor, along
with infrastructure to register, gate, and surface them.

## What is the current behavior?

Clicking into the grid "traps" the keyboard: Escape doesn't pop out,
there are no shortcuts for row selection / deletion / navigation, and
the search-tables input grabs focus on page load.

## What is the new behavior?

### New shortcuts (all scoped to the table editor)

| Keybind | Action | Surface |
|---|---|---|
| `Esc` | Exit grid selection — clears the highlighted cell and drops
focus back to the page | hotkey |
| `↑` / `↓` | Start grid navigation from the first cell when no cell is
selected | hotkey |
| `Shift+Space` | Toggle selection on the current row | hotkey +
checkbox tooltip |
| `Mod+A` | Toggle selection on all displayed rows (matches Excel) |
hotkey + header-checkbox tooltip + Cmd+K |
| `Mod+Shift+A` | Toggle selection on all rows in the table | hotkey +
"Select all rows in table" button tooltip + Cmd+K |
| `Mod+Backspace` | Delete selected rows | hotkey + delete-button
tooltip + Cmd+K |

### Infrastructure

- **Split registry** — table-editor shortcuts moved to
`state/shortcuts/registry/table-editor.ts`, spread into `SHORTCUT_IDS`.
Makes it easy to scope a runtime check to a specific surface.
- **`eventMatchesAnyShortcut`** (`state/shortcuts/matchEvent.ts`) —
queries the hotkey library's live `SequenceManager` so gated shortcuts
(`enabled: false`) are correctly excluded. Covered by
`matchEvent.test.ts`.
- **`handleCellKeyDown`** now calls `event.preventGridDefault()`
whenever the keystroke matches an active table-editor shortcut, so rdg's
"start editing on key press" default doesn't compete with shortcut
actions (e.g. typing `Shift+X` no longer opens edit mode with `X` as
input).
- **`<Shortcut>` / `<ShortcutTooltip>`** used on the header checkbox,
the per-row checkbox, the "Select all rows in table" button, and the
delete button — keybinds show up on hover (Linear-style) so users can
discover them without reading docs.
- **CSS** — `.rdg:not(:focus-within) .rdg-cell[aria-selected='true']`
drops the selected-cell outline whenever focus leaves the grid,
reinforcing the "you're out" feedback after `Esc`.
- **`useShortcut`** wraps the Cmd+K-registered action to close the
command menu after firing (previously menu stayed open after selecting
an action).
- **Search-tables input** no longer auto-focuses on load, so arrow
shortcuts work immediately without clicking out first.

## Additional context

Linear: FE-3057

### Test plan

- [x] Open any table → `↓` selects the first cell; subsequent arrows
navigate rows
- [x] `Esc` drops focus out of the grid and re-enables `↓` to re-enter
- [x] Click a cell → `Shift+Space` toggles that row's selection
(checkbox)
- [x] `Mod+A` toggles all displayed rows
- [x] With pagination + some rows selected → `Mod+Shift+A` toggles
"Select all rows in table"
- [x] With rows selected → `Mod+Backspace` deletes them (existing
confirmation flow)
- [x] Hover the header checkbox / per-row checkbox / delete button →
keybind tooltip after ~500ms
- [x] Cmd+K with selection → the relevant action shows up; selecting it
closes the palette and runs

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

* **New Features**
* Added table editor keyboard shortcuts for navigation, row selection,
and cell actions, with command-menu integration and visible shortcut
tooltips.

* **Improvements**
* Better keyboard handling in grid cells allowing external shortcuts to
override default behavior.
* Select-all/deselect-all toggle and improved select-row UX;
selected-cell styling no longer shows when grid loses focus.
  * Command menu now reliably closes before executing shortcut actions.
* Removed autofocus on the table editor search input for consistent
focus behavior.

* **Tests**
* Added unit tests covering shortcut matching and command-menu shortcut
behavior.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-04-28 08:20:04 -06:00

553 lines
10 KiB
CSS

.sb-grid {
@apply flex h-full flex-col;
}
.sb-grid-fill-container:after {
content: '';
display: inline-block;
width: 100%;
}
.rdg-cell {
@apply flex;
@apply text-grid;
@apply border-secondary border-r border-b;
@apply text-foreground;
white-space: nowrap;
overflow: hidden;
text-overflow: ellipsis;
line-height: inherit;
}
/* Apply parent bg colour while editing */
.rdg-cell.rdg-editor-container > * {
background-color: inherit;
}
.rdg-cell > div[draggable='true'] {
@apply h-full;
}
.rdg-cell-frozen-last {
@apply border-secondary border-r-2 shadow-none;
}
.rdg-cell[aria-selected='true'] {
box-shadow: inset 0 0 0 1px #24b47e;
}
.rdg:not(:focus-within) .rdg-cell[aria-selected='true'] {
box-shadow: none;
outline: none;
}
/* Cell with unsaved changes - warning (amber) background/text color */
.rdg-cell.rdg-cell--dirty {
background-color: hsl(var(--warning-300) / 0.75);
color: hsl(var(--warning-default));
}
/* Row pending addition - green background, green text */
.rdg-row.rdg-row--added {
background-color: hsl(var(--brand-200) / 0.3);
&:hover {
background-color: hsl(var(--brand-200) / 0.5);
}
.rdg-cell {
border-left-color: hsl(var(--brand-default));
color: hsl(var(--brand-link));
}
/* First cell gets a stronger left border to indicate new row */
.rdg-cell:first-child {
box-shadow: inset 2px 0 0 0 hsl(var(--brand-default));
}
}
/* Row pending deletion - red background with strikethrough effect, red text */
.rdg-row.rdg-row--deleted {
background-color: hsl(var(--destructive-300) / 0.3);
&:hover {
background-color: hsl(var(--destructive-300) / 0.5);
}
.rdg-cell {
text-decoration: line-through;
text-decoration-color: hsl(var(--destructive-default));
border-left-color: hsl(var(--destructive-default));
color: hsl(var(--destructive-default));
}
/* First cell gets a stronger left border to indicate deleted row */
.rdg-cell:first-child {
box-shadow: inset 2px 0 0 0 hsl(var(--destructive-default));
}
}
.rdg {
@apply box-border select-none overflow-x-auto overflow-y-scroll bg-dash-canvas;
@apply border-t border-r-0 border-l-0;
contain: strict;
font-size: 14px;
}
.rdg *,
.rdg ::after,
.rdg ::before {
box-sizing: inherit;
}
@supports not (contain: strict) {
.rdg {
position: relative;
z-index: 0;
}
}
.rdg-focus-sink {
position: sticky;
top: 0;
left: 0;
height: 0;
width: 0;
outline: 0;
}
/*
Row header
*/
.rdg-header-row {
@apply bg-surface-200 select-none border-none;
}
.rdg-header-row {
height: var(--header-row-height);
line-height: var(--header-row-height);
top: 0;
}
.rdg-header-row .rdg-cell {
@apply bg-surface-200 border-default border-b;
}
.rdg-header-row .rdg-cell p {
@apply text-typography-body-light [[data-theme*=dark]_&]:text-typography-body-dark;
}
.rdg-header-row .rdg-cell .react-contextmenu-wrapper {
@apply flex h-full items-center px-2 transition duration-100 ease-in-out;
}
.rdg-header-row .rdg-cell .react-contextmenu-wrapper:hover {
@apply bg-surface-200;
}
.rdg-header-row .rdg-checkbox {
@apply bg-surface-200 border-default rounded-sm border;
}
.rdg-header-row .rdg-checkbox-input:checked + .rdg-checkbox {
@apply border-default border-4 bg-green-900;
}
.rdg-header-row .rdg-checkbox-input:focus + .rdg-checkbox {
box-shadow: none;
}
.rdg-cell .Select {
max-height: 30px;
font-size: 12px;
font-weight: 400;
}
/*
Row
*/
.rdg-row {
@apply bg-dash-sidebar transition-colors;
@apply hover:bg-surface-200;
}
/* edit button */
.rdg-row__select-column__edit-action {
@apply opacity-0;
}
.rdg-row:hover .rdg-row__select-column__edit-action {
@apply opacity-100;
}
.rdg-row__select-column__edit-action:hover {
opacity: 1 !important;
}
/* select row */
.rdg-row[aria-selected='true'] {
@apply bg-surface-200;
}
.tab-cursor {
cursor: pointer !important;
}
/*
Checkbox
*/
.sb-grid {
/* reset styles */
[type='checkbox'] {
webkit-appearance: none;
-moz-appearance: none;
appearance: none;
padding: 0;
-webkit-print-color-adjust: exact;
print-color-adjust: exact;
display: inline-block;
vertical-align: middle;
background-origin: border-box;
-webkit-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
user-select: none;
flex-shrink: 0;
height: 1rem;
width: 1rem;
color: #2563eb;
background-color: #fff;
border-color: #6b7280;
border-width: 1px;
}
[type='checkbox']:checked {
@apply bg-foreground;
background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16' fill='hsl(0, 0%, 100%)'%3E%3Cpath d='M12.207 4.793a1 1 0 010 1.414l-5 5a1 1 0 01-1.414 0l-2-2a1 1 0 011.414-1.414L6.5 9.086l4.293-4.293a1 1 0 011.414 0z'/%3E%3C/svg%3E") !important;
}
[type='checkbox']:indeterminate {
@apply bg-foreground;
background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16' fill='hsl(0, 0%, 100%)'%3E%3Crect x='3' y='7' width='10' height='2'/%3E%3C/svg%3E") !important;
[data-theme='dark'] & {
background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16' fill='hsl(0, 0%, 0%)'%3E%3Crect x='3' y='7' width='10' height='2'/%3E%3C/svg%3E") !important;
}
}
[type='checkbox'] {
@apply cursor-pointer rounded border border-solid;
@apply text-foreground border-strong transition-all;
@apply hover:border-foreground focus:ring-0 focus:outline-none;
@apply bg-control;
margin-top: 2px;
}
}
/* Dark mode */
[data-theme='dark'] .sb-grid [type='checkbox']:checked {
background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16' fill='hsl(0, 0%, 0%)'%3E%3Cpath d='M12.207 4.793a1 1 0 010 1.414l-5 5a1 1 0 01-1.414 0l-2-2a1 1 0 011.414-1.414L6.5 9.086l4.293-4.293a1 1 0 011.414 0z'/%3E%3C/svg%3E") !important;
}
.rdg__segmented-control {
@apply border-default relative mx-2 h-8 rounded-md border;
}
.rdg__segmented-control__button {
@apply absolute top-0 inline-flex h-full items-center justify-center;
@apply text-xs font-medium;
@apply text-border-muted;
@apply active:bg-alternative hover:text-white focus:z-10 focus:outline-none;
@apply transition duration-150 ease-in-out;
@apply cursor-pointer;
z-index: 1;
}
.rdg__segmented-control__button--option {
@apply text-background;
}
.rdg__segmented-control__button--right {
@apply right-0;
}
.rdg__segmented-control__button--left {
@apply left-0;
}
.rdg__segmented-control__label {
@apply bg-overlay-hover border-control z-0 inline-block h-full transform rounded border shadow transition duration-200 ease-in-out;
}
.rdg__segmented-control__label--left {
@apply translate-x-0;
}
.rdg__segmented-control__label--right {
@apply translate-x-12;
}
.rdg__segmented-control__options-label {
@apply uppercase;
color: inherit;
}
/*
DropdownControl
*/
.dropdown-control {
@apply overflow-auto;
}
.dropdown-control .sbui-typography {
@apply block px-2 py-4;
}
/*
NullValue
*/
.null-value {
@apply block;
}
/*
CheckboxEditor
*/
.sb-grid-checkbox-editor {
@apply flex h-full w-full;
}
.sb-grid-checkbox-editor__input {
@apply h-4 w-4;
outline: 4px auto -webkit-focus-ring-color;
}
/*
JsonEditor
*/
.sb-grid-json-editor__trigger {
@apply text-grid overflow-hidden text-ellipsis px-2;
}
/*
NumberEditor
*/
.sb-grid-number-editor {
@apply h-full w-full px-2;
}
/*
SelectEditor
*/
.sb-grid-select-editor {
button {
@apply border-none rounded-none shadow-none;
box-shadow: none !important;
}
}
/*
TextEditor
*/
.sb-grid-text-editor__trigger {
@apply text-grid overflow-hidden text-ellipsis px-2;
}
/*
TimeEditor
*/
.sb-grid-time-editor {
@apply h-full w-full px-2;
}
/*
Footer
*/
.sb-grid-footer {
@apply bg-surface-100 flex h-10 items-center justify-between px-2;
}
.sb-grid-footer__inner {
@apply flex items-center;
}
/*
ForeignKeyFormatter
*/
.sb-grid-foreign-key-formatter {
@apply flex w-full items-center justify-between;
}
.sb-grid-foreign-key-formatter__text {
@apply m-0 grow overflow-hidden text-ellipsis;
}
/*
ColumnHeader
*/
.sb-grid-column-header {
@apply flex h-full w-full items-center justify-between;
}
.sb-grid-column-header--cursor {
@apply cursor-default;
}
.sb-grid-column-header__inner {
@apply flex items-center gap-2 overflow-hidden text-ellipsis;
}
.sb-grid-column-header__inner__name {
@apply text-foreground overflow-hidden text-ellipsis text-xs select-text;
}
.sb-grid-column-header__inner__format {
@apply text-xs;
@apply overflow-hidden text-ellipsis font-normal;
@apply text-foreground-light;
}
.sb-grid-column-header__inner__primary-key {
@apply flex rotate-45 transform items-center;
}
.sb-grid-column-header__inner svg {
@apply border-brand text-brand;
}
/*
Grid
*/
.sb-grid-grid--loading {
@apply flex justify-center bg-transparent;
}
.sb-grid-grid--loading__inner {
@apply flex items-center;
}
.sb-grid-grid--loading__inner__text {
@apply m-8;
}
/*
SelectColumn
*/
.sb-grid-select-cell__formatter {
@apply flex h-full w-full items-center justify-between;
}
.sb-grid-select-cell__header {
@apply flex h-full w-full items-center justify-between;
}
.sb-grid-select-cell__header__input {
/* @apply focus:ring-brand-300; */
@apply border-background-surface-100;
}
/*
Header
*/
.sb-grid-header {
@apply bg-surface-100 flex h-10 justify-between px-2;
}
.sb-grid-header__inner {
@apply flex items-center space-x-2;
}
.sb-grid-header__inner__divider {
@apply py-2;
}
.row_header__selected-rows {
@apply ml-2 mr-2;
}
/*
StatusLabel
*/
.sb-grid-status-label {
@apply text-grid text-white;
}
.sb-grid-status-label__no-msg {
@apply flex h-5 w-5;
}
.sb-grid-status-label__no-msg > div {
@apply m-auto h-2 w-2 rounded-full bg-green-900;
}
/*
Empty value
*/
.sb-grid-empty-value {
@apply block;
}
/*
header/sort/SortDropdown
*/
.sb-grid-sort-popover {
@apply w-96;
}
.sb-grid-dropdown__empty {
@apply py-2;
}
.sb-grid-dropdown__empty__text {
@apply block;
}
.sb-grid-dropdown__item-trigger {
@apply my-1;
}
/*
header/sort/SortRow
*/
.sb-grid-sort-row {
@apply flex justify-between space-x-3;
}
.sb-grid-sort-row__item {
@apply flex items-center space-x-3;
}
.sb-grid-sort-row__item__remove {
@apply bg-transparent p-0 hover:bg-transparent;
}
.sb-grid-sort-row__item__label {
@apply flex items-center space-x-2;
}
.sb-grid-sort-row__item_toogle {
@apply flex w-28 items-center gap-0 space-x-3;
}
.sb-grid-sort-row__item__move {
@apply flex cursor-move;
}