@sqlrooms/data-table 0.5.1 → 0.7.0

package/README.md

@@ -0,0 +1,123 @@
+A high-performance data table component library for SQLRooms applications. This package provides flexible and feature-rich table components for displaying and interacting with large datasets, with special support for Apache Arrow data structures.
+
+## Features
+
+- 📊 **Multiple Table Variants**: Paginated, virtualized, and query-specific tables
+- 🚀 **High Performance**: Optimized for handling large datasets efficiently
+- 🏹 **Arrow Integration**: Native support for Apache Arrow data structures
+- 🔍 **Sorting & Filtering**: Built-in data manipulation capabilities
+- 📱 **Responsive Design**: Tables that work well on all screen sizes
+- 🎨 **Customizable**: Flexible styling and configuration options
+
+## Installation
+
+```bash
+npm install @sqlrooms/data-table
+# or
+yarn add @sqlrooms/data-table
+```
+
+## Basic Usage
+
+### Paginated Data Table
+
+```tsx
+import {DataTablePaginated} from '@sqlrooms/data-table';
+
+function MyDataTable() {
+  const data = [
+    {id: 1, name: 'Alice', age: 28},
+    {id: 2, name: 'Bob', age: 34},
+    {id: 3, name: 'Charlie', age: 42},
+    // More data...
+  ];
+
+  const columns = [
+    {accessorKey: 'id', header: 'ID'},
+    {accessorKey: 'name', header: 'Name'},
+    {accessorKey: 'age', header: 'Age'},
+  ];
+
+  return (
+    <DataTablePaginated
+      data={data}
+      columns={columns}
+      pageSize={10}
+      enableSorting
+      enableFiltering
+    />
+  );
+}
+```
+
+### Virtualized Data Table for Large Datasets
+
+```tsx
+import {DataTableVirtualized} from '@sqlrooms/data-table';
+
+function LargeDataTable() {
+  // Imagine this is a very large dataset
+  const largeDataset = generateLargeDataset(10000);
+
+  const columns = [
+    {accessorKey: 'id', header: 'ID'},
+    {accessorKey: 'name', header: 'Name'},
+    {accessorKey: 'email', header: 'Email'},
+    {accessorKey: 'status', header: 'Status'},
+    {accessorKey: 'lastActive', header: 'Last Active'},
+  ];
+
+  return (
+    <DataTableVirtualized
+      data={largeDataset}
+      columns={columns}
+      height={500}
+      width="100%"
+    />
+  );
+}
+```
+
+### Working with SQL Query Results
+
+```tsx
+import {QueryDataTable} from '@sqlrooms/data-table';
+import {useSql} from '@sqlrooms/duckdb';
+
+function QueryResultsTable() {
+  const {data, isLoading, error} = useSql({
+    query:
+      'SELECT id, name, email, created_at FROM users ORDER BY created_at DESC',
+  });
+
+  if (isLoading) return <div>Loading...</div>;
+  if (error) return <div>Error: {error.message}</div>;
+  if (!data) return null;
+
+  return <QueryDataTable data={data} />;
+}
+```
+
+### Using with Apache Arrow
+
+```tsx
+import {useArrowDataTable} from '@sqlrooms/data-table';
+import {Table} from 'apache-arrow';
+
+function ArrowTable({arrowTable}: {arrowTable: Table}) {
+  const {columns, data} = useArrowDataTable(arrowTable);
+
+  return <DataTablePaginated columns={columns} data={data} pageSize={25} />;
+}
+```
+
+## Advanced Features
+
+- **Custom Cell Rendering**: Define custom renderers for specific cell types
+- **Row Selection**: Enable row selection with checkboxes
+- **Expandable Rows**: Show additional details in expandable row sections
+- **Column Resizing**: Allow users to resize columns
+- **Export Options**: Export table data to CSV or other formats
+- **Theming**: Customize the appearance to match your application
+
+For more information, visit the SQLRooms documentation.

package/dist/index.d.ts

