Keyboard-shortcuts overlay

Prop showShortcuts — adapter chrome, default false.

Guide

When to use it

Show users the keyboard shortcuts active on this grid — a discoverability aid for power features.

How it works

Adds a "?" button (also opens on the ? key) → a theme-aware overlay listing the shortcuts that are actually wired (grouped · searchable · ⌘/Ctrl-aware). It reads the live flag set, so it shows only what's on (selection / clipboard / editing / undo / …). Force the platform with showShortcuts={{ platform: 'mac' }}.

Gotchas

• The list is derived from the active flags, so it never advertises a shortcut the grid can't do.
• Chrome — needs showToolbar for the button (the ? key works regardless).

Live example

Example source

import React from 'react'
import { BstTableMui } from '@bloomskill/table-mui'
import type { BstTableColumn } from '@bloomskill/table-engine'
import '@bloomskill/table-engine/styles.css'
type Row = { id: string; name: string; team: string; role: string; score: number }
const seed: Row[] = [
  { id: '1', name: 'Ada Lovelace',    team: 'Platform', role: 'Engineer',  score: 92 },
  { id: '2', name: 'Alan Turing',     team: 'Research', role: 'Scientist', score: 88 },
  { id: '3', name: 'Grace Hopper',    team: 'Platform', role: 'Engineer',  score: 95 },
  { id: '4', name: 'Katherine J.',    team: 'Research', role: 'Analyst',   score: 90 },
  { id: '5', name: 'Edsger Dijkstra', team: 'Platform', role: 'Architect', score: 84 },
]
const columns: BstTableColumn<Row>[] = [
  { id: 'name', accessorKey: 'name', header: 'Name' },
  { id: 'team', accessorKey: 'team', header: 'Team' },
  { id: 'role', accessorKey: 'role', header: 'Role' },
  { id: 'score', accessorKey: 'score', header: 'Score', sortFn: 'basic' },
]
export default function App() {
  return (
    <BstTableMui data={seed} columns={columns} getRowId={(r) => r.id}
      enableCellSelection enableClipboard enableEditing showShortcuts />
  )
}

Loading live example…

All keyboard shortcuts

Every shortcut Bst-Table supports, with both Mac and Windows / Linux keys. The in-grid overlay shows only the shortcuts active on a given grid; this reference lists them all. Each needs the flag(s) in Requires to be on.

Navigate

Action	Mac	Windows / Linux	Requires
Move active cell	↑ ↓ ← →	↑ ↓ ← →	enableCellSelection
Extend selection	⇧ + arrows	Shift + arrows	enableCellSelection
Jump to edge	⌘ + arrows	Ctrl + arrows	enableCellSelection
Next cell (wraps rows)	Tab	Tab	enableCellSelection
Previous cell	⇧ + Tab	Shift + Tab	enableCellSelection
Row start / Row end	Home / End	Home / End	enableCellSelection
Grid start	⌘ + Home	Ctrl + Home	enableCellSelection
Grid end	⌘ + End	Ctrl + End	enableCellSelection
Select all	⌘ + A	Ctrl + A	enableCellSelection

Find

Action	Mac	Windows / Linux	Requires
Open find	⌘ + F	Ctrl + F	enableFind
Next match	F3	F3	enableFind
Previous match	⇧ + F3	Shift + F3	enableFind
Next / previous (in find box)	Enter / ⇧ + Enter	Enter / Shift + Enter	enableFind
Close find	Esc	Esc	enableFind

Edit

Action	Mac	Windows / Linux	Requires
Edit cell (or move down)	Enter	Enter	enableCellSelection + enableEditing
Edit cell in place	F2	F2	enableEditing
Cancel edit / clear selection	Esc	Esc	enableCellSelection
Type to overwrite the cell	any A–Z / 0–9	any A–Z / 0–9	enableTypeToEdit
Commit & move down (⇧ = up)	Enter	Enter	enableTypeToEdit
Commit & move right (⇧ = left)	Tab	Tab	enableTypeToEdit

Clipboard

Action	Mac	Windows / Linux	Requires
Copy selection	⌘ + C	Ctrl + C	enableClipboard
Paste	⌘ + V	Ctrl + V	enableClipboard + enableEditing
Select whole column	⌘ + Space	Ctrl + Space	enableCopyColumn
Select whole row	⇧ + Space	Shift + Space	enableCopyRow

History

Action	Mac	Windows / Linux	Requires
Undo	⌘ + Z	Ctrl + Z	enableUndoRedo
Redo	⌘ + ⇧ + Z	Ctrl + Shift + Z	enableUndoRedo
Redo (alternate)	—	Ctrl + Y	enableUndoRedo
Open this shortcuts overlay	?	?	showShortcuts

Overview

Layer	show* (chrome, resolved in the adapter)
Type	boolean
Default	false
Maps to	adapter toolbar "?" button + a dep-free, theme-aware overlay listing the keyboard shortcuts ACTIVE on this grid (grouped · searchable · platform-aware ⌘/Ctrl), also opens on the ? key. Headless BSTSHORTCUTSREGISTRY + pure resolveActiveShortcuts(flags, query) filter by enableCellSelection/enableClipboard/enableEditing/enableUndoRedo/enableCopyColumn/enableCopyRow (mirrors the onKeyDown handler, guarded by shortcuts.test.tsx). Not a settings-sheet toggle
Status	✅ done
Since	v0.36.0

Enable it

<BstTableMui
  data={rows}
  columns={columns}
  showShortcuts
/>

Swap BstTableMui for BstTableShadcn (and the CSS import) for the shadcn skin — same props.

Options

Option	Notes
BstShortcuts	Related prop for this feature.
BST_SHORTCUTS_REGISTRY	Related prop for this feature.

Behavior & interactions

• A "?" button + dep-free overlay listing the keyboard shortcuts ACTIVE on this grid — filtered by enableCellSelection / enableClipboard / enableEditing / enableUndoRedo / copy toggles. Also opens on the ? key. Backed by BST_SHORTCUTS_REGISTRY + resolveActiveShortcuts.
• Chrome flag: it only renders its control when the matching enable* behaviour is on.