ui_zenkit 1.0.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 +61 -0
- package/dist/index.d.mts +4776 -0
- package/dist/index.d.ts +4776 -0
- package/dist/index.js +16739 -0
- package/dist/index.js.map +1 -0
- package/dist/index.mjs +16401 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +87 -0
package/README.md
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# @zenkit-ui/core
|
|
2
|
+
|
|
3
|
+
Core components for ZenKit UI - A modern React component library built on ZenKit CSS.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @zenkit-ui/core zenkit-css
|
|
9
|
+
# or
|
|
10
|
+
pnpm add @zenkit-ui/core zenkit-css
|
|
11
|
+
# or
|
|
12
|
+
yarn add @zenkit-ui/core zenkit-css
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
First, import ZenKit CSS in your app's entry point:
|
|
18
|
+
|
|
19
|
+
```tsx
|
|
20
|
+
import 'zenkit-css/dist/zenkit.css';
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Then use components:
|
|
24
|
+
|
|
25
|
+
```tsx
|
|
26
|
+
import { Button } from '@zenkit-ui/core';
|
|
27
|
+
|
|
28
|
+
function App() {
|
|
29
|
+
return (
|
|
30
|
+
<Button variant="solid" colorScheme="primary">
|
|
31
|
+
Click me
|
|
32
|
+
</Button>
|
|
33
|
+
);
|
|
34
|
+
}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Components
|
|
38
|
+
|
|
39
|
+
- **Button** - Versatile button with variants, sizes, loading states, and icons
|
|
40
|
+
|
|
41
|
+
More components coming soon!
|
|
42
|
+
|
|
43
|
+
## Props
|
|
44
|
+
|
|
45
|
+
### Button
|
|
46
|
+
|
|
47
|
+
| Prop | Type | Default | Description |
|
|
48
|
+
|------|------|---------|-------------|
|
|
49
|
+
| variant | 'solid' \| 'outline' \| 'ghost' \| 'link' \| 'soft' | 'solid' | Button style variant |
|
|
50
|
+
| colorScheme | ColorScheme | 'primary' | Color scheme |
|
|
51
|
+
| size | 'sm' \| 'md' \| 'lg' | 'md' | Button size |
|
|
52
|
+
| fullWidth | boolean | false | Full width button |
|
|
53
|
+
| loading | boolean | false | Loading state |
|
|
54
|
+
| loadingText | string | - | Text shown during loading |
|
|
55
|
+
| leftIcon | ReactNode | - | Icon on the left |
|
|
56
|
+
| rightIcon | ReactNode | - | Icon on the right |
|
|
57
|
+
| iconOnly | boolean | false | Icon-only button |
|
|
58
|
+
|
|
59
|
+
## License
|
|
60
|
+
|
|
61
|
+
MIT
|