@sqlrooms/schema-tree 0.28.0-rc.0 → 0.28.0

package/README.md

@@ -1,19 +1,58 @@
-This package is part of the SQLRooms framework.
+React components for rendering DuckDB database/schema/table/column trees in SQLRooms apps.
 
-# DuckDB schema tree
+## Installation
 
-A React component library for rendering DuckDB schema trees in a hierarchical view. It provides components to display database schemas, tables, and columns in an interactive tree structure with features like:
+```bash
+npm install @sqlrooms/schema-tree @sqlrooms/duckdb @sqlrooms/ui
+```
 
-- Expandable/collapsible tree nodes
-- Column type badges
-- Context menus for actions (e.g. copying column names)
-- Customizable node rendering
-- Hover states and visual feedback
+## What this package provides
 
-The main components are:
+- `TableSchemaTree` for rendering full schema hierarchies
+- node components (`DatabaseTreeNode`, `SchemaTreeNode`, `TableTreeNode`, `ColumnTreeNode`)
+- `TreeNodeActionsMenu` for context-style node actions
+- `defaultRenderTableSchemaNode` for quick customization
 
-- `TableSchemaTree`: The root tree component that renders the full schema hierarchy
-- `ColumnTreeNode`: Specialized node for displaying column information
-- `TreeNodeActionsMenu`: Reusable menu component for node actions
+## Basic usage
 
-This package is used by SQLRooms to provide schema browsing capabilities in the database explorer interface.
+```tsx
+import {TableSchemaTree} from '@sqlrooms/schema-tree';
+import {useRoomStore} from './store';
+
+export function SchemaExplorer() {
+  const schemaTrees = useRoomStore((state) => state.db.schemaTrees ?? []);
+
+  if (!schemaTrees.length) {
+    return <div className="p-2 text-sm">No schema loaded yet.</div>;
+  }
+
+  return (
+    <TableSchemaTree
+      className="h-full"
+      schemaTrees={schemaTrees}
+      skipSingleDatabaseOrSchema
+    />
+  );
+}
+```
+
+## Custom node rendering
+
+```tsx
+import {DbSchemaNode} from '@sqlrooms/duckdb';
+import {defaultRenderTableSchemaNode, TableSchemaTree} from '@sqlrooms/schema-tree';
+
+const renderNode = (node: DbSchemaNode, isOpen: boolean) => (
+  <div className={isOpen ? 'opacity-100' : 'opacity-90'}>
+    {defaultRenderTableSchemaNode(node)}
+  </div>
+);
+
+<TableSchemaTree schemaTrees={schemaTrees} renderNode={renderNode} />;
+```
+
+## Notes
+
+- `schemaTrees` comes from the DuckDB slice (`state.db.schemaTrees`).
+- Call `state.db.refreshTableSchemas()` after table changes to keep the tree up to date.
+- This package is used by SQLRooms SQL editor table-structure panels.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sqlrooms/schema-tree",
-  "version": "0.28.0-rc.0",
+  "version": "0.28.0",
   "author": "SQLRooms Contributors",
   "license": "MIT",
   "repository": {
@@ -25,10 +25,10 @@
     "typedoc": "typedoc"
   },
   "dependencies": {
-    "@sqlrooms/data-table": "0.28.0-rc.0",
-    "@sqlrooms/duckdb": "0.28.0-rc.0",
-    "@sqlrooms/ui": "0.28.0-rc.0",
-    "@sqlrooms/utils": "0.28.0-rc.0",
+    "@sqlrooms/data-table": "0.28.0",
+    "@sqlrooms/duckdb": "0.28.0",
+    "@sqlrooms/ui": "0.28.0",
+    "@sqlrooms/utils": "0.28.0",
     "lucide-react": "^0.556.0"
   },
   "peerDependencies": {
@@ -39,5 +39,5 @@
     "@types/react": "^19.1.13",
     "@types/react-dom": "^19.1.9"
   },
-  "gitHead": "87a478edbff690e04c38cc717db8e11e844565c8"
+  "gitHead": "dcac54f8adf77240e293c93d224a0ce9fd8142a9"
 }