hazo_ui 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 +53 -0
- package/dist/index.cjs +849 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +49 -0
- package/dist/index.d.ts +49 -0
- package/dist/index.js +823 -0
- package/dist/index.js.map +1 -0
- package/package.json +86 -0
package/README.md
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# hazo_ui
|
|
2
|
+
|
|
3
|
+
A set of UI components for common interaction elements in a SaaS app.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install hazo_ui
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
Import components individually for optimal tree-shaking:
|
|
14
|
+
|
|
15
|
+
```tsx
|
|
16
|
+
import { ExampleComponent } from 'hazo_ui';
|
|
17
|
+
|
|
18
|
+
function App() {
|
|
19
|
+
return <ExampleComponent>Hello World</ExampleComponent>;
|
|
20
|
+
}
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Development
|
|
24
|
+
|
|
25
|
+
### Build the library
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
npm run build
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### Run Storybook
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
npm run storybook
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Run dev app
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
npm run dev:app
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### Test before publishing
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
npm run test:build
|
|
47
|
+
npm run test:dev
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## License
|
|
51
|
+
|
|
52
|
+
MIT
|
|
53
|
+
|