@jielga/tmdatagrid 0.1.0 → 0.3.0

package/README.md

@@ -15,6 +15,11 @@ Peer dependencies: `react` and `react-dom` (19.1 or later), `@mantine/core`,
 `@tanstack/react-table` (v9), `@tanstack/react-store`, `@tanstack/store`,
 `@tanstack/react-virtual` and `@tabler/icons-react`.
 
+> **TanStack Table v9 is still in beta.** The grid is built against
+> `^9.0.0-beta.21` and uses its feature-registry API, which beta releases may
+> change without a major bump. Pin `@tanstack/react-table` and
+> `@tanstack/table-core` to an exact version if you need reproducible installs.
+
 Import both stylesheets once in your app, Mantine's first:
 
 ```ts
@@ -54,6 +59,7 @@ export function Employees({ data }: { data: Employee[] }) {
     data,
     columns,
     getRowId: (row) => String(row.id),
+    enablePagination: true,
   });
 
   return (
@@ -72,8 +78,10 @@ export function Employees({ data }: { data: Employee[] }) {
 }
 ```
 
-Only the parts you render exist. Leave out `TMDataGrid.Footer` and there is no
-pagination; a column that defines no filter shows no filter control.
+Only the parts you render exist, and only the features you enable have state.
+Pagination is opt-in via `enablePagination` (implied by `manualPagination`) —
+by default every row renders, virtualized. A column that defines no filter
+shows no filter control.
 
 ## Documentation
 
@@ -94,12 +102,37 @@ demo site:
 The grid lives in [`src/tmdatagrid/`](src/tmdatagrid); everything else in `src`
 is the demo site that documents it.
 
+| Path                | Contents                                                     |
+| ------------------- | ------------------------------------------------------------ |
+| `index.ts`          | The public API — the only entry point the package exposes     |
+| `useTMDataGrid.tsx` | The hook that builds the table, and the types it is built on  |
+| `core/`             | Headless logic: filtering, ordering, persistence, capabilities |
+| `components/`       | The React chrome and its co-located CSS modules               |
+
 ```sh
 npm install
 npm run dev    # demo site with the grid example and docs
 npm run lint   # oxlint
+npm run test   # vitest, once
+npm run test:watch
 ```
 
+## Testing
+
+Vitest with React Testing Library, in jsdom. Tests sit next to the code they
+cover as `*.test.ts(x)` and are excluded from both the package and the
+declaration build; shared fixtures live in [`src/test/`](src/test) so they stay
+out of `src/tmdatagrid/` entirely.
+
+Two things worth knowing before adding to them:
+
+- `vitest.setup.ts` installs what jsdom does not provide — an in-memory
+  `Storage`, `matchMedia`, `ResizeObserver`, and element sizes. The last one
+  matters: without a measurable box, the virtualizer renders no rows at all.
+- The Mantine provider in the harness runs with `env="test"`, which disables
+  transitions. Without it a popover never finishes mounting and its panel is
+  never found.
+
 ## Building
 
 Two independent outputs, neither committed: