antd-form-document 0.1.6 → 0.1.8

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 (19) hide show
  1. package/README.md +264 -203
  2. package/dist/components/Upload/index.d.ts.map +1 -1
  3. package/dist/config.d.ts.map +1 -1
  4. package/dist/entity/{Meta.d.ts → XML.d.ts} +3 -3
  5. package/dist/entity/XML.d.ts.map +1 -0
  6. package/dist/form/index.d.ts +6 -6
  7. package/dist/form/index.d.ts.map +1 -1
  8. package/dist/index.tsx +1 -1
  9. package/dist/index.tsx.map +1 -1
  10. package/dist/service/UIComponent.d.ts +1 -1
  11. package/dist/service/UIComponent.d.ts.map +1 -1
  12. package/dist/service/UIListComponent.d.ts +1 -1
  13. package/dist/service/UIListComponent.d.ts.map +1 -1
  14. package/dist/utils/doc.d.ts +7 -0
  15. package/dist/utils/doc.d.ts.map +1 -0
  16. package/package.json +1 -1
  17. package/dist/entity/Meta.d.ts.map +0 -1
  18. package/dist/utils/xml.d.ts +0 -7
  19. package/dist/utils/xml.d.ts.map +0 -1
package/README.md CHANGED
@@ -2,6 +2,67 @@
2
2
 
