@raydenui/ui 0.4.0 → 0.5.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 +112 -9
- package/package.json +13 -9
package/README.md
CHANGED
|
@@ -1,6 +1,12 @@
|
|
|
1
|
+
<picture>
|
|
2
|
+
<source media="(prefers-color-scheme: dark)" srcset="./public/MacBook Air - 17.png">
|
|
3
|
+
<source media="(prefers-color-scheme: light)" srcset="./public/MacBook Air - 17.png">
|
|
4
|
+
<img alt="Rayden UI - Build UI faster. A React UI system designed for humans and AI." src="./public/MacBook Air - 17.png" width="100%">
|
|
5
|
+
</picture>
|
|
6
|
+
|
|
1
7
|
# Rayden UI
|
|
2
8
|
|
|
3
|
-
A modern, accessible React component library built with Tailwind CSS v4. Rayden UI brings the [Rayna UI](https://www.
|
|
9
|
+
A modern, accessible React component library built with Tailwind CSS v4. Rayden UI brings the [Rayna UI](https://www.raynaui.com/) Figma design system to life with pixel-perfect React components.
|
|
4
10
|
|
|
5
11
|
[](https://www.npmjs.com/package/@raydenui/ui)
|
|
6
12
|
[](https://opensource.org/licenses/MIT)
|
|
@@ -77,6 +83,67 @@ function App() {
|
|
|
77
83
|
}
|
|
78
84
|
```
|
|
79
85
|
|
|
86
|
+
## Tailwind Integration
|
|
87
|
+
|
|
88
|
+
Rayden UI ships pre-compiled CSS, so components work out of the box. However, if you want to use Rayden's design tokens in your own Tailwind classes (e.g., `bg-primary-400`, `text-grey-700`), you need additional configuration.
|
|
89
|
+
|
|
90
|
+
### Using Rayden Tokens in Your Code
|
|
91
|
+
|
|
92
|
+
Extend your Tailwind config with Rayden's color palette:
|
|
93
|
+
|
|
94
|
+
```js
|
|
95
|
+
// tailwind.config.js (Tailwind v3)
|
|
96
|
+
import { colors } from "@raydenui/ui/preset";
|
|
97
|
+
|
|
98
|
+
export default {
|
|
99
|
+
theme: {
|
|
100
|
+
extend: {
|
|
101
|
+
colors,
|
|
102
|
+
},
|
|
103
|
+
},
|
|
104
|
+
content: [
|
|
105
|
+
"./src/**/*.{js,ts,jsx,tsx}",
|
|
106
|
+
// Include Rayden UI components so Tailwind scans them
|
|
107
|
+
"node_modules/@raydenui/ui/dist/**/*.js",
|
|
108
|
+
],
|
|
109
|
+
};
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
For Tailwind v4 with CSS-based config:
|
|
113
|
+
|
|
114
|
+
```css
|
|
115
|
+
/* app.css */
|
|
116
|
+
@import "tailwindcss";
|
|
117
|
+
@import "@raydenui/ui/styles.css";
|
|
118
|
+
|
|
119
|
+
@source "node_modules/@raydenui/ui/dist/**/*.js";
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
Or extend the theme in CSS:
|
|
123
|
+
|
|
124
|
+
```css
|
|
125
|
+
@import "tailwindcss";
|
|
126
|
+
@import "@raydenui/ui/styles.css";
|
|
127
|
+
|
|
128
|
+
@theme {
|
|
129
|
+
--color-primary-400: #F56630;
|
|
130
|
+
--color-primary-500: #EB5017;
|
|
131
|
+
/* ... other tokens from @raydenui/ui/preset */
|
|
132
|
+
}
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### Available Token Exports
|
|
136
|
+
|
|
137
|
+
```tsx
|
|
138
|
+
import {
|
|
139
|
+
colors, // Color palette (primary, grey, success, error, warning, info)
|
|
140
|
+
shadows, // Box shadows (soft, hard variants)
|
|
141
|
+
spacing, // Spacing scale (4px base)
|
|
142
|
+
typography, // Font sizes, line heights, letter spacing
|
|
143
|
+
grid, // Breakpoints and layout tokens
|
|
144
|
+
} from "@raydenui/ui/preset";
|
|
145
|
+
```
|
|
146
|
+
|
|
80
147
|
## Components
|
|
81
148
|
|
|
82
149
|
### Forms & Inputs
|
|
@@ -163,7 +230,11 @@ function App() {
|
|
|
163
230
|
The `@raydenui/ai` package enables LLMs to reliably generate Rayden UI code without hallucination.
|
|
164
231
|
|
|
165
232
|
```bash
|
|
166
|
-
|
|
233
|
+
# Run directly with npx (no install needed)
|
|
234
|
+
npx @raydenui/ai
|
|
235
|
+
|
|
236
|
+
# Or install globally
|
|
237
|
+
npm install -g @raydenui/ai
|
|
167
238
|
```
|
|
168
239
|
|
|
169
240
|
### Features
|
|
@@ -173,15 +244,47 @@ pnpm add @raydenui/ai
|
|
|
173
244
|
- **Composition Rules** — Guidelines for combining components correctly
|
|
174
245
|
- **MCP Server** — Model Context Protocol server for AI assistants
|
|
175
246
|
|
|
176
|
-
###
|
|
247
|
+
### Claude Desktop Integration
|
|
248
|
+
|
|
249
|
+
Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
|
|
177
250
|
|
|
178
|
-
|
|
251
|
+
```json
|
|
252
|
+
{
|
|
253
|
+
"mcpServers": {
|
|
254
|
+
"rayden-ai": {
|
|
255
|
+
"command": "npx",
|
|
256
|
+
"args": ["@raydenui/ai"]
|
|
257
|
+
}
|
|
258
|
+
}
|
|
259
|
+
}
|
|
260
|
+
```
|
|
261
|
+
|
|
262
|
+
### Claude Code Integration
|
|
263
|
+
|
|
264
|
+
Add to your project's `.mcp.json`:
|
|
265
|
+
|
|
266
|
+
```json
|
|
267
|
+
{
|
|
268
|
+
"mcpServers": {
|
|
269
|
+
"rayden-ai": {
|
|
270
|
+
"command": "npx",
|
|
271
|
+
"args": ["@raydenui/ai"]
|
|
272
|
+
}
|
|
273
|
+
}
|
|
274
|
+
}
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
### Programmatic Usage
|
|
179
278
|
|
|
180
279
|
```tsx
|
|
181
|
-
import {
|
|
280
|
+
import { getComponentManifest, getAllManifests } from "@raydenui/ai/manifests";
|
|
281
|
+
import { tokens } from "@raydenui/ai/tokens";
|
|
282
|
+
|
|
283
|
+
// Get all component definitions
|
|
284
|
+
const manifests = getAllManifests();
|
|
182
285
|
|
|
183
|
-
//
|
|
184
|
-
|
|
286
|
+
// Get a specific component
|
|
287
|
+
const buttonManifest = getComponentManifest("Button");
|
|
185
288
|
```
|
|
186
289
|
|
|
187
290
|
See the full [AI Integration Guide](./docs/rayden-ai.md) for setup instructions.
|
|
@@ -304,9 +407,9 @@ MIT License - see [LICENSE](./LICENSE) for details.
|
|
|
304
407
|
|
|
305
408
|
## Acknowledgments
|
|
306
409
|
|
|
307
|
-
- Design system based on [Rayna UI](https://
|
|
410
|
+
- Design system based on [Rayna UI](https://raynaui.com) by Rayna UI Team
|
|
308
411
|
- Built with [React](https://react.dev/), [Tailwind CSS](https://tailwindcss.com/), and [Storybook](https://storybook.js.org/)
|
|
309
412
|
|
|
310
413
|
---
|
|
311
414
|
|
|
312
|
-
Made with care for the React community.
|
|
415
|
+
Made with care for the React community. By Ovalay Studios (https://ovalay.studio)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@raydenui/ui",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.0",
|
|
4
4
|
"description": "A modern React UI component library",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.cjs",
|
|
@@ -26,6 +26,14 @@
|
|
|
26
26
|
"files": [
|
|
27
27
|
"dist"
|
|
28
28
|
],
|
|
29
|
+
"scripts": {
|
|
30
|
+
"build": "tsup && npx @tailwindcss/cli -i src/styles/globals.css -o dist/styles.css --minify",
|
|
31
|
+
"dev": "tsup --watch",
|
|
32
|
+
"typecheck": "tsc --noEmit",
|
|
33
|
+
"storybook": "storybook dev -p 6006",
|
|
34
|
+
"build-storybook": "storybook build",
|
|
35
|
+
"chromatic": "npx chromatic --project-token=chpt_22e6810e48a2640"
|
|
36
|
+
},
|
|
29
37
|
"peerDependencies": {
|
|
30
38
|
"react": ">=18",
|
|
31
39
|
"react-dom": ">=18"
|
|
@@ -42,6 +50,8 @@
|
|
|
42
50
|
"*.css"
|
|
43
51
|
],
|
|
44
52
|
"devDependencies": {
|
|
53
|
+
"@chromatic-com/storybook": "^5.0.1",
|
|
54
|
+
"@storybook/addon-a11y": "^10.2.19",
|
|
45
55
|
"@storybook/addon-docs": "^10.2.19",
|
|
46
56
|
"@storybook/addon-vitest": "^10.2.19",
|
|
47
57
|
"@storybook/react": "^10.2.19",
|
|
@@ -54,6 +64,7 @@
|
|
|
54
64
|
"@vitest/browser-playwright": "^4.1.0",
|
|
55
65
|
"@vitest/coverage-v8": "^4.1.0",
|
|
56
66
|
"autoprefixer": "^10.4.27",
|
|
67
|
+
"chromatic": "^15.2.0",
|
|
57
68
|
"clsx": "^2.1.1",
|
|
58
69
|
"playwright": "^1.58.2",
|
|
59
70
|
"postcss": "^8.5.8",
|
|
@@ -66,12 +77,5 @@
|
|
|
66
77
|
"typescript": "^5.9.3",
|
|
67
78
|
"vite": "^7.3.1",
|
|
68
79
|
"vitest": "^4.1.0"
|
|
69
|
-
},
|
|
70
|
-
"scripts": {
|
|
71
|
-
"build": "tsup && npx @tailwindcss/cli -i src/styles/globals.css -o dist/styles.css --minify",
|
|
72
|
-
"dev": "tsup --watch",
|
|
73
|
-
"typecheck": "tsc --noEmit",
|
|
74
|
-
"storybook": "storybook dev -p 6006",
|
|
75
|
-
"build-storybook": "storybook build"
|
|
76
80
|
}
|
|
77
|
-
}
|
|
81
|
+
}
|