@trellisjs/react 0.1.0-alpha.1 → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 TrellisJS Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,86 @@
+# @trellisjs/react
+
+Headless data table components and hooks for React, powered by `@trellisjs/core`.
+
+## Installation
+
+```bash
+npm install @trellisjs/react @trellisjs/core react react-dom
+```
+
+Requires React >= 18.
+
+## API
+
+### `useTrellis<T>(options)`
+
+Creates and manages a Trellis instance. Returns `{ api }` where `api` is a
+`TrellisAPI<T>`. The instance is created once and re-renders are triggered
+automatically on state changes. Compatible with React StrictMode double-mount.
+
+```ts
+const { api } = useTrellis<User>({ columns, data });
+```
+
+**Parameters** -- `options: TrellisOptions<T>` (column definitions, initial
+data, plugins, etc.) passed directly to the `Trellis` constructor.
+
+### `TrellisContext`
+
+A React context holding a `TrellisAPI` instance. Wrap your tree with
+`<TrellisContext.Provider value={api}>` so child components can access the
+table API.
+
+### `useTrellisContext<T>()`
+
+Hook that reads the `TrellisAPI` from `TrellisContext`. Throws if called
+outside a provider.
+
+### Components
+
+| Component | Description |
+|-----------|-------------|
+| `Table` | Renders a `<table>` with `<TableHead>` and `<TableBody>`. |
+| `TableHead` | Header row from column definitions. |
+| `TableBody` | Body rows from current data and columns. |
+| `Tr` / `Th` / `Td` | Primitive row and cell components. |
+
+### `SlotRenderer`
+
+Renders a named slot from the Trellis slot registry.
+
+```tsx
+<SlotRenderer name="toolbar" fallback={<div>No toolbar</div>} />
+```
+
+Props:
+
+- `name` -- slot name to look up.
+- `context` -- optional `SlotContext` passed to the renderer.
+- `fallback` -- rendered when no slot is registered.
+
+## Quick Usage
+
+```tsx
+import { useTrellis, TrellisContext, Table, SlotRenderer } from '@trellisjs/react';
+
+const columns = [
+  { id: 'name', label: 'Name' },
+  { id: 'email', label: 'Email' },
+];
+
+function App() {
+  const { api } = useTrellis({ columns, data: users });
+
+  return (
+    <TrellisContext.Provider value={api}>
+      <SlotRenderer name="toolbar" />
+      <Table />
+    </TrellisContext.Provider>
+  );
+}
+```
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trellisjs/react",
-  "version": "0.1.0-alpha.1",
+  "version": "1.0.0",
   "description": "Trellis 的 React 適配器 — 無頭式資料表格元件",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -20,22 +20,14 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "clean": "rm -rf dist *.tsbuildinfo"
-  },
   "peerDependencies": {
-    "@trellisjs/core": "workspace:*",
     "react": ">=18.0.0",
-    "react-dom": ">=18.0.0"
+    "react-dom": ">=18.0.0",
+    "@trellisjs/core": "0.1.0"
   },
   "devDependencies": {
     "@testing-library/jest-dom": "^6.9.1",
     "@testing-library/react": "^16.3.0",
-    "@trellisjs/core": "workspace:*",
     "@types/react": "^19.1.0",
     "@types/react-dom": "^19.1.0",
     "jsdom": "^26.1.0",
@@ -43,8 +35,21 @@
     "react-dom": "^19.1.0",
     "tsup": "^8.4.0",
     "typescript": "^5.7.0",
-    "vitest": "^3.1.0"
+    "vitest": "^3.1.0",
+    "@trellisjs/core": "0.1.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cluion/trellis.git",
+    "directory": "packages/react"
   },
   "license": "MIT",
-  "sideEffects": false
-}
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "clean": "rm -rf dist *.tsbuildinfo"
+  }
+}