@pretable/react 0.0.1 → 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Brian Love
+
+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,50 @@
+# @pretable/react
+
+The React surface for [pretable](https://pretable.dev/). Ships three components and one hook on top of `@pretable/core`'s headless engine.
+
+## When to reach for what
+
+- **`<Pretable>`** — drop-in. Pass `columns` and `rows` and you're done. Best for quick wins.
+- **`<PretableSurface>`** — controlled. Pass `state` to drive sort, filter, selection, focus, or column layout from the outside. Best for production apps.
+- **`usePretable`** — the hook. Returns `{ grid, snapshot, renderSnapshot, telemetry }` for custom rendering. Best when you need more control than `<PretableSurface>` provides — e.g., a non-default DOM layout or a different framework.
+
+`<InspectionGrid>` and `<LabeledGridSurface>` are special-purpose surfaces tagged `@beta` — they work, but expect shape changes pre-1.0.
+
+## Install
+
+```sh
+npm install @pretable/react @pretable/core @pretable/ui
+# or pnpm add … / yarn add …
+```
+
+`@pretable/ui` ships the CSS theme; import the stylesheet once at the root of your app.
+
+## Minimal example
+
+```tsx
+import { Pretable } from "@pretable/react";
+import "@pretable/ui/grid.css";
+
+function App() {
+  return (
+    <Pretable
+      columns={[
+        { id: "name", header: "Name" },
+        { id: "age", header: "Age", sortable: true },
+      ]}
+      rows={[
+        { id: "1", name: "Ada", age: 36 },
+        { id: "2", name: "Grace", age: 85 },
+      ]}
+    />
+  );
+}
+```
+
+## Full public surface
+
+See **[`react.api.md`](./react.api.md)** for every exported component, hook, type, and function with their full signatures. The file is generated by [API Extractor](https://api-extractor.com/) and committed to the repo; CI fails if it drifts.
+
+## License
+
+MIT — see [LICENSE](../../LICENSE).