@mithunsalinda/veyqor-ui 0.1.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 +44 -0
- package/dist/index.cjs +3875 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +1029 -0
- package/dist/index.d.ts +1029 -0
- package/dist/index.js +3804 -0
- package/dist/index.js.map +1 -0
- package/dist/styles.css +5606 -0
- package/package.json +51 -0
package/README.md
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# @mithunsalinda/veyqor-ui
|
|
2
|
+
|
|
3
|
+
React components for the Veyqor Design System.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
This package expects React and React DOM from the consuming application.
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
pnpm add @mithunsalinda/veyqor-ui
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
Import the CSS once:
|
|
16
|
+
|
|
17
|
+
```tsx
|
|
18
|
+
import "@mithunsalinda/veyqor-ui/styles.css";
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Use components from the package root:
|
|
22
|
+
|
|
23
|
+
```tsx
|
|
24
|
+
import { Button, Dialog, Select } from "@mithunsalinda/veyqor-ui";
|
|
25
|
+
|
|
26
|
+
export function ProductActions() {
|
|
27
|
+
return (
|
|
28
|
+
<Dialog trigger={<Button>Edit product</Button>} title="Edit product">
|
|
29
|
+
Product editor content
|
|
30
|
+
</Dialog>
|
|
31
|
+
);
|
|
32
|
+
}
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Development
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
corepack pnpm --filter @mithunsalinda/veyqor-ui test
|
|
39
|
+
corepack pnpm --filter @mithunsalinda/veyqor-ui typecheck
|
|
40
|
+
corepack pnpm --filter @mithunsalinda/veyqor-ui lint
|
|
41
|
+
corepack pnpm --filter @mithunsalinda/veyqor-ui build
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Storybook examples live in `apps/storybook`.
|