vuiii 1.0.0-beta.81 → 1.0.0-beta.82

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.
Files changed (2) hide show
  1. package/README.md +41 -7
  2. package/package.json +14 -9
package/README.md CHANGED
@@ -1,17 +1,51 @@
1
1
  # VUIII
2
2
 
3
- A stupid simple components and utils library for rapid development of the UI in your project.
3
+ 'Yet another' simple and customizable Vue 3 component library for rapid UI development.
4
4
 
5
- ## Instalation
5
+ Key features:
6
+
7
+ - Full TypeScript support
8
+ - Dynamic form generation with validation
9
+ - Dialog and snackbar notification systems
10
+ - Composables for async actions, pagination, and data loading
11
+ - Customizable icon resolver for any icon library
12
+ - Flexible option parsing for selects, autocompletes, and radio groups
13
+ - ARIA accessibility support
14
+ - CSS variables for easy theming
15
+
16
+ [Documentation and examples](https://greegus.github.io/vuiii/)
17
+
18
+ ## Installation
6
19
 
7
20
  ```sh
8
- npm install vuiii
21
+ npm install vuiii@latest
9
22
  ```
10
23
 
11
- ## Storybook
24
+ No global setup is required. Import the stylesheet once in your app entry point and use components directly.
12
25
 
13
- Run showcase of all provided components in storybook
26
+ ```typescript
27
+ import "vuiii/style.css";
28
+ ```
14
29
 
15
- ```sh
16
- npm run storybook
30
+ ```typescript
31
+ import { Button, Input, Select, FormFields } from "vuiii";
17
32
  ```
33
+
34
+ ### Custom Icons
35
+
36
+ Register a custom icon resolver to integrate your icon library (Heroicons, FontAwesome, etc.):
37
+
38
+ ```typescript
39
+ import { registerCustomIconResolver } from "vuiii";
40
+ import { defineAsyncComponent } from "vue";
41
+
42
+ registerCustomIconResolver((name) => {
43
+ return defineAsyncComponent(() => import(`./icons/${name}.vue`));
44
+ });
45
+ ```
46
+
47
+ ## Documentation and examples
48
+
49
+ Storybook serves as the primary documentation for VUIII. It contains interactive examples, component API references, and usage patterns for all components.
50
+
51
+ https://greegus.github.io/vuiii/
package/package.json CHANGED
@@ -1,9 +1,9 @@
1
1
  {
2
2
  "name": "vuiii",
3
- "version": "1.0.0-beta.81",
3
+ "version": "1.0.0-beta.82",
4
4
  "repository": {
5
5
  "type": "git",
6
- "url": "git+https://github.com/greegus/vui.git"
6
+ "url": "git+https://github.com/greegus/vuiii.git"
7
7
  },
8
8
  "files": [
9
9
  "dist",
@@ -28,13 +28,17 @@
28
28
  "storybook": "storybook dev -p 6006",
29
29
  "build-storybook": "storybook build",
30
30
  "chromatic": "npx chromatic --exit-zero-on-changes",
31
- "docs": "npx jiti scripts/generate-docs.ts"
31
+ "docs": "npx jiti scripts/generate-docs.ts",
32
+ "docs:dev": "vitepress dev docs",
33
+ "docs:build": "vitepress build docs",
34
+ "docs:preview": "vitepress preview docs",
35
+ "docs:generate": "npx jiti scripts/generate-vitepress-docs.ts"
32
36
  },
33
37
  "devDependencies": {
34
38
  "@chromatic-com/storybook": "^5.0.0",
35
- "@storybook/addon-docs": "^10.2.0",
36
- "@storybook/addon-links": "^10.2.0",
37
- "@storybook/vue3-vite": "^10.2.0",
39
+ "@storybook/addon-docs": "^10.2.3",
40
+ "@storybook/addon-links": "^10.2.3",
41
+ "@storybook/vue3-vite": "^10.2.3",
38
42
  "@tsconfig/node24": "^24.0.3",
39
43
  "@types/node": "^24.10.4",
40
44
  "@vitejs/plugin-vue": "^6.0.3",
@@ -43,19 +47,20 @@
43
47
  "npm-run-all2": "^8.0.4",
44
48
  "oxfmt": "^0.24.0",
45
49
  "oxlint": "^1.1.0",
46
- "storybook": "^10.2.0",
50
+ "storybook": "^10.2.3",
47
51
  "typescript": "~5.9.3",
48
52
  "vite": "^7.3.1",
49
53
  "vite-plugin-dts": "^4.5.4",
54
+ "vitepress": "^1.6.4",
50
55
  "vue-loader": "^17.4.2",
51
56
  "vue-router": "^4.2.5",
52
57
  "vue-tsc": "^3.2.2"
53
58
  },
54
59
  "peerDependencies": {
55
60
  "vue": "^3.5.26",
56
- "vue-router": "^4.2.5"
61
+ "vue-router": "5.x"
57
62
  },
58
63
  "engines": {
59
64
  "node": ">=24.0.0"
60
65
  }
61
- }
66
+ }