3
3
  基于[ant-design](https://ant.design/) [cn](https://ant-design.gitee.io/) 表单设计
4
4
 
5
+ <!-- @import "[TOC]" {cmd="toc" depthFrom=1 depthTo=6 orderedList=false} -->
6
+
7
+ <!-- code_chunk_output -->
8
+
9
+ - [Antd-Form-Document](#antd-form-document)
10
+ - [一、安装](#一安装)
11
+ - [二、示例](#二示例)
12
+ - [XML Document 格式](#xml-document-格式)
13
+ - [三、XML 文档说明](#三xml-文档说明)
14
+ - [表单](#表单)
15
+ - [Form](#form)
16
+ - [容器](#容器)
17
+ - [Row](#row)
18
+ - [Col](#col)
19
+ - [Divider](#divider)
20
+ - [Steps](#steps)
21
+ - [Step](#step)
22
+ - [Content](#content)
23
+ - [Collapse](#collapse)
24
+ - [Tabs](#tabs)
25
+ - [Card](#card)
26
+ - [组件](#组件)
27
+ - [Label](#label)
28
+ - [Tooltip](#tooltip)
29
+ - [Text](#text)
30
+ - [TextArea](#textarea)
31
+ - [Number](#number)
32
+ - [Editor](#editor)
33
+ - [Select](#select)
34
+ - [Checkbox](#checkbox)
35
+ - [Radio](#radio)
36
+ - [Switch](#switch)
37
+ - [Duration](#duration)
38
+ - [DatePicker](#datepicker)
39
+ - [TimePicker](#timepicker)
40
+ - [RangePicker](#rangepicker)
41
+ - [Upload](#upload)
42
+ - [SuperUpload](#superupload)
43
+ - [Table](#table)
44
+ - [Columns](#columns)
45
+ - [Column](#column)
46
+ - [注：](#注)
47
+ - [控件](#控件)
48
+ - [Validates](#validates)
49
+ - [Validate](#validate)
50
+ - [Conditions](#conditions)
51
+ - [Condition](#condition)
52
+ - [Collection](#collection)
53
+ - [Compute](#compute)
54
+ - [Options](#options)
55
+ - [Option](#option)
56
+ - [四、应用](#四应用)
57
+ - [FormDocument标签](#formdocument标签)
58
+ - [Config配置](#config配置)
59
+ - [自定义组件](#自定义组件)
60
+ - [Department](#department)
61
+ - [UploadList](#uploadlist)
62
+
63
+ <!-- /code_chunk_output -->
64
+
65
+
5
66
  ## 一、安装
6
67
 
7
68
  ```shell
@@ -176,16 +237,16 @@ const App = () => {
176
237
 
177
238
  ### 表单
178
239
 
179
- #### **Form**
240
+ #### Form
180
241
 
181
242
  表单
182
243
 
183
- | 参数 | 说明 | 类型 | 默认值 | 必填项 |
184
- | ----------- | -------------------- | ------- | ------ | ------ |
185
- | style | css表单样式 | string | - | |
186
- | showTitle | 是否显示控件的标题`title` | boolean | true | - |
187
- | labelCol | 全局`title` 标签布局 | number | - | |
188
- | wrapperCol | 全局控件布局，同labelCol对应使用 | number | - | |
244
+ | 参数 | 说明 | 类型 | 默认值 | 必填项 |
245
+ | ---------- | -------------------------------- | ------- | ------ | ------ |
246
+ | style | css表单样式 | string | - | |
247
+ | showTitle | 是否显示控件的标题`title` | boolean | true | - |
248
+ | labelCol | 全局`title` 标签布局 | number | - | |
249
+ | wrapperCol | 全局控件布局，同labelCol对应使用 | number | - | |
189
250
 
190
251
  **例**
191
252
 
@@ -201,7 +262,7 @@ const App = () => {
201
262
 
202
263
  容器是对页面控件的位置定位布局
203
264
 
204
- #### **Row**
265
+ #### Row
205
266
 
206
267
  行
207
268
 
@@ -211,7 +272,7 @@ const App = () => {
211
272
 
212
273
 
213
274
 
214
- #### **Col**
275
+ #### Col
215
276
 
216
277
  列
217
278
 
@@ -244,16 +305,16 @@ const App = () => {
244
305
 
245
306
 
246
307
 
247
- #### **Divider**
308
+ #### Divider
248
309
 
249
310
  分割线
250
311
 
251
- | 参数 | 说明 | 类型 | 默认值 | 必填项 |
252
- | ----------- | ---------------- | -------------------------- | ------ | ------ |
253
- | dashed | 是否虚线 | boolean | false | - |
312
+ | 参数 | 说明 | 类型 | 默认值 | 必填项 |
313
+ | ----------- | ---------------- | ----------------------------- | ------ | ------ |
314
+ | dashed | 是否虚线 | boolean | false | - |
254
315
  | orientation | 分割线标题的位置 | `left` 丨 `right` 丨 `center` | center | |
255
316
 
256
- **例：**对不同章节的文本段落进行分割
317
+ **例：** 对不同章节的文本段落进行分割
257
318
 
258
319
  ```xml
259
320
  <Divider orientation="left">基本信息填写</Divider>
@@ -261,7 +322,7 @@ const App = () => {
261
322
 
262
323
 
263
324
 
264
- #### **Steps**
325
+ #### Steps
265
326
 
266
327
  步骤条
267
328
 
@@ -269,7 +330,7 @@ const App = () => {
269
330
  | --------- | ------------------------------------------------------------ | -------------------------- | ------------ | ------ |
270
331
  | direction | 指定步骤条方向。水平（`horizontal`）和竖直（`vertical`）方向 | `horizontal` 丨 `vertical` | `horizontal` | - |
271
332
 
272
- ##### **Step**
333
+ ##### Step
273
334
 
274
335
  步骤条内的每一个步骤
275
336
 
@@ -278,7 +339,7 @@ const App = () => {
278
339
  | title | 标题 | string | - | ✓ |
279
340
  | description | 步骤的详情描述 | string | - | |
280
341
 
281
- ##### **Content**
342
+ ##### Content
282
343
 
283
344
  步骤条内容
284
345
 
@@ -287,7 +348,7 @@ const App = () => {
287
348
  | style | css样式 | string | - | |
288
349
  | stepIndex | 步骤条位置下标 | number | - | ✓ |
289
350
 
290
- **例：**引导用户按照流程完成任务的导航条，切换步骤时，按Content 位置下标 stepIndex开始。stepIndex从0开始
351
+ **例：** 引导用户按照流程完成任务的导航条，切换步骤时，按Content 位置下标 stepIndex开始。stepIndex从0开始
291
352
 
292
353
  ```xml
293
354
  <Steps direction="horizontal">
@@ -302,7 +363,7 @@ const App = () => {
302
363
 
303
364
 
304
365
 
305
- #### **Collapse**
366
+ #### Collapse
306
367
 
307
368
  折叠
308
369
 
@@ -325,7 +386,7 @@ const App = () => {
325
386
 
326
387
 
327
388
 
328
- #### **Tabs**
389
+ #### Tabs
329
390
 
330
391
  标签页 — 暂缺
331
392
 
@@ -337,7 +398,7 @@ const App = () => {
337
398
 
338
399
 
339
400
 
340
- #### **Card**
401
+ #### Card
341
402
 
342
403
  卡片 — 暂缺
343
404
 
@@ -353,7 +414,7 @@ const App = () => {
353
414
 
354
415
  功能组件
355
416
 
356
- #### **Label**
417
+ #### Label
357
418
 
358
419
  标签
359
420
 
@@ -373,7 +434,7 @@ const App = () => {
373
434
 
374
435
 
375
436
 
376
- #### **Tooltip**
437
+ #### Tooltip
377
438
 
378
439
  提示框
379
440
 
@@ -399,39 +460,39 @@ const App = () => {
399
460
 
400
461
 
401
462
 
402
- #### **Text**
463
+ #### Text
403
464
 
404
465
  文本
405
466
 
406
- | 参数 | 说明 | 类型 | 默认值 | 必填项 |
407
- | ------------- | ----------------------------- | ----------------------- | ------ | ---- |
408
- | style | css样式 | string | - | |
409
- | code | 字段编号全局唯一 | string | - | ✓ |
410
- | title | 字段标题 | string | - | ✓ |
411
- | type | 类型标记，不做验证 | `text` 丨 `url` 丨 `email` 丨 `phone` | `text` | |
412
- | maxLength | 最大输入字符长度 | number | - | |
413
- | placeholder | 输入框提示信息 | string | - | |
414
- | defaultValue | 默认输入框内容 | string | - | |
415
- | defaultHide | 默认是否隐藏 | boolean | false | - |
416
- | tips | 字段提示 | string | - | |
417
- | hidden | 是否隐藏 | boolean | false | - |
418
- | readonly | 是否只读 | boolean | false | - |
419
- | labelCol | `title`布局，与同 `<Col>` 组件设置 | number | - | |
420
- | wrapperCol | 组件布局，同 `<Col>` 组件设置 | number | - | |
421
- | allowClear | 是否有清除按钮 | boolean | false | - |
422
- | showCount | 是否展示输入字数 | boolean | false | - |
467
+ | 参数 | 说明 | 类型 | 默认值 | 必填项 |
468
+ | ------------ | ---------------------------------- | ------------------------------------- | ------ | ------ |
469
+ | style | css样式 | string | - | |
470
+ | code | 字段编号全局唯一 | string | - | ✓ |
471
+ | title | 字段标题 | string | - | ✓ |
472
+ | type | 类型标记，不做验证 | `text` 丨 `url` 丨 `email` 丨 `phone` | `text` | |
473
+ | maxLength | 最大输入字符长度 | number | - | |
474
+ | placeholder | 输入框提示信息 | string | - | |
475
+ | defaultValue | 默认输入框内容 | string | - | |
476
+ | defaultHide | 默认是否隐藏 | boolean | false | - |
477
+ | tips | 字段提示 | string | - | |
478
+ | hidden | 是否隐藏 | boolean | false | - |
479
+ | readonly | 是否只读 | boolean | false | - |
480
+ | labelCol | `title`布局，与同 `<Col>` 组件设置 | number | - | |
481
+ | wrapperCol | 组件布局，同 `<Col>` 组件设置 | number | - | |
482
+ | allowClear | 是否有清除按钮 | boolean | false | - |
483
+ | showCount | 是否展示输入字数 | boolean | false | - |
423
484
 
424
485
  **例：**
425
486
 
426
487
  ```xml
427
- <Text code="code" title="编码" labelSpan="8" wrapperSpan="16">
488
+ <Text code="code" title="编码" labelCol="8" wrapperCol="16">
428
489
  XXX子控件
429
490
  </Text>
430
491
  ```
431
492
 
432
493
 
433
494
 
434
- #### **TextArea**
495
+ #### TextArea
435
496
 
436
497
  文本域
437
498
 
@@ -462,7 +523,7 @@ const App = () => {
462
523
 
463
524
 
464
525
 
465
- #### **Number**
526
+ #### Number
466
527
 
467
528
  数值框
468
529
 
@@ -493,7 +554,7 @@ const App = () => {
493
554
 
494
555
 
495
556
 
496
- #### **Editor**
557
+ #### Editor
497
558
 
498
559
  富文本
499
560
 
@@ -521,26 +582,26 @@ const App = () => {
521
582
 
522
583
 
523
584
 
524
- #### **Select**
585
+ #### Select
525
586
 
526
587
  选择框
527
588
 
528
- | 参数 | 说明 | 类型 | 默认值 | 必填项 |
529
- | ------------ | ------------------------------------------------------------ | ------- | ------ | ------ |
530
- | style | css样式 | string | - | |
531
- | code | 字段编号全局唯一 | string | - | ✓ |
532
- | title | 字段标题 | string | - | ✓ |
533
- | multiple | 选择框是否可以多选 | boolean | false | |
534
- | placeholder | 选择框提示信息 | string | - | |
535
- | defaultValue | 默认选择框`value` | string | - | |
536
- | defaultHide | 默认是否隐藏 | boolean | false | - |
537
- | tips | 字段提示 | string | - | |
589
+ | 参数 | 说明 | 类型 | 默认值 | 必填项 |
590
+ | ------------ | -------------------------------------------------------------------------- | ------- | ------ | ------ |
591
+ | style | css样式 | string | - | |
592
+ | code | 字段编号全局唯一 | string | - | ✓ |
593
+ | title | 字段标题 | string | - | ✓ |
594
+ | multiple | 选择框是否可以多选 | boolean | false | |
595
+ | placeholder | 选择框提示信息 | string | - | |
596
+ | defaultValue | 默认选择框`value` | string | - | |
597
+ | defaultHide | 默认是否隐藏 | boolean | false | - |
598
+ | tips | 字段提示 | string | - | |
538
599
  | remote | 远程请求数据项url地址，优先级低于`<Options>`,响应数据以List<Map>内容为结果 | string | - | |
539
- | hidden | 是否隐藏 | boolean | false | - |
540
- | readonly | 是否只读 | boolean | false | - |
541
- | labelCol | `title`布局，与同 `<Col>` 组件设置 | number | - | |
542
- | wrapperCol | 组件布局，同 `<Col>` 组件设置 | number | - | |
543
- | allowClear | 是否有清除按钮 | boolean | true | - |
600
+ | hidden | 是否隐藏 | boolean | false | - |
601
+ | readonly | 是否只读 | boolean | false | - |
602
+ | labelCol | `title`布局，与同 `<Col>` 组件设置 | number | - | |
603
+ | wrapperCol | 组件布局，同 `<Col>` 组件设置 | number | - | |
604
+ | allowClear | 是否有清除按钮 | boolean | true | - |
544
605
 
545
606
  **例1：**
546
607
 
@@ -564,23 +625,23 @@ const App = () => {
564
625
 
565
626
 
566
627
 
567
- #### **Checkbox**
628
+ #### Checkbox
568
629
 
569
630
  复选框
570
631
 
571
- | 参数 | 说明 | 类型 | 默认值 | 必填项 |
572
- | ------------ | ------------------------------------------------------------ | ------- | ------ | ------ |
573
- | style | css样式 | string | - | |
574
- | code | 字段编号全局唯一 | string | - | ✓ |
575
- | title | 字段标题 | string | - | ✓ |
576
- | defaultValue | 默认复选框`value` | string | - | |
577
- | defaultHide | 默认是否隐藏 | boolean | false | - |
578
- | tips | 字段提示 | string | - | |
632
+ | 参数 | 说明 | 类型 | 默认值 | 必填项 |
633
+ | ------------ | -------------------------------------------------------------------------- | ------- | ------ | ------ |
634
+ | style | css样式 | string | - | |
635
+ | code | 字段编号全局唯一 | string | - | ✓ |
636
+ | title | 字段标题 | string | - | ✓ |
637
+ | defaultValue | 默认复选框`value` | string | - | |
638
+ | defaultHide | 默认是否隐藏 | boolean | false | - |
639
+ | tips | 字段提示 | string | - | |
579
640
  | remote | 远程请求数据项url地址，优先级低于`<Options>`,响应数据以List<Map>内容为结果 | string | - | |
580
- | hidden | 是否隐藏 | boolean | false | - |
581
- | readonly | 是否只读 | boolean | false | - |
582
- | labelCol | `title`布局，与同 `<Col>` 组件设置 | number | - | |
583
- | wrapperCol | 组件布局，同 `<Col>` 组件设置 | number | - | |
641
+ | hidden | 是否隐藏 | boolean | false | - |
642
+ | readonly | 是否只读 | boolean | false | - |
643
+ | labelCol | `title`布局，与同 `<Col>` 组件设置 | number | - | |
644
+ | wrapperCol | 组件布局，同 `<Col>` 组件设置 | number | - | |
584
645
 
585
646
  **例1：**
586
647
 
@@ -604,24 +665,24 @@ const App = () => {
604
665
 
605
666
 
606
667
 
607
- #### **Radio**
668
+ #### Radio
608
669
 
609
670
  单选框
610
671
 
611
- | 参数 | 说明 | 类型 | 默认值 | 必填项 |
612
- | ------------ | ------------------------------------------------------------ | -------------------- | ------- | ------ |
613
- | style | css样式 | string | - | |
614
- | code | 字段编号全局唯一 | string | - | ✓ |
615
- | title | 字段标题 | string | - | ✓ |
616
- | defaultValue | 默认单选框`value` | string | - | |
617
- | defaultHide | 默认是否隐藏 | boolean | false | - |
618
- | tips | 字段提示 | string | - | |
619
- | remote | 远程请求数据项url地址，优先级低于`<Options>`,响应数据以List<Map>内容为结果 | string | - | |
620
- | hidden | 是否隐藏 | boolean | false | - |
621
- | readonly | 是否只读 | boolean | false | - |
622
- | labelCol | `title`布局，与同 `<Col>` 组件设置 | number | - | |
623
- | wrapperCol | 组件布局，同 `<Col>` 组件设置 | number | - | |
624
- | optionType | 按钮风格:`默认风格`、`按钮风格` | `default` 丨 `button` | `default` | |
672
+ | 参数 | 说明 | 类型 | 默认值 | 必填项 |
673
+ | ------------ | -------------------------------------------------------------------------- | --------------------- | --------- | ------ |
674
+ | style | css样式 | string | - | |
675
+ | code | 字段编号全局唯一 | string | - | ✓ |
676
+ | title | 字段标题 | string | - | ✓ |
677
+ | defaultValue | 默认单选框`value` | string | - | |
678
+ | defaultHide | 默认是否隐藏 | boolean | false | - |
679
+ | tips | 字段提示 | string | - | |
680
+ | remote | 远程请求数据项url地址，优先级低于`<Options>`,响应数据以List<Map>内容为结果 | string | - | |
681
+ | hidden | 是否隐藏 | boolean | false | - |
682
+ | readonly | 是否只读 | boolean | false | - |
683
+ | labelCol | `title`布局，与同 `<Col>` 组件设置 | number | - | |
684
+ | wrapperCol | 组件布局，同 `<Col>` 组件设置 | number | - | |
685
+ | optionType | 按钮风格:`默认风格`、`按钮风格` | `default` 丨 `button` | `default` | |
625
686
 
626
687
  **例1：**
627
688
 
@@ -645,7 +706,7 @@ const App = () => {
645
706
 
646
707
 
647
708
 
648
- #### **Switch**
709
+ #### Switch
649
710
 
650
711
  开关
651
712
 
@@ -672,7 +733,7 @@ const App = () => {
672
733
 
673
734
 
674
735
 
675
- #### **Duration**
736
+ #### Duration
676
737
 
677
738
  时长
678
739
 
@@ -699,27 +760,27 @@ const App = () => {
699
760
 
700
761
 
701
762
 
702
- #### **DatePicker**
763
+ #### DatePicker
703
764
 
704
765
  日期选择器
705
766
 
706
- | 参数 | 说明 | 类型 | 默认值 | 必填项 |
707
- | ------------ | ------------------------------------------------------------ | -------------------------------------------------- | ---------- | ------ |
708
- | style | css样式 | string | - | |
709
- | code | 字段编号全局唯一 | string | - | ✓ |
710
- | title | 字段标题 | string | - | ✓ |
711
- | type | 日期选择框类型，`日期`、`星期`、`月份`、`季度`、`年份` | `date` 丨 `week` 丨 `month` 丨 `quarter` 丨 `year` | `date` | - |
767
+ | 参数 | 说明 | 类型 | 默认值 | 必填项 |
768
+ | ------------ | ------------------------------------------------------------------------ | -------------------------------------------------- | ---------- | ------ |
769
+ | style | css样式 | string | - | |
770
+ | code | 字段编号全局唯一 | string | - | ✓ |
771
+ | title | 字段标题 | string | - | ✓ |
772
+ | type | 日期选择框类型，`日期`、`星期`、`月份`、`季度`、`年份` | `date` 丨 `week` 丨 `month` 丨 `quarter` 丨 `year` | `date` | - |
712
773
  | format | 日期显示格式，[moment](http://momentjs.cn/docs/#/displaying/format/)格式 | string | YYYY-MM-DD | - |
713
- | showTime | 显示时间选择功能 | boolean | false | - |
714
- | placeholder | 日期选择框提示信息 | string | - | |
715
- | defaultValue | 默认日期选择框`value`,格式`YYYY-MM-DD` | string | - | |
716
- | defaultHide | 默认是否隐藏 | boolean | false | - |
717
- | tips | 字段提示 | string | - | |
718
- | hidden | 是否隐藏 | boolean | false | - |
719
- | readonly | 是否只读 | boolean | false | - |
720
- | labelCol | `title`布局，与同 `<Col>` 组件设置 | number | - | |
721
- | wrapperCol | 组件布局，同 `<Col>` 组件设置 | number | - | |
722
- | allowClear | 是否有清除按钮 | boolean | true | - |
774
+ | showTime | 显示时间选择功能 | boolean | false | - |
775
+ | placeholder | 日期选择框提示信息 | string | - | |
776
+ | defaultValue | 默认日期选择框`value`,格式`YYYY-MM-DD` | string | - | |
777
+ | defaultHide | 默认是否隐藏 | boolean | false | - |
778
+ | tips | 字段提示 | string | - | |
779
+ | hidden | 是否隐藏 | boolean | false | - |
780
+ | readonly | 是否只读 | boolean | false | - |
781
+ | labelCol | `title`布局，与同 `<Col>` 组件设置 | number | - | |
782
+ | wrapperCol | 组件布局，同 `<Col>` 组件设置 | number | - | |
783
+ | allowClear | 是否有清除按钮 | boolean | true | - |
723
784
 
724
785
  **例：**
725
786
 
@@ -731,25 +792,25 @@ const App = () => {
731
792
 
732
793
 
733
794
 
734
- #### **TimePicker**
795
+ #### TimePicker
735
796
 
736
797
  时间选择器
737
798
 
738
- | 参数 | 说明 | 类型 | 默认值 | 必填项 |
739
- | ------------ | ------------------------------------------------------------ | ------- | -------- | ------ |
740
- | style | css样式 | string | - | |
741
- | code | 字段编号全局唯一 | string | - | ✓ |
742
- | title | 字段标题 | string | - | ✓ |
799
+ | 参数 | 说明 | 类型 | 默认值 | 必填项 |
800
+ | ------------ | ------------------------------------------------------------------------ | ------- | -------- | ------ |
801
+ | style | css样式 | string | - | |
802
+ | code | 字段编号全局唯一 | string | - | ✓ |
803
+ | title | 字段标题 | string | - | ✓ |
743
804
  | format | 时间显示格式，[moment](http://momentjs.cn/docs/#/displaying/format/)格式 | string | HH:mm:ss | - |
744
- | placeholder | 时间选择框提示信息 | string | - | |
745
- | defaultValue | 默认时间选择器`value`,格式`HH:mm:ss` | string | - | |
746
- | defaultHide | 默认是否隐藏 | boolean | false | - |
747
- | tips | 字段提示 | string | - | |
748
- | hidden | 是否隐藏 | boolean | false | - |
749
- | readonly | 是否只读 | boolean | false | - |
750
- | labelCol | `title`布局，与同 `<Col>` 组件设置 | number | - | |
751
- | wrapperCol | 组件布局，同 `<Col>` 组件设置 | number | - | |
752
- | allowClear | 是否有清除按钮 | boolean | true | - |
805
+ | placeholder | 时间选择框提示信息 | string | - | |
806
+ | defaultValue | 默认时间选择器`value`,格式`HH:mm:ss` | string | - | |
807
+ | defaultHide | 默认是否隐藏 | boolean | false | - |
808
+ | tips | 字段提示 | string | - | |
809
+ | hidden | 是否隐藏 | boolean | false | - |
810
+ | readonly | 是否只读 | boolean | false | - |
811
+ | labelCol | `title`布局，与同 `<Col>` 组件设置 | number | - | |
812
+ | wrapperCol | 组件布局，同 `<Col>` 组件设置 | number | - | |
813
+ | allowClear | 是否有清除按钮 | boolean | true | - |
753
814
 
754
815
  **例：**
755
816
 
@@ -773,27 +834,27 @@ const App = () => {
773
834
 
774
835
 
775
836
 
776
- #### **Upload**
837
+ #### Upload
777
838
 
778
839
  上传
779
840
 
780
- | 参数 | 说明 | 类型 | 默认值 | 必填项 |
781
- | --------------- | ------------------------------------------------------------ | ------- | ------ | ------ |
782
- | style | css样式 | string | - | |
783
- | code | 字段编号全局唯一 | string | - | ✓ |
784
- | title | 字段标题 | string | - | ✓ |
785
- | action | 暂缺 | string | - | ✓ |
786
- | multiple | 暂缺 | boolean | false | - |
787
- | maxCount | 最大上传文件个数 | number | - | |
788
- | fileSize | 单个文件最大字节；`1B`、`1KB`、`1MB`、`1GB`、`1TB`、`1PB` | string | - | |
841
+ | 参数 | 说明 | 类型 | 默认值 | 必填项 |
842
+ | --------------- | ------------------------------------------------------------------------------------------------------ | ------- | ------ | ------ |
843
+ | style | css样式 | string | - | |
844
+ | code | 字段编号全局唯一 | string | - | ✓ |
845
+ | title | 字段标题 | string | - | ✓ |
846
+ | action | 暂缺 | string | - | ✓ |
847
+ | multiple | 暂缺 | boolean | false | - |
848
+ | maxCount | 最大上传文件个数 | number | - | |
849
+ | fileSize | 单个文件最大字节；`1B`、`1KB`、`1MB`、`1GB`、`1TB`、`1PB` | string | - | |
789
850
  | fileType | 上传文件类型；[mime-type](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#accept) | string | - | |
790
- | fileTypeMessage | 上传文件类型提示说明 | string | - | |
791
- | defaultHide | 默认是否隐藏 | boolean | false | - |
792
- | tips | 字段提示 | string | - | |
793
- | hidden | 是否隐藏 | boolean | false | - |
794
- | readonly | 是否只读 | boolean | false | - |
795
- | labelCol | `title`布局，与同 `<Col>` 组件设置 | number | - | |
796
- | wrapperCol | 组件布局，同 `<Col>` 组件设置 | number | - | |
851
+ | fileTypeMessage | 上传文件类型提示说明 | string | - | |
852
+ | defaultHide | 默认是否隐藏 | boolean | false | - |
853
+ | tips | 字段提示 | string | - | |
854
+ | hidden | 是否隐藏 | boolean | false | - |
855
+ | readonly | 是否只读 | boolean | false | - |
856
+ | labelCol | `title`布局，与同 `<Col>` 组件设置 | number | - | |
857
+ | wrapperCol | 组件布局，同 `<Col>` 组件设置 | number | - | |
797
858
 
798
859
  **例：**
799
860
 
@@ -805,27 +866,27 @@ const App = () => {
805
866
 
806
867
 
807
868
 
808
- #### **SuperUpload**
869
+ #### SuperUpload
809
870
 
810
871
  分片上传
811
872
 
812
- | 参数 | 说明 | 类型 | 默认值 | 必填项 |
813
- | --------------- | ------------------------------------------------------------ | ------- | ------ | ------ |
814
- | style | css样式 | string | - | |
815
- | code | 字段编号全局唯一 | string | - | ✓ |
816
- | title | 字段标题 | string | - | ✓ |
817
- | action | 暂缺 | string | - | ✓ |
818
- | multiple | 暂缺 | boolean | false | - |
819
- | maxCount | 最大上传文件个数 | number | - | |
820
- | fileSize | 单个文件最大字节；`1B`、`1KB`、`1MB`、`1GB`、`1TB`、`1PB` | string | - | |
873
+ | 参数 | 说明 | 类型 | 默认值 | 必填项 |
874
+ | --------------- | ------------------------------------------------------------------------------------------------------ | ------- | ------ | ------ |
875
+ | style | css样式 | string | - | |
876
+ | code | 字段编号全局唯一 | string | - | ✓ |
877
+ | title | 字段标题 | string | - | ✓ |
878
+ | action | 暂缺 | string | - | ✓ |
879
+ | multiple | 暂缺 | boolean | false | - |
880
+ | maxCount | 最大上传文件个数 | number | - | |
881
+ | fileSize | 单个文件最大字节；`1B`、`1KB`、`1MB`、`1GB`、`1TB`、`1PB` | string | - | |
821
882
  | fileType | 上传文件类型；[mime-type](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#accept) | string | - | |
822
- | fileTypeMessage | 上传文件类型提示说明 | string | - | |
823
- | defaultHide | 默认是否隐藏 | boolean | false | - |
824
- | tips | 字段提示 | string | - | |
825
- | hidden | 是否隐藏 | boolean | false | - |
826
- | readonly | 是否只读 | boolean | false | - |
827
- | labelCol | `title`布局，与同 `<Col>` 组件设置 | number | - | |
828
- | wrapperCol | 组件布局，同 `<Col>` 组件设置 | number | - | |
883
+ | fileTypeMessage | 上传文件类型提示说明 | string | - | |
884
+ | defaultHide | 默认是否隐藏 | boolean | false | - |
885
+ | tips | 字段提示 | string | - | |
886
+ | hidden | 是否隐藏 | boolean | false | - |
887
+ | readonly | 是否只读 | boolean | false | - |
888
+ | labelCol | `title`布局，与同 `<Col>` 组件设置 | number | - | |
889
+ | wrapperCol | 组件布局，同 `<Col>` 组件设置 | number | - | |
829
890
 
830
891
  **例：**
831
892
 
@@ -837,7 +898,7 @@ const App = () => {
837
898
 
838
899
 
839
900
 
840
- #### **Table**
901
+ #### Table
841
902
 
842
903
  表格
843
904
 
@@ -855,11 +916,11 @@ const App = () => {
855
916
 
856
917
 
857
918
 
858
- #### **Columns**
919
+ #### Columns
859
920
 
860
921
  表格列集合
861
922
 
862
- ##### **Column**
923
+ ##### Column
863
924
 
864
925
  表格列内容
865
926
 
@@ -896,22 +957,22 @@ const App = () => {
896
957
 
897
958
 
898
959
 
899
- #### **Validates**
960
+ #### Validates
900
961
 
901
962
  验证集合
902
963
 
903
964
  ##### Validate
904
965
 
905
- | 参数 | 说明 | 类型 | 默认值 | 必填项 |
906
- | --------- | --------------------------------------------------------- | ------------------------------------------------------------ | ------ | ------ |
966
+ | 参数 | 说明 | 类型 | 默认值 | 必填项 |
967
+ | --------- | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | ------ | ------ |
907
968
  | type | 验证类型 | `string` 丨 `number` 丨 `integer` 丨 `float` 丨 `boolean` 丨 `url` 丨 `email` 丨 `phone` 丨 `date` 丨 `regexp` | string | - |
908
- | required | 是否为必选字段 | boolean | - | |
909
- | minlength | `type`：string 类型为字符串最小长度 | number | - | |
910
- | maxlength | `type`：string 类型为字符串最大长度 | number | - | |
911
- | min | `type`：number 类型时为最小值；array 类型时为数组最小长度 | number | - | |
912
- | max | `type`：number 类型时为最大值；array 类型时为数组最大长度 | number | - | |
913
- | pattern | `type`：regexp 类型时，使用正则表达式匹配 | RegExp | - | |
914
- | message | 触发验证提示信息 | string | - | ✓ |
969
+ | required | 是否为必选字段 | boolean | - | |
970
+ | minlength | `type`：string 类型为字符串最小长度 | number | - | |
971
+ | maxlength | `type`：string 类型为字符串最大长度 | number | - | |
972
+ | min | `type`：number 类型时为最小值；array 类型时为数组最小长度 | number | - | |
973
+ | max | `type`：number 类型时为最大值；array 类型时为数组最大长度 | number | - | |
974
+ | pattern | `type`：regexp 类型时，使用正则表达式匹配 | RegExp | - | |
975
+ | message | 触发验证提示信息 | string | - | ✓ |
915
976
 
916
977
  **例：**
917
978
 
@@ -925,14 +986,14 @@ const App = () => {
925
986
 
926
987
 
927
988
 
928
- #### **Conditions**
989
+ #### Conditions
929
990
 
930
991
  条件集合
931
992
 
932
- | 参数 | 说明 | 类型 | 默认值 | 必填项 |
933
- | ------ | ------------------------ | ---------- | ------ | ------ |
993
+ | 参数 | 说明 | 类型 | 默认值 | 必填项 |
994
+ | ------ | ------------------------ | ---------------- | ------ | ------ |
934
995
  | action | 执行动作，`显示`、`隐藏` | `show` 丨 `hide` | - | ✓ |
935
- | type | 条件类型：`并`、`或` | `and` 丨 `or` | - | ✓ |
996
+ | type | 条件类型：`并`、`或` | `and` 丨 `or` | - | ✓ |
936
997
 
937
998
  ##### Condition
938
999
 
@@ -953,7 +1014,7 @@ const App = () => {
953
1014
 
954
1015
 
955
1016
 
956
- #### **Collection**
1017
+ #### Collection
957
1018
 
958
1019
  集合：通过条件过滤组件中选项
959
1020
 
@@ -979,7 +1040,7 @@ const App = () => {
979
1040
 
980
1041
 
981
1042
 
982
- #### **Compute**
1043
+ #### Compute
983
1044
 
984
1045
  计算：结果赋值个value
985
1046
 
@@ -1006,18 +1067,18 @@ const App = () => {
1006
1067
  </Compute>
1007
1068
  ```
1008
1069
 
1009
- **注：**支持[moment](http://momentjs.cn)使用
1070
+ **注：** 支持[moment](http://momentjs.cn)使用
1010
1071
 
1011
1072
 
1012
1073
 
1013
- #### **Options**
1074
+ #### Options
1014
1075
 
1015
1076
  选项集合
1016
1077
 
1017
1078
  | 参数 | 说明 | 类型 | 默认值 | 必填项 |
1018
1079
  | ---- | ---- | ---- | ------ | ------ |
1019
1080
 
1020
- ##### **Option**
1081
+ ##### Option
1021
1082
 
1022
1083
  选项内容
1023
1084
 
@@ -1035,7 +1096,7 @@ const App = () => {
1035
1096
  </Options>
1036
1097
  ```
1037
1098
 
1038
- **注：**仅`Select`、`Checkbox`、`Radio`组件支持该子控件
1099
+ **注：** 仅`Select`、`Checkbox`、`Radio`组件支持该子控件
1039
1100
 
1040
1101
 
1041
1102
 
@@ -1043,18 +1104,18 @@ const App = () => {
1043
1104
 
1044
1105
 
1045
1106
 
1046
- ### **FormDesign标签**
1107
+ ### FormDocument标签
1047
1108
 
1048
- | 参数 | 说明 | 类型 | 默认值 | 必填项 |
1049
- | -------- | ------------------------------------------------------------ | ----------------------------- | ------ | ------ |
1050
- | document | xml document 由`容器`、`组件`、`控件`组成 | string | - | ✓ |
1051
- | form | form 控制实例，不提供时会自动创建 | React.RefObject<FormInstance> | - | |
1052
- | preview | 是否启用预览模式 | boolean | false | - |
1053
- | collapse | 是否显示启用展示标签`<Collapse>` | boolean | false | - |
1109
+ | 参数 | 说明 | 类型 | 默认值 | 必填项 |
1110
+ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | ------ | ------ |
1111
+ | document | xml document 由`容器`、`组件`、`控件`组成 | string | - | ✓ |
1112
+ | form | form 控制实例，不提供时会自动创建 | React.RefObject<FormInstance> | - | |
1113
+ | preview | 是否启用预览模式 | boolean | false | - |
1114
+ | collapse | 是否显示启用展示标签`<Collapse>` | boolean | false | - |
1054
1115
  | readonly | `boolean`：是否开启只读模式；`array`：开启只读模式，并以数组方式，指定需要只读字段；`object`：开启只读模式，并以对象方式，指定需要只读字段； | `boolean`丨`array`丨`object` | false | - |
1055
1116
  | hidden | `boolean`：是否开启隐藏模式；`array`：开启隐藏模式，并以数组方式，指定需要隐藏字段；`object`：开启隐藏模式，并以对象方式，指定需要隐藏字段； | `boolean`丨`array`丨`object` | false | - |
1056
- | params | 附加`fetch`请求的参数 | object | - | |
1057
- | 自定义 | 自定义标签属性及参数，可通过`context`方式获取 | any | - | |
1117
+ | params | 附加`fetch`请求的参数 | object | - | |
1118
+ | 自定义 | 自定义标签属性及参数，可通过`context`方式获取 | any | - | |
1058
1119
 
1059
1120
  **例：**
1060
1121
 
@@ -1137,21 +1198,21 @@ export default defineConfig({
1137
1198
 
1138
1199
  上传列表
1139
1200
 
1140
- | 参数 | 说明 | 类型 | 默认值 | 必填项 |
1141
- | --------------- | ------------------------------------------------------------ | ------- | ------ | ------ |
1142
- | style | css样式 | string | - | |
1143
- | code | 字段编号全局唯一 | string | - | ✓ |
1144
- | title | 字段标题 | string | - | ✓ |
1145
- | maxCount | 最大上传文件个数 | number | - | |
1146
- | fileSize | 单个文件最大字节；`1B`、`1KB`、`1MB`、`1GB`、`1TB`、`1PB` | string | - | |
1201
+ | 参数 | 说明 | 类型 | 默认值 | 必填项 |
1202
+ | --------------- | ------------------------------------------------------------------------------------------------------ | ------- | ------ | ------ |
1203
+ | style | css样式 | string | - | |
1204
+ | code | 字段编号全局唯一 | string | - | ✓ |
1205
+ | title | 字段标题 | string | - | ✓ |
1206
+ | maxCount | 最大上传文件个数 | number | - | |
1207
+ | fileSize | 单个文件最大字节；`1B`、`1KB`、`1MB`、`1GB`、`1TB`、`1PB` | string | - | |
1147
1208
  | fileType | 上传文件类型；[mime-type](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#accept) | string | - | |
1148
- | fileTypeMessage | 上传文件类型提示说明 | string | - | |
1149
- | defaultHide | 默认是否隐藏 | boolean | false | - |
1150
- | tips | 字段提示 | string | - | |
1151
- | hidden | 是否隐藏 | boolean | false | - |
1152
- | readonly | 是否只读 | boolean | false | - |
1153
- | labelCol | `title`布局，与同 `<Col>` 组件设置 | number | - | |
1154
- | wrapperCol | 组件布局，同 `<Col>` 组件设置 | number | - | |
1209
+ | fileTypeMessage | 上传文件类型提示说明 | string | - | |
1210
+ | defaultHide | 默认是否隐藏 | boolean | false | - |
1211
+ | tips | 字段提示 | string | - | |
1212
+ | hidden | 是否隐藏 | boolean | false | - |
1213
+ | readonly | 是否只读 | boolean | false | - |
1214
+ | labelCol | `title`布局，与同 `<Col>` 组件设置 | number | - | |
1215
+ | wrapperCol | 组件布局，同 `<Col>` 组件设置 | number | - | |
1155
1216
 
1156
1217
  **例：**
1157
1218