antd-form-document 5.0.7 → 5.0.9
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 +172 -64
- package/dist/index.tsx +1 -1
- package/dist/index.tsx.map +1 -1
- package/dist/src/components/Audio/index.d.ts +6 -0
- package/dist/src/components/Audio/index.d.ts.map +1 -0
- package/dist/src/components/Rate/index.d.ts +12 -0
- package/dist/src/components/Rate/index.d.ts.map +1 -0
- package/dist/src/components/Video/index.d.ts +6 -0
- package/dist/src/components/Video/index.d.ts.map +1 -0
- package/dist/src/components/index.d.ts +3 -0
- package/dist/src/components/index.d.ts.map +1 -1
- package/dist/src/config.d.ts +1 -1
- package/dist/src/config.d.ts.map +1 -1
- package/dist/src/form/index.d.ts +0 -1
- package/dist/src/form/index.d.ts.map +1 -1
- package/dist/src/preview/index.d.ts +3 -0
- package/dist/src/preview/index.d.ts.map +1 -1
- package/dist/src/service/UIComponent.d.ts.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
****# Antd-Form-Document
|
|
2
2
|
|
|
3
3
|
基于[ant-design](https://ant.design/) [cn](https://ant-design.gitee.io/) 表单设计
|
|
4
4
|
|
|
@@ -6,64 +6,66 @@
|
|
|
6
6
|
|
|
7
7
|
<!-- code_chunk_output -->
|
|
8
8
|
|
|
9
|
-
- [
|
|
10
|
-
|
|
11
|
-
- [
|
|
12
|
-
|
|
13
|
-
- [
|
|
14
|
-
- [
|
|
15
|
-
|
|
16
|
-
- [
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
- [
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
- [
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
- [
|
|
48
|
-
- [
|
|
49
|
-
|
|
50
|
-
- [
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
- [
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
9
|
+
- [一、安装](#一-安装)
|
|
10
|
+
- [二、示例](#二-示例)
|
|
11
|
+
- [XML Document 格式](#xml-document-格式)
|
|
12
|
+
- [三、XML 文档说明](#三-xml-文档说明)
|
|
13
|
+
- [表单](#表单)
|
|
14
|
+
- [Form](#form)
|
|
15
|
+
- [容器](#容器)
|
|
16
|
+
- [Row](#row)
|
|
17
|
+
- [Col](#col)
|
|
18
|
+
- [Divider](#divider)
|
|
19
|
+
- [Steps](#steps)
|
|
20
|
+
- [Step](#step)
|
|
21
|
+
- [Content](#content)
|
|
22
|
+
- [Collapse](#collapse)
|
|
23
|
+
- [Tabs](#tabs)
|
|
24
|
+
- [Card](#card)
|
|
25
|
+
- [组件](#组件)
|
|
26
|
+
- [Label](#label)
|
|
27
|
+
- [Tooltip](#tooltip)
|
|
28
|
+
- [Text](#text)
|
|
29
|
+
- [TextArea](#textarea)
|
|
30
|
+
- [Number](#number)
|
|
31
|
+
- [Editor](#editor)
|
|
32
|
+
- [Select](#select)
|
|
33
|
+
- [Checkbox](#checkbox)
|
|
34
|
+
- [Radio](#radio)
|
|
35
|
+
- [Switch](#switch)
|
|
36
|
+
- [Duration](#duration)
|
|
37
|
+
- [DatePicker](#datepicker)
|
|
38
|
+
- [TimePicker](#timepicker)
|
|
39
|
+
- [RangePicker](#rangepicker)
|
|
40
|
+
- [Rate](#rate)
|
|
41
|
+
- [Upload](#upload)
|
|
42
|
+
- [Photo](#photo)
|
|
43
|
+
- [Audio](#audio)
|
|
44
|
+
- [Video](#video)
|
|
45
|
+
- [SuperUpload](#superupload)
|
|
46
|
+
- [Table](#table)
|
|
47
|
+
- [Columns](#columns)
|
|
48
|
+
- [Column](#column)
|
|
49
|
+
- [FormList](#formlist)
|
|
50
|
+
- [Columns](#columns-1)
|
|
51
|
+
- [Column](#column-1)
|
|
52
|
+
- [注：](#注)
|
|
53
|
+
- [控件](#控件)
|
|
54
|
+
- [Validates](#validates)
|
|
55
|
+
- [Validate](#validate)
|
|
56
|
+
- [Conditions](#conditions)
|
|
57
|
+
- [Condition](#condition)
|
|
58
|
+
- [Collection](#collection)
|
|
59
|
+
- [Compute](#compute)
|
|
60
|
+
- [Options](#options)
|
|
61
|
+
- [Option](#option)
|
|
62
|
+
- [四、应用](#四-应用)
|
|
63
|
+
- [FormDocument标签](#formdocument标签)
|
|
64
|
+
- [Config配置](#config配置)
|
|
65
|
+
- [自定义组件](#自定义组件)
|
|
66
|
+
- [Department](#department)
|
|
67
|
+
- [UploadList](#uploadlist)
|
|
68
|
+
- [Sign](#sign)
|
|
67
69
|
|
|
68
70
|
<!-- /code_chunk_output -->
|
|
69
71
|
|
|
@@ -91,7 +93,9 @@ const App = () => {
|
|
|
91
93
|
id={121}
|
|
92
94
|
form={form}
|
|
93
95
|
document={documentString}
|
|
94
|
-
collapse={true}
|
|
96
|
+
collapse={true}
|
|
97
|
+
preview={true}
|
|
98
|
+
tooltip={false}
|
|
95
99
|
readonly={["name"]}}
|
|
96
100
|
initialValues={{name: "张三", xb: 'M', gender: "F", nationality:"778"}}
|
|
97
101
|
/>
|
|
@@ -876,6 +880,37 @@ const App = () => {
|
|
|
876
880
|
|
|
877
881
|
|
|
878
882
|
|
|
883
|
+
#### Rate
|
|
884
|
+
|
|
885
|
+
评分
|
|
886
|
+
|
|
887
|
+
| 参数 | 说明 | 类型 | 默认值 | 必填项 |
|
|
888
|
+
| ------------ | ---------------------------------- | ------- | ------ | ------ |
|
|
889
|
+
| code | 字段编号全局唯一 | string | - | ✓ |
|
|
890
|
+
| title | 字段标题 | string | - | ✓ |
|
|
891
|
+
| count | star 总数 | number | 5 | |
|
|
892
|
+
| allowHalf | 是否允许半选 | boolean | false | |
|
|
893
|
+
| defaultValue | 默认开关`value` | boolean | - | |
|
|
894
|
+
| defaultHide | 默认是否隐藏 | boolean | false | - |
|
|
895
|
+
| tips | 字段提示 | string | - | |
|
|
896
|
+
| hideClear | 是否在控件隐藏时清除数据 | boolean | false | - |
|
|
897
|
+
| hidden | 是否隐藏 | boolean | false | - |
|
|
898
|
+
| readonly | 是否只读 | boolean | false | - |
|
|
899
|
+
| labelCol | `title`布局，与同 `<Col>` 组件设置 | number | - | |
|
|
900
|
+
| wrapperCol | 组件布局，同 `<Col>` 组件设置 | number | - | |
|
|
901
|
+
| style | 组件样式 | string | - | |
|
|
902
|
+
| labelStyle | 标签样式 | string | - | |
|
|
903
|
+
| itemStyle | 表单样式 | string | - | |
|
|
904
|
+
|
|
905
|
+
**例：**
|
|
906
|
+
|
|
907
|
+
```xml
|
|
908
|
+
<Rate code="mark" title="评分" count="true">
|
|
909
|
+
XXX子控件
|
|
910
|
+
</Rate>
|
|
911
|
+
```
|
|
912
|
+
|
|
913
|
+
|
|
879
914
|
#### Upload
|
|
880
915
|
|
|
881
916
|
上传
|
|
@@ -912,7 +947,7 @@ const App = () => {
|
|
|
912
947
|
|
|
913
948
|
#### Photo
|
|
914
949
|
|
|
915
|
-
|
|
950
|
+
上传图片
|
|
916
951
|
|
|
917
952
|
| 参数 | 说明 | 类型 | 默认值 | 必填项 |
|
|
918
953
|
| --------------- | ------------------------------------------------------------------------------------------------------ | ------- | ------ | ------ |
|
|
@@ -941,6 +976,76 @@ const App = () => {
|
|
|
941
976
|
</Photo>
|
|
942
977
|
```
|
|
943
978
|
|
|
979
|
+
#### Audio
|
|
980
|
+
|
|
981
|
+
上传
|
|
982
|
+
|
|
983
|
+
| 参数 | 说明 | 类型 | 默认值 | 必填项 |
|
|
984
|
+
| --------------- | ------------------------------------------------------------------------------------------------------ | ------- | ------ | ------ |
|
|
985
|
+
| code | 字段编号全局唯一 | string | - | ✓ |
|
|
986
|
+
| title | 字段标题 | string | - | ✓ |
|
|
987
|
+
| maxCount | 最大上传文件个数 | number | - | ✓ |
|
|
988
|
+
| fileSize | 单个文件最大字节；`1B`、`1KB`、`1MB`、`1GB`、`1TB`、`1PB` | string | - | |
|
|
989
|
+
| fileWidth | 文件宽度比 | number | 100 | |
|
|
990
|
+
| fileHeight | 文件高度比 | number | 100 | |
|
|
991
|
+
| defaultHide | 默认是否隐藏 | boolean | false | - |
|
|
992
|
+
| tips | 字段提示 | string | - | |
|
|
993
|
+
| autoplay | 是否自动播放 | booolean | false | |
|
|
994
|
+
| muted | 是否静音 | booolean | false | |
|
|
995
|
+
| loop | 是否循环播放 | booolean | false | |
|
|
996
|
+
| preload | 预加载方式 | string | `auto`丨`metadata`丨`none` | |
|
|
997
|
+
| hideClear | 是否在控件隐藏时清除数据 | boolean | false | - |
|
|
998
|
+
| hidden | 是否隐藏 | boolean | false | - |
|
|
999
|
+
| readonly | 是否只读 | boolean | false | - |
|
|
1000
|
+
| labelCol | `title`布局，与同 `<Col>` 组件设置 | number | - | |
|
|
1001
|
+
| wrapperCol | 组件布局，同 `<Col>` 组件设置 | number | - | |
|
|
1002
|
+
| style | 组件样式 | string | - | |
|
|
1003
|
+
| labelStyle | 标签样式 | string | - | |
|
|
1004
|
+
| itemStyle | 表单样式 | string | - | |
|
|
1005
|
+
|
|
1006
|
+
**例：**
|
|
1007
|
+
|
|
1008
|
+
```xml
|
|
1009
|
+
<Audio code="mp3" title="音频" maxCount="2" fileSize="20MB" fileWidth="390" fileHeight="567" tips="按照要求上传音频！" preload="metadata">
|
|
1010
|
+
XXX子控件
|
|
1011
|
+
</Audio>
|
|
1012
|
+
```
|
|
1013
|
+
|
|
1014
|
+
#### Video
|
|
1015
|
+
|
|
1016
|
+
上传视频
|
|
1017
|
+
|
|
1018
|
+
| 参数 | 说明 | 类型 | 默认值 | 必填项 |
|
|
1019
|
+
| --------------- | ------------------------------------------------------------------------------------------------------ | ------- | ------ | ------ |
|
|
1020
|
+
| code | 字段编号全局唯一 | string | - | ✓ |
|
|
1021
|
+
| title | 字段标题 | string | - | ✓ |
|
|
1022
|
+
| maxCount | 最大上传文件个数 | number | - | ✓ |
|
|
1023
|
+
| fileSize | 单个文件最大字节；`1B`、`1KB`、`1MB`、`1GB`、`1TB`、`1PB` | string | - | |
|
|
1024
|
+
| fileWidth | 文件宽度比 | number | 100 | |
|
|
1025
|
+
| fileHeight | 文件高度比 | number | 100 | |
|
|
1026
|
+
| defaultHide | 默认是否隐藏 | boolean | false | - |
|
|
1027
|
+
| tips | 字段提示 | string | - | |
|
|
1028
|
+
| controls | 是否显示播放控件 | booolean | true | |
|
|
1029
|
+
| autoplay | 是否自动播放 | booolean | false | |
|
|
1030
|
+
| muted | 是否静音 | booolean | false | |
|
|
1031
|
+
| loop | 是否循环播放 | booolean | false | |
|
|
1032
|
+
| preload | 预加载方式 | string | `auto`丨`metadata`丨`none` | |
|
|
1033
|
+
| hideClear | 是否在控件隐藏时清除数据 | boolean | false | - |
|
|
1034
|
+
| hidden | 是否隐藏 | boolean | false | - |
|
|
1035
|
+
| readonly | 是否只读 | boolean | false | - |
|
|
1036
|
+
| labelCol | `title`布局，与同 `<Col>` 组件设置 | number | - | |
|
|
1037
|
+
| wrapperCol | 组件布局，同 `<Col>` 组件设置 | number | - | |
|
|
1038
|
+
| style | 组件样式 | string | - | |
|
|
1039
|
+
| labelStyle | 标签样式 | string | - | |
|
|
1040
|
+
| itemStyle | 表单样式 | string | - | |
|
|
1041
|
+
|
|
1042
|
+
**例：**
|
|
1043
|
+
|
|
1044
|
+
```xml
|
|
1045
|
+
<Video code="mp4" title="视频" maxCount="2" fileSize="200MB" fileWidth="390" fileHeight="567" tips="按照要求上传视频！" controls="true">
|
|
1046
|
+
XXX子控件
|
|
1047
|
+
</Video>
|
|
1048
|
+
```
|
|
944
1049
|
|
|
945
1050
|
|
|
946
1051
|
#### SuperUpload
|
|
@@ -1245,6 +1350,7 @@ const App = () => {
|
|
|
1245
1350
|
| document | xml document 由`容器`、`组件`、`控件`组成 | string | - | ✓ |
|
|
1246
1351
|
| form | form 控制实例，不提供时会自动创建 | React.RefObject<FormInstance> | - | |
|
|
1247
1352
|
| preview | 是否启用预览模式 | boolean | false | - |
|
|
1353
|
+
| tooltip | 是否显示提示框内容 | boolean | true | - |
|
|
1248
1354
|
| collapse | 是否显示启用展示标签`<Collapse>` | boolean | false | - |
|
|
1249
1355
|
| readonly | `boolean`：是否开启只读模式；`array`：开启只读模式，并以数组方式，指定需要只读字段；`object`：开启只读模式，并以对象方式，指定需要只读字段； | `boolean`丨`array`丨`object` | false | - |
|
|
1250
1356
|
| hidden | `boolean`：是否开启隐藏模式；`array`：开启隐藏模式，并以数组方式，指定需要隐藏字段；`object`：开启隐藏模式，并以对象方式，指定需要隐藏字段； | `boolean`丨`array`丨`object` | false | - |
|
|
@@ -1258,7 +1364,9 @@ const App = () => {
|
|
|
1258
1364
|
id={1}
|
|
1259
1365
|
form={form}
|
|
1260
1366
|
document={documentString}
|
|
1261
|
-
collapse={true}
|
|
1367
|
+
collapse={true}
|
|
1368
|
+
preview={true}
|
|
1369
|
+
tooltip={false}
|
|
1262
1370
|
readonly={['gender', 'code']}
|
|
1263
1371
|
initialValues={{name: "张三", gender: 'M'}}
|
|
1264
1372
|
/>
|
|
@@ -1271,7 +1379,7 @@ const App = () => {
|
|
|
1271
1379
|
| 参数 | 说明 | 类型 | 默认值 | 必填项 |
|
|
1272
1380
|
| ---------- | ---------- | ------ | ------ | ------ |
|
|
1273
1381
|
| components | 自定义组件 | object | - | |
|
|
1274
|
-
|
|
|
1382
|
+
| previewComponents | 预览组件 | { PreviewText`文本预览`、PreviewDuration`时长预览`、PreviewSwitch`切换预览`、PreviewList`列表预览`、PreviewImage`图片预览`、PreviewFile`文件预览` } | - | |
|
|
1275
1383
|
| request | 请求参数 | object | - | |
|
|
1276
1384
|
| file | 文件参数 | object | - | |
|
|
1277
1385
|
| chunk | 大文件上传参数 | object | - | |
|
|
@@ -1286,7 +1394,7 @@ export default defineConfig({
|
|
|
1286
1394
|
Department,
|
|
1287
1395
|
UploadList
|
|
1288
1396
|
},
|
|
1289
|
-
|
|
1397
|
+
previewComponents: {
|
|
1290
1398
|
PreviewFile
|
|
1291
1399
|
},
|
|
1292
1400
|
mimeType: {
|