@xuefx/ui-theme 1.0.1 → 1.0.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 +33 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# @xuefx/ui-theme
|
|
2
|
+
|
|
3
|
+
Design tokens, Tailwind preset, and theming tools for [@xuefx/ui](https://www.npmjs.com/package/@xuefx/ui).
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```js
|
|
8
|
+
// 1. Import design tokens (CSS custom properties)
|
|
9
|
+
import '@xuefx/ui-theme/styles.css';
|
|
10
|
+
|
|
11
|
+
// 2. Build your own theme
|
|
12
|
+
import { ThemeProvider, createTheme, themes } from '@xuefx/ui-theme';
|
|
13
|
+
|
|
14
|
+
const myTheme = createTheme({
|
|
15
|
+
colors: { primary: '142 76% 36%', 'primary-foreground': '0 0% 100%' },
|
|
16
|
+
});
|
|
17
|
+
|
|
18
|
+
// 3. Or use a preset
|
|
19
|
+
<ThemeProvider theme={themes.green}>
|
|
20
|
+
<App />
|
|
21
|
+
</ThemeProvider>
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Presets
|
|
25
|
+
|
|
26
|
+
| Preset | |
|
|
27
|
+
|---|---|
|
|
28
|
+
| `themes.green` | Emerald green |
|
|
29
|
+
| `themes.cyan` | Sky blue |
|
|
30
|
+
| `themes.red` | Warm red |
|
|
31
|
+
| `themes.purple` | Purple |
|
|
32
|
+
| `themes.orange` | Orange |
|
|
33
|
+
| `themes.dark` | Dark mode |
|