Cell notes / comments
Prop enableNotes — engine behaviour, default false.
Overview
| Layer | enable* (engine, resolved in useBstTable) |
| Type | boolean | BstNotesOptions |
| Default | false |
| Maps to | custom — attach annotations to individual cells without mutating row data. Cells with notes render a corner marker; hover shows a preview popover; Shift+F2 opens the resizable note editor; context menu has Add/Edit/Delete note. In settings ("Selection & clipboard", always shown). Both skins inherit it |
| Status | ✅ done |
| Since | v0.46.0 |
| Settings sheet | Selection & clipboard |
Cell notes / comments — attach annotations to individual cells without mutating row data. Cells with notes display a corner marker; hovering opens a popover; Shift+F2 or the context menu opens the resizable editor. Default: false.
Enable it
<BstTableMui
data={rows}
columns={columns}
enableNotes={/* boolean | BstNotesOptions */}
/>
Swap
BstTableMuiforBstTableShadcn(and the CSS import) for the shadcn skin — same props.
Options
| Option | Notes |
|---|---|
BstNotesOptions | Related prop for this feature. |
notes | Related prop for this feature. |
onNotesChange | Related prop for this feature. |
onNoteSave | Related prop for this feature. |
Behavior & interactions
- Attach comments / annotations to cells without mutating row data. Cells with notes render a corner dog-ear marker; hover shows a preview popover; Shift+F2 opens the resizable note editor; context menu has Add/Edit/Delete note.
Spec coverage
Spec codes (
A1,C2,X8, …) are Bst-Table's internal requirement IDs from the capability matrix;P0–P2mark the delivery phase. They are traceability tags, not part of the public API.
- F2 · Disable row — ✅ built. P2 — rowDisabled