@zentauri-ui/zentauri-components 0.0.92 → 0.0.93
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 +36 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -20,7 +20,7 @@ The `<name>` segment matches the folder under `src/ui/` (for example `accordion`
|
|
|
20
20
|
## Requirements
|
|
21
21
|
|
|
22
22
|
- **React** and **React DOM** `>= 18` (peer dependencies)
|
|
23
|
-
- A Tailwind pipeline that can **scan** this package (see Step
|
|
23
|
+
- A Tailwind pipeline that can **scan** this package (see Step 3 below)
|
|
24
24
|
|
|
25
25
|
## Components
|
|
26
26
|
|
|
@@ -52,7 +52,7 @@ Each area is available from the barrel and from its own subpath (`…/ui/<subpat
|
|
|
52
52
|
|
|
53
53
|
## Installation
|
|
54
54
|
|
|
55
|
-
**Getting started** — Add the package, point Tailwind at the library sources, then import from the UI barrel or from a specific `ui/<name>` subpath.
|
|
55
|
+
**Getting started** — Add the package, install peer dependencies so primitives resolve correctly, point Tailwind at the library sources, then import from the UI barrel or from a specific `ui/<name>` subpath.
|
|
56
56
|
|
|
57
57
|
### Step 1 — Install the package
|
|
58
58
|
|
|
@@ -70,7 +70,39 @@ pnpm install @zentauri-ui/zentauri-components
|
|
|
70
70
|
yarn add @zentauri-ui/zentauri-components
|
|
71
71
|
```
|
|
72
72
|
|
|
73
|
-
### Step 2 —
|
|
73
|
+
### Step 2 — Install peer dependencies
|
|
74
|
+
|
|
75
|
+
The library expects `react`, `react-dom`, `class-variance-authority`, `clsx`, and `tailwind-merge` in your app. Install them alongside the components package.
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
npm install react react-dom class-variance-authority clsx tailwind-merge
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
pnpm add react react-dom class-variance-authority clsx tailwind-merge
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
yarn add react react-dom class-variance-authority clsx tailwind-merge
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
#### Optional: animations and icons
|
|
90
|
+
|
|
91
|
+
Add `framer-motion` when using motion-based UI, and `react-icons` when using icon sets from that package.
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
npm install framer-motion react-icons
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
```bash
|
|
98
|
+
pnpm add framer-motion react-icons
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
```bash
|
|
102
|
+
yarn add framer-motion react-icons
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### Step 3 — Include library paths in globals.css
|
|
74
106
|
|
|
75
107
|
Add an `@source` entry so Tailwind scans class names inside `@zentauri-ui/zentauri-components`. The path is relative to this CSS file—adjust `../` if your file lives elsewhere.
|
|
76
108
|
|
|
@@ -79,7 +111,7 @@ Add an `@source` entry so Tailwind scans class names inside `@zentauri-ui/zentau
|
|
|
79
111
|
@source "../node_modules/@zentauri-ui/zentauri-components";
|
|
80
112
|
```
|
|
81
113
|
|
|
82
|
-
### Step
|
|
114
|
+
### Step 4 — Import and use components
|
|
83
115
|
|
|
84
116
|
Prefer a **subpath** when you only need one area (smaller resolved graph than the full barrel). The barrel remains valid when you use many primitives from different areas.
|
|
85
117
|
|