@jnrs/vue-core 1.2.9 → 1.2.11

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 CHANGED
@@ -19,9 +19,9 @@ pnpm add @jnrs/vue-core
19
19
 
20
20
  ## 🔍 使用示例
21
21
  ```typescript
22
- import type { User, DictItem } from '@jnrs/vue-core'
22
+ import type { IPageData } from '@jnrs/vue-core'
23
23
  import { useRouter, useRoute } from '@jnrs/vue-core/router'
24
- import { useAuthStore } from '@jnrs/vue-core/pinia'
24
+ import { useSystemStore } from '@jnrs/vue-core/pinia'
25
25
  ```
26
26
 
27
27
  ## 📋 API
@@ -41,7 +41,7 @@ import { useAuthStore } from '@jnrs/vue-core/pinia'
41
41
  可选值:'default' | 'primary' | 'success' | 'info' | 'warning' | 'text' | 'danger'
42
42
  ```
43
43
 
44
- - MenuItem 菜单项
44
+ - IMenuItem 菜单项
45
45
 
46
46
  | 属性名 | 描述 | 类型 |
47
47
  |--------|------|------|
@@ -50,7 +50,7 @@ import { useAuthStore } from '@jnrs/vue-core/pinia'
50
50
  | name | 名称(可选) | `string` |
51
51
  | component | 组件路径(可选) | `string` |
52
52
  | redirect | 重定向路径(可选) | `string` |
53
- | children | 子菜单项(可选) | `MenuItem[]` |
53
+ | children | 子菜单项(可选) | `IMenuItem[]` |
54
54
 
55
55
  - Attachment(文件信息)
56
56
 
@@ -70,7 +70,7 @@ import { useAuthStore } from '@jnrs/vue-core/pinia'
70
70
  | pageNo | 当前页码 | `number` |
71
71
  | pageSize | 每页大小 | `number` |
72
72
 
73
- - PageTableDataT(分页列表数据)继承自 Pagination
73
+ - IPageData<T>(分页列表数据)继承自 IPagination
74
74
 
75
75
  | 属性名 | 描述 | 类型 |
76
76
  |--------|------|------|
@@ -78,18 +78,6 @@ import { useAuthStore } from '@jnrs/vue-core/pinia'
78
78
  | count | 数据总数 | `number` |
79
79
 
80
80
 
81
- #### @jnrs/vue-core/request 模块
82
- 函数
83
- ``` typescript
84
- /**
85
- * axios 请求方法(泛型拓展)
86
- * @param options 请求配置项
87
- * @returns Promise<T> 响应数据
88
- */
89
- axiosRequest: <T = BusinessResponse<unknown>>(options: BusinessRequest) => Promise<T>
90
- ```
91
-
92
-
93
81
  #### @jnrs/vue-core/pinia 模块
94
82
  函数
95
83
  ``` typescript
@@ -104,17 +92,6 @@ axiosRequest: <T = BusinessResponse<unknown>>(options: BusinessRequest) => Promi
104
92
  */
105
93
  ```
106
94
  ``` typescript
