From 384e2f869fff81773cc5ed0b8d0931a777fad09c Mon Sep 17 00:00:00 2001 From: SyedSibtainRazvi Date: Wed, 18 Nov 2026 17:57:55 +0530 Subject: [PATCH 1/3] feat: type straight into cells, and add rows from right below them --- .../sheets/src/hooks/use-inline-edit.test.tsx | 50 +++++++++++++++++ packages/sheets/src/hooks/use-inline-edit.ts | 26 +++++++-- packages/sheets/src/ui/cells/edit-key.ts | 25 +++++++++ .../src/ui/cells/editable-text-cell.test.tsx | 53 +++++++++++++++++++ .../src/ui/cells/editable-text-cell.tsx | 14 +++-- .../sheets/src/ui/cells/primary-cell.test.tsx | 29 ++++++++++ packages/sheets/src/ui/cells/primary-cell.tsx | 15 ++++-- packages/sheets/src/ui/sheet-add-row.tsx | 19 ++++--- packages/sheets/src/ui/sheet.tsx | 4 +- 9 files changed, 209 insertions(+), 26 deletions(-) create mode 100644 packages/sheets/src/hooks/use-inline-edit.test.tsx create mode 100644 packages/sheets/src/ui/cells/edit-key.ts diff --git a/packages/sheets/src/hooks/use-inline-edit.test.tsx b/packages/sheets/src/hooks/use-inline-edit.test.tsx new file mode 100644 index 0000000..e2d2cf9 --- /dev/null +++ b/packages/sheets/src/hooks/use-inline-edit.test.tsx @@ -0,0 +1,50 @@ +import { fireEvent, render, screen } from '@testing-library/react'; +import { describe, expect, it } from 'vitest'; +import { useInlineEdit } from './use-inline-edit.js'; + +/** A cell built on the hook, as an app's own editable cell would be. */ +function Cell({ type }: { type: 'text' | 'number' }) { + const { isEditing, beginEdit, triggerRef, inputProps } = useInlineEdit({ + value: '42', + }); + if (isEditing) + return ; + return ( + + ); +} + +describe('useInlineEdit', () => { + it('opens with the caret after the text', () => { + render(); + + fireEvent.click(screen.getByRole('button', { name: '42' })); + + const input = screen.getByRole('textbox'); + expect(document.activeElement).toBe(input); + expect(input.selectionStart).toBe(2); + }); + + // A number input has no caret, and placing one throws. The throw happens in + // a focus handler, which reports it as an uncaught error rather than failing + // the render, so listen for that. + it('opens a number input without placing a caret', () => { + const errors: unknown[] = []; + const onError = (event: ErrorEvent) => { + errors.push(event.error); + event.preventDefault(); + }; + window.addEventListener('error', onError); + try { + render(); + fireEvent.click(screen.getByRole('button', { name: '42' })); + } finally { + window.removeEventListener('error', onError); + } + + expect(errors).toEqual([]); + expect(screen.getByRole('spinbutton', { name: 'Amount' })).toBeTruthy(); + }); +}); diff --git a/packages/sheets/src/hooks/use-inline-edit.ts b/packages/sheets/src/hooks/use-inline-edit.ts index e8d6f87..23f2e69 100644 --- a/packages/sheets/src/hooks/use-inline-edit.ts +++ b/packages/sheets/src/hooks/use-inline-edit.ts @@ -53,11 +53,19 @@ export function useInlineEdit({ } }, [isEditing]); - const beginEdit = useCallback(() => { - committedRef.current = false; - setDraft(value); - setIsEditing(true); - }, [value]); + /** + * Opens the editor on the value, or on `draft` instead, such as the key typed + * into a focused cell. Anything else passed in, like the click event from + * `onClick={beginEdit}`, is ignored. + */ + const beginEdit = useCallback( + (draft?: T) => { + committedRef.current = false; + setDraft(typeof draft === 'string' ? draft : value); + setIsEditing(true); + }, + [value], + ); const commit = useCallback(async () => { if (committedRef.current) return; @@ -128,6 +136,14 @@ export function useInlineEdit({ setDraft(e.target.value as T), onKeyDown: handleKeyDown, onBlur: handleBlur, + // The caret goes after the text, so typing carries on from a typed first + // key in every browser, rather than landing in front of it. + // Number, email and date inputs have no caret to place: setting one throws. + onFocus: (e: FocusEvent) => { + if (e.currentTarget.selectionStart === null) return; + const end = e.currentTarget.value.length; + e.currentTarget.setSelectionRange(end, end); + }, autoFocus: true, }, }; diff --git a/packages/sheets/src/ui/cells/edit-key.ts b/packages/sheets/src/ui/cells/edit-key.ts new file mode 100644 index 0000000..22a86f0 --- /dev/null +++ b/packages/sheets/src/ui/cells/edit-key.ts @@ -0,0 +1,25 @@ +import type { KeyboardEvent } from 'react'; + +/** + * Opens a focused cell's editor from the keyboard, as in a spreadsheet: a + * typed character replaces the value, and F2 keeps it. Enter and Space already + * open the editor, since the cell is a button, so Space is not taken as a typed + * character. Other keys are left alone. + */ +export function editOnKey( + event: KeyboardEvent, + start: (draft?: string) => void, +) { + if (event.key === 'F2') { + event.preventDefault(); + start(); + return; + } + // An input method composes its text in the editor once it's open. + if (event.nativeEvent.isComposing || event.keyCode === 229) return; + // Shortcuts. Ctrl with Alt is AltGr on Windows, which types @ and €. + if (event.metaKey || (event.ctrlKey && !event.altKey)) return; + if (event.key.length !== 1 || event.key === ' ') return; + event.preventDefault(); + start(event.key); +} diff --git a/packages/sheets/src/ui/cells/editable-text-cell.test.tsx b/packages/sheets/src/ui/cells/editable-text-cell.test.tsx index f532d99..329c262 100644 --- a/packages/sheets/src/ui/cells/editable-text-cell.test.tsx +++ b/packages/sheets/src/ui/cells/editable-text-cell.test.tsx @@ -113,6 +113,59 @@ describe('SheetEditableTextCell', () => { // The rule lives with the column and this cell executes it, same contract as // SheetPrimaryCell. Reporting needs a Sheet, so the scope is provided here. + // Data entry, as in a spreadsheet: a focused cell opens on the key typed. + describe('typing into the cell', () => { + const cell = () => screen.getByRole('button', { name: 'Project One' }); + const editor = () => screen.queryByRole('textbox'); + + it('opens on a typed character, which replaces the value', () => { + const { onCommit } = renderCell({ autoFocus: false }); + + fireEvent.keyDown(cell(), { key: 'R' }); + + expect(editor()?.value).toBe('R'); + expect(document.activeElement).toBe(editor()); + fireEvent.keyDown(editor() as HTMLInputElement, { key: 'Enter' }); + expect(onCommit).toHaveBeenCalledWith('R'); + }); + + it('keeps the value on F2', () => { + renderCell({ autoFocus: false }); + + fireEvent.keyDown(cell(), { key: 'F2' }); + + expect(editor()?.value).toBe('Project One'); + }); + + // Space presses the button, which opens the editor with the value kept. + it('does not take Space as a typed character', () => { + renderCell({ autoFocus: false }); + + fireEvent.keyDown(cell(), { key: ' ' }); + + expect(editor()).toBeNull(); + }); + + it('leaves shortcuts alone, but types AltGr characters', () => { + renderCell({ autoFocus: false }); + + fireEvent.keyDown(cell(), { key: 'c', ctrlKey: true }); + fireEvent.keyDown(cell(), { key: 'v', metaKey: true }); + expect(editor()).toBeNull(); + + fireEvent.keyDown(cell(), { key: '@', ctrlKey: true, altKey: true }); + expect(editor()?.value).toBe('@'); + }); + + it('leaves the key to an input method that is composing', () => { + renderCell({ autoFocus: false }); + + fireEvent.keyDown(cell(), { key: 'a', isComposing: true }); + + expect(editor()).toBeNull(); + }); + }); + describe('schema', () => { const required = { '~standard': { diff --git a/packages/sheets/src/ui/cells/editable-text-cell.tsx b/packages/sheets/src/ui/cells/editable-text-cell.tsx index 05b4d1e..c2ded1f 100644 --- a/packages/sheets/src/ui/cells/editable-text-cell.tsx +++ b/packages/sheets/src/ui/cells/editable-text-cell.tsx @@ -1,6 +1,7 @@ 'use client'; import { cx } from '../cx.js'; +import { editOnKey } from './edit-key.js'; import { useSheetLabels } from '../labels.js'; import { useInlineEdit } from '../../hooks/use-inline-edit.js'; import type { @@ -97,6 +98,13 @@ export function SheetEditableTextCell({ autoFocus, }); + // A click, F2 or a typed key. The standing error on the cell goes: the user + // is acting on it. + const start = (draft?: string) => { + cell.clearOnEditStart(); + beginEdit(draft); + }; + if (isEditing) { return ( { - cell.clearOnEditStart(); - beginEdit(); - }} + onClick={() => start()} + onKeyDown={(event) => editOnKey(event, start)} className={cx( 'block w-full cursor-text truncate px-2 py-1.5 text-start text-sm', displayValue diff --git a/packages/sheets/src/ui/cells/primary-cell.test.tsx b/packages/sheets/src/ui/cells/primary-cell.test.tsx index 2c41f2c..f89affa 100644 --- a/packages/sheets/src/ui/cells/primary-cell.test.tsx +++ b/packages/sheets/src/ui/cells/primary-cell.test.tsx @@ -198,6 +198,35 @@ describe('SheetPrimaryCell', () => { expect(onCommit).toHaveBeenCalledWith('Renamed Seven'); }); + it('opens on a typed character, which replaces the name', () => { + const onEditStart = vi.fn(); + render( + + Project Seven + , + ); + + fireEvent.keyDown(screen.getByRole('button', { name: 'Project Seven' }), { + key: 'N', + }); + + expect(screen.getByRole('textbox').value).toBe('N'); + expect(onEditStart).toHaveBeenCalledTimes(1); + }); + + // Without `editable` the name opens the row, so typing on it does nothing. + it('ignores typing on a name that is not editable', () => { + render( + Project Seven, + ); + + fireEvent.keyDown(screen.getByRole('button', { name: 'Project Seven' }), { + key: 'N', + }); + + expect(screen.queryByRole('textbox')).toBeNull(); + }); + it('restores the name and does not commit on Escape', () => { const { onCommit } = renderEditable(); diff --git a/packages/sheets/src/ui/cells/primary-cell.tsx b/packages/sheets/src/ui/cells/primary-cell.tsx index 3e26b8d..0760b23 100644 --- a/packages/sheets/src/ui/cells/primary-cell.tsx +++ b/packages/sheets/src/ui/cells/primary-cell.tsx @@ -1,6 +1,7 @@ 'use client'; import { cx } from '../cx.js'; +import { editOnKey } from './edit-key.js'; import { ArrowUpRight, PanelRight } from '../icons.js'; import { useSheetLabels } from '../labels.js'; import type { MouseEvent, ReactNode } from 'react'; @@ -171,6 +172,13 @@ export function SheetPrimaryCell({ onCancel: end, }); + // A click, F2 or a typed key on the editable name. + const start = (draft?: string) => { + cell.clearOnEditStart(); + editable?.onEditStart?.(); + beginEdit(draft); + }; + if (editable && isEditing) { return ( { - cell.clearOnEditStart(); - editable.onEditStart?.(); - beginEdit(); - }} + onClick={() => start()} + onKeyDown={(event) => editOnKey(event, start)} className="block min-w-0 flex-1 cursor-text truncate px-2 py-1.5 text-start text-sm text-sheet-fg dark:text-sheet-fg-dark" > {/* An empty value means a refused edit is still on screen, so show the diff --git a/packages/sheets/src/ui/sheet-add-row.tsx b/packages/sheets/src/ui/sheet-add-row.tsx index 81bc608..0130f9a 100644 --- a/packages/sheets/src/ui/sheet-add-row.tsx +++ b/packages/sheets/src/ui/sheet-add-row.tsx @@ -11,30 +11,29 @@ export type SheetAddRowProps = { label?: string; }; -/** The sticky footer row with the add button. */ +/** + * The row with the add button, right below the last row. The button sits in + * the row-number column, where the next row's number would be. + */ export function SheetAddRow({ onClick, disabled, label }: SheetAddRowProps) { const labels = useSheetLabels(); return ( -
+