Document DesignEditableGrid props, layout rules, and usage patterns

Capture the flat label/value grid, edit-state behavior, and shared
control class helpers in the design guide.

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
Developing-Gamer 2026-07-15 18:47:44 -07:00
parent 31310b49f9
commit de67cb1364

View File

@ -520,14 +520,22 @@ Use for:
Props:
- `items` (typed union: `text`, `boolean`, `dropdown`, `custom-dropdown`, `custom-button`, `custom`)
- shared item metadata: `itemKey`, `icon`, `name`, optional `description` and `tooltip`
- `columns`: `1 | 2`
- `size`: `"sm" | "md"`
- `deferredSave`, `hasChanges`, `onSave`, `onDiscard`
- `externalModifiedKeys`
Rules:
- prefer this for config forms that are row-based and editable inline
- layout is a flat label/value grid (no per-field cards); editable values use white controls in light mode
- use deferred save mode when many fields should be committed together
- text values enter an explicit edit state; Enter saves and Escape cancels
- omit `onUpdate` or set `readOnly` for a non-editable value
- use `description` for persistent context and `tooltip` only for secondary details
- `custom-dropdown` owns its popover; provide both `triggerContent` and `popoverContent`
- for page-local editable triggers outside the typed union, reuse `designEditableGridControlClassName` / `designEditableGridPopoverClassName`
### 4.12 `DataGrid` + `useDataSource` + `createDefaultDataGridState`