@karakuri-ui/react 0.1.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 +77 -0
- package/dist/index.d.mts +1796 -0
- package/dist/index.d.ts +1796 -0
- package/dist/index.js +7828 -0
- package/dist/index.js.map +1 -0
- package/dist/index.mjs +7571 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +120 -0
package/README.md
ADDED
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# KARAKURI Design System
|
|
2
|
+
|
|
3
|
+
Enterprise React component library with design token system.
|
|
4
|
+
|
|
5
|
+
📖 [KARAKURI Design System](https://karakuri-ai.github.io/design-system)
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Quick Start
|
|
10
|
+
|
|
11
|
+
### Components + Tokens
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install @karakuri-ui/react @karakuri-ui/tokens
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
### Tokens Only
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npm install @karakuri-ui/tokens
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
### Tailwind v4
|
|
24
|
+
|
|
25
|
+
```css
|
|
26
|
+
@import "tailwindcss";
|
|
27
|
+
|
|
28
|
+
@import '@karakuri-ui/tokens/tailwind/v4.css';
|
|
29
|
+
|
|
30
|
+
@source "../node_modules/@karakuri-ui/react/dist";
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Tailwind v3
|
|
34
|
+
|
|
35
|
+
```css
|
|
36
|
+
@tailwind base;
|
|
37
|
+
@tailwind components;
|
|
38
|
+
@tailwind utilities;
|
|
39
|
+
|
|
40
|
+
@import '@karakuri-ui/tokens/css/all.css';
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
```js
|
|
44
|
+
// tailwind.config.js
|
|
45
|
+
module.exports = {
|
|
46
|
+
presets: [require('@karakuri-ui/tokens/tailwind/v3-preset')],
|
|
47
|
+
content: [
|
|
48
|
+
'./node_modules/@karakuri-ui/react/dist/**/*.{js,mjs}',
|
|
49
|
+
],
|
|
50
|
+
}
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Usage
|
|
54
|
+
|
|
55
|
+
```tsx
|
|
56
|
+
import { Button, Card } from '@karakuri-ui/react'
|
|
57
|
+
|
|
58
|
+
<Button variant="solid" color="primary">Get Started</Button>
|
|
59
|
+
|
|
60
|
+
<Card>
|
|
61
|
+
<Card.Header>
|
|
62
|
+
<Card.Title>Settings</Card.Title>
|
|
63
|
+
</Card.Header>
|
|
64
|
+
<Card.Content>...</Card.Content>
|
|
65
|
+
</Card>
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Tech Stack
|
|
69
|
+
|
|
70
|
+
| | |
|
|
71
|
+
|---|---|
|
|
72
|
+
| **Framework** | React 18 + TypeScript |
|
|
73
|
+
| **Styling** | Tailwind CSS v3 / v4 + CSS Variables |
|
|
74
|
+
| **Primitives** | Radix UI |
|
|
75
|
+
| **Charts** | Recharts |
|
|
76
|
+
| **Tokens** | Figma Token Studio → `sync-tokens` |
|
|
77
|
+
| **Build** | tsup (library), Next.js (docs) |
|