@vashu96/ui 0.0.4 → 0.0.7
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/LICENSE +21 -0
- package/README.md +29 -1
- package/package.json +12 -7
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Vashu Chogada
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -9,12 +9,22 @@
|
|
|
9
9
|
- **Accessible**: Follows WAI-ARIA patterns.
|
|
10
10
|
- **Type-Safe**: Written in TypeScript with full type definitions.
|
|
11
11
|
|
|
12
|
+
## Requirements
|
|
13
|
+
|
|
14
|
+
This library requires the following peer dependencies to be installed in your project:
|
|
15
|
+
|
|
16
|
+
- **React**: `^19.2.0`
|
|
17
|
+
- **React DOM**: `^19.2.0`
|
|
18
|
+
- **TanStack Table**: `^8.0.0` (Required for `DataTable` component)
|
|
19
|
+
|
|
12
20
|
## Installation
|
|
13
21
|
|
|
14
22
|
```bash
|
|
15
|
-
npm install @vashu96/ui
|
|
23
|
+
npm install @vashu96/ui @tanstack/react-table
|
|
16
24
|
```
|
|
17
25
|
|
|
26
|
+
Check our `package.json` for all dependencies.
|
|
27
|
+
|
|
18
28
|
## Setup
|
|
19
29
|
|
|
20
30
|
### 1. Import Styles
|
|
@@ -153,6 +163,24 @@ function ThemeSwitcher() {
|
|
|
153
163
|
Available presets via `PRESETS`:
|
|
154
164
|
`indigo`, `emerald`, `rose`, `amber`, `cyan`, `violet`, `sky`, `fuchsia`, `orange`, `teal`.
|
|
155
165
|
|
|
166
|
+
## Publishing
|
|
167
|
+
|
|
168
|
+
To publish a new version of the library to NPM, use the following commands:
|
|
169
|
+
|
|
170
|
+
- **Patch release**: `npm run release` or `npm run release:patch` (e.g., v0.0.1 -> v0.0.2)
|
|
171
|
+
- **Minor release**: `npm run release:minor` (e.g., v0.0.2 -> v0.1.0)
|
|
172
|
+
- **Major release**: `npm run release:major` (e.g., v0.1.0 -> v1.0.0)
|
|
173
|
+
|
|
174
|
+
These scripts will automatically:
|
|
175
|
+
|
|
176
|
+
1. Build the production bundle.
|
|
177
|
+
2. Increment the version in `package.json`.
|
|
178
|
+
3. Create a git tag for the new version.
|
|
179
|
+
4. Publish the package to NPM with public access.
|
|
180
|
+
|
|
181
|
+
> [!IMPORTANT]
|
|
182
|
+
> Ensure you are logged into NPM (`npm login`) and have a clean git working directory before running these commands.
|
|
183
|
+
|
|
156
184
|
## License
|
|
157
185
|
|
|
158
186
|
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vashu96/ui",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.7",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"module": "./dist/index.js",
|
|
@@ -18,18 +18,23 @@
|
|
|
18
18
|
],
|
|
19
19
|
"scripts": {
|
|
20
20
|
"build": "vite build",
|
|
21
|
-
"dev": "vite build --watch"
|
|
21
|
+
"dev": "vite build --watch",
|
|
22
|
+
"release": "npm run release:patch",
|
|
23
|
+
"release:patch": "npm run build && npm version patch && npm publish --access public",
|
|
24
|
+
"release:minor": "npm run build && npm version minor && npm publish --access public",
|
|
25
|
+
"release:major": "npm run build && npm version major && npm publish --access public"
|
|
22
26
|
},
|
|
23
27
|
"peerDependencies": {
|
|
24
|
-
"react": "^19.
|
|
25
|
-
"react-dom": "^19.
|
|
28
|
+
"react": "^19.2.0",
|
|
29
|
+
"react-dom": "^19.2.0"
|
|
26
30
|
},
|
|
27
31
|
"dependencies": {
|
|
28
|
-
"@sglara/cn": "^1.0.0"
|
|
32
|
+
"@sglara/cn": "^1.0.0",
|
|
33
|
+
"@tanstack/react-table": "^8.21.3"
|
|
29
34
|
},
|
|
30
35
|
"devDependencies": {
|
|
31
|
-
"@types/react": "^19.
|
|
32
|
-
"@types/react-dom": "^19.
|
|
36
|
+
"@types/react": "^19.2.0",
|
|
37
|
+
"@types/react-dom": "^19.2.0",
|
|
33
38
|
"@vitejs/plugin-react": "^5.1.1",
|
|
34
39
|
"typescript": "~5.7.2",
|
|
35
40
|
"vite": "^7.3.1",
|