@foundrykit/tailwind 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/CHANGELOG.md +8 -0
- package/README.md +48 -36
- package/package.json +2 -2
- package/src/globals.css +7 -6
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -1,11 +1,15 @@
|
|
|
1
1
|
# @foundrykit/tailwind
|
|
2
2
|
|
|
3
|
-
Tailwind CSS configuration and theme setup for the FoundryKit design system.
|
|
3
|
+
Tailwind CSS configuration and theme setup for the FoundryKit design system.
|
|
4
|
+
Provides consistent design tokens, utilities, and styling across all FoundryKit
|
|
5
|
+
components.
|
|
4
6
|
|
|
5
7
|
## Features
|
|
6
8
|
|
|
7
|
-
- **Design tokens** - Consistent colors, spacing, typography, and other design
|
|
8
|
-
|
|
9
|
+
- **Design tokens** - Consistent colors, spacing, typography, and other design
|
|
10
|
+
values
|
|
11
|
+
- **Component utilities** - Pre-built utility classes for common component
|
|
12
|
+
patterns
|
|
9
13
|
- **Theme integration** - Seamless integration with your existing theme
|
|
10
14
|
- **CSS variables** - Modern CSS custom properties for dynamic theming
|
|
11
15
|
- **Tailwind v4** - Built for the latest Tailwind CSS version
|
|
@@ -23,20 +27,20 @@ pnpm add @foundrykit/tailwind
|
|
|
23
27
|
In your main CSS file (e.g., `globals.css`):
|
|
24
28
|
|
|
25
29
|
```css
|
|
26
|
-
@import
|
|
30
|
+
@import '@foundrykit/tailwind/globals.css';
|
|
27
31
|
```
|
|
28
32
|
|
|
29
33
|
### 2. Use in Components
|
|
30
34
|
|
|
31
35
|
```tsx
|
|
32
|
-
import { Button } from '@foundrykit/primitives/button'
|
|
36
|
+
import { Button } from '@foundrykit/primitives/button';
|
|
33
37
|
|
|
34
38
|
function MyComponent() {
|
|
35
39
|
return (
|
|
36
|
-
<Button className=
|
|
40
|
+
<Button className='bg-primary text-primary-foreground hover:bg-primary/90'>
|
|
37
41
|
Click me
|
|
38
42
|
</Button>
|
|
39
|
-
)
|
|
43
|
+
);
|
|
40
44
|
}
|
|
41
45
|
```
|
|
42
46
|
|
|
@@ -151,19 +155,21 @@ Consistent border radius values:
|
|
|
151
155
|
### Basic Styling
|
|
152
156
|
|
|
153
157
|
```tsx
|
|
154
|
-
import { Button } from '@foundrykit/primitives/button'
|
|
158
|
+
import { Button } from '@foundrykit/primitives/button';
|
|
155
159
|
|
|
156
160
|
function StyledButton() {
|
|
157
161
|
return (
|
|
158
|
-
<Button
|
|
162
|
+
<Button
|
|
163
|
+
className='
|
|
159
164
|
bg-primary text-primary-foreground
|
|
160
165
|
hover:bg-primary/90
|
|
161
|
-
px-4 py-2
|
|
166
|
+
rounded-md px-4 py-2
|
|
162
167
|
font-medium transition-colors
|
|
163
|
-
|
|
168
|
+
'
|
|
169
|
+
>
|
|
164
170
|
Styled Button
|
|
165
171
|
</Button>
|
|
166
|
-
)
|
|
172
|
+
);
|
|
167
173
|
}
|
|
168
174
|
```
|
|
169
175
|
|
|
@@ -172,15 +178,17 @@ function StyledButton() {
|
|
|
172
178
|
```tsx
|
|
173
179
|
function Card() {
|
|
174
180
|
return (
|
|
175
|
-
<div
|
|
181
|
+
<div
|
|
182
|
+
className='
|
|
176
183
|
bg-background text-foreground
|
|
177
|
-
border
|
|
184
|
+
border-border rounded-lg border
|
|
178
185
|
p-6 shadow-sm
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
<
|
|
186
|
+
'
|
|
187
|
+
>
|
|
188
|
+
<h3 className='mb-2 text-lg font-semibold'>Card Title</h3>
|
|
189
|
+
<p className='text-muted-foreground'>Card content goes here</p>
|
|
182
190
|
</div>
|
|
183
|
-
)
|
|
191
|
+
);
|
|
184
192
|
}
|
|
185
193
|
```
|
|
186
194
|
|
|
@@ -189,14 +197,16 @@ function Card() {
|
|
|
189
197
|
```tsx
|
|
190
198
|
function ResponsiveComponent() {
|
|
191
199
|
return (
|
|
192
|
-
<div
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
200
|
+
<div
|
|
201
|
+
className='
|
|
202
|
+
grid grid-cols-1 gap-4 p-4
|
|
203
|
+
md:grid-cols-2 md:gap-6 md:p-6
|
|
204
|
+
lg:grid-cols-3 lg:gap-8 lg:p-8
|
|
205
|
+
'
|
|
206
|
+
>
|
|
197
207
|
{/* Content */}
|
|
198
208
|
</div>
|
|
199
|
-
)
|
|
209
|
+
);
|
|
200
210
|
}
|
|
201
211
|
```
|
|
202
212
|
|
|
@@ -205,16 +215,18 @@ function ResponsiveComponent() {
|
|
|
205
215
|
```tsx
|
|
206
216
|
function ThemeAwareComponent() {
|
|
207
217
|
return (
|
|
208
|
-
<div
|
|
218
|
+
<div
|
|
219
|
+
className='
|
|
209
220
|
bg-background text-foreground
|
|
210
221
|
dark:bg-background dark:text-foreground
|
|
211
|
-
border
|
|
212
|
-
|
|
213
|
-
|
|
222
|
+
border-border dark:border-border border
|
|
223
|
+
'
|
|
224
|
+
>
|
|
225
|
+
<p className='text-muted-foreground dark:text-muted-foreground'>
|
|
214
226
|
This component adapts to light and dark themes
|
|
215
227
|
</p>
|
|
216
228
|
</div>
|
|
217
|
-
)
|
|
229
|
+
);
|
|
218
230
|
}
|
|
219
231
|
```
|
|
220
232
|
|
|
@@ -225,20 +237,20 @@ function ThemeAwareComponent() {
|
|
|
225
237
|
Create your own `globals.css` to extend the theme:
|
|
226
238
|
|
|
227
239
|
```css
|
|
228
|
-
@import
|
|
240
|
+
@import '@foundrykit/tailwind/globals.css';
|
|
229
241
|
|
|
230
242
|
/* Custom design tokens */
|
|
231
243
|
:root {
|
|
232
244
|
--color-brand: 220 14% 96%;
|
|
233
245
|
--color-brand-foreground: 220 9% 46%;
|
|
234
|
-
|
|
246
|
+
|
|
235
247
|
--font-size-custom: 1.1rem;
|
|
236
248
|
--spacing-custom: 1.75rem;
|
|
237
249
|
}
|
|
238
250
|
|
|
239
251
|
/* Custom utilities */
|
|
240
252
|
@utility custom-button {
|
|
241
|
-
@apply bg-brand text-brand-foreground px-custom py-2
|
|
253
|
+
@apply bg-brand text-brand-foreground px-custom rounded-md py-2;
|
|
242
254
|
}
|
|
243
255
|
```
|
|
244
256
|
|
|
@@ -255,7 +267,7 @@ Create your own `globals.css` to extend the theme:
|
|
|
255
267
|
}
|
|
256
268
|
|
|
257
269
|
@utility card-elevated {
|
|
258
|
-
@apply bg-background border
|
|
270
|
+
@apply bg-background border-border rounded-lg border shadow-lg;
|
|
259
271
|
}
|
|
260
272
|
```
|
|
261
273
|
|
|
@@ -283,7 +295,7 @@ Create your own `globals.css` to extend the theme:
|
|
|
283
295
|
In your `app/globals.css`:
|
|
284
296
|
|
|
285
297
|
```css
|
|
286
|
-
@import
|
|
298
|
+
@import '@foundrykit/tailwind/globals.css';
|
|
287
299
|
|
|
288
300
|
/* Your custom styles */
|
|
289
301
|
```
|
|
@@ -293,7 +305,7 @@ In your `app/globals.css`:
|
|
|
293
305
|
In your `src/index.css`:
|
|
294
306
|
|
|
295
307
|
```css
|
|
296
|
-
@import
|
|
308
|
+
@import '@foundrykit/tailwind/globals.css';
|
|
297
309
|
|
|
298
310
|
/* Your custom styles */
|
|
299
311
|
```
|
|
@@ -303,7 +315,7 @@ In your `src/index.css`:
|
|
|
303
315
|
In your `src/assets/main.css`:
|
|
304
316
|
|
|
305
317
|
```css
|
|
306
|
-
@import
|
|
318
|
+
@import '@foundrykit/tailwind/globals.css';
|
|
307
319
|
|
|
308
320
|
/* Your custom styles */
|
|
309
321
|
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@foundrykit/tailwind",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"private": false,
|
|
6
6
|
"publishConfig": {
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
},
|
|
19
19
|
"devDependencies": {
|
|
20
20
|
"eslint": "^9.0.0",
|
|
21
|
-
"@foundrykit/eslint-config": "0.
|
|
21
|
+
"@foundrykit/eslint-config": "0.2.1"
|
|
22
22
|
},
|
|
23
23
|
"peerDependencies": {
|
|
24
24
|
"tailwindcss": "^4.1.1",
|
package/src/globals.css
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
|
|
1
|
+
/* biome biome-ignore-file */
|
|
2
|
+
@import 'tailwindcss';
|
|
2
3
|
@source "../../../apps/**/*.{ts,tsx}";
|
|
3
4
|
@source "../../../components/**/*.{ts,tsx}";
|
|
4
5
|
@source "../**/*.{ts,tsx}";
|
|
@@ -9,7 +10,7 @@
|
|
|
9
10
|
/* When consumed from npm: scan installed @foundrykit packages */
|
|
10
11
|
@source "../../../node_modules/@foundrykit/**/*.{ts,tsx,js,jsx,mjs,cjs}";
|
|
11
12
|
|
|
12
|
-
@import
|
|
13
|
+
@import 'tw-animate-css';
|
|
13
14
|
|
|
14
15
|
@custom-variant dark (&:is(.dark *));
|
|
15
16
|
|
|
@@ -132,7 +133,7 @@
|
|
|
132
133
|
}
|
|
133
134
|
|
|
134
135
|
button:not(:disabled),
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
}
|
|
136
|
+
[role='button']:not(:disabled) {
|
|
137
|
+
cursor: pointer;
|
|
138
|
+
}
|
|
139
|
+
}
|