general-basic-form 2.2.5 → 2.3.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/README.md CHANGED
@@ -1,707 +1,772 @@
1
- <!-- @format -->
2
-
3
- # GeneralBasicForm
4
-
5
- ## 一个兼容 Vue2 、Vue3 和 React(未来实现) 的表单组件,支持 typescript,vue2 请使用@1 版本,Vue3 请使用@2 版本,React19 请使用@3 版本。
6
-
7
- | 组件\兼容性 | vue2 | vue3 | Ant Design Vue(next) | Element Plus | Element(ui) | React19 | shadcn/ui |
8
- | ------------------------- | ---- | ---- | ---------------------- | ------------ | ------------- | ------- | --------- |
9
- | VGeneralBasicForm | √ | √ | | √ | √ | | |
10
- | VSearchBox | √ | | | | √ | | |
11
- | VInfiniteScrollList | | √ | | √ | | | |
12
- | VDescriptions | √ | √ | √ | √ | √ | | |
13
- | VInputMobilecVerification | | √ | √ | √ | | | |
14
- | VInputGraphicVerification | | √ | √ | √ | | | |
15
- | VTreeTransfer | √ | √ | | √ | √ | | |
16
- | VTabs | √ | | | | √ | | |
17
- | RGeneralBasicForm | | | | | | √ | √ |
18
- | RFormList | | | | | | √ | √ |
19
- | RTabs | | | | | | √ | √ |
20
-
21
- 安装:npm i general-basic-form<br/>
22
- install: npm i general-basic-form
23
-
24
- webpack4 兼容:
25
- 加入配置:module.exports = {
26
- transpileDependencies: ['general-basic-form'],
27
- }
28
-
29
- 示例:
30
-
31
- 因为兼容性问题,目前只能使用完整引入
32
-
33
- ```
34
- import { RGeneralBasicForm,RBasicForm } from 'general-basic-form';
35
- ```
36
-
37
- ```
38
- <RGeneralBasicForm
39
- formItem={formItem}
40
- getList={getList}
41
- parametersType="data"
42
- noInputBlank
43
- formData={detail}
44
- fieldGroupSetting={{ className: 'grid grid-cols-4 gap-4' }}
45
- > </RGeneralBasicForm>
46
-
47
- <RBasicForm
48
- formItem={formItem}
49
- getList={getList}
50
- parametersType="data"
51
- noInputBlank
52
- formData={detail}
53
- fieldGroupSetting={{ className: 'grid grid-cols-4 gap-4' }}
54
- footFieldSetting={{ className: 'col-start-1 col-span-4 col-end-3 mb-8' }}
55
- fieldLabelSetting={{ className: "text-lg" }}
56
- coms={{
57
- Input,
58
- Button,
59
- Select,
60
- SelectContent,
61
- SelectItem,
62
- SelectTrigger,
63
- SelectValue,
64
- SelectGroup,
65
- }} >
66
- </RBasicForm>
67
- ```
68
-
69
- ![image-20210903165502942](https://raw.githubusercontent.com/Alan1034/PicturesServer/main/PicGo_imgs/202109031655830.png)
70
-
71
- 在单纯作为表单的时候可以这样使用:
72
-
73
- const RGeneralBasicFormRef = useRef(null);
74
-
75
- <RGeneralBasicForm
76
- formOnly
77
- ref={RGeneralBasicFormRef}
78
- className="py-4"
79
- formItem={formItem}
80
- getList={getList}
81
- parametersType="data"
82
- noInputBlank
83
- formData={formData}
84
- fieldGroupSetting={{ className: 'grid grid-cols-2 gap-4' }}
85
- >
86
- //自定义组件
87
- </RGeneralBasicForm>
88
-
89
- getList 会传出默认的参数,首次请求时会有页数和分页大小,重置后会传出默认页数 1
90
-
91
- async getList(
92
- params = {
93
- page: Number(this.$route.query.page) || 1,
94
- limit: Number(this.$route.query.limit) || 10,
95
- }
96
- ) {}
97
-
98
- 表单数据校验需要拿到内部表单的 ref
99
-
100
- RGeneralBasicFormRef.current.formAction(); // 触发表单校验和getList
101
-
102
- ![image-20211014191532067](https://raw.githubusercontent.com/Alan1034/PicturesServer/main/PicGo_imgs/202110141915657.png)
103
-
104
- parametersType 类型介绍
105
-
106
- | parametersType 形式 | 支持页面刷新 | 参数改变引起路由跳转 | 组件间共享数据 | 存储上限 | 浏览器兼容性 |
107
- | ------------------- | ------------ | -------------------- | -------------- | -------- | ------------ |
108
- | url | | | | | |
109
- | data | | | | | 高 |
110
- | indexDB | | 否 | | 高 | |
111
-
112
- 数据示例:
113
-
114
- formOnly:true // 只展示表单不展示按钮
115
- getList(queryParams); // 请求数据的函数
116
- afterReset(queryParams); // 在重置按钮点击完后但还没重新请求时触发的的函数
117
- formOnly:true // 只展示表单不展示按钮
118
- parametersType:"url" // 见parametersType类型介绍
119
- DBPrimaryKey: user_id // indexDB主键,配合indexDB使用
120
- loading:false // 加载动画
121
- formData:{} // 表单数据不完整
122
- noInputBlank: true //校验input框不能仅输入空格
123
- //例子:formData.value.x=y | formData.value={...formData.value,x:y} ✔
124
- currentPageKey:"page", //当前页数key
125
- pageSizeKey:"limit", //每页显示个数key
126
- defCurrentPage:1, //默认的页数
127
- defPageSize:10, //默认的每页显示个数
128
- queryWhenReady:false,//初始化完成后自动触发查找数据函数
129
- footFieldSetting: {} // 表单底部按钮设置
130
- fieldGroupSetting: {} // 表单分组设置
131
- fieldLabelSetting: {} // 表单字段label设置
132
- onFormChange(queryParams):表单数据变化时触发的函数
133
- formItem: [
134
-
135
- {
136
- label: "普通输入框",
137
- prop: "bsName",
138
- type: "input",
139
- legend: '这是一个可选的标题',
140
- setting: {
141
- placeholder: '请输入手机验证码',
142
- // style: 'width: 100%',
143
- required: true,
144
- // type: 'number',
145
- // min: 1,
146
- // max: 100,
147
- },
148
- fieldSetting: {
149
- className: fieldClassName,
150
- },
151
- rules: [
152
- {
153
- message: "请输入信息",
154
- required: true,
155
- },
156
- {
157
- pattern: /^\w+[\,\,\-\w' '#]+$/,
158
- message: "请输入正确的Invoice单号"
159
- },
160
- {
161
- validator: (rule, value, callback) => {
162
- callback();
163
- },
164
- },
165
- ],
166
- separator: true, //分割线
167
- },
168
- {
169
- label: "文本区域",
170
- prop: "Textarea",
171
- type: "textarea",
172
- setting: {
173
- placeholder: '请输入文本区域',
174
- },
175
- fieldSetting: {
176
- className: fieldClassName,
177
- }
178
- },
179
- {
180
- label: "复杂输入框",
181
- prop: "input-group",
182
- type: "input-group",
183
- setting: {
184
- placeholder: '请输入手机验证码',
185
- // style: 'width: 100%',
186
- addons: [
187
- {
188
- text: '前缀,一般和type: input 配合使用',
189
- align: "inline-start",
190
- render: (props) => {
191
- return (
192
- <div className="flex items-center">
193
- <span>{props}</span>
194
- </div>
195
- );
196
- },
197
- },
198
- {
199
- text: '后缀,一般和type: input 配合使用',
200
- align: "inline-end"
201
- },
202
- // {
203
- // text: '底部盒子,一般和type: 'textarea'配合使用',
204
- // align: "block-end"
205
- // },
206
- ],
207
- // type: 'textarea',//input|textarea
208
- },
209
- fieldSetting: {
210
- className: fieldClassName,
211
- },
212
- },
213
- {
214
- label: '',
215
- prop: 'description',
216
- type: 'description',
217
- fieldSetting: {
218
- className: fieldClassName,
219
- },
220
- description: [
221
- 'AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
222
- '段落2',
223
- 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
224
- ],
225
- },
226
- {
227
- label: '多维数组',
228
- prop: 'prices',
229
- type: 'form-list',
230
- description: [
231
- '段落1',
232
- '段落2',
233
- ],
234
- separator: "text", //文字分割线
235
- setting: {
236
- heading: true, //是否显示标题
237
- dim: 5, // 多维数组,注意要和columns的长度相等,输出为对象数组
238
- itemWidth: 'mean',//itemWidth: 'auto' | 'mean' 自动宽度(满行) | 平均分配宽度
239
- onChange: (value) => {
240
- console.log(value);
241
- setDetail({ ...detail, prices: value })
242
- },
243
- columns: [
244
- {
245
- prop: 'id',
246
- label: '套餐ID',
247
- type: 'input',
248
- setting: {
249
- placeholder: '请输入套餐ID',
250
- disabled: true,
251
- className: 'hidden',
252
- },
253
- },
254
- {
255
- prop: 'days',
256
- label: '套餐名称',
257
- type: 'input',
258
- setting: {
259
- required: true,
260
- placeholder: '请输入套餐名称',
261
- type: 'number'
262
- },
263
- },
264
- {
265
- prop: 'serviceType',
266
- label: '服务类型',
267
- type: 'select',
268
- option: [
269
- { label: '到家服务', value: 'home_service' },
270
- { label: '医院陪护', value: 'hospital_care' },
271
- ],
272
- setting: {
273
- placeholder: '请选择服务类型',
274
- required: true,
275
- className: 'w-full',
276
- },
277
- },
278
- {
279
- label: '组合分类',
280
- prop: 'expense_category_id',
281
- type: 'combobox',
282
- setting: {
283
- placeholder: '请输入分类',
284
- },
285
- options: [
286
- {
287
- label: '指南',
288
- value: '指南',
289
- separator: true, //分割线
290
- children: [
291
- {
292
- value: 'shejiyuanze',
293
- label: '设计原则',
294
- shortcut: 'ctrl+z', //选项右侧的内容
295
- },
296
- ],
297
- },
298
- {
299
- label: '资源',
300
- value: 'resource',
301
- children: [
302
- {
303
- value: 'axure',
304
- label: 'Axure Components',
305
- },
306
- ],
307
- },
308
- ],
309
- },
310
- {
311
- label: '组合分类-多选',
312
- prop: 'expense_multiple_checkbox_test',
313
- type: 'combobox',
314
- setting: {
315
- placeholder: '请选择等级',
316
- type: 'checkbox-list',
317
- },
318
- option: [
319
- { label: 'Yysyayayasuydsaiewqnkerwjrklwjlwerjwlejrlj3', value: 'Y3' },
320
- { label: 'Yysyayayasuydsaiewqnkerwjrklwjlwerjwlejrlj4', value: 'Y4' },
321
-
322
- ],
323
- },
324
- ],
325
- },
326
- fieldSetting: {
327
- className: fieldClassName,
328
- },
329
- rules: [
330
- {
331
- validator: (rule, value, callback) => {
332
- console.log(value);
333
- for (let i = 0; i < value.length; i++) {
334
- const element = value[i];
335
- if (!Number(element.days)) {
336
- callback(new Error('请输入数字'));
337
- return;
338
- }
339
- }
340
- callback();
341
- },
342
- },
343
- ],
344
- removeItemAction: (item, index) => {
345
- // 删除项会触发此函数
346
- console.log(item, index);
347
- },
348
- },
349
- {
350
- label: '1维数组',
351
- prop: 'nursingCare',
352
- type: 'form-list',
353
- setting: {
354
- placeholder: ['请输入服务内容'],
355
- required: true,
356
- dim: 1, // 1维数组,输出为字符串数组
357
- },
358
- fieldSetting: {
359
- className: fieldClassName,
360
- },
361
- rules: [
362
- {
363
- validator: (rule, value, callback) => {
364
- for (let i = 0; i < value.length; i++) {
365
- const element = value[i];
366
- if (!element) {
367
- callback(new Error('请输入服务内容'));
368
- return;
369
- }
370
- }
371
- callback();
372
- },
373
- },
374
- ],
375
- },
376
- {
377
- prop: 'level1',
378
- label: '选择框',
379
- type: 'select',
380
- option: [
381
- { label: 'Y3', value: 'Y3' },
382
- { label: 'Y4', value: 'Y4' },
383
- { label: 'Y5', value: 'Y5' },
384
- ],
385
- setting: {
386
- placeholder: '请选择等级',
387
- required: true,
388
- },
389
- fieldSetting: {
390
- className: fieldClassName,
391
- },
392
- },
393
- {
394
- label: "开关",
395
- prop: "switch_test",
396
- type: "switch",
397
- setting: {
398
- },
399
- fieldSetting: {
400
- className: 'col-start-2 col-span-2 mb-8',
401
- },
402
- },
403
- // {
404
- // label: "创建时间",
405
- // prop: "create_time",
406
- // type: "date-picker",
407
- // setting: {
408
- // "range-separator": "至",
409
- // },
410
- // fieldSetting: {
411
- // className: fieldClassName,
412
- // },
413
- // },
414
-
415
- // {
416
- // label: '是否必填',
417
- // prop: 'is_optional',
418
- // type: 'radio',
419
- // setting: {
420
- // disabled: true
421
- // },
422
- // option: [
423
- // { value: '是', label: 'true', border: true },
424
- // { value: '', label: 'false' }
425
- // ],
426
- // fieldSetting: {
427
- // className: fieldClassName,
428
- // },
429
- // rules: [
430
- // {
431
- // required: true,
432
- // message: '请输入标签项名称',
433
- // trigger: 'blur'
434
- // }
435
- // ]
436
- // },
437
- {
438
- prop: 'level',
439
- label: '多选列表',
440
- legend: '标题',
441
- type: 'checkbox-list',
442
- gap: 3,
443
- option: [
444
- { label: 'Y3', value: 'Y3' },
445
- { label: 'Y4', value: 'Y4' },
446
- { label: 'Y5', value: 'Y5' },
447
- ],
448
- fieldSetting: {
449
- className: 'col-start-2 col-span-2 mb-8',
450
- },
451
- setting: {
452
- placeholder: '请选择等级',
453
- },
454
- },
455
- {
456
- prop: 'test1',
457
- label: '选择框',
458
- type: 'checkbox',
459
- fieldSetting: {
460
- className: 'col-start-4 col-span-2 mb-8',
461
- },
462
- setting: {
463
- placeholder: '请选择套餐',
464
- },
465
- },
466
- // enum ComTypes {
467
- // "command" = "command",
468
- // "rc-tree" = "rc-tree",
469
- // "ant-tree" = "ant-tree",
470
- // "checkbox-list" = "checkbox-list",
471
- // }
472
- {
473
- label: "分类",
474
- prop: "分类",
475
- type: "command",
476
- setting: {
477
- placeholder: "请输入分类",
478
- empty: "搜索内容为空的提示",
479
- },
480
- fieldSetting: {
481
- className: fieldClassName,
482
- },
483
- options: [
484
- {
485
- label: "指南",
486
- value: "guide",
487
- separator: true, //分割线
488
- children: [
489
- {
490
- value: 'shejiyuanze',
491
- label: '设计原则',
492
- onSelect: (value) => {
493
- console.log('Selected', value);
494
- },
495
- shortcut: 'ctrl+z', //选项右侧的内容
496
- },
497
-
498
- ],
499
- },
500
- {
501
- label: "资源",
502
- value: "resource",
503
- children: [
504
- {
505
- value: "axure",
506
- label: "Axure Components",
507
- }
508
- ],
509
- },
510
- ],
511
- },
512
- {
513
- label: '组合分类-多选',
514
- prop: 'expense_multiple_checkbox',
515
- type: 'combobox',
516
- setting: {
517
- placeholder: '请选择等级',
518
- type: 'checkbox-list',
519
- },
520
- fieldSetting: {
521
- className: fieldClassName,
522
- },
523
- option: [
524
- { label: 'Y3', value: 'Y3' },
525
- { label: 'Y4', value: 'Y4' },
526
- { label: 'Y5', value: 'Y5' },
527
- ],
528
- },
529
- {
530
- label: '组合分类',
531
- prop: 'expense_category_id',
532
- type: 'combobox',
533
- setting: {
534
- placeholder: '请输入分类',
535
- empty: '搜索内容为空的提示',
536
- },
537
- fieldSetting: {
538
- className: fieldClassName,
539
- },
540
- options: [
541
- {
542
- label: '指南',
543
- value: '指南',
544
- separator: true, //分割线
545
- children: [
546
- {
547
- value: 'shejiyuanze',
548
- label: '设计原则',
549
- shortcut: 'ctrl+z', //选项右侧的内容
550
- },
551
- ],
552
- },
553
- {
554
- label: '资源',
555
- value: 'resource',
556
- children: [
557
- {
558
- value: 'axure',
559
- label: 'Axure Components',
560
- },
561
- ],
562
- },
563
- ],
564
- },
565
- {
566
- label: '树形选择',
567
- prop: 'select_tree',
568
- type: 'combobox',
569
- setting: {
570
- placeholder: '请输入分类',
571
- empty: '搜索内容为空的提示',
572
- type: 'ant-tree',
573
- width: `500px`,//控制组件宽度
574
- // checkable: true,
575
- // selectable: false
576
- },
577
- fieldSetting: {
578
- className: fieldClassName,
579
- },
580
- options: [
581
- {
582
- label: '指南',
583
- value: '指南',
584
- children: [
585
- {
586
- value: 'shejiyuanze',
587
- label: '设计原则',
588
- setting: {
589
- icon: () => {
590
- return <div>ID</div>
591
- }
592
- },
593
- children: [
594
- {
595
- value: 'leaf',
596
- label: '叶子节点',
597
- shortcut: 'ctrl+z', //选项右侧的内容
598
- },
599
- {
600
- value: 'leaf1',
601
- label: '叶子节点1',
602
- shortcut: 'ctrl+z', //选项右侧的内容
603
- },
604
- ],
605
- },
606
- ],
607
- },
608
- {
609
- label: '资源',
610
- value: 'resource',
611
- children: [
612
- {
613
- value: 'axure',
614
- label: 'Axure Components',
615
- },
616
- ],
617
- },
618
- ],
619
- },
620
- ]
621
-
622
- //rules为表单校验规则,每个组件都可以传入
623
-
624
- //input支持template,支持以下几个属性:
625
- //prefix 输入框头部内容,只对 type="text"(默认) 有效
626
- //suffix 输入框尾部内容,只对 type="text" 有效
627
- //prepend 输入框前置内容,只对 type="text" 有效
628
- //append 输入框后置内容,只对 type="text" 有效
629
-
630
- //divider支持template:
631
- //default
632
-
633
- 支持组件 type:
634
-
635
- export enum FormType {
636
- /**
637
- * @description: 输入框
638
- * @return {*}
639
- */
640
- "input" = "input",
641
- /**
642
- * @description: 文本区域
643
- * @return {*}
644
- */
645
- "textarea" = "textarea",
646
- /**
647
- * @description: 复杂输入框,可自定义前后缀和大小
648
- * @return {*}
649
- */
650
- "input-group" = "input-group",
651
- /**
652
- * @description: 表单中的多维列表,可增减元素,内部可以使用的数据类型除自身form-list外同FormType
653
- * @return {*}
654
- */
655
- "form-list" = "form-list",
656
- /**
657
- * @description: 选择器
658
- * @return {*}
659
- */
660
- "select" = "select",
661
- /**
662
- * @description: 开关
663
- * @return {*}
664
- */
665
- "switch" = "switch",
666
- /**
667
- * @description: 带搜索的二级菜单
668
- * @return {*}
669
- */
670
- "command" = "command",
671
- /**
672
- * @description: 响应式下拉框+带搜索的二级菜单/多选
673
- * @return {*}
674
- */
675
- "combobox" = "combobox",
676
- /**
677
- * @description: 日期选择器
678
- * @return {*}
679
- */
680
- "date-picker" = "date-picker",
681
-
682
- /**
683
- * @description: 单选框
684
- * @return {*}
685
- */
686
- "radio" = "radio",
687
- // /**
688
- // * @description: 自定义元素,插槽组件
689
- // * @return {*}
690
- // */
691
- // "form-item-slot" = "form-item-slot",
692
- /**
693
- * @description: 多选框
694
- * @return {*}
695
- */
696
- "checkbox" = "checkbox",
697
- /**
698
- * @description: 多选框列表,输入输出都是字符串列表 ["value1", "value2", "value3"]
699
- * @return {*}
700
- */
701
- "checkbox-list" = "checkbox-list",
702
- /**
703
- * @description: FieldDescription 描述
704
- * @return {*}
705
- */
706
- "description" = "description",
707
- }
1
+ <!-- @format -->
2
+
3
+ # GeneralBasicForm
4
+
5
+ ## 一个兼容 Vue2 、Vue3 和 React(未来实现) 的表单组件,支持 typescript,vue2 请使用@1 版本,Vue3 请使用@2 版本,React19 请使用@3 版本。
6
+
7
+ | 组件\兼容性 | vue2 | vue3 | Ant Design Vue(next) | Element Plus | Element(ui) | React19 | shadcn/ui |
8
+ | ------------------------- | ---- | ---- | ---------------------- | ------------ | ------------- | ------- | --------- |
9
+ | VGeneralBasicForm | √ | √ | | √ | √ | | |
10
+ | VSearchBox | √ | | | | √ | | |
11
+ | VInfiniteScrollList | | √ | | √ | | | |
12
+ | VDescriptions | √ | √ | √ | √ | √ | | |
13
+ | VInputMobilecVerification | | √ | √ | √ | | | |
14
+ | VInputGraphicVerification | | √ | √ | √ | | | |
15
+ | VTreeTransfer | √ | √ | | √ | √ | | |
16
+ | VTabs | √ | | | | √ | | |
17
+ | RGeneralBasicForm | | | | | | √ | √ |
18
+ | RFormList | | | | | | √ | √ |
19
+ | RBaseTabs | | | | | | √ | √ |
20
+ | RBaseCombobox | | | | | | √ | √ |
21
+
22
+ 安装:npm i general-basic-form<br/>
23
+ install: npm i general-basic-form
24
+
25
+ webpack4 兼容:
26
+ 加入配置:module.exports = {
27
+ transpileDependencies: ['general-basic-form'],
28
+ }
29
+
30
+ 示例:
31
+
32
+ 因为兼容性问题,目前只能使用完整引入
33
+
34
+ ```
35
+ import { RGeneralBasicForm,RBasicForm } from 'general-basic-form';
36
+ ```
37
+
38
+ ```
39
+ <RGeneralBasicForm
40
+ formItem={formItem}
41
+ getList={getList}
42
+ parametersType="data"
43
+ noInputBlank
44
+ formData={detail}
45
+ fieldGroupSetting={{ className: 'grid grid-cols-4 gap-4' }}
46
+ > </RGeneralBasicForm>
47
+
48
+ <RBasicForm
49
+ formItem={formItem}
50
+ getList={getList}
51
+ parametersType="data"
52
+ noInputBlank
53
+ formData={detail}
54
+ fieldGroupSetting={{ className: 'grid grid-cols-4 gap-4' }}
55
+ footFieldSetting={{ className: 'col-start-1 col-span-4 col-end-3 mb-8' }}
56
+ fieldLabelSetting={{ className: "text-lg" }}
57
+ coms={{
58
+ Input,
59
+ Button,
60
+ Select,
61
+ SelectContent,
62
+ SelectItem,
63
+ SelectTrigger,
64
+ SelectValue,
65
+ SelectGroup,
66
+ }} >
67
+ </RBasicForm>
68
+ ```
69
+
70
+ ![image-20210903165502942](https://raw.githubusercontent.com/Alan1034/PicturesServer/main/PicGo_imgs/202109031655830.png)
71
+
72
+ 在单纯作为表单的时候可以这样使用:
73
+
74
+ const RGeneralBasicFormRef = useRef(null);
75
+
76
+ <RGeneralBasicForm
77
+ formOnly
78
+ ref={RGeneralBasicFormRef}
79
+ className="py-4"
80
+ formItem={formItem}
81
+ getList={getList}
82
+ parametersType="data"
83
+ noInputBlank
84
+ formData={formData}
85
+ fieldGroupSetting={{ className: 'grid grid-cols-2 gap-4' }}
86
+ >
87
+ //自定义组件
88
+ </RGeneralBasicForm>
89
+
90
+ getList 会传出默认的参数,首次请求时会有页数和分页大小,重置后会传出默认页数 1
91
+
92
+ async getList(
93
+ params = {
94
+ page: Number(this.$route.query.page) || 1,
95
+ limit: Number(this.$route.query.limit) || 10,
96
+ }
97
+ ) {}
98
+
99
+ 表单数据校验需要拿到内部表单的 ref
100
+
101
+ RGeneralBasicFormRef.current.formAction(); // 触发表单校验和getList
102
+
103
+ ![image-20211014191532067](https://raw.githubusercontent.com/Alan1034/PicturesServer/main/PicGo_imgs/202110141915657.png)
104
+
105
+ parametersType 类型介绍
106
+
107
+ | parametersType 形式 | 支持页面刷新 | 参数改变引起路由跳转 | 组件间共享数据 | 存储上限 | 浏览器兼容性 |
108
+ | ------------------- | ------------ | -------------------- | -------------- | -------- | ------------ |
109
+ | url | | | | | 高 |
110
+ | data | | 否 | | 高 | |
111
+ | indexDB | 是 | 否 | 是 | 高 | 中 |
112
+
113
+ 数据示例:
114
+
115
+ formOnly:true // 只展示表单不展示按钮
116
+ getList(queryParams); // 请求数据的函数
117
+ afterReset(queryParams); // 在重置按钮点击完后但还没重新请求时触发的的函数
118
+ formOnly:true // 只展示表单不展示按钮
119
+ parametersType:"url" // 见parametersType类型介绍
120
+ DBPrimaryKey: user_id // indexDB主键,配合indexDB使用
121
+ loading:false // 加载动画
122
+ formData:{} // 表单数据不完整
123
+ noInputBlank: true //校验input框不能仅输入空格
124
+ //例子:formData.value.x=y ✘ | formData.value={...formData.value,x:y}
125
+ currentPageKey:"page", //当前页数key
126
+ pageSizeKey:"limit", //每页显示个数key
127
+ defCurrentPage:1, //默认的页数
128
+ defPageSize:10, //默认的每页显示个数
129
+ queryWhenReady:false,//初始化完成后自动触发查找数据函数
130
+ footFieldSetting: {} // 表单底部按钮设置
131
+ fieldGroupSetting: {} // 表单分组设置
132
+ fieldLabelSetting: {} // 表单字段label设置
133
+ onFormChange(queryParams):表单数据变化时触发的函数
134
+ formItem: [
135
+
136
+ {
137
+ label: "普通输入框",
138
+ prop: "bsName",
139
+ type: "input",
140
+ legend: '这是一个可选的标题',
141
+ setting: {
142
+ placeholder: '请输入手机验证码',
143
+ // style: 'width: 100%',
144
+ required: true,
145
+ // type: 'number',
146
+ // min: 1,
147
+ // max: 100,
148
+ },
149
+ fieldSetting: {
150
+ className: fieldClassName,
151
+ },
152
+ rules: [
153
+ {
154
+ message: "请输入信息",
155
+ required: true,
156
+ },
157
+ {
158
+ pattern: /^\w+[\,\,\-\w' '#]+$/,
159
+ message: "请输入正确的Invoice单号"
160
+ },
161
+ {
162
+ validator: (rule, value, callback) => {
163
+ callback();
164
+ },
165
+ },
166
+ ],
167
+ separator: true, //分割线
168
+ },
169
+ {
170
+ label: "文本区域",
171
+ prop: "Textarea",
172
+ type: "textarea",
173
+ setting: {
174
+ placeholder: '请输入文本区域',
175
+ },
176
+ fieldSetting: {
177
+ className: fieldClassName,
178
+ }
179
+ },
180
+ {
181
+ label: "复杂输入框",
182
+ prop: "input-group",
183
+ type: "input-group",
184
+ setting: {
185
+ placeholder: '请输入手机验证码',
186
+ // style: 'width: 100%',
187
+ addons: [
188
+ {
189
+ text: '前缀,一般和type: input 配合使用',
190
+ align: "inline-start",
191
+ render: (props) => {
192
+ return (
193
+ <div className="flex items-center">
194
+ <span>{props}</span>
195
+ </div>
196
+ );
197
+ },
198
+ },
199
+ {
200
+ text: '后缀,一般和type: input 配合使用',
201
+ align: "inline-end"
202
+ },
203
+ // {
204
+ // text: '底部盒子,一般和type: 'textarea'配合使用',
205
+ // align: "block-end"
206
+ // },
207
+ ],
208
+ // type: 'textarea',//input|textarea
209
+ },
210
+ fieldSetting: {
211
+ className: fieldClassName,
212
+ },
213
+ },
214
+ {
215
+ label: '',
216
+ prop: 'description',
217
+ type: 'description',
218
+ fieldSetting: {
219
+ className: fieldClassName,
220
+ },
221
+ description: [
222
+ 'AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
223
+ '段落2',
224
+ 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
225
+ ],
226
+ },
227
+ {
228
+ label: '多维数组',
229
+ prop: 'prices',
230
+ type: 'form-list',
231
+ description: [
232
+ '段落1',
233
+ '段落2',
234
+ ],
235
+ separator: "text", //文字分割线
236
+ setting: {
237
+ heading: true, //是否显示标题
238
+ dim: 5, // 多维数组,注意要和columns的长度相等,输出为对象数组
239
+ itemWidth: 'mean',//itemWidth: 'auto' | 'mean' 自动宽度(满行) | 平均分配宽度
240
+ onChange: (value) => {
241
+ console.log(value);
242
+ setDetail({ ...detail, prices: value })
243
+ },
244
+ columns: [
245
+ {
246
+ prop: 'id',
247
+ label: '套餐ID',
248
+ type: 'input',
249
+ setting: {
250
+ placeholder: '请输入套餐ID',
251
+ disabled: true,
252
+ className: 'hidden',
253
+ },
254
+ },
255
+ {
256
+ prop: 'days',
257
+ label: '套餐名称',
258
+ type: 'input',
259
+ setting: {
260
+ required: true,
261
+ placeholder: '请输入套餐名称',
262
+ type: 'number'
263
+ },
264
+ },
265
+ {
266
+ prop: 'serviceType',
267
+ label: '服务类型',
268
+ type: 'select',
269
+ option: [
270
+ { label: '到家服务', value: 'home_service' },
271
+ { label: '医院陪护', value: 'hospital_care' },
272
+ ],
273
+ setting: {
274
+ placeholder: '请选择服务类型',
275
+ required: true,
276
+ className: 'w-full',
277
+ },
278
+ },
279
+ {
280
+ label: '组合分类',
281
+ prop: 'expense_category_id',
282
+ type: 'combobox',
283
+ setting: {
284
+ placeholder: '请输入分类',
285
+ },
286
+ options: [
287
+ {
288
+ label: '指南',
289
+ value: '指南',
290
+ separator: true, //分割线
291
+ children: [
292
+ {
293
+ value: 'shejiyuanze',
294
+ label: '设计原则',
295
+ shortcut: 'ctrl+z', //选项右侧的内容
296
+ },
297
+ ],
298
+ },
299
+ {
300
+ label: '资源',
301
+ value: 'resource',
302
+ children: [
303
+ {
304
+ value: 'axure',
305
+ label: 'Axure Components',
306
+ },
307
+ ],
308
+ },
309
+ ],
310
+ },
311
+ {
312
+ label: '组合分类-多选',
313
+ prop: 'expense_multiple_checkbox_test',
314
+ type: 'combobox',
315
+ setting: {
316
+ placeholder: '请选择等级',
317
+ type: 'checkbox-list',
318
+ },
319
+ option: [
320
+ { label: 'Yysyayayasuydsaiewqnkerwjrklwjlwerjwlejrlj3', value: 'Y3' },
321
+ { label: 'Yysyayayasuydsaiewqnkerwjrklwjlwerjwlejrlj4', value: 'Y4' },
322
+
323
+ ],
324
+ },
325
+ ],
326
+ },
327
+ fieldSetting: {
328
+ className: fieldClassName,
329
+ },
330
+ rules: [
331
+ {
332
+ validator: (rule, value, callback) => {
333
+ console.log(value);
334
+ for (let i = 0; i < value.length; i++) {
335
+ const element = value[i];
336
+ if (!Number(element.days)) {
337
+ callback(new Error('请输入数字'));
338
+ return;
339
+ }
340
+ }
341
+ callback();
342
+ },
343
+ },
344
+ ],
345
+ removeItemAction: (item, index) => {
346
+ // 删除项会触发此函数
347
+ console.log(item, index);
348
+ },
349
+ },
350
+ {
351
+ label: '1维数组',
352
+ prop: 'nursingCare',
353
+ type: 'form-list',
354
+ setting: {
355
+ placeholder: ['请输入服务内容'],
356
+ required: true,
357
+ dim: 1, // 1维数组,输出为字符串数组
358
+ },
359
+ fieldSetting: {
360
+ className: fieldClassName,
361
+ },
362
+ rules: [
363
+ {
364
+ validator: (rule, value, callback) => {
365
+ for (let i = 0; i < value.length; i++) {
366
+ const element = value[i];
367
+ if (!element) {
368
+ callback(new Error('请输入服务内容'));
369
+ return;
370
+ }
371
+ }
372
+ callback();
373
+ },
374
+ },
375
+ ],
376
+ },
377
+ {
378
+ prop: 'level1',
379
+ label: '选择框',
380
+ type: 'select',
381
+ option: [
382
+ { label: 'Y3', value: 'Y3' },
383
+ { label: 'Y4', value: 'Y4' },
384
+ { label: 'Y5', value: 'Y5' },
385
+ ],
386
+ setting: {
387
+ placeholder: '请选择等级',
388
+ required: true,
389
+ },
390
+ fieldSetting: {
391
+ className: fieldClassName,
392
+ },
393
+ },
394
+ {
395
+ label: "开关",
396
+ prop: "switch_test",
397
+ type: "switch",
398
+ setting: {
399
+ },
400
+ fieldSetting: {
401
+ className: 'col-start-2 col-span-2 mb-8',
402
+ },
403
+ },
404
+ // {
405
+ // label: "创建时间",
406
+ // prop: "create_time",
407
+ // type: "date-picker",
408
+ // setting: {
409
+ // "range-separator": "至",
410
+ // },
411
+ // fieldSetting: {
412
+ // className: fieldClassName,
413
+ // },
414
+ // },
415
+
416
+ // {
417
+ // label: '是否必填',
418
+ // prop: 'is_optional',
419
+ // type: 'radio',
420
+ // setting: {
421
+ // disabled: true
422
+ // },
423
+ // option: [
424
+ // { value: '', label: 'true', border: true },
425
+ // { value: '否', label: 'false' }
426
+ // ],
427
+ // fieldSetting: {
428
+ // className: fieldClassName,
429
+ // },
430
+ // rules: [
431
+ // {
432
+ // required: true,
433
+ // message: '请输入标签项名称',
434
+ // trigger: 'blur'
435
+ // }
436
+ // ]
437
+ // },
438
+ {
439
+ prop: 'level',
440
+ label: '多选列表',
441
+ legend: '标题',
442
+ type: 'checkbox-list',
443
+ gap: 3,
444
+ option: [
445
+ { label: 'Y3', value: 'Y3' },
446
+ { label: 'Y4', value: 'Y4' },
447
+ { label: 'Y5', value: 'Y5' },
448
+ ],
449
+ fieldSetting: {
450
+ className: 'col-start-2 col-span-2 mb-8',
451
+ },
452
+ setting: {
453
+ placeholder: '请选择等级',
454
+ },
455
+ },
456
+ {
457
+ prop: 'test1',
458
+ label: '选择框',
459
+ type: 'checkbox',
460
+ fieldSetting: {
461
+ className: 'col-start-4 col-span-2 mb-8',
462
+ },
463
+ setting: {
464
+ placeholder: '请选择套餐',
465
+ },
466
+ },
467
+ // enum ComTypes {
468
+ // "command" = "command",
469
+ // "rc-tree" = "rc-tree",
470
+ // "ant-tree" = "ant-tree",
471
+ // "checkbox-list" = "checkbox-list",
472
+ // }
473
+
474
+ // enum ContainerTypes {
475
+ // "Popover" = "Popover",
476
+ // "Drawer" = "Drawer",
477
+ // "Dialog" = "Dialog",
478
+ // }
479
+ {
480
+ label: "分类",
481
+ prop: "分类",
482
+ type: "command",
483
+ setting: {
484
+ placeholder: "请输入分类",
485
+ empty: "搜索内容为空的提示",
486
+ },
487
+ fieldSetting: {
488
+ className: fieldClassName,
489
+ },
490
+ options: [
491
+ {
492
+ label: "指南",
493
+ value: "guide",
494
+ separator: true, //分割线
495
+ children: [
496
+ {
497
+ value: 'shejiyuanze',
498
+ label: '设计原则',
499
+ onSelect: (value) => {
500
+ console.log('Selected', value);
501
+ },
502
+ shortcut: 'ctrl+z', //选项右侧的内容
503
+ },
504
+
505
+ ],
506
+ },
507
+ {
508
+ label: "资源",
509
+ value: "resource",
510
+ children: [
511
+ {
512
+ value: "axure",
513
+ label: "Axure Components",
514
+ }
515
+ ],
516
+ },
517
+ ],
518
+ },
519
+ {
520
+ label: '组合分类-多选',
521
+ prop: 'expense_multiple_checkbox',
522
+ type: 'combobox',
523
+ setting: {
524
+ placeholder: '请选择等级',
525
+ type: 'checkbox-list',
526
+ },
527
+ fieldSetting: {
528
+ className: fieldClassName,
529
+ },
530
+ option: [
531
+ { label: 'Y3', value: 'Y3' },
532
+ { label: 'Y4', value: 'Y4' },
533
+ { label: 'Y5', value: 'Y5' },
534
+ ],
535
+ },
536
+ {
537
+ label: '组合分类',
538
+ prop: 'expense_category_id',
539
+ type: 'combobox',
540
+ setting: {
541
+ placeholder: '请输入分类',
542
+ empty: '搜索内容为空的提示',
543
+ },
544
+ fieldSetting: {
545
+ className: fieldClassName,
546
+ },
547
+ options: [
548
+ {
549
+ label: '指南',
550
+ value: '指南',
551
+ separator: true, //分割线
552
+ children: [
553
+ {
554
+ value: 'shejiyuanze',
555
+ label: '设计原则',
556
+ shortcut: 'ctrl+z', //选项右侧的内容
557
+ },
558
+ ],
559
+ },
560
+ {
561
+ label: '资源',
562
+ value: 'resource',
563
+
564
+ },
565
+ ],
566
+ },
567
+ {
568
+ label: '树形选择',
569
+ prop: 'select_tree',
570
+ type: 'combobox',
571
+ setting: {
572
+ placeholder: '请输入分类',
573
+ empty: '搜索内容为空的提示',
574
+ type: 'ant-tree',
575
+ width: `300px`,//控制组件宽度
576
+ // checkable: true,
577
+ // selectable: false
578
+ },
579
+ container: "Dialog",
580
+ fieldSetting: {
581
+ className: fieldClassName,
582
+ },
583
+ options: [
584
+ {
585
+ label: '指南',
586
+ value: '指南',
587
+ children: [
588
+ {
589
+ value: 'shejiyuanze',
590
+ label: '设计原则',
591
+ setting: {
592
+ icon: () => {
593
+ return <div>ID</div>
594
+ }
595
+ },
596
+ children: [
597
+ {
598
+ value: 'leaf',
599
+ label: '叶子节点',
600
+ shortcut: 'ctrl+z', //选项右侧的内容
601
+ },
602
+ {
603
+ value: 'leaf1',
604
+ label: '叶子节点1',
605
+ shortcut: 'ctrl+z', //选项右侧的内容
606
+ },
607
+ ],
608
+ },
609
+ ],
610
+ },
611
+ {
612
+ label: '资源',
613
+ value: 'resource',
614
+ children: [
615
+ {
616
+ value: 'axure',
617
+ label: 'Axure Components',
618
+ },
619
+ ],
620
+ },
621
+ ],
622
+ },
623
+ ]
624
+
625
+ //rules为表单校验规则,每个组件都可以传入
626
+
627
+ //input支持template,支持以下几个属性:
628
+ //prefix 输入框头部内容,只对 type="text"(默认) 有效
629
+ //suffix 输入框尾部内容,只对 type="text" 有效
630
+ //prepend 输入框前置内容,只对 type="text" 有效
631
+ //append 输入框后置内容,只对 type="text" 有效
632
+
633
+ //divider支持template:
634
+ //default
635
+
636
+ 支持组件 type:
637
+
638
+ export enum FormType {
639
+ /\*\*
640
+
641
+ - @description: 输入框
642
+ - @return {_}
643
+ _/
644
+ "input" = "input",
645
+ /\*\*
646
+ - @description: 文本区域
647
+ - @return {_}
648
+ _/
649
+ "textarea" = "textarea",
650
+ /\*\*
651
+ - @description: 复杂输入框,可自定义前后缀和大小
652
+ - @return {_}
653
+ _/
654
+ "input-group" = "input-group",
655
+ /\*\*
656
+ - @description: 表单中的多维列表,可增减元素,内部可以使用的数据类型除自身 form-list 外同 FormType
657
+ - @return {_}
658
+ _/
659
+ "form-list" = "form-list",
660
+ /\*\*
661
+ - @description: 选择器
662
+ - @return {_}
663
+ _/
664
+ "select" = "select",
665
+ /\*\*
666
+ - @description: 开关
667
+ - @return {_}
668
+ _/
669
+ "switch" = "switch",
670
+ /\*\*
671
+ - @description: 带搜索的二级菜单
672
+ - @return {_}
673
+ _/
674
+ "command" = "command",
675
+ /\*\*
676
+ - @description: 响应式下拉框+带搜索的二级菜单/多选
677
+ - @return {_}
678
+ _/
679
+ "combobox" = "combobox",
680
+ /\*\*
681
+ - @description: 日期选择器
682
+ - @return {_}
683
+ _/
684
+ "date-picker" = "date-picker",
685
+
686
+ /\*\*
687
+
688
+ - @description: 单选框
689
+ - @return {_}
690
+ _/
691
+ "radio" = "radio",
692
+ // /**
693
+ // _ @description: 自定义元素,插槽组件
694
+ // _ @return {_}
695
+ // _/
696
+ // "form-item-slot" = "form-item-slot",
697
+ /**
698
+ - @description: 多选框
699
+ - @return {_}
700
+ _/
701
+ "checkbox" = "checkbox",
702
+ /\*\*
703
+ - @description: 多选框列表,输入输出都是字符串列表 ["value1", "value2", "value3"]
704
+ - @return {_}
705
+ _/
706
+ "checkbox-list" = "checkbox-list",
707
+ /\*\*
708
+ - @description: FieldDescription 描述
709
+ - @return {_}
710
+ _/
711
+ "description" = "description",
712
+ }
713
+
714
+ # RBaseTabs
715
+
716
+ tab栏,支持parametersType
717
+
718
+ ```
719
+ import { RBaseTabs } from 'general-basic-form';
720
+ const tabPanes = [
721
+ {
722
+ value: 'rewards',
723
+ label: '配置1',
724
+ render: (tabPane, index) => {
725
+ return <Rewards />;
726
+ },
727
+ }
728
+ ]
729
+ <RBaseTabs tabPanes={tabPanes} parametersType="indexDB" DBPrimaryKey={auth.get.user().id}></RBaseTabs>;
730
+ ```
731
+
732
+
733
+
734
+ # RBaseCombobox 单独使用
735
+
736
+ 多功能组合弹出框
737
+
738
+ ```
739
+ import { RGeneralBasicForm, RBasicForm, RBaseCombobox } from 'general-basic-form';
740
+ <RBaseCombobox
741
+ onFormChange={(params) => {
742
+ console.log('queryParams', params);
743
+ }}
744
+ value='resource'
745
+ item={{
746
+ options: [
747
+ {
748
+ label: '指南',
749
+ value: '指南',
750
+ separator: true, //分割线
751
+ children: [
752
+ {
753
+ value: 'shejiyuanze',
754
+ label: '设计原则',
755
+ shortcut: 'ctrl+z', //选项右侧的内容
756
+ },
757
+ ],
758
+ },
759
+ {
760
+ label: '资源',
761
+ value: 'resource',
762
+ },
763
+ ],
764
+ setting: {
765
+ placeholder: '请输入分类',
766
+ empty: '搜索内容为空的提示',
767
+ },
768
+ container: 'Dialog',
769
+ }}
770
+ />
771
+
772
+ ```