gy-ui-plus 1.0.2 → 1.0.3
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 +115 -0
- package/package.json +6 -2
package/README.md
CHANGED
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
# gy-ui-plus
|
|
2
|
+
|
|
3
|
+
一个基于 Vue 3 开发的企业级 UI 组件库，提供丰富的组件和功能，帮助开发者快速构建高质量的前端应用。
|
|
4
|
+
|
|
5
|
+
## 特性
|
|
6
|
+
|
|
7
|
+
- 基于 Vue 3 + TypeScript 开发，提供完整的类型定义
|
|
8
|
+
- 组件设计遵循现代 UI/UX 设计理念
|
|
9
|
+
- 支持按需引入，减小打包体积
|
|
10
|
+
- 丰富的组件功能和配置选项
|
|
11
|
+
- 基于 Element Plus 扩展，保持良好的兼容性
|
|
12
|
+
|
|
13
|
+
## 安装
|
|
14
|
+
|
|
15
|
+
使用 npm 或 yarn 安装：
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm install gy-ui-plus
|
|
19
|
+
# 或
|
|
20
|
+
yarn add gy-ui-plus
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## 快速开始
|
|
24
|
+
|
|
25
|
+
### 完整引入
|
|
26
|
+
|
|
27
|
+
在 main.ts 中引入组件库及样式：
|
|
28
|
+
|
|
29
|
+
```typescript
|
|
30
|
+
import { createApp } from 'vue'
|
|
31
|
+
import App from './App.vue'
|
|
32
|
+
import GyUiPlus from 'gy-ui-plus'
|
|
33
|
+
import 'gy-ui-plus/dist/gy-ui-plus.css'
|
|
34
|
+
|
|
35
|
+
const app = createApp(App)
|
|
36
|
+
app.use(GyUiPlus)
|
|
37
|
+
app.mount('#app')
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### 按需引入
|
|
41
|
+
|
|
42
|
+
可以单独引入需要的组件：
|
|
43
|
+
|
|
44
|
+
```typescript
|
|
45
|
+
import { createApp } from 'vue'
|
|
46
|
+
import App from './App.vue'
|
|
47
|
+
import { JButton, JTable } from 'gy-ui-plus'
|
|
48
|
+
import 'gy-ui-plus/dist/gy-ui-plus.css'
|
|
49
|
+
|
|
50
|
+
const app = createApp(App)
|
|
51
|
+
app.component('JButton', JButton)
|
|
52
|
+
app.component('JTable', JTable)
|
|
53
|
+
app.mount('#app')
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## 组件文档
|
|
57
|
+
|
|
58
|
+
## 开发
|
|
59
|
+
|
|
60
|
+
### 环境要求
|
|
61
|
+
|
|
62
|
+
- Node.js >= 20.19.0
|
|
63
|
+
- npm >= 10.0.0
|
|
64
|
+
|
|
65
|
+
### 安装依赖
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
npm install
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### 启动开发服务器
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
npm run dev
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### 构建组件库
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
npm run lib
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
## 项目结构
|
|
84
|
+
|
|
85
|
+
```
|
|
86
|
+
gy-ui-plus/
|
|
87
|
+
├── packages/ # 组件源码目录
|
|
88
|
+
│ ├── index.ts # 组件库入口
|
|
89
|
+
│ ├── withInstall.ts # 组件安装工具
|
|
90
|
+
│ ├── j-button/ # 按钮组件
|
|
91
|
+
│ └── j-table/ # 表格组件
|
|
92
|
+
├── dist/ # 构建输出目录
|
|
93
|
+
├── vite.config.ts # Vite 配置
|
|
94
|
+
├── tsconfig.json # TypeScript 配置
|
|
95
|
+
└── package.json # 项目配置
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
## 许可证
|
|
99
|
+
|
|
100
|
+
MIT License
|
|
101
|
+
|
|
102
|
+
## 贡献
|
|
103
|
+
|
|
104
|
+
欢迎提交 Issue 和 Pull Request 来帮助改进这个项目！
|
|
105
|
+
|
|
106
|
+
## 联系方式
|
|
107
|
+
|
|
108
|
+
如有问题或建议，欢迎通过以下方式联系：
|
|
109
|
+
|
|
110
|
+
- GitHub Issues:
|
|
111
|
+
- Email: your.email@example.com
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
感谢使用 gy-ui-plus！
|
package/package.json
CHANGED
|
@@ -3,7 +3,9 @@
|
|
|
3
3
|
"publishConfig": {
|
|
4
4
|
"access": "public"
|
|
5
5
|
},
|
|
6
|
-
"
|
|
6
|
+
"author": "zyj",
|
|
7
|
+
"license": "MIT",
|
|
8
|
+
"version": "1.0.3",
|
|
7
9
|
"private": false,
|
|
8
10
|
"type": "module",
|
|
9
11
|
"main": "dist/gy-ui-plus.umd.js",
|
|
@@ -18,7 +20,9 @@
|
|
|
18
20
|
},
|
|
19
21
|
"files": [
|
|
20
22
|
"dist",
|
|
21
|
-
"packages"
|
|
23
|
+
"packages",
|
|
24
|
+
"README.md",
|
|
25
|
+
"LICENSE"
|
|
22
26
|
],
|
|
23
27
|
"engines": {
|
|
24
28
|
"node": "^20.19.0 || >=22.12.0"
|