elseware-ui 2.30.1 → 2.31.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 +109 -109
- package/dist/index.css +1791 -541
- package/dist/index.css.map +1 -1
- package/dist/index.d.mts +1327 -1225
- package/dist/index.d.ts +1327 -1225
- package/dist/index.js +1171 -381
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +1167 -381
- package/dist/index.mjs.map +1 -1
- package/package.json +110 -110
package/README.md
CHANGED
|
@@ -1,109 +1,109 @@
|
|
|
1
|
-
# elseware UI
|
|
2
|
-
|
|
3
|
-
## Component Imports Structure
|
|
4
|
-
|
|
5
|
-
```javascript
|
|
6
|
-
// External
|
|
7
|
-
import { ReactNode } from "react";
|
|
8
|
-
|
|
9
|
-
// Internal
|
|
10
|
-
import { cn } from "@/utils";
|
|
11
|
-
|
|
12
|
-
// Types
|
|
13
|
-
import { BaseComponentProps } from "@/interfaces";
|
|
14
|
-
import { Variant, Shape, Size } from "@/types";
|
|
15
|
-
|
|
16
|
-
// Data
|
|
17
|
-
import {
|
|
18
|
-
shapes,
|
|
19
|
-
variants,
|
|
20
|
-
borderVariants,
|
|
21
|
-
avatarSizes,
|
|
22
|
-
} from "@/data/styles";
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
Copy the following and define the component imports accordingly
|
|
26
|
-
|
|
27
|
-
```javascript
|
|
28
|
-
// External
|
|
29
|
-
|
|
30
|
-
// Internal
|
|
31
|
-
|
|
32
|
-
// Types
|
|
33
|
-
|
|
34
|
-
// Data
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
## Folder Hierarchy
|
|
39
|
-
- components: Base UI primitives (buttons, inputs, modals, etc.)
|
|
40
|
-
- compositions: Composite reusable structures built from primitives
|
|
41
|
-
- data: Metadata used on the components/compositions
|
|
42
|
-
- layouts: Page layouts that can be used to quickly structure the page formats
|
|
43
|
-
- styles: Tailwind/CSS stylings
|
|
44
|
-
- types: Custom react types
|
|
45
|
-
- utils: Reusable utility functions and hooks
|
|
46
|
-
|
|
47
|
-
## Setup
|
|
48
|
-
|
|
49
|
-
Install the dependendecies via `npm i`.
|
|
50
|
-
|
|
51
|
-
## Run Storybook
|
|
52
|
-
|
|
53
|
-
To test the components and its features start storybook using `npm run dev`.
|
|
54
|
-
|
|
55
|
-
## Build
|
|
56
|
-
|
|
57
|
-
Run `npm run build` to build the UI framework.
|
|
58
|
-
|
|
59
|
-
## Publishing to npm
|
|
60
|
-
|
|
61
|
-
### Publishing a New Version
|
|
62
|
-
|
|
63
|
-
1. **Update the version number**:
|
|
64
|
-
- Before publishing a new version, update the version in `package.json` following [semantic versioning](https://semver.org/).
|
|
65
|
-
- Example:
|
|
66
|
-
```json
|
|
67
|
-
{
|
|
68
|
-
"name": "elseware-ui",
|
|
69
|
-
"version": "1.0.1",
|
|
70
|
-
...
|
|
71
|
-
}
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
2. **Build the UI Framework**:
|
|
75
|
-
- Run the following command to ensure your changes are built and ready to be published:
|
|
76
|
-
```bash
|
|
77
|
-
npm run build
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
3. **Login to npm**:
|
|
81
|
-
- If you're not already logged in to npm, log in using:
|
|
82
|
-
```bash
|
|
83
|
-
npm login
|
|
84
|
-
```
|
|
85
|
-
|
|
86
|
-
4. **Publish the package**:
|
|
87
|
-
- To publish the package, run the following command:
|
|
88
|
-
```bash
|
|
89
|
-
npm publish --access public
|
|
90
|
-
```
|
|
91
|
-
- Make sure the package name in `package.json` is unique and does not conflict with other packages on npm.
|
|
92
|
-
|
|
93
|
-
### Unpublishing an Older Version
|
|
94
|
-
|
|
95
|
-
If you need to unpublish a specific version of the package:
|
|
96
|
-
|
|
97
|
-
1. **Unpublish a specific version**:
|
|
98
|
-
- To unpublish a specific version of your package (e.g., `1.0.0`), run:
|
|
99
|
-
```bash
|
|
100
|
-
npm unpublish elseware-ui@1.0.0
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
2. **Unpublish the entire package**:
|
|
104
|
-
- If you need to unpublish the entire package, you can run the following command (not recommended for public packages):
|
|
105
|
-
```bash
|
|
106
|
-
npm unpublish elseware-ui --force
|
|
107
|
-
```
|
|
108
|
-
|
|
109
|
-
**Note:** Be cautious when using `--force` as npm restricts package unpublishing for packages that are older than 72 hours to avoid breaking dependencies.
|
|
1
|
+
# elseware UI
|
|
2
|
+
|
|
3
|
+
## Component Imports Structure
|
|
4
|
+
|
|
5
|
+
```javascript
|
|
6
|
+
// External
|
|
7
|
+
import { ReactNode } from "react";
|
|
8
|
+
|
|
9
|
+
// Internal
|
|
10
|
+
import { cn } from "@/utils";
|
|
11
|
+
|
|
12
|
+
// Types
|
|
13
|
+
import { BaseComponentProps } from "@/interfaces";
|
|
14
|
+
import { Variant, Shape, Size } from "@/types";
|
|
15
|
+
|
|
16
|
+
// Data
|
|
17
|
+
import {
|
|
18
|
+
shapes,
|
|
19
|
+
variants,
|
|
20
|
+
borderVariants,
|
|
21
|
+
avatarSizes,
|
|
22
|
+
} from "@/data/styles";
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Copy the following and define the component imports accordingly
|
|
26
|
+
|
|
27
|
+
```javascript
|
|
28
|
+
// External
|
|
29
|
+
|
|
30
|
+
// Internal
|
|
31
|
+
|
|
32
|
+
// Types
|
|
33
|
+
|
|
34
|
+
// Data
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
## Folder Hierarchy
|
|
39
|
+
- components: Base UI primitives (buttons, inputs, modals, etc.)
|
|
40
|
+
- compositions: Composite reusable structures built from primitives
|
|
41
|
+
- data: Metadata used on the components/compositions
|
|
42
|
+
- layouts: Page layouts that can be used to quickly structure the page formats
|
|
43
|
+
- styles: Tailwind/CSS stylings
|
|
44
|
+
- types: Custom react types
|
|
45
|
+
- utils: Reusable utility functions and hooks
|
|
46
|
+
|
|
47
|
+
## Setup
|
|
48
|
+
|
|
49
|
+
Install the dependendecies via `npm i`.
|
|
50
|
+
|
|
51
|
+
## Run Storybook
|
|
52
|
+
|
|
53
|
+
To test the components and its features start storybook using `npm run dev`.
|
|
54
|
+
|
|
55
|
+
## Build
|
|
56
|
+
|
|
57
|
+
Run `npm run build` to build the UI framework.
|
|
58
|
+
|
|
59
|
+
## Publishing to npm
|
|
60
|
+
|
|
61
|
+
### Publishing a New Version
|
|
62
|
+
|
|
63
|
+
1. **Update the version number**:
|
|
64
|
+
- Before publishing a new version, update the version in `package.json` following [semantic versioning](https://semver.org/).
|
|
65
|
+
- Example:
|
|
66
|
+
```json
|
|
67
|
+
{
|
|
68
|
+
"name": "elseware-ui",
|
|
69
|
+
"version": "1.0.1",
|
|
70
|
+
...
|
|
71
|
+
}
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
2. **Build the UI Framework**:
|
|
75
|
+
- Run the following command to ensure your changes are built and ready to be published:
|
|
76
|
+
```bash
|
|
77
|
+
npm run build
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
3. **Login to npm**:
|
|
81
|
+
- If you're not already logged in to npm, log in using:
|
|
82
|
+
```bash
|
|
83
|
+
npm login
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
4. **Publish the package**:
|
|
87
|
+
- To publish the package, run the following command:
|
|
88
|
+
```bash
|
|
89
|
+
npm publish --access public
|
|
90
|
+
```
|
|
91
|
+
- Make sure the package name in `package.json` is unique and does not conflict with other packages on npm.
|
|
92
|
+
|
|
93
|
+
### Unpublishing an Older Version
|
|
94
|
+
|
|
95
|
+
If you need to unpublish a specific version of the package:
|
|
96
|
+
|
|
97
|
+
1. **Unpublish a specific version**:
|
|
98
|
+
- To unpublish a specific version of your package (e.g., `1.0.0`), run:
|
|
99
|
+
```bash
|
|
100
|
+
npm unpublish elseware-ui@1.0.0
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
2. **Unpublish the entire package**:
|
|
104
|
+
- If you need to unpublish the entire package, you can run the following command (not recommended for public packages):
|
|
105
|
+
```bash
|
|
106
|
+
npm unpublish elseware-ui --force
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
**Note:** Be cautious when using `--force` as npm restricts package unpublishing for packages that are older than 72 hours to avoid breaking dependencies.
|