| 1 | {
|
| 2 | "name": "Form",
|
| 3 | "props": {
|
| 4 | "prefix": {
|
| 5 | "type": {
|
| 6 | "name": "string"
|
| 7 | },
|
| 8 | "required": false,
|
| 9 | "description": "样式前缀",
|
| 10 | "defaultValue": {
|
| 11 | "value": "'next-'",
|
| 12 | "computed": false
|
| 13 | },
|
| 14 | "docblock": "样式前缀"
|
| 15 | },
|
| 16 | "inline": {
|
| 17 | "type": {
|
| 18 | "name": "bool"
|
| 19 | },
|
| 20 | "required": false,
|
| 21 | "description": "内联表单",
|
| 22 | "docblock": "内联表单"
|
| 23 | },
|
| 24 | "size": {
|
| 25 | "type": {
|
| 26 | "name": "enum",
|
| 27 | "value": [
|
| 28 | {
|
| 29 | "value": "'large'",
|
| 30 | "computed": false,
|
| 31 | "description": "大"
|
| 32 | },
|
| 33 | {
|
| 34 | "value": "'medium'",
|
| 35 | "computed": false,
|
| 36 | "description": "中"
|
| 37 | },
|
| 38 | {
|
| 39 | "value": "'small'",
|
| 40 | "computed": false,
|
| 41 | "description": "小"
|
| 42 | }
|
| 43 | ]
|
| 44 | },
|
| 45 | "required": false,
|
| 46 | "description": "单个 Item 的 size 自定义，优先级高于 Form 的 size, 并且当组件与 Item 一起使用时，组件自身设置 size 属性无效。",
|
| 47 | "defaultValue": {
|
| 48 | "value": "'medium'",
|
| 49 | "computed": false
|
| 50 | },
|
| 51 | "docblock": "单个 Item 的 size 自定义，优先级高于 Form 的 size, 并且当组件与 Item 一起使用时，组件自身设置 size 属性无效。\n@enumdesc 大, 中, 小",
|
| 52 | "value": [
|
| 53 | {
|
| 54 | "value": "'large'",
|
| 55 | "computed": false,
|
| 56 | "description": "大"
|
| 57 | },
|
| 58 | {
|
| 59 | "value": "'medium'",
|
| 60 | "computed": false,
|
| 61 | "description": "中"
|
| 62 | },
|
| 63 | {
|
| 64 | "value": "'small'",
|
| 65 | "computed": false,
|
| 66 | "description": "小"
|
| 67 | }
|
| 68 | ]
|
| 69 | },
|
| 70 | "fullWidth": {
|
| 71 | "type": {
|
| 72 | "name": "bool"
|
| 73 | },
|
| 74 | "required": false,
|
| 75 | "description": "单个 Item 中表单类组件宽度是否是100%",
|
| 76 | "docblock": "单个 Item 中表单类组件宽度是否是100%"
|
| 77 | },
|
| 78 | "labelAlign": {
|
| 79 | "type": {
|
| 80 | "name": "enum",
|
| 81 | "value": [
|
| 82 | {
|
| 83 | "value": "'top'",
|
| 84 | "computed": false,
|
| 85 | "description": "上"
|
| 86 | },
|
| 87 | {
|
| 88 | "value": "'left'",
|
| 89 | "computed": false,
|
| 90 | "description": "左"
|
| 91 | },
|
| 92 | {
|
| 93 | "value": "'inset'",
|
| 94 | "computed": false,
|
| 95 | "description": "内"
|
| 96 | }
|
| 97 | ]
|
| 98 | },
|
| 99 | "required": false,
|
| 100 | "description": "标签的位置, 如果不设置 labelCol 和 wrapperCol 那么默认是标签在上",
|
| 101 | "defaultValue": {
|
| 102 | "value": "'left'",
|
| 103 | "computed": false
|
| 104 | },
|
| 105 | "docblock": "标签的位置, 如果不设置 labelCol 和 wrapperCol 那么默认是标签在上\n@enumdesc 上, 左, 内",
|
| 106 | "value": [
|
| 107 | {
|
| 108 | "value": "'top'",
|
| 109 | "computed": false,
|
| 110 | "description": "上"
|
| 111 | },
|
| 112 | {
|
| 113 | "value": "'left'",
|
| 114 | "computed": false,
|
| 115 | "description": "左"
|
| 116 | },
|
| 117 | {
|
| 118 | "value": "'inset'",
|
| 119 | "computed": false,
|
| 120 | "description": "内"
|
| 121 | }
|
| 122 | ]
|
| 123 | },
|
| 124 | "labelTextAlign": {
|
| 125 | "type": {
|
| 126 | "name": "enum",
|
| 127 | "value": [
|
| 128 | {
|
| 129 | "value": "'left'",
|
| 130 | "computed": false,
|
| 131 | "description": "左"
|
| 132 | },
|
| 133 | {
|
| 134 | "value": "'right'",
|
| 135 | "computed": false,
|
| 136 | "description": "右"
|
| 137 | }
|
| 138 | ]
|
| 139 | },
|
| 140 | "required": false,
|
| 141 | "description": "标签的左右对齐方式",
|
| 142 | "docblock": "标签的左右对齐方式\n@enumdesc 左, 右",
|
| 143 | "value": [
|
| 144 | {
|
| 145 | "value": "'left'",
|
| 146 | "computed": false,
|
| 147 | "description": "左"
|
| 148 | },
|
| 149 | {
|
| 150 | "value": "'right'",
|
| 151 | "computed": false,
|
| 152 | "description": "右"
|
| 153 | }
|
| 154 | ]
|
| 155 | },
|
| 156 | "field": {
|
| 157 | "type": {
|
| 158 | "name": "any"
|
| 159 | },
|
| 160 | "required": false,
|
| 161 | "description": "field 实例, 传 false 会禁用 field",
|
| 162 | "docblock": "field 实例, 传 false 会禁用 field"
|
| 163 | },
|
| 164 | "saveField": {
|
| 165 | "type": {
|
| 166 | "name": "func"
|
| 167 | },
|
| 168 | "required": false,
|
| 169 | "description": "保存 Form 自动生成的 field 对象",
|
| 170 | "defaultValue": {
|
| 171 | "value": "func.noop",
|
| 172 | "computed": true
|
| 173 | },
|
| 174 | "docblock": "保存 Form 自动生成的 field 对象",
|
| 175 | "params": [],
|
| 176 | "returns": null
|
| 177 | },
|
| 178 | "labelCol": {
|
| 179 | "type": {
|
| 180 | "name": "object"
|
| 181 | },
|
| 182 | "required": false,
|
| 183 | "description": "控制第一级 Item 的 labelCol",
|
| 184 | "docblock": "控制第一级 Item 的 labelCol",
|
| 185 | "properties": []
|
| 186 | },
|
| 187 | "wrapperCol": {
|
| 188 | "type": {
|
| 189 | "name": "object"
|
| 190 | },
|
| 191 | "required": false,
|
| 192 | "description": "控制第一级 Item 的 wrapperCol",
|
| 193 | "docblock": "控制第一级 Item 的 wrapperCol",
|
| 194 | "properties": []
|
| 195 | },
|
| 196 | "onSubmit": {
|
| 197 | "type": {
|
| 198 | "name": "func"
|
| 199 | },
|
| 200 | "required": false,
|
| 201 | "description": "form内有 `htmlType=\"submit\"` 的元素的时候会触发",
|
| 202 | "defaultValue": {
|
| 203 | "value": "function preventDefault(e) {\n e.preventDefault();\n}",
|
| 204 | "computed": false
|
| 205 | },
|
| 206 | "docblock": "form内有 `htmlType=\"submit\"` 的元素的时候会触发",
|
| 207 | "params": [],
|
| 208 | "returns": null
|
| 209 | },
|
| 210 | "children": {
|
| 211 | "type": {
|
| 212 | "name": "any"
|
| 213 | },
|
| 214 | "required": false,
|
| 215 | "description": "子元素",
|
| 216 | "docblock": "子元素"
|
| 217 | },
|
| 218 | "className": {
|
| 219 | "type": {
|
| 220 | "name": "string"
|
| 221 | },
|
| 222 | "required": false,
|
| 223 | "description": "扩展class",
|
| 224 | "docblock": "扩展class"
|
| 225 | },
|
| 226 | "style": {
|
| 227 | "type": {
|
| 228 | "name": "object"
|
| 229 | },
|
| 230 | "required": false,
|
| 231 | "description": "自定义内联样式",
|
| 232 | "docblock": "自定义内联样式",
|
| 233 | "properties": []
|
| 234 | },
|
| 235 | "value": {
|
| 236 | "type": {
|
| 237 | "name": "object"
|
| 238 | },
|
| 239 | "required": false,
|
| 240 | "description": "表单数值",
|
| 241 | "docblock": "表单数值",
|
| 242 | "properties": []
|
| 243 | },
|
| 244 | "onChange": {
|
| 245 | "type": {
|
| 246 | "name": "func"
|
| 247 | },
|
| 248 | "required": false,
|
| 249 | "description": "表单变化回调",
|
| 250 | "defaultValue": {
|
| 251 | "value": "func.noop",
|
| 252 | "computed": true
|
| 253 | },
|
| 254 | "docblock": "表单变化回调\n@param {Object} values 表单数据\n@param {Object} item 详细\n@param {String} item.name 变化的组件名\n@param {String} item.value 变化的数据\n@param {Object} item.field field 实例",
|
| 255 | "params": [
|
| 256 | {
|
| 257 | "name": "values",
|
| 258 | "description": "表单数据",
|
| 259 | "type": {
|
| 260 | "name": "Object"
|
| 261 | }
|
| 262 | },
|
| 263 | {
|
| 264 | "name": "item",
|
| 265 | "description": "详细",
|
| 266 | "type": {
|
| 267 | "name": "Object"
|
| 268 | }
|
| 269 | },
|
| 270 | {
|
| 271 | "name": "item.name",
|
| 272 | "description": "变化的组件名",
|
| 273 | "type": {
|
| 274 | "name": "String"
|
| 275 | }
|
| 276 | },
|
| 277 | {
|
| 278 | "name": "item.value",
|
| 279 | "description": "变化的数据",
|
| 280 | "type": {
|
| 281 | "name": "String"
|
| 282 | }
|
| 283 | },
|
| 284 | {
|
| 285 | "name": "item.field",
|
| 286 | "description": "field 实例",
|
| 287 | "type": {
|
| 288 | "name": "Object"
|
| 289 | }
|
| 290 | }
|
| 291 | ],
|
| 292 | "returns": null
|
| 293 | },
|
| 294 | "component": {
|
| 295 | "type": {
|
| 296 | "name": "union",
|
| 297 | "value": [
|
| 298 | {
|
| 299 | "name": "string"
|
| 300 | },
|
| 301 | {
|
| 302 | "name": "func"
|
| 303 | }
|
| 304 | ]
|
| 305 | },
|
| 306 | "required": false,
|
| 307 | "description": "设置标签类型",
|
| 308 | "defaultValue": {
|
| 309 | "value": "'form'",
|
| 310 | "computed": false
|
| 311 | },
|
| 312 | "docblock": "设置标签类型"
|
| 313 | },
|
| 314 | "device": {
|
| 315 | "type": {
|
| 316 | "name": "enum",
|
| 317 | "value": [
|
| 318 | {
|
| 319 | "value": "'phone'",
|
| 320 | "computed": false
|
| 321 | },
|
| 322 | {
|
| 323 | "value": "'tablet'",
|
| 324 | "computed": false
|
| 325 | },
|
| 326 | {
|
| 327 | "value": "'desktop'",
|
| 328 | "computed": false
|
| 329 | }
|
| 330 | ]
|
| 331 | },
|
| 332 | "required": false,
|
| 333 | "description": "预设屏幕宽度",
|
| 334 | "defaultValue": {
|
| 335 | "value": "'desktop'",
|
| 336 | "computed": false
|
| 337 | },
|
| 338 | "docblock": "预设屏幕宽度"
|
| 339 | },
|
| 340 | "responsive": {
|
| 341 | "type": {
|
| 342 | "name": "bool"
|
| 343 | },
|
| 344 | "required": false,
|
| 345 | "description": "是否开启内置的响应式布局 （使用ResponsiveGrid）",
|
| 346 | "docblock": "是否开启内置的响应式布局 （使用ResponsiveGrid）\n@version 1.19",
|
| 347 | "version": {
|
| 348 | "value": "1.19",
|
| 349 | "computed": false
|
| 350 | }
|
| 351 | },
|
| 352 | "isPreview": {
|
| 353 | "type": {
|
| 354 | "name": "bool"
|
| 355 | },
|
| 356 | "required": false,
|
| 357 | "description": "是否开启预览态",
|
| 358 | "docblock": "是否开启预览态\n@version 1.19",
|
| 359 | "version": {
|
| 360 | "value": "1.19",
|
| 361 | "computed": false
|
| 362 | }
|
| 363 | },
|
| 364 | "useLabelForErrorMessage": {
|
| 365 | "type": {
|
| 366 | "name": "bool"
|
| 367 | },
|
| 368 | "required": false,
|
| 369 | "description": "是否使用 label 替换校验信息的 name 字段",
|
| 370 | "docblock": "是否使用 label 替换校验信息的 name 字段\n@version 1.20",
|
| 371 | "version": {
|
| 372 | "value": "1.20",
|
| 373 | "computed": false
|
| 374 | }
|
| 375 | },
|
| 376 | "colon": {
|
| 377 | "type": {
|
| 378 | "name": "bool"
|
| 379 | },
|
| 380 | "required": false,
|
| 381 | "description": "表示是否显示 label 后面的冒号",
|
| 382 | "defaultValue": {
|
| 383 | "value": "false",
|
| 384 | "computed": false
|
| 385 | },
|
| 386 | "docblock": "表示是否显示 label 后面的冒号\n@version 1.22",
|
| 387 | "version": {
|
| 388 | "value": "1.22",
|
| 389 | "computed": false
|
| 390 | }
|
| 391 | },
|
| 392 | "disabled": {
|
| 393 | "type": {
|
| 394 | "name": "bool"
|
| 395 | },
|
| 396 | "required": false,
|
| 397 | "description": "是否禁用表单",
|
| 398 | "defaultValue": {
|
| 399 | "value": "false",
|
| 400 | "computed": false
|
| 401 | },
|
| 402 | "docblock": "是否禁用表单"
|
| 403 | }
|
| 404 | },
|
| 405 | "methods": [],
|
| 406 | "subComponents": [
|
| 407 | {
|
| 408 | "name": "Item",
|
| 409 | "props": {
|
| 410 | "prefix": {
|
| 411 | "type": {
|
| 412 | "name": "string"
|
| 413 | },
|
| 414 | "required": false,
|
| 415 | "description": "样式前缀",
|
| 416 | "defaultValue": {
|
| 417 | "value": "'next-'",
|
| 418 | "computed": false
|
| 419 | },
|
| 420 | "docblock": "样式前缀"
|
| 421 | },
|
| 422 | "label": {
|
| 423 | "type": {
|
| 424 | "name": "node"
|
| 425 | },
|
| 426 | "required": false,
|
| 427 | "description": "label 标签的文本",
|
| 428 | "docblock": "label 标签的文本"
|
| 429 | },
|
| 430 | "labelCol": {
|
| 431 | "type": {
|
| 432 | "name": "object"
|
| 433 | },
|
| 434 | "required": false,
|
| 435 | "description": "label 标签布局，通 `<Col>` 组件，设置 span offset 值，如 {span: 8, offset: 16}，该项仅在垂直表单有效",
|
| 436 | "docblock": "label 标签布局，通 `<Col>` 组件，设置 span offset 值，如 {span: 8, offset: 16}，该项仅在垂直表单有效",
|
| 437 | "properties": []
|
| 438 | },
|
| 439 | "wrapperCol": {
|
| 440 | "type": {
|
| 441 | "name": "object"
|
| 442 | },
|
| 443 | "required": false,
|
| 444 | "description": "需要为输入控件设置布局样式时，使用该属性，用法同 labelCol",
|
| 445 | "docblock": "需要为输入控件设置布局样式时，使用该属性，用法同 labelCol",
|
| 446 | "properties": []
|
| 447 | },
|
| 448 | "help": {
|
| 449 | "type": {
|
| 450 | "name": "node"
|
| 451 | },
|
| 452 | "required": false,
|
| 453 | "description": "自定义提示信息，如不设置，则会根据校验规则自动生成.",
|
| 454 | "docblock": "自定义提示信息，如不设置，则会根据校验规则自动生成."
|
| 455 | },
|
| 456 | "name": {
|
| 457 | "type": {
|
| 458 | "name": "string"
|
| 459 | },
|
| 460 | "required": false,
|
| 461 | "description": "字段名，默认赋值给第一个子元素",
|
| 462 | "docblock": "字段名，默认赋值给第一个子元素"
|
| 463 | },
|
| 464 | "extra": {
|
| 465 | "type": {
|
| 466 | "name": "node"
|
| 467 | },
|
| 468 | "required": false,
|
| 469 | "description": "额外的提示信息，和 help 类似，当需要错误信息和提示文案同时出现时，可以使用这个。 位于错误信息后面",
|
| 470 | "docblock": "额外的提示信息，和 help 类似，当需要错误信息和提示文案同时出现时，可以使用这个。 位于错误信息后面"
|
| 471 | },
|
| 472 | "validateState": {
|
| 473 | "type": {
|
| 474 | "name": "enum",
|
| 475 | "value": [
|
| 476 | {
|
| 477 | "value": "'error'",
|
| 478 | "computed": false,
|
| 479 | "description": "失败"
|
| 480 | },
|
| 481 | {
|
| 482 | "value": "'success'",
|
| 483 | "computed": false,
|
| 484 | "description": "成功"
|
| 485 | },
|
| 486 | {
|
| 487 | "value": "'loading'",
|
| 488 | "computed": false,
|
| 489 | "description": "校验中"
|
| 490 | },
|
| 491 | {
|
| 492 | "value": "'warning'",
|
| 493 | "computed": false,
|
| 494 | "description": "警告"
|
| 495 | }
|
| 496 | ]
|
| 497 | },
|
| 498 | "required": false,
|
| 499 | "description": "校验状态，如不设置，则会根据校验规则自动生成",
|
| 500 | "docblock": "校验状态，如不设置，则会根据校验规则自动生成\n@enumdesc 失败, 成功, 校验中, 警告",
|
| 501 | "value": [
|
| 502 | {
|
| 503 | "value": "'error'",
|
| 504 | "computed": false,
|
| 505 | "description": "失败"
|
| 506 | },
|
| 507 | {
|
| 508 | "value": "'success'",
|
| 509 | "computed": false,
|
| 510 | "description": "成功"
|
| 511 | },
|
| 512 | {
|
| 513 | "value": "'loading'",
|
| 514 | "computed": false,
|
| 515 | "description": "校验中"
|
| 516 | },
|
| 517 | {
|
| 518 | "value": "'warning'",
|
| 519 | "computed": false,
|
| 520 | "description": "警告"
|
| 521 | }
|
| 522 | ]
|
| 523 | },
|
| 524 | "hasFeedback": {
|
| 525 | "type": {
|
| 526 | "name": "bool"
|
| 527 | },
|
| 528 | "required": false,
|
| 529 | "description": "配合 validateState 属性使用，是否展示 success/loading 的校验状态图标, 目前只有Input支持",
|
| 530 | "defaultValue": {
|
| 531 | "value": "false",
|
| 532 | "computed": false
|
| 533 | },
|
| 534 | "docblock": "配合 validateState 属性使用，是否展示 success/loading 的校验状态图标, 目前只有Input支持"
|
| 535 | },
|
| 536 | "style": {
|
| 537 | "type": {
|
| 538 | "name": "object"
|
| 539 | },
|
| 540 | "required": false,
|
| 541 | "description": "自定义内联样式",
|
| 542 | "docblock": "自定义内联样式",
|
| 543 | "properties": []
|
| 544 | },
|
| 545 | "children": {
|
| 546 | "type": {
|
| 547 | "name": "union",
|
| 548 | "value": [
|
| 549 | {
|
| 550 | "name": "node"
|
| 551 | },
|
| 552 | {
|
| 553 | "name": "func"
|
| 554 | }
|
| 555 | ]
|
| 556 | },
|
| 557 | "required": false,
|
| 558 | "description": "node 或者 function(values)",
|
| 559 | "docblock": "node 或者 function(values)"
|
| 560 | },
|
| 561 | "size": {
|
| 562 | "type": {
|
| 563 | "name": "enum",
|
| 564 | "value": [
|
| 565 | {
|
| 566 | "value": "'large'",
|
| 567 | "computed": false
|
| 568 | },
|
| 569 | {
|
| 570 | "value": "'small'",
|
| 571 | "computed": false
|
| 572 | },
|
| 573 | {
|
| 574 | "value": "'medium'",
|
| 575 | "computed": false
|
| 576 | }
|
| 577 | ]
|
| 578 | },
|
| 579 | "required": false,
|
| 580 | "description": "单个 Item 的 size 自定义，优先级高于 Form 的 size, 并且当组件与 Item 一起使用时，组件自身设置 size 属性无效。",
|
| 581 | "docblock": "单个 Item 的 size 自定义，优先级高于 Form 的 size, 并且当组件与 Item 一起使用时，组件自身设置 size 属性无效。"
|
| 582 | },
|
| 583 | "fullWidth": {
|
| 584 | "type": {
|
| 585 | "name": "bool"
|
| 586 | },
|
| 587 | "required": false,
|
| 588 | "description": "单个 Item 中表单类组件宽度是否是100%",
|
| 589 | "docblock": "单个 Item 中表单类组件宽度是否是100%"
|
| 590 | },
|
| 591 | "labelAlign": {
|
| 592 | "type": {
|
| 593 | "name": "enum",
|
| 594 | "value": [
|
| 595 | {
|
| 596 | "value": "'top'",
|
| 597 | "computed": false,
|
| 598 | "description": "上"
|
| 599 | },
|
| 600 | {
|
| 601 | "value": "'left'",
|
| 602 | "computed": false,
|
| 603 | "description": "左"
|
| 604 | },
|
| 605 | {
|
| 606 | "value": "'inset'",
|
| 607 | "computed": false,
|
| 608 | "description": "内"
|
| 609 | }
|
| 610 | ]
|
| 611 | },
|
| 612 | "required": false,
|
| 613 | "description": "标签的位置, 如果不设置 labelCol 和 wrapperCol 那么默认是标签在上",
|
| 614 | "docblock": "标签的位置, 如果不设置 labelCol 和 wrapperCol 那么默认是标签在上\n@enumdesc 上, 左, 内",
|
| 615 | "value": [
|
| 616 | {
|
| 617 | "value": "'top'",
|
| 618 | "computed": false,
|
| 619 | "description": "上"
|
| 620 | },
|
| 621 | {
|
| 622 | "value": "'left'",
|
| 623 | "computed": false,
|
| 624 | "description": "左"
|
| 625 | },
|
| 626 | {
|
| 627 | "value": "'inset'",
|
| 628 | "computed": false,
|
| 629 | "description": "内"
|
| 630 | }
|
| 631 | ]
|
| 632 | },
|
| 633 | "labelTextAlign": {
|
| 634 | "type": {
|
| 635 | "name": "enum",
|
| 636 | "value": [
|
| 637 | {
|
| 638 | "value": "'left'",
|
| 639 | "computed": false,
|
| 640 | "description": "左"
|
| 641 | },
|
| 642 | {
|
| 643 | "value": "'right'",
|
| 644 | "computed": false,
|
| 645 | "description": "右"
|
| 646 | }
|
| 647 | ]
|
| 648 | },
|
| 649 | "required": false,
|
| 650 | "description": "标签的左右对齐方式",
|
| 651 | "docblock": "标签的左右对齐方式\n@enumdesc 左, 右",
|
| 652 | "value": [
|
| 653 | {
|
| 654 | "value": "'left'",
|
| 655 | "computed": false,
|
| 656 | "description": "左"
|
| 657 | },
|
| 658 | {
|
| 659 | "value": "'right'",
|
| 660 | "computed": false,
|
| 661 | "description": "右"
|
| 662 | }
|
| 663 | ]
|
| 664 | },
|
| 665 | "className": {
|
| 666 | "type": {
|
| 667 | "name": "string"
|
| 668 | },
|
| 669 | "required": false,
|
| 670 | "description": "扩展class",
|
| 671 | "docblock": "扩展class"
|
| 672 | },
|
| 673 | "required": {
|
| 674 | "type": {
|
| 675 | "name": "bool"
|
| 676 | },
|
| 677 | "required": false,
|
| 678 | "description": "[表单校验] 不能为空",
|
| 679 | "docblock": "[表单校验] 不能为空"
|
| 680 | },
|
| 681 | "asterisk": {
|
| 682 | "type": {
|
| 683 | "name": "bool"
|
| 684 | },
|
| 685 | "required": false,
|
| 686 | "description": "required 的星号是否显示",
|
| 687 | "docblock": "required 的星号是否显示"
|
| 688 | },
|
| 689 | "requiredMessage": {
|
| 690 | "type": {
|
| 691 | "name": "string"
|
| 692 | },
|
| 693 | "required": false,
|
| 694 | "description": "required 自定义错误信息",
|
| 695 | "docblock": "required 自定义错误信息"
|
| 696 | },
|
| 697 | "requiredTrigger": {
|
| 698 | "type": {
|
| 699 | "name": "union",
|
| 700 | "value": [
|
| 701 | {
|
| 702 | "name": "string"
|
| 703 | },
|
| 704 | {
|
| 705 | "name": "array"
|
| 706 | }
|
| 707 | ]
|
| 708 | },
|
| 709 | "required": false,
|
| 710 | "description": "required 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/...",
|
| 711 | "docblock": "required 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/..."
|
| 712 | },
|
| 713 | "min": {
|
| 714 | "type": {
|
| 715 | "name": "number"
|
| 716 | },
|
| 717 | "required": false,
|
| 718 | "description": "[表单校验] 最小值",
|
| 719 | "docblock": "[表单校验] 最小值"
|
| 720 | },
|
| 721 | "max": {
|
| 722 | "type": {
|
| 723 | "name": "number"
|
| 724 | },
|
| 725 | "required": false,
|
| 726 | "description": "[表单校验] 最大值",
|
| 727 | "docblock": "[表单校验] 最大值"
|
| 728 | },
|
| 729 | "minmaxMessage": {
|
| 730 | "type": {
|
| 731 | "name": "string"
|
| 732 | },
|
| 733 | "required": false,
|
| 734 | "description": "min/max 自定义错误信息",
|
| 735 | "docblock": "min/max 自定义错误信息"
|
| 736 | },
|
| 737 | "minmaxTrigger": {
|
| 738 | "type": {
|
| 739 | "name": "union",
|
| 740 | "value": [
|
| 741 | {
|
| 742 | "name": "string"
|
| 743 | },
|
| 744 | {
|
| 745 | "name": "array"
|
| 746 | }
|
| 747 | ]
|
| 748 | },
|
| 749 | "required": false,
|
| 750 | "description": "min/max 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/...",
|
| 751 | "docblock": "min/max 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/..."
|
| 752 | },
|
| 753 | "minLength": {
|
| 754 | "type": {
|
| 755 | "name": "number"
|
| 756 | },
|
| 757 | "required": false,
|
| 758 | "description": "[表单校验] 字符串最小长度 / 数组最小个数",
|
| 759 | "docblock": "[表单校验] 字符串最小长度 / 数组最小个数"
|
| 760 | },
|
| 761 | "maxLength": {
|
| 762 | "type": {
|
| 763 | "name": "number"
|
| 764 | },
|
| 765 | "required": false,
|
| 766 | "description": "[表单校验] 字符串最大长度 / 数组最大个数",
|
| 767 | "docblock": "[表单校验] 字符串最大长度 / 数组最大个数"
|
| 768 | },
|
| 769 | "minmaxLengthMessage": {
|
| 770 | "type": {
|
| 771 | "name": "string"
|
| 772 | },
|
| 773 | "required": false,
|
| 774 | "description": "minLength/maxLength 自定义错误信息",
|
| 775 | "docblock": "minLength/maxLength 自定义错误信息"
|
| 776 | },
|
| 777 | "minmaxLengthTrigger": {
|
| 778 | "type": {
|
| 779 | "name": "union",
|
| 780 | "value": [
|
| 781 | {
|
| 782 | "name": "string"
|
| 783 | },
|
| 784 | {
|
| 785 | "name": "array"
|
| 786 | }
|
| 787 | ]
|
| 788 | },
|
| 789 | "required": false,
|
| 790 | "description": "minLength/maxLength 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/...",
|
| 791 | "docblock": "minLength/maxLength 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/..."
|
| 792 | },
|
| 793 | "length": {
|
| 794 | "type": {
|
| 795 | "name": "number"
|
| 796 | },
|
| 797 | "required": false,
|
| 798 | "description": "[表单校验] 字符串精确长度 / 数组精确个数",
|
| 799 | "docblock": "[表单校验] 字符串精确长度 / 数组精确个数"
|
| 800 | },
|
| 801 | "lengthMessage": {
|
| 802 | "type": {
|
| 803 | "name": "string"
|
| 804 | },
|
| 805 | "required": false,
|
| 806 | "description": "length 自定义错误信息",
|
| 807 | "docblock": "length 自定义错误信息"
|
| 808 | },
|
| 809 | "lengthTrigger": {
|
| 810 | "type": {
|
| 811 | "name": "union",
|
| 812 | "value": [
|
| 813 | {
|
| 814 | "name": "string"
|
| 815 | },
|
| 816 | {
|
| 817 | "name": "array"
|
| 818 | }
|
| 819 | ]
|
| 820 | },
|
| 821 | "required": false,
|
| 822 | "description": "length 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/...",
|
| 823 | "docblock": "length 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/..."
|
| 824 | },
|
| 825 | "pattern": {
|
| 826 | "type": {
|
| 827 | "name": "any"
|
| 828 | },
|
| 829 | "required": false,
|
| 830 | "description": "正则校验",
|
| 831 | "docblock": "正则校验"
|
| 832 | },
|
| 833 | "patternMessage": {
|
| 834 | "type": {
|
| 835 | "name": "string"
|
| 836 | },
|
| 837 | "required": false,
|
| 838 | "description": "pattern 自定义错误信息",
|
| 839 | "docblock": "pattern 自定义错误信息"
|
| 840 | },
|
| 841 | "patternTrigger": {
|
| 842 | "type": {
|
| 843 | "name": "union",
|
| 844 | "value": [
|
| 845 | {
|
| 846 | "name": "string"
|
| 847 | },
|
| 848 | {
|
| 849 | "name": "array"
|
| 850 | }
|
| 851 | ]
|
| 852 | },
|
| 853 | "required": false,
|
| 854 | "description": "pattern 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/...",
|
| 855 | "docblock": "pattern 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/..."
|
| 856 | },
|
| 857 | "format": {
|
| 858 | "type": {
|
| 859 | "name": "enum",
|
| 860 | "value": [
|
| 861 | {
|
| 862 | "value": "'number'",
|
| 863 | "computed": false
|
| 864 | },
|
| 865 | {
|
| 866 | "value": "'email'",
|
| 867 | "computed": false
|
| 868 | },
|
| 869 | {
|
| 870 | "value": "'url'",
|
| 871 | "computed": false
|
| 872 | },
|
| 873 | {
|
| 874 | "value": "'tel'",
|
| 875 | "computed": false
|
| 876 | }
|
| 877 | ]
|
| 878 | },
|
| 879 | "required": false,
|
| 880 | "description": "[表单校验] 四种常用的 pattern",
|
| 881 | "docblock": "[表单校验] 四种常用的 pattern"
|
| 882 | },
|
| 883 | "formatMessage": {
|
| 884 | "type": {
|
| 885 | "name": "string"
|
| 886 | },
|
| 887 | "required": false,
|
| 888 | "description": "format 自定义错误信息",
|
| 889 | "docblock": "format 自定义错误信息"
|
| 890 | },
|
| 891 | "formatTrigger": {
|
| 892 | "type": {
|
| 893 | "name": "union",
|
| 894 | "value": [
|
| 895 | {
|
| 896 | "name": "string"
|
| 897 | },
|
| 898 | {
|
| 899 | "name": "array"
|
| 900 | }
|
| 901 | ]
|
| 902 | },
|
| 903 | "required": false,
|
| 904 | "description": "format 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/...",
|
| 905 | "docblock": "format 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/..."
|
| 906 | },
|
| 907 | "validator": {
|
| 908 | "type": {
|
| 909 | "name": "func"
|
| 910 | },
|
| 911 | "required": false,
|
| 912 | "description": "[表单校验] 自定义校验函数",
|
| 913 | "docblock": "[表单校验] 自定义校验函数",
|
| 914 | "params": [],
|
| 915 | "returns": null
|
| 916 | },
|
| 917 | "validatorTrigger": {
|
| 918 | "type": {
|
| 919 | "name": "union",
|
| 920 | "value": [
|
| 921 | {
|
| 922 | "name": "string"
|
| 923 | },
|
| 924 | {
|
| 925 | "name": "array"
|
| 926 | }
|
| 927 | ]
|
| 928 | },
|
| 929 | "required": false,
|
| 930 | "description": "validator 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/...",
|
| 931 | "docblock": "validator 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/..."
|
| 932 | },
|
| 933 | "autoValidate": {
|
| 934 | "type": {
|
| 935 | "name": "bool"
|
| 936 | },
|
| 937 | "required": false,
|
| 938 | "description": "是否修改数据时自动触发校验",
|
| 939 | "docblock": "是否修改数据时自动触发校验"
|
| 940 | },
|
| 941 | "device": {
|
| 942 | "type": {
|
| 943 | "name": "enum",
|
| 944 | "value": [
|
| 945 | {
|
| 946 | "value": "'phone'",
|
| 947 | "computed": false
|
| 948 | },
|
| 949 | {
|
| 950 | "value": "'tablet'",
|
| 951 | "computed": false
|
| 952 | },
|
| 953 | {
|
| 954 | "value": "'desktop'",
|
| 955 | "computed": false
|
| 956 | }
|
| 957 | ]
|
| 958 | },
|
| 959 | "required": false,
|
| 960 | "description": "预设屏幕宽度",
|
| 961 | "docblock": "预设屏幕宽度"
|
| 962 | },
|
| 963 | "colSpan": {
|
| 964 | "type": {
|
| 965 | "name": "number"
|
| 966 | },
|
| 967 | "required": false,
|
| 968 | "description": "在响应式布局模式下，表单项占多少列",
|
| 969 | "docblock": "在响应式布局模式下，表单项占多少列"
|
| 970 | },
|
| 971 | "labelWidth": {
|
| 972 | "type": {
|
| 973 | "name": "union",
|
| 974 | "value": [
|
| 975 | {
|
| 976 | "name": "string"
|
| 977 | },
|
| 978 | {
|
| 979 | "name": "number"
|
| 980 | }
|
| 981 | ]
|
| 982 | },
|
| 983 | "required": false,
|
| 984 | "description": "在响应式布局下，且label在左边时，label的宽度是多少",
|
| 985 | "defaultValue": {
|
| 986 | "value": "100",
|
| 987 | "computed": false
|
| 988 | },
|
| 989 | "docblock": "在响应式布局下，且label在左边时，label的宽度是多少"
|
| 990 | },
|
| 991 | "isPreview": {
|
| 992 | "type": {
|
| 993 | "name": "bool"
|
| 994 | },
|
| 995 | "required": false,
|
| 996 | "description": "是否开启预览态",
|
| 997 | "docblock": "是否开启预览态"
|
| 998 | },
|
| 999 | "renderPreview": {
|
| 1000 | "type": {
|
| 1001 | "name": "func"
|
| 1002 | },
|
| 1003 | "required": false,
|
| 1004 | "description": "预览态模式下渲染的内容",
|
| 1005 | "docblock": "预览态模式下渲染的内容\n@param {any} value 根据包裹的组件的 value 类型而决定",
|
| 1006 | "params": [
|
| 1007 | {
|
| 1008 | "name": "value",
|
| 1009 | "description": "根据包裹的组件的 value 类型而决定",
|
| 1010 | "type": {
|
| 1011 | "name": "any"
|
| 1012 | }
|
| 1013 | }
|
| 1014 | ],
|
| 1015 | "returns": null
|
| 1016 | },
|
| 1017 | "useLabelForErrorMessage": {
|
| 1018 | "type": {
|
| 1019 | "name": "bool"
|
| 1020 | },
|
| 1021 | "required": false,
|
| 1022 | "description": "是否使用 label 替换校验信息的 name 字段",
|
| 1023 | "docblock": "是否使用 label 替换校验信息的 name 字段"
|
| 1024 | },
|
| 1025 | "colon": {
|
| 1026 | "type": {
|
| 1027 | "name": "bool"
|
| 1028 | },
|
| 1029 | "required": false,
|
| 1030 | "description": "表示是否显示 label 后面的冒号",
|
| 1031 | "docblock": "表示是否显示 label 后面的冒号"
|
| 1032 | },
|
| 1033 | "disabled": {
|
| 1034 | "type": {
|
| 1035 | "name": "bool"
|
| 1036 | },
|
| 1037 | "required": false,
|
| 1038 | "description": "是否禁用表单",
|
| 1039 | "docblock": "是否禁用表单"
|
| 1040 | },
|
| 1041 | "valueName": {
|
| 1042 | "type": {
|
| 1043 | "name": "string"
|
| 1044 | },
|
| 1045 | "required": false,
|
| 1046 | "description": "子元素的 value 名称",
|
| 1047 | "docblock": "子元素的 value 名称"
|
| 1048 | }
|
| 1049 | },
|
| 1050 | "methods": [
|
| 1051 | {
|
| 1052 | "name": "getNames",
|
| 1053 | "docblock": "从子元素里面提取表单组件. TODO: 2.x 中改为只获取一个元素",
|
| 1054 | "modifiers": [],
|
| 1055 | "params": [
|
| 1056 | {
|
| 1057 | "name": "children"
|
| 1058 | }
|
| 1059 | ],
|
| 1060 | "returns": null,
|
| 1061 | "description": "从子元素里面提取表单组件. TODO: 2.x 中改为只获取一个元素"
|
| 1062 | }
|
| 1063 | ],
|
| 1064 | "description": "手动传递了 wrapCol labelCol 会使用 Grid 辅助布局; labelAlign='top' 会强制禁用 Grid",
|
| 1065 | "order": 1
|
| 1066 | },
|
| 1067 | {
|
| 1068 | "name": "Submit",
|
| 1069 | "props": {
|
| 1070 | "type": {
|
| 1071 | "type": {
|
| 1072 | "name": "enum",
|
| 1073 | "value": [
|
| 1074 | {
|
| 1075 | "value": "'primary'",
|
| 1076 | "computed": false
|
| 1077 | },
|
| 1078 | {
|
| 1079 | "value": "'secondary'",
|
| 1080 | "computed": false
|
| 1081 | },
|
| 1082 | {
|
| 1083 | "value": "'normal'",
|
| 1084 | "computed": false
|
| 1085 | }
|
| 1086 | ]
|
| 1087 | },
|
| 1088 | "required": false,
|
| 1089 | "description": "按钮的类型",
|
| 1090 | "defaultValue": {
|
| 1091 | "value": "'normal'",
|
| 1092 | "computed": false
|
| 1093 | },
|
| 1094 | "docblock": "按钮的类型"
|
| 1095 | },
|
| 1096 | "size": {
|
| 1097 | "type": {
|
| 1098 | "name": "enum",
|
| 1099 | "value": [
|
| 1100 | {
|
| 1101 | "value": "'small'",
|
| 1102 | "computed": false
|
| 1103 | },
|
| 1104 | {
|
| 1105 | "value": "'medium'",
|
| 1106 | "computed": false
|
| 1107 | },
|
| 1108 | {
|
| 1109 | "value": "'large'",
|
| 1110 | "computed": false
|
| 1111 | }
|
| 1112 | ]
|
| 1113 | },
|
| 1114 | "required": false,
|
| 1115 | "description": "按钮的尺寸",
|
| 1116 | "defaultValue": {
|
| 1117 | "value": "'medium'",
|
| 1118 | "computed": false
|
| 1119 | },
|
| 1120 | "docblock": "按钮的尺寸"
|
| 1121 | },
|
| 1122 | "icons": {
|
| 1123 | "type": {
|
| 1124 | "name": "shape",
|
| 1125 | "value": {
|
| 1126 | "loading": {
|
| 1127 | "name": "node",
|
| 1128 | "required": false
|
| 1129 | }
|
| 1130 | }
|
| 1131 | },
|
| 1132 | "required": false,
|
| 1133 | "description": "按钮中可配置的 Icon，格式为 { loading: <Icon type=\"loading\" /> }",
|
| 1134 | "defaultValue": {
|
| 1135 | "value": "{}",
|
| 1136 | "computed": false
|
| 1137 | },
|
| 1138 | "docblock": "按钮中可配置的 Icon，格式为 { loading: <Icon type=\"loading\" /> }",
|
| 1139 | "properties": []
|
| 1140 | },
|
| 1141 | "iconSize": {
|
| 1142 | "type": {
|
| 1143 | "name": "union",
|
| 1144 | "value": [
|
| 1145 | {
|
| 1146 | "name": "enum",
|
| 1147 | "value": [
|
| 1148 | {
|
| 1149 | "value": "'xxs'",
|
| 1150 | "computed": false
|
| 1151 | },
|
| 1152 | {
|
| 1153 | "value": "'xs'",
|
| 1154 | "computed": false
|
| 1155 | },
|
| 1156 | {
|
| 1157 | "value": "'small'",
|
| 1158 | "computed": false
|
| 1159 | },
|
| 1160 | {
|
| 1161 | "value": "'medium'",
|
| 1162 | "computed": false
|
| 1163 | },
|
| 1164 | {
|
| 1165 | "value": "'large'",
|
| 1166 | "computed": false
|
| 1167 | },
|
| 1168 | {
|
| 1169 | "value": "'xl'",
|
| 1170 | "computed": false
|
| 1171 | },
|
| 1172 | {
|
| 1173 | "value": "'xxl'",
|
| 1174 | "computed": false
|
| 1175 | },
|
| 1176 | {
|
| 1177 | "value": "'xxxl'",
|
| 1178 | "computed": false
|
| 1179 | },
|
| 1180 | {
|
| 1181 | "value": "'inherit'",
|
| 1182 | "computed": false
|
| 1183 | }
|
| 1184 | ]
|
| 1185 | },
|
| 1186 | {
|
| 1187 | "name": "number"
|
| 1188 | }
|
| 1189 | ]
|
| 1190 | },
|
| 1191 | "required": false,
|
| 1192 | "description": "按钮中 Icon 的尺寸，用于替代 Icon 的默认大小",
|
| 1193 | "docblock": "按钮中 Icon 的尺寸，用于替代 Icon 的默认大小"
|
| 1194 | },
|
| 1195 | "htmlType": {
|
| 1196 | "type": {
|
| 1197 | "name": "enum",
|
| 1198 | "value": [
|
| 1199 | {
|
| 1200 | "value": "'submit'",
|
| 1201 | "computed": false
|
| 1202 | },
|
| 1203 | {
|
| 1204 | "value": "'reset'",
|
| 1205 | "computed": false
|
| 1206 | },
|
| 1207 | {
|
| 1208 | "value": "'button'",
|
| 1209 | "computed": false
|
| 1210 | }
|
| 1211 | ]
|
| 1212 | },
|
| 1213 | "required": false,
|
| 1214 | "description": "当 component = 'button' 时，设置 button 标签的 type 值",
|
| 1215 | "defaultValue": {
|
| 1216 | "value": "'button'",
|
| 1217 | "computed": false
|
| 1218 | },
|
| 1219 | "docblock": "当 component = 'button' 时，设置 button 标签的 type 值"
|
| 1220 | },
|
| 1221 | "component": {
|
| 1222 | "type": {
|
| 1223 | "name": "enum",
|
| 1224 | "value": [
|
| 1225 | {
|
| 1226 | "value": "'button'",
|
| 1227 | "computed": false
|
| 1228 | },
|
| 1229 | {
|
| 1230 | "value": "'a'",
|
| 1231 | "computed": false
|
| 1232 | },
|
| 1233 | {
|
| 1234 | "value": "'div'",
|
| 1235 | "computed": false
|
| 1236 | },
|
| 1237 | {
|
| 1238 | "value": "'span'",
|
| 1239 | "computed": false
|
| 1240 | }
|
| 1241 | ]
|
| 1242 | },
|
| 1243 | "required": false,
|
| 1244 | "description": "设置标签类型",
|
| 1245 | "defaultValue": {
|
| 1246 | "value": "'button'",
|
| 1247 | "computed": false
|
| 1248 | },
|
| 1249 | "docblock": "设置标签类型"
|
| 1250 | },
|
| 1251 | "loading": {
|
| 1252 | "type": {
|
| 1253 | "name": "bool"
|
| 1254 | },
|
| 1255 | "required": false,
|
| 1256 | "description": "设置按钮的载入状态",
|
| 1257 | "defaultValue": {
|
| 1258 | "value": "false",
|
| 1259 | "computed": false
|
| 1260 | },
|
| 1261 | "docblock": "设置按钮的载入状态"
|
| 1262 | },
|
| 1263 | "ghost": {
|
| 1264 | "type": {
|
| 1265 | "name": "enum",
|
| 1266 | "value": [
|
| 1267 | {
|
| 1268 | "value": "true",
|
| 1269 | "computed": false
|
| 1270 | },
|
| 1271 | {
|
| 1272 | "value": "false",
|
| 1273 | "computed": false
|
| 1274 | },
|
| 1275 | {
|
| 1276 | "value": "'light'",
|
| 1277 | "computed": false
|
| 1278 | },
|
| 1279 | {
|
| 1280 | "value": "'dark'",
|
| 1281 | "computed": false
|
| 1282 | }
|
| 1283 | ]
|
| 1284 | },
|
| 1285 | "required": false,
|
| 1286 | "description": "是否为幽灵按钮",
|
| 1287 | "defaultValue": {
|
| 1288 | "value": "false",
|
| 1289 | "computed": false
|
| 1290 | },
|
| 1291 | "docblock": "是否为幽灵按钮"
|
| 1292 | },
|
| 1293 | "text": {
|
| 1294 | "type": {
|
| 1295 | "name": "bool"
|
| 1296 | },
|
| 1297 | "required": false,
|
| 1298 | "description": "是否为文本按钮",
|
| 1299 | "defaultValue": {
|
| 1300 | "value": "false",
|
| 1301 | "computed": false
|
| 1302 | },
|
| 1303 | "docblock": "是否为文本按钮"
|
| 1304 | },
|
| 1305 | "warning": {
|
| 1306 | "type": {
|
| 1307 | "name": "bool"
|
| 1308 | },
|
| 1309 | "required": false,
|
| 1310 | "description": "是否为警告按钮",
|
| 1311 | "defaultValue": {
|
| 1312 | "value": "false",
|
| 1313 | "computed": false
|
| 1314 | },
|
| 1315 | "docblock": "是否为警告按钮"
|
| 1316 | },
|
| 1317 | "disabled": {
|
| 1318 | "type": {
|
| 1319 | "name": "bool"
|
| 1320 | },
|
| 1321 | "required": false,
|
| 1322 | "description": "是否禁用",
|
| 1323 | "defaultValue": {
|
| 1324 | "value": "false",
|
| 1325 | "computed": false
|
| 1326 | },
|
| 1327 | "docblock": "是否禁用"
|
| 1328 | },
|
| 1329 | "onClick": {
|
| 1330 | "type": {
|
| 1331 | "name": "func"
|
| 1332 | },
|
| 1333 | "required": false,
|
| 1334 | "description": "点击提交后触发",
|
| 1335 | "defaultValue": {
|
| 1336 | "value": "func.noop",
|
| 1337 | "computed": true
|
| 1338 | },
|
| 1339 | "docblock": "点击提交后触发\n@param {Object} value 数据\n@param {Object} errors 错误数据\n@param {class} field 实例",
|
| 1340 | "params": [
|
| 1341 | {
|
| 1342 | "name": "value",
|
| 1343 | "description": "数据",
|
| 1344 | "type": {
|
| 1345 | "name": "Object"
|
| 1346 | }
|
| 1347 | },
|
| 1348 | {
|
| 1349 | "name": "errors",
|
| 1350 | "description": "错误数据",
|
| 1351 | "type": {
|
| 1352 | "name": "Object"
|
| 1353 | }
|
| 1354 | },
|
| 1355 | {
|
| 1356 | "name": "field",
|
| 1357 | "description": "实例",
|
| 1358 | "type": {
|
| 1359 | "name": "class"
|
| 1360 | }
|
| 1361 | }
|
| 1362 | ],
|
| 1363 | "returns": null
|
| 1364 | },
|
| 1365 | "validate": {
|
| 1366 | "type": {
|
| 1367 | "name": "union",
|
| 1368 | "value": [
|
| 1369 | {
|
| 1370 | "name": "bool"
|
| 1371 | },
|
| 1372 | {
|
| 1373 | "name": "array"
|
| 1374 | }
|
| 1375 | ]
|
| 1376 | },
|
| 1377 | "required": false,
|
| 1378 | "description": "是否校验/需要校验的 name 数组",
|
| 1379 | "docblock": "是否校验/需要校验的 name 数组"
|
| 1380 | },
|
| 1381 | "field": {
|
| 1382 | "type": {
|
| 1383 | "name": "object"
|
| 1384 | },
|
| 1385 | "required": false,
|
| 1386 | "description": "自定义 field (在 Form 内不需要设置)",
|
| 1387 | "docblock": "自定义 field (在 Form 内不需要设置)",
|
| 1388 | "properties": []
|
| 1389 | }
|
| 1390 | },
|
| 1391 | "methods": [],
|
| 1392 | "description": "继承 Button API",
|
| 1393 | "order": 2
|
| 1394 | },
|
| 1395 | {
|
| 1396 | "name": "Reset",
|
| 1397 | "props": {
|
| 1398 | "type": {
|
| 1399 | "type": {
|
| 1400 | "name": "enum",
|
| 1401 | "value": [
|
| 1402 | {
|
| 1403 | "value": "'primary'",
|
| 1404 | "computed": false
|
| 1405 | },
|
| 1406 | {
|
| 1407 | "value": "'secondary'",
|
| 1408 | "computed": false
|
| 1409 | },
|
| 1410 | {
|
| 1411 | "value": "'normal'",
|
| 1412 | "computed": false
|
| 1413 | }
|
| 1414 | ]
|
| 1415 | },
|
| 1416 | "required": false,
|
| 1417 | "description": "按钮的类型",
|
| 1418 | "defaultValue": {
|
| 1419 | "value": "'normal'",
|
| 1420 | "computed": false
|
| 1421 | },
|
| 1422 | "docblock": "按钮的类型"
|
| 1423 | },
|
| 1424 | "size": {
|
| 1425 | "type": {
|
| 1426 | "name": "enum",
|
| 1427 | "value": [
|
| 1428 | {
|
| 1429 | "value": "'small'",
|
| 1430 | "computed": false
|
| 1431 | },
|
| 1432 | {
|
| 1433 | "value": "'medium'",
|
| 1434 | "computed": false
|
| 1435 | },
|
| 1436 | {
|
| 1437 | "value": "'large'",
|
| 1438 | "computed": false
|
| 1439 | }
|
| 1440 | ]
|
| 1441 | },
|
| 1442 | "required": false,
|
| 1443 | "description": "按钮的尺寸",
|
| 1444 | "defaultValue": {
|
| 1445 | "value": "'medium'",
|
| 1446 | "computed": false
|
| 1447 | },
|
| 1448 | "docblock": "按钮的尺寸"
|
| 1449 | },
|
| 1450 | "icons": {
|
| 1451 | "type": {
|
| 1452 | "name": "shape",
|
| 1453 | "value": {
|
| 1454 | "loading": {
|
| 1455 | "name": "node",
|
| 1456 | "required": false
|
| 1457 | }
|
| 1458 | }
|
| 1459 | },
|
| 1460 | "required": false,
|
| 1461 | "description": "按钮中可配置的 Icon，格式为 { loading: <Icon type=\"loading\" /> }",
|
| 1462 | "defaultValue": {
|
| 1463 | "value": "{}",
|
| 1464 | "computed": false
|
| 1465 | },
|
| 1466 | "docblock": "按钮中可配置的 Icon，格式为 { loading: <Icon type=\"loading\" /> }",
|
| 1467 | "properties": []
|
| 1468 | },
|
| 1469 | "iconSize": {
|
| 1470 | "type": {
|
| 1471 | "name": "union",
|
| 1472 | "value": [
|
| 1473 | {
|
| 1474 | "name": "enum",
|
| 1475 | "value": [
|
| 1476 | {
|
| 1477 | "value": "'xxs'",
|
| 1478 | "computed": false
|
| 1479 | },
|
| 1480 | {
|
| 1481 | "value": "'xs'",
|
| 1482 | "computed": false
|
| 1483 | },
|
| 1484 | {
|
| 1485 | "value": "'small'",
|
| 1486 | "computed": false
|
| 1487 | },
|
| 1488 | {
|
| 1489 | "value": "'medium'",
|
| 1490 | "computed": false
|
| 1491 | },
|
| 1492 | {
|
| 1493 | "value": "'large'",
|
| 1494 | "computed": false
|
| 1495 | },
|
| 1496 | {
|
| 1497 | "value": "'xl'",
|
| 1498 | "computed": false
|
| 1499 | },
|
| 1500 | {
|
| 1501 | "value": "'xxl'",
|
| 1502 | "computed": false
|
| 1503 | },
|
| 1504 | {
|
| 1505 | "value": "'xxxl'",
|
| 1506 | "computed": false
|
| 1507 | },
|
| 1508 | {
|
| 1509 | "value": "'inherit'",
|
| 1510 | "computed": false
|
| 1511 | }
|
| 1512 | ]
|
| 1513 | },
|
| 1514 | {
|
| 1515 | "name": "number"
|
| 1516 | }
|
| 1517 | ]
|
| 1518 | },
|
| 1519 | "required": false,
|
| 1520 | "description": "按钮中 Icon 的尺寸，用于替代 Icon 的默认大小",
|
| 1521 | "docblock": "按钮中 Icon 的尺寸，用于替代 Icon 的默认大小"
|
| 1522 | },
|
| 1523 | "htmlType": {
|
| 1524 | "type": {
|
| 1525 | "name": "enum",
|
| 1526 | "value": [
|
| 1527 | {
|
| 1528 | "value": "'submit'",
|
| 1529 | "computed": false
|
| 1530 | },
|
| 1531 | {
|
| 1532 | "value": "'reset'",
|
| 1533 | "computed": false
|
| 1534 | },
|
| 1535 | {
|
| 1536 | "value": "'button'",
|
| 1537 | "computed": false
|
| 1538 | }
|
| 1539 | ]
|
| 1540 | },
|
| 1541 | "required": false,
|
| 1542 | "description": "当 component = 'button' 时，设置 button 标签的 type 值",
|
| 1543 | "defaultValue": {
|
| 1544 | "value": "'button'",
|
| 1545 | "computed": false
|
| 1546 | },
|
| 1547 | "docblock": "当 component = 'button' 时，设置 button 标签的 type 值"
|
| 1548 | },
|
| 1549 | "component": {
|
| 1550 | "type": {
|
| 1551 | "name": "enum",
|
| 1552 | "value": [
|
| 1553 | {
|
| 1554 | "value": "'button'",
|
| 1555 | "computed": false
|
| 1556 | },
|
| 1557 | {
|
| 1558 | "value": "'a'",
|
| 1559 | "computed": false
|
| 1560 | },
|
| 1561 | {
|
| 1562 | "value": "'div'",
|
| 1563 | "computed": false
|
| 1564 | },
|
| 1565 | {
|
| 1566 | "value": "'span'",
|
| 1567 | "computed": false
|
| 1568 | }
|
| 1569 | ]
|
| 1570 | },
|
| 1571 | "required": false,
|
| 1572 | "description": "设置标签类型",
|
| 1573 | "defaultValue": {
|
| 1574 | "value": "'button'",
|
| 1575 | "computed": false
|
| 1576 | },
|
| 1577 | "docblock": "设置标签类型"
|
| 1578 | },
|
| 1579 | "loading": {
|
| 1580 | "type": {
|
| 1581 | "name": "bool"
|
| 1582 | },
|
| 1583 | "required": false,
|
| 1584 | "description": "设置按钮的载入状态",
|
| 1585 | "defaultValue": {
|
| 1586 | "value": "false",
|
| 1587 | "computed": false
|
| 1588 | },
|
| 1589 | "docblock": "设置按钮的载入状态"
|
| 1590 | },
|
| 1591 | "ghost": {
|
| 1592 | "type": {
|
| 1593 | "name": "enum",
|
| 1594 | "value": [
|
| 1595 | {
|
| 1596 | "value": "true",
|
| 1597 | "computed": false
|
| 1598 | },
|
| 1599 | {
|
| 1600 | "value": "false",
|
| 1601 | "computed": false
|
| 1602 | },
|
| 1603 | {
|
| 1604 | "value": "'light'",
|
| 1605 | "computed": false
|
| 1606 | },
|
| 1607 | {
|
| 1608 | "value": "'dark'",
|
| 1609 | "computed": false
|
| 1610 | }
|
| 1611 | ]
|
| 1612 | },
|
| 1613 | "required": false,
|
| 1614 | "description": "是否为幽灵按钮",
|
| 1615 | "defaultValue": {
|
| 1616 | "value": "false",
|
| 1617 | "computed": false
|
| 1618 | },
|
| 1619 | "docblock": "是否为幽灵按钮"
|
| 1620 | },
|
| 1621 | "text": {
|
| 1622 | "type": {
|
| 1623 | "name": "bool"
|
| 1624 | },
|
| 1625 | "required": false,
|
| 1626 | "description": "是否为文本按钮",
|
| 1627 | "defaultValue": {
|
| 1628 | "value": "false",
|
| 1629 | "computed": false
|
| 1630 | },
|
| 1631 | "docblock": "是否为文本按钮"
|
| 1632 | },
|
| 1633 | "warning": {
|
| 1634 | "type": {
|
| 1635 | "name": "bool"
|
| 1636 | },
|
| 1637 | "required": false,
|
| 1638 | "description": "是否为警告按钮",
|
| 1639 | "defaultValue": {
|
| 1640 | "value": "false",
|
| 1641 | "computed": false
|
| 1642 | },
|
| 1643 | "docblock": "是否为警告按钮"
|
| 1644 | },
|
| 1645 | "disabled": {
|
| 1646 | "type": {
|
| 1647 | "name": "bool"
|
| 1648 | },
|
| 1649 | "required": false,
|
| 1650 | "description": "是否禁用",
|
| 1651 | "defaultValue": {
|
| 1652 | "value": "false",
|
| 1653 | "computed": false
|
| 1654 | },
|
| 1655 | "docblock": "是否禁用"
|
| 1656 | },
|
| 1657 | "onClick": {
|
| 1658 | "type": {
|
| 1659 | "name": "func"
|
| 1660 | },
|
| 1661 | "required": false,
|
| 1662 | "description": "点击提交后触发",
|
| 1663 | "defaultValue": {
|
| 1664 | "value": "func.noop",
|
| 1665 | "computed": true
|
| 1666 | },
|
| 1667 | "docblock": "点击提交后触发",
|
| 1668 | "params": [],
|
| 1669 | "returns": null
|
| 1670 | },
|
| 1671 | "names": {
|
| 1672 | "type": {
|
| 1673 | "name": "array"
|
| 1674 | },
|
| 1675 | "required": false,
|
| 1676 | "description": "自定义重置的字段",
|
| 1677 | "docblock": "自定义重置的字段"
|
| 1678 | },
|
| 1679 | "toDefault": {
|
| 1680 | "type": {
|
| 1681 | "name": "bool"
|
| 1682 | },
|
| 1683 | "required": false,
|
| 1684 | "description": "返回默认值",
|
| 1685 | "docblock": "返回默认值"
|
| 1686 | },
|
| 1687 | "field": {
|
| 1688 | "type": {
|
| 1689 | "name": "object"
|
| 1690 | },
|
| 1691 | "required": false,
|
| 1692 | "description": "自定义 field (在 Form 内不需要设置)",
|
| 1693 | "docblock": "自定义 field (在 Form 内不需要设置)",
|
| 1694 | "properties": []
|
| 1695 | }
|
| 1696 | },
|
| 1697 | "methods": [],
|
| 1698 | "description": "继承 Button API",
|
| 1699 | "order": 3
|
| 1700 | },
|
| 1701 | {
|
| 1702 | "name": "Error",
|
| 1703 | "props": {
|
| 1704 | "name": {
|
| 1705 | "type": {
|
| 1706 | "name": "union",
|
| 1707 | "value": [
|
| 1708 | {
|
| 1709 | "name": "string"
|
| 1710 | },
|
| 1711 | {
|
| 1712 | "name": "array"
|
| 1713 | }
|
| 1714 | ]
|
| 1715 | },
|
| 1716 | "required": false,
|
| 1717 | "description": "表单名",
|
| 1718 | "docblock": "表单名"
|
| 1719 | },
|
| 1720 | "field": {
|
| 1721 | "type": {
|
| 1722 | "name": "object"
|
| 1723 | },
|
| 1724 | "required": false,
|
| 1725 | "description": "自定义 field (在 Form 内不需要设置)",
|
| 1726 | "docblock": "自定义 field (在 Form 内不需要设置)",
|
| 1727 | "properties": []
|
| 1728 | },
|
| 1729 | "children": {
|
| 1730 | "type": {
|
| 1731 | "name": "union",
|
| 1732 | "value": [
|
| 1733 | {
|
| 1734 | "name": "node"
|
| 1735 | },
|
| 1736 | {
|
| 1737 | "name": "func"
|
| 1738 | }
|
| 1739 | ]
|
| 1740 | },
|
| 1741 | "required": false,
|
| 1742 | "description": "自定义错误渲染, 可以是 node 或者 function(errors, state)",
|
| 1743 | "docblock": "自定义错误渲染, 可以是 node 或者 function(errors, state)"
|
| 1744 | }
|
| 1745 | },
|
| 1746 | "methods": [],
|
| 1747 | "description": "自定义错误展示",
|
| 1748 | "order": 4
|
| 1749 | }
|
| 1750 | ]
|
| 1751 | } |
| \ | No newline at end of file |