@puzzle-ui/hooks 0.3.0 → 0.4.0

package/README.md

@@ -1,82 +1,99 @@
-# @puzzle-ui/hooks
+---
+title: Getting Started
+description: Install Puzzle in your React app, build your first interface, and customize the theme.
+---
 
-React hooks for keyboard events and roving focus, shared by Puzzle UI
-components and available for custom interfaces.
+> \[!WARNING\] **Puzzle is not ready for production use.**
+>
+> This project is under active development. APIs, component props,
+> package exports, styling, and internal implementation may change
+> without notice. Components may be incomplete, and testing,
+> accessibility, documentation, and framework compatibility are not yet
+> guaranteed. Use it for experimentation and evaluation only---not for
+> production applications.
 
-> Puzzle is under active development. APIs may change without notice; use it
-> for experimentation and evaluation rather than production applications.
+Puzzle is a TypeScript and React UI component library built around reusable components and shared design tokens. Its components are composable and router-independent, with styling supplied by `"@puzzle-ui/theme`. The framework is setup to be compatible with `Next.js`, `Tanstack Start` and `react-router`.
 
-## Installation
+**Puzzle is under active development and is not ready for production use.** APIs, props, exports, and styling may change without notice. Accessibility and framework compatibility are still being tested. Use the project for experimentation and evaluation.
 
-```sh
-npm install @puzzle-ui/hooks
-# or
-bun add @puzzle-ui/hooks
-# or
-pnpm add @puzzle-ui/hooks
-# or
-yarn add @puzzle-ui/hooks
-```
+## Prerequisites
 
-Requires React 19 (`^19.0.0`). No theme provider or stylesheet is required.
+- A package manager: npm, Bun, pnpm, or Yarn.
+- An existing React application with a bundler that supports CSS imports, such as Vite.
+- Familiarity with React and TypeScript. The UI and theme packages require React and React DOM 19 or later within the supported React 19 range.
 
-## Keyboard events
+## Set up a new project
 
-`useKeyboardKeys` subscribes to window keyboard events and cleans up its
-listeners when disabled or unmounted.
+Simple run our @puzzle-ui/create project template to get started.
 
-```tsx
-"use client";
+npm:
 
-import { useKeyboardKeys } from "@puzzle-ui/hooks";
+```bash
+npx @puzzle-ui/create
+```
 
-export const EscapeHint = () => {
-  useKeyboardKeys({
-    keys: ["Escape"],
-    onKeyDown: () => console.log("Escape pressed"),
-  });
+bun:
 
-  return <p>Press Escape to try the keyboard handler.</p>;
-};
+```bash
+bunx @puzzle-ui/create
 ```
 
-Options include `keys`, `onKeyDown`, `onKeyUp`, `enabled`, `preventDefault`,
-and `stopPropagation`. Callbacks receive modifier flags, repeat state, and
-the native event. These are global listeners: scope application shortcuts
-carefully so they do not interfere with inputs or other controls.
+Puzzle can set up a new project for you with the following framework options:
+
+- Basic React app
+- Tanstack start
+- Next.js
+
+Furthermore you can choose to install tailwindcss or not.
+It directly installs all dependencies and sets up the project for you.
+
+## Set up in an existing project:
 
-## Roving focus
+Install the UI library and theme package in your application's directory. Choose your package manager below:
 
-`useRovingFocus<T>` manages a single tab stop among items identified by stable
-IDs. It supports horizontal, vertical, or both orientations, RTL direction,
-looping, disabled items, and an initial active ID.
+npm:
 
-Wire its `getItemRef`, `getItemTabIndex`, `onItemFocus`, and `onItemKeyDown`
-helpers to each focusable element. Use `focusItem` for programmatic focus
-and `activeId` to inspect the current item.
+```bash
+npm install @puzzle-ui/ui --save
+```
 
-Focus management does not supply widget semantics or selection state. Add
-the appropriate roles, accessible names, and selection behavior yourself.
+bun:
 
-## Compatibility
+```bash
+bun add @puzzle-ui/create
+```
 
-Call these hooks in React function components or custom hooks, not in server
-components. In React Server Component applications, use a `"use client"`
-module for interactive consumers. ESM and CommonJS builds and their
-TypeScript declarations are included.
+pnpm:
 
-## Development
+```bash
+pnpm add @puzzle-ui/ui
+```
 
-From an installed repository checkout:
+yarn:
 
-```sh
-npm run build --workspace=@puzzle-ui/hooks
+```bash
+yarn add @puzzle-ui/ui
 ```
 
-This package currently has no dedicated test script. `prepack` rebuilds it
-before packing or publishing. See the root
-[publishing guide](../../README.md#publishing-packages).
+These commands install published packages; they do not clone the repository or build its workspaces. Puzzle does not require Bun in your application. React and React DOM are peer dependencies and should already be installed in your app.
 
-## License
+## Your first interface
 
-MIT. See [LICENSE](../../LICENSE); the published license is at `dist/LICENSE`.
+Import components from `"@puzzle-ui/ui` and wrap your application in `Theme` from `"@puzzle-ui/theme`:
+
+```tsx
+import { Theme } from "@puzzle-ui/theme";
+import { Button } from "@puzzle-ui/ui";
+
+export const App = () => (
+  <Theme>
+    <main>
+      <h1>Hello, Puzzle</h1>
+      <p>Build your interface with reusable components and shared tokens.</p>
+      <Button onClick={() => window.alert("Welcome to Puzzle!")}>
+        Get started
+      </Button>
+    </main>
+  </Theme>
+);
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@puzzle-ui/hooks",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Reusable React hooks for Puzzle",
   "license": "MIT",
   "publishConfig": {
@@ -29,11 +29,12 @@
   ],
   "scripts": {
     "build": "tsdown",
+    "typecheck": "tsc --noEmit -p .",
     "clean": "rm -rf dist",
     "prepack": "tsdown"
   },
   "dependencies": {
-    "@puzzle-ui/core": "^0.3.0"
+    "@puzzle-ui/core": "^0.4.0"
   },
   "peerDependencies": {
     "react": "^19.0.0"