@cyberbloxai/ui-kit 0.1.1 → 0.1.2
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 +43 -5
- package/dist/favicon.ico +0 -0
- package/package.json +7 -5
package/README.md
CHANGED
|
@@ -22,28 +22,66 @@ CyberBlox UI Kit is a modular, themeable component library designed for building
|
|
|
22
22
|
npm install @cyberbloxai/ui-kit
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
+
> **Note**: If you are using **Tailwind CSS v4** and encounter a dependency conflict (`ERESOLVE`), you can install using:
|
|
26
|
+
> `npm install @cyberbloxai/ui-kit --legacy-peer-deps`
|
|
27
|
+
|
|
25
28
|
## Quick Start
|
|
26
29
|
|
|
27
|
-
1. **Import Styles**: Add the CSS to your main entry file (e.g., `main.tsx` or `App.tsx`):
|
|
30
|
+
1. **Import Styles**: Add the CSS to your main entry file (e.g., `main.tsx` or `App.tsx`) **before** your other imports:
|
|
28
31
|
|
|
29
32
|
```tsx
|
|
30
33
|
import "@cyberbloxai/ui-kit/styles.css";
|
|
31
34
|
```
|
|
32
35
|
|
|
33
|
-
2. **
|
|
36
|
+
2. **Tailwind CSS Configuration**:
|
|
37
|
+
|
|
38
|
+
### For Tailwind CSS v4 (Recommended)
|
|
39
|
+
In your main CSS file (e.g., `index.css` or `app.css`), ensure you have:
|
|
40
|
+
```css
|
|
41
|
+
@import "tailwindcss";
|
|
42
|
+
/* If your components are unstyled, you may need to import the library CSS here instead */
|
|
43
|
+
@import "@cyberbloxai/ui-kit/styles.css";
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### For Tailwind CSS v3
|
|
47
|
+
In your `tailwind.config.js`, you **must** add the library to the `content` array so Tailwind can find the classes used in the components:
|
|
48
|
+
|
|
49
|
+
```javascript
|
|
50
|
+
/** @type {import('tailwindcss').Config} */
|
|
51
|
+
export default {
|
|
52
|
+
content: [
|
|
53
|
+
"./index.html",
|
|
54
|
+
"./src/**/*.{js,ts,jsx,tsx}",
|
|
55
|
+
"./node_modules/@cyberbloxai/ui-kit/dist/**/*.{js,mjs}" // Add this line
|
|
56
|
+
],
|
|
57
|
+
// ... rest of config
|
|
58
|
+
}
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
3. **Use Components**:
|
|
34
62
|
|
|
35
63
|
```tsx
|
|
36
64
|
import { Button } from "@cyberbloxai/ui-kit";
|
|
37
65
|
|
|
38
66
|
function App() {
|
|
39
67
|
return (
|
|
40
|
-
<
|
|
41
|
-
|
|
42
|
-
|
|
68
|
+
<div className="p-8">
|
|
69
|
+
<Button variant="default" onClick={() => console.log("Clicked!")}>
|
|
70
|
+
Click Me
|
|
71
|
+
</Button>
|
|
72
|
+
</div>
|
|
43
73
|
);
|
|
44
74
|
}
|
|
45
75
|
```
|
|
46
76
|
|
|
77
|
+
## Troubleshooting
|
|
78
|
+
|
|
79
|
+
- **Blank Page / White Screen**: This usually indicates a JavaScript error. Check your browser console (`F12` -> Console).
|
|
80
|
+
- Ensure you have `react` and `react-dom` installed.
|
|
81
|
+
- If using Vite, try clearing your cache: `rm -rf node_modules/.vite` and restart with `npm run dev`.
|
|
82
|
+
- **Unstyled Components**: Ensure you have imported `@cyberbloxai/ui-kit/styles.css` and configured your Tailwind `content` (for v3) or `@import` (for v4).
|
|
83
|
+
|
|
84
|
+
|
|
47
85
|
## Technologies Used
|
|
48
86
|
|
|
49
87
|
- **Vite**: Next-generation frontend tooling.
|
package/dist/favicon.ico
CHANGED
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cyberbloxai/ui-kit",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "Production-ready UI component library built on Radix UI + Tailwind CSS.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -25,11 +25,13 @@
|
|
|
25
25
|
"dist",
|
|
26
26
|
"README.md"
|
|
27
27
|
],
|
|
28
|
-
"sideEffects":
|
|
28
|
+
"sideEffects": [
|
|
29
|
+
"**/*.css"
|
|
30
|
+
],
|
|
29
31
|
"peerDependencies": {
|
|
30
|
-
"react": "^18.0.0",
|
|
31
|
-
"react-dom": "^18.0.0",
|
|
32
|
-
"tailwindcss": "^3.0.0"
|
|
32
|
+
"react": "^18.0.0 || ^19.0.0",
|
|
33
|
+
"react-dom": "^18.0.0 || ^19.0.0",
|
|
34
|
+
"tailwindcss": "^3.0.0 || ^4.0.0"
|
|
33
35
|
},
|
|
34
36
|
"scripts": {
|
|
35
37
|
"dev": "vite",
|