etudes 25.0.0 → 26.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +33 -0
- package/build/etudes.js +10243 -8541
- package/build/etudes.umd.cjs +7 -7
- package/build/hooks/useScrollPosition.d.ts +20 -0
- package/build/index.d.ts +1 -2
- package/package.json +15 -15
- package/build/hooks/usePosition.d.ts +0 -15
package/README.md
CHANGED
|
@@ -1,3 +1,36 @@
|
|
|
1
1
|
# Études [](https://www.npmjs.com/package/etudes) [](https://github.com/andrewscwei/etudes/actions?query=workflow%3ACD)
|
|
2
2
|
|
|
3
3
|
A study of headless React components.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
# Development (watch build + demo server on port 8080)
|
|
9
|
+
npm run dev
|
|
10
|
+
|
|
11
|
+
# Build the library
|
|
12
|
+
npm run build
|
|
13
|
+
|
|
14
|
+
# Run tests
|
|
15
|
+
npm run unit
|
|
16
|
+
|
|
17
|
+
# Run tests with coverage
|
|
18
|
+
npm run unit -- --coverage
|
|
19
|
+
|
|
20
|
+
# Type-check without emitting
|
|
21
|
+
npm run typecheck
|
|
22
|
+
|
|
23
|
+
# Lint
|
|
24
|
+
npm run lint
|
|
25
|
+
npm run lint:fix
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Components
|
|
29
|
+
|
|
30
|
+
- **`primitives/`** — Base UI building blocks, headless/unstyled by design
|
|
31
|
+
- **`components/`** — Higher-level components built on top of primitives
|
|
32
|
+
- **`hooks/`** — Standalone React hooks covering drag/gestures, observers, media, storage, and general utilities
|
|
33
|
+
- **`flows/`** — Control-flow JSX components
|
|
34
|
+
- **`hocs/`** — Higher-order components
|
|
35
|
+
- **`utils/`** — Pure utility functions for style manipulation, data transformation, key generation, device detection, and React helpers
|
|
36
|
+
- **`types/`** — Shared type definitions used across the library
|