@umami/react-zen 0.216.0 → 0.218.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 +36 -11
- package/dist/index.d.mts +385 -316
- package/dist/index.d.ts +385 -316
- package/dist/index.js +14666 -9520
- package/dist/index.mjs +14722 -9571
- package/package.json +45 -31
- package/styles.css +225 -5344
- package/styles.full.css +2 -0
- package/tailwind.preset.ts +129 -0
- package/dist/index.css +0 -5139
- package/dist/index.css.map +0 -1
package/README.md
CHANGED
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
# zen
|
|
2
2
|
|
|
3
|
-
**zen** is a
|
|
3
|
+
**zen** is a props-driven React component library built for speed. Build polished interfaces without writing HTML, CSS, or thinking about Tailwind classes.
|
|
4
4
|
|
|
5
|
-
-
|
|
6
|
-
-
|
|
5
|
+
- **Props over classes** - Style through component props, not utility classes
|
|
6
|
+
- **Design included** - Complete design system out of the box with dark mode
|
|
7
|
+
- **Accessible** - Built on [React Aria](https://react-spectrum.adobe.com/react-aria/) primitives
|
|
8
|
+
- **Powered by Tailwind** - Uses [Tailwind CSS](https://tailwindcss.com/) under the hood, but you never touch it
|
|
7
9
|
|
|
8
|
-
[
|
|
10
|
+
[Documentation](https://zen.umami.is/)
|
|
9
11
|
|
|
10
12
|
## Installation
|
|
11
13
|
|
|
@@ -21,16 +23,39 @@ npm install @umami/react-zen
|
|
|
21
23
|
import '@umami/react-zen/styles.css';
|
|
22
24
|
```
|
|
23
25
|
|
|
24
|
-
###
|
|
25
|
-
|
|
26
|
-
```
|
|
27
|
-
import { Button } from '@umami/react-zen';
|
|
28
|
-
|
|
29
|
-
export default function () {
|
|
30
|
-
return
|
|
26
|
+
### Build with components
|
|
27
|
+
|
|
28
|
+
```jsx
|
|
29
|
+
import { Box, Column, Heading, Text, Button } from '@umami/react-zen';
|
|
30
|
+
|
|
31
|
+
export default function Welcome() {
|
|
32
|
+
return (
|
|
33
|
+
<Box padding="6" border borderRadius="lg" shadow="lg">
|
|
34
|
+
<Column alignItems="center" gap="6">
|
|
35
|
+
<Heading size="3xl">Welcome</Heading>
|
|
36
|
+
<Text color="muted">This is the zen way.</Text>
|
|
37
|
+
<Button variant="primary">Enter</Button>
|
|
38
|
+
</Column>
|
|
39
|
+
</Box>
|
|
40
|
+
);
|
|
31
41
|
}
|
|
32
42
|
```
|
|
33
43
|
|
|
44
|
+
No `className`. No CSS files. Just components and props.
|
|
45
|
+
|
|
46
|
+
## Why zen?
|
|
47
|
+
|
|
48
|
+
Building UI is slow. You have to think about markup, CSS organization, responsive breakpoints, accessibility, and design consistency.
|
|
49
|
+
|
|
50
|
+
zen eliminates that friction:
|
|
51
|
+
|
|
52
|
+
| Traditional approach | zen approach |
|
|
53
|
+
|---------------------|--------------|
|
|
54
|
+
| Write HTML structure | Compose components |
|
|
55
|
+
| Add Tailwind classes | Pass props |
|
|
56
|
+
| Handle responsive manually | Use responsive objects |
|
|
57
|
+
| Configure accessibility | Already done |
|
|
58
|
+
|
|
34
59
|
## License
|
|
35
60
|
|
|
36
61
|
MIT
|