@tapizlabs/ui 0.1.2 → 0.1.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 +32 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -19,6 +19,14 @@ It is intended to keep multiple apps visually aligned while reducing duplicated
|
|
|
19
19
|
npm install @tapizlabs/ui
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
+
This package expects Tailwind CSS v4 to already exist in the consuming app.
|
|
23
|
+
|
|
24
|
+
If your app does not use Tailwind yet, install it before using `@tapizlabs/ui`:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
npm install tailwindcss @tailwindcss/postcss
|
|
28
|
+
```
|
|
29
|
+
|
|
22
30
|
## Requirements
|
|
23
31
|
|
|
24
32
|
- `react >= 19`
|
|
@@ -27,6 +35,8 @@ npm install @tapizlabs/ui
|
|
|
27
35
|
|
|
28
36
|
These are declared as peer dependencies and must be provided by the consuming app.
|
|
29
37
|
|
|
38
|
+
Important: `@tapizlabs/ui` is not Tailwind-free. Consumer applications must have Tailwind CSS v4 configured, otherwise shared styles and local utility classes will not build correctly.
|
|
39
|
+
|
|
30
40
|
## Package Exports
|
|
31
41
|
|
|
32
42
|
This package exposes:
|
|
@@ -78,6 +88,28 @@ export function ExamplePanel() {
|
|
|
78
88
|
|
|
79
89
|
`@tapizlabs/ui/theme.css` is published as a compiled CSS bundle, so consumer apps only need to import it. No extra `@source` directive is required in application code.
|
|
80
90
|
|
|
91
|
+
You still must keep Tailwind enabled in the consuming app itself.
|
|
92
|
+
|
|
93
|
+
Minimum consumer setup:
|
|
94
|
+
|
|
95
|
+
```js
|
|
96
|
+
// postcss.config.js
|
|
97
|
+
export default {
|
|
98
|
+
plugins: {
|
|
99
|
+
"@tailwindcss/postcss": {},
|
|
100
|
+
},
|
|
101
|
+
};
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
```css
|
|
105
|
+
/* app entry CSS */
|
|
106
|
+
@import "@tapizlabs/ui/theme.css";
|
|
107
|
+
@import "tailwindcss";
|
|
108
|
+
@source "./**/*.{ts,tsx}";
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
If Tailwind is missing from the consumer app, `@tapizlabs/ui` will not render correctly.
|
|
112
|
+
|
|
81
113
|
## Included Components
|
|
82
114
|
|
|
83
115
|
Current exports include:
|