@agenticindiedev/ui 0.2.1 → 0.2.3
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 +67 -15
- package/dist/index.cjs +7 -7
- package/dist/index.js +227 -224
- package/dist/styles.css +308 -0
- package/package.json +28 -10
package/README.md
CHANGED
|
@@ -28,22 +28,35 @@ bun dev
|
|
|
28
28
|
|
|
29
29
|
This launches Storybook at `http://localhost:6006` where you can preview and develop components.
|
|
30
30
|
|
|
31
|
+
### 3. Component Gallery
|
|
32
|
+
|
|
33
|
+
View the component gallery (demo page) locally:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
cd demo
|
|
37
|
+
bun install
|
|
38
|
+
bun run dev
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
This launches the demo gallery at `http://localhost:3000` showcasing all components using the built library.
|
|
42
|
+
|
|
31
43
|
## Scripts
|
|
32
44
|
|
|
33
|
-
| Command
|
|
34
|
-
|
|
|
35
|
-
| `bun dev`
|
|
36
|
-
| `bun run build`
|
|
37
|
-
| `bun run build
|
|
38
|
-
| `bun run build:
|
|
39
|
-
| `bun run
|
|
40
|
-
| `bun run
|
|
41
|
-
| `bun run
|
|
42
|
-
| `bun run format:
|
|
43
|
-
| `bun run
|
|
44
|
-
| `bun run lint:
|
|
45
|
-
| `bun
|
|
46
|
-
| `bun
|
|
45
|
+
| Command | Description |
|
|
46
|
+
| ------------------------- | -------------------------------------- |
|
|
47
|
+
| `bun dev` | Start Storybook development server |
|
|
48
|
+
| `bun run build` | Build the library for production |
|
|
49
|
+
| `bun run build-storybook` | Build Storybook for deployment |
|
|
50
|
+
| `bun run build:lib` | Build only the JS/TS bundle |
|
|
51
|
+
| `bun run build:css` | Build only the CSS bundle |
|
|
52
|
+
| `bun run pre:install` | Update dependencies and rebuild |
|
|
53
|
+
| `bun run prepare:deploy` | Format, lint, and build for deployment |
|
|
54
|
+
| `bun run format:check` | Check code formatting |
|
|
55
|
+
| `bun run format:fix` | Fix code formatting |
|
|
56
|
+
| `bun run lint:check` | Check for linting errors |
|
|
57
|
+
| `bun run lint:fix` | Fix linting errors |
|
|
58
|
+
| `bun test` | Run tests |
|
|
59
|
+
| `bun run typecheck` | Run TypeScript type checking |
|
|
47
60
|
|
|
48
61
|
## Usage
|
|
49
62
|
|
|
@@ -250,7 +263,7 @@ src/
|
|
|
250
263
|
│ └── patterns/ # Complex patterns
|
|
251
264
|
│ └── DataTable/
|
|
252
265
|
├── styles/
|
|
253
|
-
│ └── globals.
|
|
266
|
+
│ └── globals.scss # Tailwind CSS entry point
|
|
254
267
|
├── utils/
|
|
255
268
|
│ └── cn.ts # Class name utility
|
|
256
269
|
└── index.ts # Public exports
|
|
@@ -274,6 +287,45 @@ If you were using DaisyUI, note that this package has migrated to shadcn/ui patt
|
|
|
274
287
|
- ✅ Better performance
|
|
275
288
|
- ✅ Active maintenance and updates
|
|
276
289
|
|
|
290
|
+
## Storybook
|
|
291
|
+
|
|
292
|
+
This project uses [Storybook](https://storybook.js.org/) for component development and documentation. All components have corresponding `.stories.tsx` files that demonstrate their usage, variants, and interactive examples.
|
|
293
|
+
|
|
294
|
+
### Viewing Storybook
|
|
295
|
+
|
|
296
|
+
- **Local Development**: Run `bun dev` to start Storybook at `http://localhost:6006`
|
|
297
|
+
- **Online**: View the deployed Storybook on [GitHub Pages](https://agenticindiedev.github.io/ui/) (automatically deployed on push to main)
|
|
298
|
+
|
|
299
|
+
### Storybook Features
|
|
300
|
+
|
|
301
|
+
- Interactive component playground
|
|
302
|
+
- All component variants and states
|
|
303
|
+
- Code examples for each component
|
|
304
|
+
- Auto-generated documentation
|
|
305
|
+
- Dark mode support
|
|
306
|
+
|
|
307
|
+
## Demo Gallery
|
|
308
|
+
|
|
309
|
+
A standalone demo gallery is available in the `demo/` directory. This showcases all components using the published library in a simple, clean interface.
|
|
310
|
+
|
|
311
|
+
### Running the Demo
|
|
312
|
+
|
|
313
|
+
```bash
|
|
314
|
+
cd demo
|
|
315
|
+
bun install
|
|
316
|
+
bun run dev
|
|
317
|
+
```
|
|
318
|
+
|
|
319
|
+
The demo gallery will be available at `http://localhost:3000`.
|
|
320
|
+
|
|
321
|
+
## GitHub Pages Deployment
|
|
322
|
+
|
|
323
|
+
Storybook is automatically deployed to GitHub Pages on every push to the `main` branch via GitHub Actions. The workflow:
|
|
324
|
+
|
|
325
|
+
1. Builds Storybook using `bun run build-storybook`
|
|
326
|
+
2. Deploys the static build to the `gh-pages` branch
|
|
327
|
+
3. Makes it available at `https://agenticindiedev.github.io/ui/`
|
|
328
|
+
|
|
277
329
|
## License
|
|
278
330
|
|
|
279
331
|
MIT
|