@@ -1,3 +1,7 @@
+/**
+ * {@include ../README.md}
+ * @packageDocumentation
+ */
 export { default as DataTableModal } from './DataTableModal';
 export * from './DataTablePaginated';
 export { default as DataTablePaginated } from './DataTablePaginated';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,IAAI,cAAc,EAAC,MAAM,kBAAkB,CAAC;AAC3D,cAAc,sBAAsB,CAAC;AACrC,OAAO,EAAC,OAAO,IAAI,kBAAkB,EAAC,MAAM,sBAAsB,CAAC;AACnE,OAAO,EAAC,OAAO,IAAI,oBAAoB,EAAC,MAAM,wBAAwB,CAAC;AACvE,OAAO,EAAC,OAAO,IAAI,cAAc,EAAC,MAAM,kBAAkB,CAAC;AAC3D,OAAO,EAAC,OAAO,IAAI,iBAAiB,EAAC,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAC,OAAO,IAAI,cAAc,EAAC,MAAM,kBAAkB,CAAC;AAC3D,cAAc,sBAAsB,CAAC;AACrC,OAAO,EAAC,OAAO,IAAI,kBAAkB,EAAC,MAAM,sBAAsB,CAAC;AACnE,OAAO,EAAC,OAAO,IAAI,oBAAoB,EAAC,MAAM,wBAAwB,CAAC;AACvE,OAAO,EAAC,OAAO,IAAI,cAAc,EAAC,MAAM,kBAAkB,CAAC;AAC3D,OAAO,EAAC,OAAO,IAAI,iBAAiB,EAAC,MAAM,qBAAqB,CAAC"}

package/dist/index.js

@@ -1,3 +1,7 @@
+/**
+ * {@include ../README.md}
+ * @packageDocumentation
+ */
 export { default as DataTableModal } from './DataTableModal';
 export * from './DataTablePaginated';
 export { default as DataTablePaginated } from './DataTablePaginated';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,IAAI,cAAc,EAAC,MAAM,kBAAkB,CAAC;AAC3D,cAAc,sBAAsB,CAAC;AACrC,OAAO,EAAC,OAAO,IAAI,kBAAkB,EAAC,MAAM,sBAAsB,CAAC;AACnE,OAAO,EAAC,OAAO,IAAI,oBAAoB,EAAC,MAAM,wBAAwB,CAAC;AACvE,OAAO,EAAC,OAAO,IAAI,cAAc,EAAC,MAAM,kBAAkB,CAAC;AAC3D,OAAO,EAAC,OAAO,IAAI,iBAAiB,EAAC,MAAM,qBAAqB,CAAC","sourcesContent":["export {default as DataTableModal} from './DataTableModal';\nexport * from './DataTablePaginated';\nexport {default as DataTablePaginated} from './DataTablePaginated';\nexport {default as DataTableVirtualized} from './DataTableVirtualized';\nexport {default as QueryDataTable} from './QueryDataTable';\nexport {default as useArrowDataTable} from './useArrowDataTable';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAC,OAAO,IAAI,cAAc,EAAC,MAAM,kBAAkB,CAAC;AAC3D,cAAc,sBAAsB,CAAC;AACrC,OAAO,EAAC,OAAO,IAAI,kBAAkB,EAAC,MAAM,sBAAsB,CAAC;AACnE,OAAO,EAAC,OAAO,IAAI,oBAAoB,EAAC,MAAM,wBAAwB,CAAC;AACvE,OAAO,EAAC,OAAO,IAAI,cAAc,EAAC,MAAM,kBAAkB,CAAC;AAC3D,OAAO,EAAC,OAAO,IAAI,iBAAiB,EAAC,MAAM,qBAAqB,CAAC","sourcesContent":["/**\n * {@include ../README.md}\n * @packageDocumentation\n */\n\nexport {default as DataTableModal} from './DataTableModal';\nexport * from './DataTablePaginated';\nexport {default as DataTablePaginated} from './DataTablePaginated';\nexport {default as DataTableVirtualized} from './DataTableVirtualized';\nexport {default as QueryDataTable} from './QueryDataTable';\nexport {default as useArrowDataTable} from './useArrowDataTable';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sqlrooms/data-table",
-  "version": "0.5.1",
+  "version": "0.7.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "module": "dist/index.js",
@@ -20,9 +20,9 @@
   },
   "dependencies": {
     "@heroicons/react": "*",
-    "@sqlrooms/duckdb": "0.5.1",
-    "@sqlrooms/ui": "0.5.1",
-    "@sqlrooms/utils": "0.5.1",
+    "@sqlrooms/duckdb": "0.7.0",
+    "@sqlrooms/ui": "0.7.0",
+    "@sqlrooms/utils": "0.7.0",
     "@tanstack/react-table": "^8.10.7",
     "@tanstack/table-core": "^8.10.7",
     "react-virtual": "2.10.4"
@@ -38,5 +38,5 @@
     "lint": "eslint .",
     "typedoc": "typedoc"
   },
-  "gitHead": "5e41362f1552ee1f8a661c487fe7cdb606cc6d23"
+  "gitHead": "8be65f051c588d3a963f721322429657913b6c63"
 }