107
- /**
108
- * useAuthStore 权限仓库
109
- * @returns hasAuthenticated 是否已登录
110
- * @returns token 登录凭证
111
- * @returns userInfo 用户信息
112
- * @returns dict 字典
113
- * @methods asyncSetAuth 设置权限信息
114
- * @methods clearAuth 清除权限信息
115
- */
116
- ```
117
- ``` typescript
118
95
  /**
119
96
  * useMenuStore 菜单仓库
120
97
  * @returns hasFetchedAsyncMenus 菜单是否已获取
@@ -141,7 +118,7 @@ axiosRequest: <T = BusinessResponse<unknown>>(options: BusinessRequest) => Promi
141
118
 
142
119
  #### @jnrs/vue-core/components 模块
143
120
  Vue 组件
144
- - JnTable.vue 表格组件
121
+ - JnTable 表格组件
145
122
 
146
123
  | 属性名 | 描述 | 类型 | 默认值 |
147
124
  |--------|------|------|--------|
@@ -154,9 +131,9 @@ Vue 组件
154
131
  | showIndexColumn | 是否显示序号列 | `boolean` | `false` |
155
132
  | showSelectionColumn | 是否显示选择列 | `boolean` | `false` |
156
133
  | showMouseSelection | 是否开启鼠标框选 | `boolean` | `false` |
157
- | pagination | 当前页码和每页大小(用于序号计算) | `Pagination` | `{ pageNo: 0, pageSize: 0 }` |
134
+ | pagination | 当前页码和每页大小(用于序号计算) | `IPagination` | `{ pageNo: 0, pageSize: 0 }` |
158
135
 
159
- - JnSelectTemplate.vue 选择组件通用模板
136
+ - JnSelectTemplate 选择组件通用模板
160
137
 
161
138
  | 属性名 | 描述 | 类型 | 默认值 |
162
139
  |--------|------|------|--------|
@@ -186,32 +163,32 @@ Vue 组件
186
163
  | initialParams | 初始查询参数 | `Record<string, unknown>` | — |
187
164
  | remoteFilterKey | 下拉框查询参数远程过滤参数的 key 值 | `string` | `'name'` |
188
165
 
189
- - JnPdfView.vue PDF 文件预览组件
166
+ - JnPdfView PDF 文件预览组件
190
167
 
191
168
  | 属性名 | 描述 | 类型 | 默认值 |
192
169
  |--------|------|------|--------|
193
- | fileList | 文件列表 | `FileItem[]` | `[]` |
170
+ | fileList | 文件列表 | `IFileItem[]` | `[]` |
194
171
  | showFileName | 是否显示文件名 | `boolean` | `true` |
195
172
  | isPdf | 是否是 pdf 文件(pdf 文件直接预览,其他文件下载) | `boolean` | `false` |
196
173
  | windowWidth | 预览窗口宽度 | `number` | `800` |
197
174
  | windowHeight | 预览窗口高度 | `number` | `600` |
198
175
 
199
- - JnPagination.vue 分页组件
176
+ - JnPagination 分页组件
200
177
 
201
178
  | 属性名 | 描述 | 类型 | 默认值 |
202
179
  |--------|------|------|--------|
203
- | modelValue | 分页模型值 | `Pagination` | `{ pageNo: 1, pageSize: 20 }` |
180
+ | modelValue | 分页模型值 | `IPagination` | `{ pageNo: 1, pageSize: 20 }` |
204
181
  | total | 总条数 | `number` | `0` |
205
182
  | size | 按钮尺寸 | `ComponentSize` | `'small'` |
206
183
  | background | 是否带背景色 | `boolean` | `true` |
207
184
  | marginTop | 上边距 | `string` | `'10px'` |
208
185
 
209
- - JnImportAndExport.vue 导入 & 导出,此组件依赖 JnFileUpload 文件上传组件
186
+ - JnImportAndExport 导入 & 导出,此组件依赖 JnFileUpload 文件上传组件
210
187
 
211
188
  | 属性名 | 描述 | 类型 | 默认值 |
212
189
  |--------|------|------|--------|
213
190
  | importTemplateApi | 下载导入模板文件的 api 函数 | `() => Promise<Blob>` | — |
214
- | importApi | 数据导入 api 函数 | `(data: FormData) => Promise<BusinessResponse>` | — |
191
+ | importApi | 数据导入 api 函数 | `(data: FormData) => Promise<IBusinessResponse>` | — |
215
192
  | importFieldName | 数据导入的字段名 | `string` | `'file'` |
216
193
  | importParams | 导入的参数 | `Record<string, unknown>` | — |
217
194
  | fileUploadConfig | 导入的文件上传配置 | `{ accept: string; limit: number }` | `{ accept: '.xls,.xlsx', limit: 1 }` |
@@ -230,17 +207,17 @@ Vue 组件
230
207
  | text | 是否为文字按钮 | `boolean` | `false` |
231
208
  | icon | 是否显示图标 | `boolean` | `true` |
232
209
 
233
- - JnImageView.vue 图片预览组件
210
+ - JnImageView 图片预览组件
234
211
 
235
212
  | 属性名 | 描述 | 类型 | 默认值 |
236
213
  |--------|------|------|--------|
237
214
  | src | 图片源地址,同原生属性一致 | `string` | `''` |
238
- | previewSrcList | 开启图片预览功能 | `FileItem[]` | `[]` |
215
+ | previewSrcList | 开启图片预览功能 | `IFileItem[]` | `[]` |
239
216
  | preview | 是否开启预览功能 | `boolean` | `false` |
240
217
  | height | 图片高度 | `string` | — |
241
218
  | maxHeight | 图片最大高度 | `string` | `'200px'` |
242
219
 
243
- - JnFileUpload.vue 通用上传 & 回显组件
220
+ - JnFileUpload 通用上传 & 回显组件
244
221
 
245
222
  | 属性名 | 描述 | 类型 | 默认值 |
246
223
  |--------|------|------|--------|
@@ -255,17 +232,17 @@ Vue 组件
255
232
  | size | Element Plus 组件的尺寸 | `'' \| 'small' \| 'default' \| 'large'` | `'small'` |
256
233
  | formRef | 父级组件的表单引用 | `FormInstance` | — |
257
234
  | validateFieldName | 父级表单中用于校验的字段名 | `string` | `''` |
258
- | downloadFileFn | 文件下载的函数 | `(data: Attachment) => void` | — |
235
+ | downloadFileFn | 文件下载的函数 | `(data: IAttachment) => void` | — |
259
236
  | autoUploadApi | 自动上传文件的 api 函数 | `(data: File) => void` | — |
260
237
 
261
- - JnDialog.vue 表格编辑组件
238
+ - JnDialog 表格编辑组件
262
239
 
263
240
  | 属性名 | 描述 | 类型 | 默认值 |
264
241
  |--------|------|------|--------|
265
242
  | title | 对话框的标题 | `string` | `''` |
266
243
  | width | 对话框的宽度 | `string \| number` | `'50%'` |
267
244
 
268
- - JnDatetime.vue 显示时间格式化,第一行是日期,第二行是时间
245
+ - JnDatetime 显示时间格式化,第一行是日期,第二行是时间
269
246
 
270
247
  | 属性名 | 描述 | 类型 | 默认值 |
271
248
  |--------|------|------|--------|
@@ -1,4 +1,4 @@
1
- interface Props {
1
+ export interface Props {
2
2
  value: string;
3
3
  color?: string;
4
4
  }
@@ -1,4 +1,4 @@
1
- interface Props {
1
+ export interface Props {
2
2
  /**
3
3
  * 对话框的宽度,默认值为 50%
4
4
  */