@sqlrooms/notebook

Tabbed notebook UI and Zustand slice for SQL/text/markdown/vega/input cells in SQLRooms apps.

• NotebookSlice stores tabs and cells under config.notebook
• SQL cells create DuckDB views in schema notebook using the cell name
• Cell execution cascades to dependents when definitions change
• Pluggable cell renderers supported via createNotebookSlice()

Installation

pnpm add @sqlrooms/notebook

API

Config

• createDefaultNotebookConfig(partial?) → default config.notebook
• Zod schemas: NotebookSliceConfig, NotebookCellSchema, NotebookTabSchema

Slice

createNotebookSlice({});

Requires a store that also includes @sqlrooms/duckdb slice for db.sqlSelectToJson and db.getConnector.

Notebook actions under notebook:

• addTab(), renameTab(id, title), setCurrentTab(id), removeTab(id)
• addCell(tabId, type), removeCell(cellId), renameCell(cellId, name), updateCell(cellId, updater)
• runCell(cellId, opts?), runAllCells(tabId), cancelRunCell(cellId)

SQL cells must contain a single SELECT statement. Validation is performed via get().db.sqlSelectToJson(lastQueryStatement). Successful execution creates or replaces a DuckDB view in schema notebook named after the cell.

Dependencies are inferred from sqlSelectToJson and basic name references; when a cell runs, dependent SQL cells are re-run unless cascade is disabled.

UI

createNotebookComponents(useStore) returns { Notebook } React component bound to your store hook.

const {Notebook} = createNotebookComponents(useRoomStore);
<Notebook />;

Tabs use EditableText for renaming, with a + Add button. SQL, Text, Markdown, Vega (stub), and Input cells are supported out of the box.

Stable vs internal imports

Use root imports from @sqlrooms/notebook as the stable API surface.

• stable: createNotebookSlice, createDefaultNotebookConfig, Notebook, useStoreWithNotebook, exported schema types
• internal: direct imports from implementation files under src/ are not semver-stable and may change without notice