@iswangh/element-plus-kit 0.1.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/LICENSE +201 -0
- package/README.md +369 -0
- package/dist/index.d.ts +87 -0
- package/dist/index.js +15 -0
- package/dist/resolver.d.ts +32 -0
- package/dist/resolver.js +32 -0
- package/package.json +63 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,369 @@
|
|
|
1
|
+
# @iswangh/element-plus-kit
|
|
2
|
+
|
|
3
|
+
Element Plus Kit - 基于 Element Plus 的 Vue 3 组件库。
|
|
4
|
+
|
|
5
|
+
## ✨ 特性
|
|
6
|
+
|
|
7
|
+
- 🎨 基于 Element Plus,保持一致的视觉风格
|
|
8
|
+
- 📦 支持按需安装,减少包体积
|
|
9
|
+
- 🔧 支持多种导入方式:全局导入、手动导入、按需引入
|
|
10
|
+
- 💪 完整的 TypeScript 类型支持
|
|
11
|
+
- 🎯 组件命名规范:所有组件以 `W` 开头(如 `WForm`、`w-form`)
|
|
12
|
+
- 📚 详细的文档和示例
|
|
13
|
+
|
|
14
|
+
## 📦 安装
|
|
15
|
+
|
|
16
|
+
### 安装全部组件
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
npm install @iswangh/element-plus-kit
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### 按需安装单个组件
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
# 安装 Form 组件
|
|
26
|
+
npm install @iswangh/element-plus-kit-form
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## ⚙️ 配置 Element Plus
|
|
30
|
+
|
|
31
|
+
Element Plus Kit 基于 Element Plus 构建,因此需要在使用 Element Plus Kit 的项目中配置 Element Plus 的全局属性(如语言、尺寸等)。
|
|
32
|
+
|
|
33
|
+
### 配置语言(中文)
|
|
34
|
+
|
|
35
|
+
Element Plus 默认使用英文,如果需要使用中文,需要在项目中配置:
|
|
36
|
+
|
|
37
|
+
#### 方式一:通过 `app.use()` 配置(推荐)
|
|
38
|
+
|
|
39
|
+
```typescript
|
|
40
|
+
import { createApp } from 'vue'
|
|
41
|
+
import ElementPlus from 'element-plus'
|
|
42
|
+
import zhCn from 'element-plus/es/locale/lang/zh-cn'
|
|
43
|
+
import ElementPlusKit from '@iswangh/element-plus-kit'
|
|
44
|
+
import 'element-plus/dist/index.css'
|
|
45
|
+
|
|
46
|
+
const app = createApp(App)
|
|
47
|
+
|
|
48
|
+
// 配置 Element Plus 使用中文
|
|
49
|
+
app.use(ElementPlus, {
|
|
50
|
+
locale: zhCn,
|
|
51
|
+
})
|
|
52
|
+
|
|
53
|
+
// 注册 Element Plus Kit
|
|
54
|
+
app.use(ElementPlusKit)
|
|
55
|
+
|
|
56
|
+
app.mount('#app')
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
#### 方式二:通过 `ConfigProvider` 组件配置
|
|
60
|
+
|
|
61
|
+
```vue
|
|
62
|
+
<template>
|
|
63
|
+
<el-config-provider :locale="zhCn" size="default">
|
|
64
|
+
<App />
|
|
65
|
+
</el-config-provider>
|
|
66
|
+
</template>
|
|
67
|
+
|
|
68
|
+
<script setup lang="ts">
|
|
69
|
+
import { ElConfigProvider } from 'element-plus'
|
|
70
|
+
import zhCn from 'element-plus/es/locale/lang/zh-cn'
|
|
71
|
+
import App from './App.vue'
|
|
72
|
+
</script>
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### 配置尺寸
|
|
76
|
+
|
|
77
|
+
可以通过 `ConfigProvider` 组件全局配置组件尺寸:
|
|
78
|
+
|
|
79
|
+
```vue
|
|
80
|
+
<template>
|
|
81
|
+
<el-config-provider :locale="zhCn" size="large">
|
|
82
|
+
<App />
|
|
83
|
+
</el-config-provider>
|
|
84
|
+
</template>
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
可选值:`'large'`、`'default'`、`'small'`
|
|
88
|
+
|
|
89
|
+
### 其他配置
|
|
90
|
+
|
|
91
|
+
更多配置选项请参考 [Element Plus ConfigProvider 文档](https://element-plus.org/zh-CN/component/config-provider.html)
|
|
92
|
+
|
|
93
|
+
> **注意**:Element Plus 的全局配置应在使用 Element Plus Kit 的项目中处理,而不是在组件库包中。这样可以保持组件库的灵活性,让不同的项目根据自身需求进行配置。
|
|
94
|
+
|
|
95
|
+
## 🚀 快速开始
|
|
96
|
+
|
|
97
|
+
### 方式一:全局导入
|
|
98
|
+
|
|
99
|
+
```typescript
|
|
100
|
+
import { createApp } from 'vue'
|
|
101
|
+
import ElementPlusKit from '@iswangh/element-plus-kit'
|
|
102
|
+
|
|
103
|
+
const app = createApp(App)
|
|
104
|
+
app.use(ElementPlusKit)
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
```vue
|
|
108
|
+
<template>
|
|
109
|
+
<WForm :model="form" :form-items="formItems" />
|
|
110
|
+
</template>
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### 方式二:手动导入
|
|
114
|
+
|
|
115
|
+
```vue
|
|
116
|
+
<script setup lang="ts">
|
|
117
|
+
import { WForm } from '@iswangh/element-plus-kit'
|
|
118
|
+
import type { FormItems } from '@iswangh/element-plus-kit-form'
|
|
119
|
+
|
|
120
|
+
const formItems: FormItems = [
|
|
121
|
+
{
|
|
122
|
+
prop: 'username',
|
|
123
|
+
label: '用户名',
|
|
124
|
+
comp: 'input',
|
|
125
|
+
},
|
|
126
|
+
]
|
|
127
|
+
|
|
128
|
+
const form = ref({
|
|
129
|
+
username: '',
|
|
130
|
+
})
|
|
131
|
+
</script>
|
|
132
|
+
|
|
133
|
+
<template>
|
|
134
|
+
<WForm :model="form" :form-items="formItems" />
|
|
135
|
+
</template>
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
### 方式三:按需引入(推荐)
|
|
139
|
+
|
|
140
|
+
配置 `unplugin-vue-components` 和 `unplugin-auto-import`:
|
|
141
|
+
|
|
142
|
+
#### 1. 安装依赖
|
|
143
|
+
|
|
144
|
+
```bash
|
|
145
|
+
npm install -D unplugin-vue-components unplugin-auto-import
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
#### 2. 配置 Vite
|
|
149
|
+
|
|
150
|
+
```typescript
|
|
151
|
+
// vite.config.ts
|
|
152
|
+
import { defineConfig } from 'vite'
|
|
153
|
+
import vue from '@vitejs/plugin-vue'
|
|
154
|
+
import AutoImport from 'unplugin-auto-import/vite'
|
|
155
|
+
import Components from 'unplugin-vue-components/vite'
|
|
156
|
+
import { ElementPlusResolver } from 'unplugin-vue-components/resolvers'
|
|
157
|
+
import { ElementPlusKitResolver, ElementPlusKitAutoImportResolver } from '@iswangh/element-plus-kit/resolver'
|
|
158
|
+
|
|
159
|
+
export default defineConfig({
|
|
160
|
+
plugins: [
|
|
161
|
+
vue(),
|
|
162
|
+
AutoImport({
|
|
163
|
+
resolvers: [
|
|
164
|
+
ElementPlusResolver(),
|
|
165
|
+
ElementPlusKitAutoImportResolver(),
|
|
166
|
+
],
|
|
167
|
+
imports: ['vue'],
|
|
168
|
+
}),
|
|
169
|
+
Components({
|
|
170
|
+
resolvers: [
|
|
171
|
+
ElementPlusResolver(),
|
|
172
|
+
ElementPlusKitResolver(),
|
|
173
|
+
],
|
|
174
|
+
}),
|
|
175
|
+
],
|
|
176
|
+
})
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
#### 3. 使用组件
|
|
180
|
+
|
|
181
|
+
```vue
|
|
182
|
+
<script setup lang="ts">
|
|
183
|
+
// 无需手动导入,组件会自动导入
|
|
184
|
+
import type { FormItems } from '@iswangh/element-plus-kit-form'
|
|
185
|
+
|
|
186
|
+
const formItems: FormItems = [
|
|
187
|
+
{
|
|
188
|
+
prop: 'username',
|
|
189
|
+
label: '用户名',
|
|
190
|
+
comp: 'input',
|
|
191
|
+
},
|
|
192
|
+
]
|
|
193
|
+
|
|
194
|
+
const form = ref({
|
|
195
|
+
username: '',
|
|
196
|
+
})
|
|
197
|
+
</script>
|
|
198
|
+
|
|
199
|
+
<template>
|
|
200
|
+
<!-- WForm 会自动导入 -->
|
|
201
|
+
<WForm :model="form" :form-items="formItems" />
|
|
202
|
+
</template>
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
## 📚 组件列表
|
|
206
|
+
|
|
207
|
+
### Form 表单组件
|
|
208
|
+
|
|
209
|
+
动态表单组件,支持通过配置快速生成表单。
|
|
210
|
+
|
|
211
|
+
- **包名**: `@iswangh/element-plus-kit-form`
|
|
212
|
+
- **组件名**: `WForm`
|
|
213
|
+
- **文档**: [Form 组件文档](../form/README.md)
|
|
214
|
+
|
|
215
|
+
## 🔧 Resolver 配置
|
|
216
|
+
|
|
217
|
+
### ElementPlusKitResolver
|
|
218
|
+
|
|
219
|
+
用于 `unplugin-vue-components` 的组件自动导入。
|
|
220
|
+
|
|
221
|
+
```typescript
|
|
222
|
+
import { ElementPlusKitResolver } from '@iswangh/element-plus-kit/resolver'
|
|
223
|
+
import Components from 'unplugin-vue-components/vite'
|
|
224
|
+
|
|
225
|
+
Components({
|
|
226
|
+
resolvers: [
|
|
227
|
+
ElementPlusKitResolver(),
|
|
228
|
+
],
|
|
229
|
+
})
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
### ElementPlusKitAutoImportResolver
|
|
233
|
+
|
|
234
|
+
用于 `unplugin-auto-import` 的 API 自动导入。
|
|
235
|
+
|
|
236
|
+
```typescript
|
|
237
|
+
import { ElementPlusKitAutoImportResolver } from '@iswangh/element-plus-kit/resolver'
|
|
238
|
+
import AutoImport from 'unplugin-auto-import/vite'
|
|
239
|
+
|
|
240
|
+
AutoImport({
|
|
241
|
+
resolvers: [
|
|
242
|
+
ElementPlusKitAutoImportResolver(),
|
|
243
|
+
],
|
|
244
|
+
})
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
## 📖 API 文档
|
|
248
|
+
|
|
249
|
+
### 全局安装函数
|
|
250
|
+
|
|
251
|
+
```typescript
|
|
252
|
+
import ElementPlusKit from '@iswangh/element-plus-kit'
|
|
253
|
+
|
|
254
|
+
app.use(ElementPlusKit)
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
### 组件导出
|
|
258
|
+
|
|
259
|
+
```typescript
|
|
260
|
+
import { WForm } from '@iswangh/element-plus-kit'
|
|
261
|
+
```
|
|
262
|
+
|
|
263
|
+
### 类型导出
|
|
264
|
+
|
|
265
|
+
```typescript
|
|
266
|
+
import type {
|
|
267
|
+
ActionConfig,
|
|
268
|
+
ActionConfigButtonItem,
|
|
269
|
+
Arrayable,
|
|
270
|
+
ColAttrs,
|
|
271
|
+
ElFormAttrs,
|
|
272
|
+
EventExtendedParams,
|
|
273
|
+
FormItem,
|
|
274
|
+
FormItems,
|
|
275
|
+
FormItemSlotScope,
|
|
276
|
+
RowAttrs,
|
|
277
|
+
} from '@iswangh/element-plus-kit'
|
|
278
|
+
```
|
|
279
|
+
|
|
280
|
+
## 💡 使用示例
|
|
281
|
+
|
|
282
|
+
### 基础表单
|
|
283
|
+
|
|
284
|
+
```vue
|
|
285
|
+
<script setup lang="ts">
|
|
286
|
+
import { WForm } from '@iswangh/element-plus-kit'
|
|
287
|
+
import type { FormItems } from '@iswangh/element-plus-kit-form'
|
|
288
|
+
|
|
289
|
+
const formItems: FormItems = [
|
|
290
|
+
{
|
|
291
|
+
prop: 'username',
|
|
292
|
+
label: '用户名',
|
|
293
|
+
comp: 'input',
|
|
294
|
+
rules: [
|
|
295
|
+
{ required: true, message: '请输入用户名', trigger: 'blur' },
|
|
296
|
+
],
|
|
297
|
+
},
|
|
298
|
+
{
|
|
299
|
+
prop: 'email',
|
|
300
|
+
label: '邮箱',
|
|
301
|
+
comp: 'input',
|
|
302
|
+
compAttrs: {
|
|
303
|
+
type: 'email',
|
|
304
|
+
},
|
|
305
|
+
rules: [
|
|
306
|
+
{ required: true, message: '请输入邮箱', trigger: 'blur' },
|
|
307
|
+
{ type: 'email', message: '请输入正确的邮箱格式', trigger: 'blur' },
|
|
308
|
+
],
|
|
309
|
+
},
|
|
310
|
+
]
|
|
311
|
+
|
|
312
|
+
const form = ref({
|
|
313
|
+
username: '',
|
|
314
|
+
email: '',
|
|
315
|
+
})
|
|
316
|
+
</script>
|
|
317
|
+
|
|
318
|
+
<template>
|
|
319
|
+
<WForm :model="form" :form-items="formItems" />
|
|
320
|
+
</template>
|
|
321
|
+
```
|
|
322
|
+
|
|
323
|
+
### 带操作按钮的表单
|
|
324
|
+
|
|
325
|
+
```vue
|
|
326
|
+
<script setup lang="ts">
|
|
327
|
+
import { WForm } from '@iswangh/element-plus-kit'
|
|
328
|
+
import type { FormItems, ActionConfig } from '@iswangh/element-plus-kit-form'
|
|
329
|
+
|
|
330
|
+
const formItems: FormItems = [
|
|
331
|
+
{
|
|
332
|
+
prop: 'keyword',
|
|
333
|
+
label: '关键词',
|
|
334
|
+
comp: 'input',
|
|
335
|
+
},
|
|
336
|
+
]
|
|
337
|
+
|
|
338
|
+
const actionConfig: ActionConfig = {
|
|
339
|
+
buttons: ['search', 'reset'],
|
|
340
|
+
}
|
|
341
|
+
|
|
342
|
+
const form = ref({
|
|
343
|
+
keyword: '',
|
|
344
|
+
})
|
|
345
|
+
</script>
|
|
346
|
+
|
|
347
|
+
<template>
|
|
348
|
+
<WForm
|
|
349
|
+
:model="form"
|
|
350
|
+
:form-items="formItems"
|
|
351
|
+
:action-config="actionConfig"
|
|
352
|
+
@search="handleSearch"
|
|
353
|
+
@reset="handleReset"
|
|
354
|
+
/>
|
|
355
|
+
</template>
|
|
356
|
+
```
|
|
357
|
+
|
|
358
|
+
## 🔗 相关链接
|
|
359
|
+
|
|
360
|
+
- [Form 组件文档](../form/README.md)
|
|
361
|
+
- [核心工具包文档](../core/README.md)
|
|
362
|
+
- [Element Plus 文档](https://element-plus.org/zh-CN/)
|
|
363
|
+
- [GitHub 仓库](https://github.com/iswangh/element-plus-kit)
|
|
364
|
+
|
|
365
|
+
## 📄 许可证
|
|
366
|
+
|
|
367
|
+
本项目采用 [Apache License 2.0](../../LICENSE) 开源协议。
|
|
368
|
+
|
|
369
|
+
更多信息请查看项目根目录的 [LICENSE](../../LICENSE) 文件。
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import { ActionConfig } from '@iswangh/element-plus-kit-form';
|
|
2
|
+
import { ActionConfigButtonItem } from '@iswangh/element-plus-kit-form';
|
|
3
|
+
import { App } from 'vue';
|
|
4
|
+
import { Arrayable } from '@iswangh/element-plus-kit-form';
|
|
5
|
+
import { ColAttrs } from '@iswangh/element-plus-kit-form';
|
|
6
|
+
import { ComponentResolver } from 'unplugin-vue-components/types';
|
|
7
|
+
import { ElFormAttrs } from '@iswangh/element-plus-kit-form';
|
|
8
|
+
import { EventExtendedParams } from '@iswangh/element-plus-kit-form';
|
|
9
|
+
import { FormItem } from '@iswangh/element-plus-kit-form';
|
|
10
|
+
import { FormItemComp } from '@iswangh/element-plus-kit-form';
|
|
11
|
+
import { FormItemCompAttrs } from '@iswangh/element-plus-kit-form';
|
|
12
|
+
import { FormItems } from '@iswangh/element-plus-kit-form';
|
|
13
|
+
import { FormItemSlotScope } from '@iswangh/element-plus-kit-form';
|
|
14
|
+
import { ResolverFunction } from 'unplugin-auto-import/types';
|
|
15
|
+
import { RowAttrs } from '@iswangh/element-plus-kit-form';
|
|
16
|
+
import { WForm } from '@iswangh/element-plus-kit-form';
|
|
17
|
+
|
|
18
|
+
export { ActionConfig }
|
|
19
|
+
|
|
20
|
+
export { ActionConfigButtonItem }
|
|
21
|
+
|
|
22
|
+
export { Arrayable }
|
|
23
|
+
|
|
24
|
+
export { ColAttrs }
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* 默认导出安装函数
|
|
28
|
+
*/
|
|
29
|
+
declare const _default: {
|
|
30
|
+
install: typeof install;
|
|
31
|
+
};
|
|
32
|
+
export default _default;
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* Element Plus Kit Resolver
|
|
36
|
+
*
|
|
37
|
+
* 统一解析器,同时支持 unplugin-vue-components 和 unplugin-auto-import
|
|
38
|
+
*
|
|
39
|
+
* @example
|
|
40
|
+
* ```typescript
|
|
41
|
+
* import Components from 'unplugin-vue-components/vite'
|
|
42
|
+
* import AutoImport from 'unplugin-auto-import/vite'
|
|
43
|
+
* import { ElementPlusKitResolver } from '@iswangh/element-plus-kit/resolver'
|
|
44
|
+
*
|
|
45
|
+
* Components({
|
|
46
|
+
* resolvers: [
|
|
47
|
+
* ElementPlusResolver(),
|
|
48
|
+
* ElementPlusKitResolver(),
|
|
49
|
+
* ],
|
|
50
|
+
* })
|
|
51
|
+
*
|
|
52
|
+
* AutoImport({
|
|
53
|
+
* resolvers: [
|
|
54
|
+
* ElementPlusResolver(),
|
|
55
|
+
* ElementPlusKitResolver(),
|
|
56
|
+
* ],
|
|
57
|
+
* })
|
|
58
|
+
* ```
|
|
59
|
+
*/
|
|
60
|
+
export declare function ElementPlusKitResolver(): ComponentResolver & ResolverFunction;
|
|
61
|
+
|
|
62
|
+
export { ElFormAttrs }
|
|
63
|
+
|
|
64
|
+
export { EventExtendedParams }
|
|
65
|
+
|
|
66
|
+
export { FormItem }
|
|
67
|
+
|
|
68
|
+
export { FormItemComp }
|
|
69
|
+
|
|
70
|
+
export { FormItemCompAttrs }
|
|
71
|
+
|
|
72
|
+
export { FormItems }
|
|
73
|
+
|
|
74
|
+
export { FormItemSlotScope }
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* Element Plus Kit 全局安装函数
|
|
78
|
+
*
|
|
79
|
+
* @param app - Vue 应用实例
|
|
80
|
+
*/
|
|
81
|
+
export declare function install(app: App): void;
|
|
82
|
+
|
|
83
|
+
export { RowAttrs }
|
|
84
|
+
|
|
85
|
+
export { WForm }
|
|
86
|
+
|
|
87
|
+
export { }
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { WForm as t } from "@iswangh/element-plus-kit-form";
|
|
2
|
+
import { WForm as s } from "@iswangh/element-plus-kit-form";
|
|
3
|
+
import { ElementPlusKitResolver as i } from "./resolver.js";
|
|
4
|
+
function r(o) {
|
|
5
|
+
o.component("WForm", t);
|
|
6
|
+
}
|
|
7
|
+
const m = {
|
|
8
|
+
install: r
|
|
9
|
+
};
|
|
10
|
+
export {
|
|
11
|
+
i as ElementPlusKitResolver,
|
|
12
|
+
s as WForm,
|
|
13
|
+
m as default,
|
|
14
|
+
r as install
|
|
15
|
+
};
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { ComponentResolver } from 'unplugin-vue-components/types';
|
|
2
|
+
import { ResolverFunction } from 'unplugin-auto-import/types';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Element Plus Kit Resolver
|
|
6
|
+
*
|
|
7
|
+
* 统一解析器,同时支持 unplugin-vue-components 和 unplugin-auto-import
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```typescript
|
|
11
|
+
* import Components from 'unplugin-vue-components/vite'
|
|
12
|
+
* import AutoImport from 'unplugin-auto-import/vite'
|
|
13
|
+
* import { ElementPlusKitResolver } from '@iswangh/element-plus-kit/resolver'
|
|
14
|
+
*
|
|
15
|
+
* Components({
|
|
16
|
+
* resolvers: [
|
|
17
|
+
* ElementPlusResolver(),
|
|
18
|
+
* ElementPlusKitResolver(),
|
|
19
|
+
* ],
|
|
20
|
+
* })
|
|
21
|
+
*
|
|
22
|
+
* AutoImport({
|
|
23
|
+
* resolvers: [
|
|
24
|
+
* ElementPlusResolver(),
|
|
25
|
+
* ElementPlusKitResolver(),
|
|
26
|
+
* ],
|
|
27
|
+
* })
|
|
28
|
+
* ```
|
|
29
|
+
*/
|
|
30
|
+
export declare function ElementPlusKitResolver(): ComponentResolver & ResolverFunction;
|
|
31
|
+
|
|
32
|
+
export { }
|
package/dist/resolver.js
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
const s = {
|
|
2
|
+
form: "element-plus-kit-form"
|
|
3
|
+
// 未来扩展
|
|
4
|
+
// table: 'element-plus-kit-table',
|
|
5
|
+
};
|
|
6
|
+
function r(t) {
|
|
7
|
+
if (!t.startsWith("W"))
|
|
8
|
+
return;
|
|
9
|
+
const n = t.slice(1).toLowerCase();
|
|
10
|
+
return s[n];
|
|
11
|
+
}
|
|
12
|
+
function c() {
|
|
13
|
+
return Object.assign({
|
|
14
|
+
type: "component",
|
|
15
|
+
resolve: (o) => {
|
|
16
|
+
const e = r(o);
|
|
17
|
+
if (e)
|
|
18
|
+
return {
|
|
19
|
+
name: o,
|
|
20
|
+
from: `@iswangh/${e}`,
|
|
21
|
+
sideEffects: `@iswangh/${e}/style.css`
|
|
22
|
+
};
|
|
23
|
+
}
|
|
24
|
+
}, (o) => {
|
|
25
|
+
const e = r(o);
|
|
26
|
+
if (e)
|
|
27
|
+
return `@iswangh/${e}`;
|
|
28
|
+
});
|
|
29
|
+
}
|
|
30
|
+
export {
|
|
31
|
+
c as ElementPlusKitResolver
|
|
32
|
+
};
|
package/package.json
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@iswangh/element-plus-kit",
|
|
3
|
+
"type": "module",
|
|
4
|
+
"version": "0.1.0",
|
|
5
|
+
"description": "Element Plus Kit - A collection of Vue 3 components based on Element Plus",
|
|
6
|
+
"author": "iswangh",
|
|
7
|
+
"license": "Apache-2.0",
|
|
8
|
+
"repository": {
|
|
9
|
+
"type": "git",
|
|
10
|
+
"url": "https://github.com/iswangh/element-plus-kit.git"
|
|
11
|
+
},
|
|
12
|
+
"keywords": [
|
|
13
|
+
"vue",
|
|
14
|
+
"vue3",
|
|
15
|
+
"element-plus",
|
|
16
|
+
"components",
|
|
17
|
+
"form",
|
|
18
|
+
"ui"
|
|
19
|
+
],
|
|
20
|
+
"exports": {
|
|
21
|
+
".": {
|
|
22
|
+
"types": "./dist/index.d.ts",
|
|
23
|
+
"import": "./dist/index.js"
|
|
24
|
+
},
|
|
25
|
+
"./resolver": {
|
|
26
|
+
"types": "./dist/resolver.d.ts",
|
|
27
|
+
"import": "./dist/resolver.js"
|
|
28
|
+
}
|
|
29
|
+
},
|
|
30
|
+
"main": "./dist/index.js",
|
|
31
|
+
"module": "./dist/index.js",
|
|
32
|
+
"types": "./dist/index.d.ts",
|
|
33
|
+
"files": [
|
|
34
|
+
"README.md",
|
|
35
|
+
"dist"
|
|
36
|
+
],
|
|
37
|
+
"peerDependencies": {
|
|
38
|
+
"element-plus": "^2.11.7",
|
|
39
|
+
"vue": "^3.5.23"
|
|
40
|
+
},
|
|
41
|
+
"dependencies": {
|
|
42
|
+
"@iswangh/element-plus-kit-form": "0.1.0"
|
|
43
|
+
},
|
|
44
|
+
"devDependencies": {
|
|
45
|
+
"@vitejs/plugin-vue": "^6.0.1",
|
|
46
|
+
"typescript": "^5.9.2",
|
|
47
|
+
"unplugin-auto-import": "^20.1.0",
|
|
48
|
+
"unplugin-vue-components": "^30.0.0",
|
|
49
|
+
"vite": "^7.1.5",
|
|
50
|
+
"vite-plugin-dts": "^4.5.4",
|
|
51
|
+
"vue": "^3.5.23",
|
|
52
|
+
"vue-tsc": "^3.0.7"
|
|
53
|
+
},
|
|
54
|
+
"publishConfig": {
|
|
55
|
+
"access": "public"
|
|
56
|
+
},
|
|
57
|
+
"scripts": {
|
|
58
|
+
"build": "vite build",
|
|
59
|
+
"dev": "vite build --watch",
|
|
60
|
+
"type-check": "vue-tsc --noEmit",
|
|
61
|
+
"clean": "node -e \"require('fs').rmSync('dist', {recursive: true, force: true})\""
|
|
62
|
+
}
|
|
63
|
+
}
|