virtual-ui-lib 1.0.0 → 1.0.1
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 +79 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# Virtual UI
|
|
2
|
+
|
|
3
|
+
Simple React UI Component Library.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
npm install virtual-ui-lib
|
|
8
|
+
|
|
9
|
+
## Usage
|
|
10
|
+
|
|
11
|
+
```jsx
|
|
12
|
+
import { Button, Card, Input } from "virtual-ui-lib"
|
|
13
|
+
|
|
14
|
+
function App() {
|
|
15
|
+
return (
|
|
16
|
+
<>
|
|
17
|
+
<Button text="Click me" />
|
|
18
|
+
|
|
19
|
+
<Card title="Hello" text="Card example">
|
|
20
|
+
<Button text="Buy" />
|
|
21
|
+
</Card>
|
|
22
|
+
|
|
23
|
+
<Input placeholder="Enter name" />
|
|
24
|
+
</>
|
|
25
|
+
)
|
|
26
|
+
}
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## Components
|
|
32
|
+
|
|
33
|
+
### Button
|
|
34
|
+
|
|
35
|
+
```jsx
|
|
36
|
+
<Button text="Click me" />
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Props:
|
|
40
|
+
|
|
41
|
+
| Prop | Description |
|
|
42
|
+
| ----- | ---------------- |
|
|
43
|
+
| text | Button text |
|
|
44
|
+
| bg | Background color |
|
|
45
|
+
| color | Text color |
|
|
46
|
+
| size | sm / md / lg |
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
### Card
|
|
51
|
+
|
|
52
|
+
```jsx
|
|
53
|
+
<Card title="Card Title" text="Card description" />
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Props:
|
|
57
|
+
|
|
58
|
+
| Prop | Description |
|
|
59
|
+
| ------ | ----------- |
|
|
60
|
+
| title | Card title |
|
|
61
|
+
| text | Card text |
|
|
62
|
+
| width | Card width |
|
|
63
|
+
| shadow | Card shadow |
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
### Input
|
|
68
|
+
|
|
69
|
+
```jsx
|
|
70
|
+
<Input placeholder="Enter name" />
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Props:
|
|
74
|
+
|
|
75
|
+
| Prop | Description |
|
|
76
|
+
| ----------- | ----------------- |
|
|
77
|
+
| placeholder | Input placeholder |
|
|
78
|
+
| width | Input width |
|
|
79
|
+
| radius | Border radius |
|