UNPKG

42.7 kBJSONView Raw
1{
2 "name": "Upload",
3 "props": {
4 "action": {
5 "type": {
6 "name": "string"
7 },
8 "required": false,
9 "description": "上传的地址",
10 "docblock": "上传的地址"
11 },
12 "accept": {
13 "type": {
14 "name": "string"
15 },
16 "required": false,
17 "description": "接受上传的文件类型 (image/png, image/jpg, .doc, .ppt) 详见 [input accept attribute](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/Input#attr-accept)",
18 "docblock": "接受上传的文件类型 (image/png, image/jpg, .doc, .ppt) 详见 [input accept attribute](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/Input#attr-accept)"
19 },
20 "data": {
21 "type": {
22 "name": "union",
23 "value": [
24 {
25 "name": "object"
26 },
27 {
28 "name": "func"
29 }
30 ]
31 },
32 "required": false,
33 "description": "上传额外传参",
34 "docblock": "上传额外传参"
35 },
36 "headers": {
37 "type": {
38 "name": "object"
39 },
40 "required": false,
41 "description": "设置上传的请求头部",
42 "docblock": "设置上传的请求头部",
43 "properties": []
44 },
45 "withCredentials": {
46 "type": {
47 "name": "bool"
48 },
49 "required": false,
50 "description": "是否允许请求携带 cookie",
51 "defaultValue": {
52 "value": "true",
53 "computed": false
54 },
55 "docblock": "是否允许请求携带 cookie"
56 },
57 "beforeUpload": {
58 "type": {
59 "name": "func"
60 },
61 "required": false,
62 "description": "可选参数, 详见 [beforeUpload](#beforeUpload)",
63 "defaultValue": {
64 "value": "func.noop",
65 "computed": true
66 },
67 "docblock": "可选参数, 详见 [beforeUpload](#beforeUpload)\n@param {Object} file 所有文件\n@param {Object} options 参数\n@returns {Boolean|Object|Promise} 返回值作用见demo",
68 "params": [
69 {
70 "name": "file",
71 "description": "所有文件",
72 "type": {
73 "name": "Object"
74 }
75 },
76 {
77 "name": "options",
78 "description": "参数",
79 "type": {
80 "name": "Object"
81 }
82 }
83 ],
84 "returns": {
85 "description": "返回值作用见demo",
86 "type": {
87 "name": "union",
88 "value": [
89 "Boolean",
90 "Object",
91 "Promise"
92 ]
93 }
94 }
95 },
96 "onProgress": {
97 "type": {
98 "name": "func"
99 },
100 "required": false,
101 "description": "上传中",
102 "defaultValue": {
103 "value": "func.noop",
104 "computed": true
105 },
106 "docblock": "上传中",
107 "params": [],
108 "returns": null
109 },
110 "onSuccess": {
111 "type": {
112 "name": "func"
113 },
114 "required": false,
115 "description": "可选参数,上传成功回调函数,参数为请求下响应信息以及文件",
116 "defaultValue": {
117 "value": "func.noop",
118 "computed": true
119 },
120 "docblock": "可选参数,上传成功回调函数,参数为请求下响应信息以及文件\n@param {Object} file 文件\n@param {Array<Object>} value 值",
121 "params": [
122 {
123 "name": "file",
124 "description": "文件",
125 "type": {
126 "name": "Object"
127 }
128 },
129 {
130 "name": "value",
131 "description": "值",
132 "type": {
133 "name": "Array"
134 }
135 }
136 ],
137 "returns": null
138 },
139 "onError": {
140 "type": {
141 "name": "func"
142 },
143 "required": false,
144 "description": "可选参数,上传失败回调函数,参数为上传失败的信息、响应信息以及文件",
145 "defaultValue": {
146 "value": "func.noop",
147 "computed": true
148 },
149 "docblock": "可选参数,上传失败回调函数,参数为上传失败的信息、响应信息以及文件\n@param {Object} file 出错的文件\n@param {Array} value 当前值",
150 "params": [
151 {
152 "name": "file",
153 "description": "出错的文件",
154 "type": {
155 "name": "Object"
156 }
157 },
158 {
159 "name": "value",
160 "description": "当前值",
161 "type": {
162 "name": "Array"
163 }
164 }
165 ],
166 "returns": null
167 },
168 "children": {
169 "type": {
170 "name": "node"
171 },
172 "required": false,
173 "description": "子元素",
174 "docblock": "子元素"
175 },
176 "timeout": {
177 "type": {
178 "name": "number"
179 },
180 "required": false,
181 "description": "设置上传超时,单位ms",
182 "docblock": "设置上传超时,单位ms"
183 },
184 "method": {
185 "type": {
186 "name": "enum",
187 "value": [
188 {
189 "value": "'post'",
190 "computed": false
191 },
192 {
193 "value": "'put'",
194 "computed": false
195 }
196 ]
197 },
198 "required": false,
199 "description": "上传方法",
200 "defaultValue": {
201 "value": "'post'",
202 "computed": false
203 },
204 "docblock": "上传方法"
205 },
206 "request": {
207 "type": {
208 "name": "func"
209 },
210 "required": false,
211 "description": "自定义上传方法",
212 "docblock": "自定义上传方法\n@param {Object} option\n@return {Object} object with abort method",
213 "params": [
214 {
215 "name": "option",
216 "description": null,
217 "type": {
218 "name": "Object"
219 }
220 }
221 ],
222 "returns": {
223 "description": "object with abort method",
224 "type": {
225 "name": "Object"
226 }
227 }
228 },
229 "name": {
230 "type": {
231 "name": "string"
232 },
233 "required": false,
234 "description": "文件名字段",
235 "docblock": "文件名字段"
236 },
237 "onSelect": {
238 "type": {
239 "name": "func"
240 },
241 "required": false,
242 "description": "选择文件回调",
243 "defaultValue": {
244 "value": "func.noop",
245 "computed": true
246 },
247 "docblock": "选择文件回调",
248 "params": [],
249 "returns": null
250 },
251 "onDrop": {
252 "type": {
253 "name": "func"
254 },
255 "required": false,
256 "description": "放文件",
257 "defaultValue": {
258 "value": "func.noop",
259 "computed": true
260 },
261 "docblock": "放文件",
262 "params": [],
263 "returns": null
264 },
265 "prefix": {
266 "type": {
267 "name": "string"
268 },
269 "required": false,
270 "description": "样式前缀",
271 "defaultValue": {
272 "value": "'next-'",
273 "computed": false
274 },
275 "docblock": "样式前缀"
276 },
277 "value": {
278 "type": {
279 "name": "array"
280 },
281 "required": false,
282 "description": "文件列表",
283 "docblock": "文件列表"
284 },
285 "defaultValue": {
286 "type": {
287 "name": "array"
288 },
289 "required": false,
290 "description": "默认文件列表",
291 "docblock": "默认文件列表"
292 },
293 "shape": {
294 "type": {
295 "name": "enum",
296 "value": [
297 {
298 "value": "'card'",
299 "computed": false
300 }
301 ]
302 },
303 "required": false,
304 "description": "上传按钮形状",
305 "docblock": "上传按钮形状"
306 },
307 "listType": {
308 "type": {
309 "name": "enum",
310 "value": [
311 {
312 "value": "'text'",
313 "computed": false,
314 "description": "文字"
315 },
316 {
317 "value": "'image'",
318 "computed": false,
319 "description": "图文"
320 },
321 {
322 "value": "'card'",
323 "computed": false,
324 "description": "卡片"
325 }
326 ]
327 },
328 "required": false,
329 "description": "上传列表的样式",
330 "docblock": "上传列表的样式\n@enumdesc 文字, 图文, 卡片",
331 "value": [
332 {
333 "value": "'text'",
334 "computed": false,
335 "description": "文字"
336 },
337 {
338 "value": "'image'",
339 "computed": false,
340 "description": "图文"
341 },
342 {
343 "value": "'card'",
344 "computed": false,
345 "description": "卡片"
346 }
347 ]
348 },
349 "formatter": {
350 "type": {
351 "name": "func"
352 },
353 "required": false,
354 "description": "数据格式化函数,配合自定义 action 使用,参数为服务器的响应数据,详见 [formatter](#formater)",
355 "docblock": "数据格式化函数,配合自定义 action 使用,参数为服务器的响应数据,详见 [formatter](#formater)\n@param {Object} response 返回\n@param {File} file 文件对象",
356 "params": [
357 {
358 "name": "response",
359 "description": "返回",
360 "type": {
361 "name": "Object"
362 }
363 },
364 {
365 "name": "file",
366 "description": "文件对象",
367 "type": {
368 "name": "File"
369 }
370 }
371 ],
372 "returns": null
373 },
374 "limit": {
375 "type": {
376 "name": "number"
377 },
378 "required": false,
379 "description": "最大文件上传个数",
380 "defaultValue": {
381 "value": "Infinity",
382 "computed": true
383 },
384 "docblock": "最大文件上传个数"
385 },
386 "dragable": {
387 "type": {
388 "name": "bool"
389 },
390 "required": false,
391 "description": "可选参数,是否支持拖拽上传,`ie10+` 支持。",
392 "docblock": "可选参数,是否支持拖拽上传,`ie10+` 支持。"
393 },
394 "useDataURL": {
395 "type": {
396 "name": "bool"
397 },
398 "required": false,
399 "description": "可选参数,是否本地预览",
400 "docblock": "可选参数,是否本地预览"
401 },
402 "disabled": {
403 "type": {
404 "name": "bool"
405 },
406 "required": false,
407 "description": "可选参数,是否禁用上传功能",
408 "docblock": "可选参数,是否禁用上传功能"
409 },
410 "onChange": {
411 "type": {
412 "name": "func"
413 },
414 "required": false,
415 "description": "上传文件改变时的状态",
416 "defaultValue": {
417 "value": "func.noop",
418 "computed": true
419 },
420 "docblock": "上传文件改变时的状态\n@param {Object} info 文件事件对象",
421 "params": [
422 {
423 "name": "info",
424 "description": "文件事件对象",
425 "type": {
426 "name": "Object"
427 }
428 }
429 ],
430 "returns": null
431 },
432 "afterSelect": {
433 "type": {
434 "name": "func"
435 },
436 "required": false,
437 "description": "可选参数, 用于校验文件,afterSelect仅在 autoUpload=false 的时候生效,autoUpload=true时,可以使用beforeUpload完全可以替代该功能.",
438 "defaultValue": {
439 "value": "func.noop",
440 "computed": true
441 },
442 "docblock": "可选参数, 用于校验文件,afterSelect仅在 autoUpload=false 的时候生效,autoUpload=true时,可以使用beforeUpload完全可以替代该功能.\n@param {Object} file\n@returns {Boolean} 返回false会阻止上传,其他则表示正常",
443 "params": [
444 {
445 "name": "file",
446 "description": null,
447 "type": {
448 "name": "Object"
449 }
450 }
451 ],
452 "returns": {
453 "description": "返回false会阻止上传,其他则表示正常",
454 "type": {
455 "name": "Boolean"
456 }
457 }
458 },
459 "onRemove": {
460 "type": {
461 "name": "func"
462 },
463 "required": false,
464 "description": "移除文件回调函数",
465 "defaultValue": {
466 "value": "func.noop",
467 "computed": true
468 },
469 "docblock": "移除文件回调函数\n@param {Object} file 文件\n@returns {Boolean|Promise} 返回 false、Promise.resolve(false)、 Promise.reject() 将阻止文件删除",
470 "params": [
471 {
472 "name": "file",
473 "description": "文件",
474 "type": {
475 "name": "Object"
476 }
477 }
478 ],
479 "returns": {
480 "description": "返回 false、Promise.resolve(false)、 Promise.reject() 将阻止文件删除",
481 "type": {
482 "name": "union",
483 "value": [
484 "Boolean",
485 "Promise"
486 ]
487 }
488 }
489 },
490 "className": {
491 "type": {
492 "name": "string"
493 },
494 "required": false,
495 "description": "自定义class",
496 "docblock": "自定义class"
497 },
498 "style": {
499 "type": {
500 "name": "object"
501 },
502 "required": false,
503 "description": "自定义内联样式",
504 "docblock": "自定义内联样式",
505 "properties": []
506 },
507 "autoUpload": {
508 "type": {
509 "name": "bool"
510 },
511 "required": false,
512 "description": "自动上传",
513 "defaultValue": {
514 "value": "true",
515 "computed": false
516 },
517 "docblock": "自动上传"
518 },
519 "progressProps": {
520 "type": {
521 "name": "object"
522 },
523 "required": false,
524 "description": "透传给Progress props",
525 "docblock": "透传给Progress props",
526 "properties": []
527 },
528 "isPreview": {
529 "type": {
530 "name": "bool"
531 },
532 "required": false,
533 "description": "是否为预览态",
534 "docblock": "是否为预览态"
535 },
536 "renderPreview": {
537 "type": {
538 "name": "func"
539 },
540 "required": false,
541 "description": "预览态模式下渲染的内容",
542 "docblock": "预览态模式下渲染的内容\n@param {number} value 评分值",
543 "params": [
544 {
545 "name": "value",
546 "description": "评分值",
547 "type": {
548 "name": "number"
549 }
550 }
551 ],
552 "returns": null
553 },
554 "fileKeyName": {
555 "type": {
556 "name": "string"
557 },
558 "required": false,
559 "description": "文件对象的 key name",
560 "docblock": "文件对象的 key name\n@version 1.21",
561 "version": {
562 "value": "1.21",
563 "computed": false
564 }
565 },
566 "fileNameRender": {
567 "type": {
568 "name": "func"
569 },
570 "required": false,
571 "description": "list 的自定义文件名渲染",
572 "docblock": "list 的自定义文件名渲染\n@param {Object} file 文件\n@return {Node} react node",
573 "params": [
574 {
575 "name": "file",
576 "description": "文件",
577 "type": {
578 "name": "Object"
579 }
580 }
581 ],
582 "returns": {
583 "description": "react node",
584 "type": {
585 "name": "Node"
586 }
587 }
588 },
589 "actionRender": {
590 "type": {
591 "name": "func"
592 },
593 "required": false,
594 "description": "操作区域额外渲染",
595 "docblock": "操作区域额外渲染\n@param {Object} file 文件\n@return {Node} react node",
596 "params": [
597 {
598 "name": "file",
599 "description": "文件",
600 "type": {
601 "name": "Object"
602 }
603 }
604 ],
605 "returns": {
606 "description": "react node",
607 "type": {
608 "name": "Node"
609 }
610 }
611 },
612 "previewOnFileName": {
613 "type": {
614 "name": "bool"
615 },
616 "required": false,
617 "description": "点击文件名时触发 onPreview",
618 "defaultValue": {
619 "value": "false",
620 "computed": false
621 },
622 "docblock": "点击文件名时触发 onPreview\n@version 1.24",
623 "version": {
624 "value": "1.24",
625 "computed": false
626 }
627 }
628 },
629 "methods": [
630 {
631 "name": "selectFiles",
632 "docblock": "对外暴露API, 添加文件\n@param files",
633 "modifiers": [],
634 "params": [
635 {
636 "name": "files",
637 "description": null,
638 "type": null
639 }
640 ],
641 "returns": null,
642 "description": "对外暴露API, 添加文件"
643 },
644 {
645 "name": "startUpload",
646 "docblock": "对外暴露api,控制文件上传",
647 "modifiers": [],
648 "params": [],
649 "returns": null,
650 "description": "对外暴露api,控制文件上传"
651 },
652 {
653 "name": "removeFile",
654 "docblock": "删除文件\n@param {File} file\n@return {void}",
655 "modifiers": [],
656 "params": [
657 {
658 "name": "file",
659 "description": null,
660 "type": {
661 "name": "File"
662 }
663 }
664 ],
665 "returns": {
666 "description": null,
667 "type": {
668 "name": "void"
669 }
670 },
671 "description": "删除文件"
672 },
673 {
674 "name": "abort",
675 "docblock": "取消上传\n@param {File} file\n@return {void}",
676 "modifiers": [],
677 "params": [
678 {
679 "name": "file",
680 "description": null,
681 "type": {
682 "name": "File"
683 }
684 }
685 ],
686 "returns": {
687 "description": null,
688 "type": {
689 "name": "void"
690 }
691 },
692 "description": "取消上传"
693 }
694 ],
695 "subComponents": [
696 {
697 "name": "Card",
698 "props": {
699 "action": {
700 "type": {
701 "name": "string"
702 },
703 "required": false,
704 "description": "上传的地址",
705 "docblock": "上传的地址"
706 },
707 "accept": {
708 "type": {
709 "name": "string"
710 },
711 "required": false,
712 "description": "接受上传的文件类型 (image/png, image/jpg, .doc, .ppt) 详见 [input accept attribute](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/Input#attr-accept)",
713 "docblock": "接受上传的文件类型 (image/png, image/jpg, .doc, .ppt) 详见 [input accept attribute](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/Input#attr-accept)"
714 },
715 "data": {
716 "type": {
717 "name": "union",
718 "value": [
719 {
720 "name": "object"
721 },
722 {
723 "name": "func"
724 }
725 ]
726 },
727 "required": false,
728 "description": "上传额外传参",
729 "docblock": "上传额外传参"
730 },
731 "headers": {
732 "type": {
733 "name": "object"
734 },
735 "required": false,
736 "description": "设置上传的请求头部",
737 "docblock": "设置上传的请求头部",
738 "properties": []
739 },
740 "withCredentials": {
741 "type": {
742 "name": "bool"
743 },
744 "required": false,
745 "description": "是否允许请求携带 cookie",
746 "defaultValue": {
747 "value": "true",
748 "computed": false
749 },
750 "docblock": "是否允许请求携带 cookie"
751 },
752 "beforeUpload": {
753 "type": {
754 "name": "func"
755 },
756 "required": false,
757 "description": "可选参数, 详见 [beforeUpload](#beforeUpload)",
758 "defaultValue": {
759 "value": "func.noop",
760 "computed": true
761 },
762 "docblock": "可选参数, 详见 [beforeUpload](#beforeUpload)\n@param {Object} file 所有文件\n@param {Object} options 参数\n@returns {Boolean|Object|Promise} 返回值作用见demo",
763 "params": [
764 {
765 "name": "file",
766 "description": "所有文件",
767 "type": {
768 "name": "Object"
769 }
770 },
771 {
772 "name": "options",
773 "description": "参数",
774 "type": {
775 "name": "Object"
776 }
777 }
778 ],
779 "returns": {
780 "description": "返回值作用见demo",
781 "type": {
782 "name": "union",
783 "value": [
784 "Boolean",
785 "Object",
786 "Promise"
787 ]
788 }
789 }
790 },
791 "onProgress": {
792 "type": {
793 "name": "func"
794 },
795 "required": false,
796 "description": "上传中",
797 "defaultValue": {
798 "value": "func.noop",
799 "computed": true
800 },
801 "docblock": "上传中",
802 "params": [],
803 "returns": null
804 },
805 "onSuccess": {
806 "type": {
807 "name": "func"
808 },
809 "required": false,
810 "description": "可选参数,上传成功回调函数,参数为请求下响应信息以及文件",
811 "defaultValue": {
812 "value": "func.noop",
813 "computed": true
814 },
815 "docblock": "可选参数,上传成功回调函数,参数为请求下响应信息以及文件\n@param {Object} file 文件\n@param {Array<Object>} value 值",
816 "params": [
817 {
818 "name": "file",
819 "description": "文件",
820 "type": {
821 "name": "Object"
822 }
823 },
824 {
825 "name": "value",
826 "description": "值",
827 "type": {
828 "name": "Array"
829 }
830 }
831 ],
832 "returns": null
833 },
834 "onError": {
835 "type": {
836 "name": "func"
837 },
838 "required": false,
839 "description": "可选参数,上传失败回调函数,参数为上传失败的信息、响应信息以及文件",
840 "defaultValue": {
841 "value": "func.noop",
842 "computed": true
843 },
844 "docblock": "可选参数,上传失败回调函数,参数为上传失败的信息、响应信息以及文件\n@param {Object} file 出错的文件\n@param {Array} value 当前值",
845 "params": [
846 {
847 "name": "file",
848 "description": "出错的文件",
849 "type": {
850 "name": "Object"
851 }
852 },
853 {
854 "name": "value",
855 "description": "当前值",
856 "type": {
857 "name": "Array"
858 }
859 }
860 ],
861 "returns": null
862 },
863 "children": {
864 "type": {
865 "name": "node"
866 },
867 "required": false,
868 "description": "子元素",
869 "docblock": "子元素"
870 },
871 "timeout": {
872 "type": {
873 "name": "number"
874 },
875 "required": false,
876 "description": "设置上传超时,单位ms",
877 "docblock": "设置上传超时,单位ms"
878 },
879 "method": {
880 "type": {
881 "name": "enum",
882 "value": [
883 {
884 "value": "'post'",
885 "computed": false
886 },
887 {
888 "value": "'put'",
889 "computed": false
890 }
891 ]
892 },
893 "required": false,
894 "description": "上传方法",
895 "defaultValue": {
896 "value": "'post'",
897 "computed": false
898 },
899 "docblock": "上传方法"
900 },
901 "request": {
902 "type": {
903 "name": "func"
904 },
905 "required": false,
906 "description": "自定义上传方法",
907 "docblock": "自定义上传方法\n@param {Object} option\n@return {Object} object with abort method",
908 "params": [
909 {
910 "name": "option",
911 "description": null,
912 "type": {
913 "name": "Object"
914 }
915 }
916 ],
917 "returns": {
918 "description": "object with abort method",
919 "type": {
920 "name": "Object"
921 }
922 }
923 },
924 "name": {
925 "type": {
926 "name": "string"
927 },
928 "required": false,
929 "description": "文件名字段",
930 "docblock": "文件名字段"
931 },
932 "onSelect": {
933 "type": {
934 "name": "func"
935 },
936 "required": false,
937 "description": "选择文件回调",
938 "defaultValue": {
939 "value": "func.noop",
940 "computed": true
941 },
942 "docblock": "选择文件回调",
943 "params": [],
944 "returns": null
945 },
946 "onDrop": {
947 "type": {
948 "name": "func"
949 },
950 "required": false,
951 "description": "放文件",
952 "defaultValue": {
953 "value": "func.noop",
954 "computed": true
955 },
956 "docblock": "放文件",
957 "params": [],
958 "returns": null
959 },
960 "prefix": {
961 "type": {
962 "name": "string"
963 },
964 "required": false,
965 "description": "样式前缀",
966 "defaultValue": {
967 "value": "'next-'",
968 "computed": false
969 },
970 "docblock": "样式前缀"
971 },
972 "value": {
973 "type": {
974 "name": "array"
975 },
976 "required": false,
977 "description": "文件列表",
978 "docblock": "文件列表"
979 },
980 "defaultValue": {
981 "type": {
982 "name": "array"
983 },
984 "required": false,
985 "description": "默认文件列表",
986 "docblock": "默认文件列表"
987 },
988 "shape": {
989 "type": {
990 "name": "enum",
991 "value": [
992 {
993 "value": "'card'",
994 "computed": false
995 }
996 ]
997 },
998 "required": false,
999 "description": "上传按钮形状",
1000 "docblock": "上传按钮形状"
1001 },
1002 "listType": {
1003 "type": {
1004 "name": "enum",
1005 "value": [
1006 {
1007 "value": "'text'",
1008 "computed": false,
1009 "description": "文字"
1010 },
1011 {
1012 "value": "'image'",
1013 "computed": false,
1014 "description": "图文"
1015 },
1016 {
1017 "value": "'card'",
1018 "computed": false,
1019 "description": "卡片"
1020 }
1021 ]
1022 },
1023 "required": false,
1024 "description": "上传列表的样式",
1025 "docblock": "上传列表的样式\n@enumdesc 文字, 图文, 卡片",
1026 "value": [
1027 {
1028 "value": "'text'",
1029 "computed": false,
1030 "description": "文字"
1031 },
1032 {
1033 "value": "'image'",
1034 "computed": false,
1035 "description": "图文"
1036 },
1037 {
1038 "value": "'card'",
1039 "computed": false,
1040 "description": "卡片"
1041 }
1042 ]
1043 },
1044 "formatter": {
1045 "type": {
1046 "name": "func"
1047 },
1048 "required": false,
1049 "description": "数据格式化函数,配合自定义 action 使用,参数为服务器的响应数据,详见 [formatter](#formater)",
1050 "docblock": "数据格式化函数,配合自定义 action 使用,参数为服务器的响应数据,详见 [formatter](#formater)\n@param {Object} response 返回\n@param {File} file 文件对象",
1051 "params": [
1052 {
1053 "name": "response",
1054 "description": "返回",
1055 "type": {
1056 "name": "Object"
1057 }
1058 },
1059 {
1060 "name": "file",
1061 "description": "文件对象",
1062 "type": {
1063 "name": "File"
1064 }
1065 }
1066 ],
1067 "returns": null
1068 },
1069 "limit": {
1070 "type": {
1071 "name": "number"
1072 },
1073 "required": false,
1074 "description": "最大文件上传个数",
1075 "defaultValue": {
1076 "value": "Infinity",
1077 "computed": true
1078 },
1079 "docblock": "最大文件上传个数"
1080 },
1081 "dragable": {
1082 "type": {
1083 "name": "bool"
1084 },
1085 "required": false,
1086 "description": "可选参数,是否支持拖拽上传,`ie10+` 支持。",
1087 "docblock": "可选参数,是否支持拖拽上传,`ie10+` 支持。"
1088 },
1089 "useDataURL": {
1090 "type": {
1091 "name": "bool"
1092 },
1093 "required": false,
1094 "description": "可选参数,是否本地预览",
1095 "docblock": "可选参数,是否本地预览"
1096 },
1097 "disabled": {
1098 "type": {
1099 "name": "bool"
1100 },
1101 "required": false,
1102 "description": "可选参数,是否禁用上传功能",
1103 "docblock": "可选参数,是否禁用上传功能"
1104 },
1105 "onChange": {
1106 "type": {
1107 "name": "func"
1108 },
1109 "required": false,
1110 "description": "改变时候的回调",
1111 "defaultValue": {
1112 "value": "func.noop",
1113 "computed": true
1114 },
1115 "docblock": "改变时候的回调",
1116 "params": [],
1117 "returns": null
1118 },
1119 "afterSelect": {
1120 "type": {
1121 "name": "func"
1122 },
1123 "required": false,
1124 "description": "可选参数, 用于校验文件,afterSelect仅在 autoUpload=false 的时候生效,autoUpload=true时,可以使用beforeUpload完全可以替代该功能.",
1125 "defaultValue": {
1126 "value": "func.noop",
1127 "computed": true
1128 },
1129 "docblock": "可选参数, 用于校验文件,afterSelect仅在 autoUpload=false 的时候生效,autoUpload=true时,可以使用beforeUpload完全可以替代该功能.\n@param {Object} file\n@returns {Boolean} 返回false会阻止上传,其他则表示正常",
1130 "params": [
1131 {
1132 "name": "file",
1133 "description": null,
1134 "type": {
1135 "name": "Object"
1136 }
1137 }
1138 ],
1139 "returns": {
1140 "description": "返回false会阻止上传,其他则表示正常",
1141 "type": {
1142 "name": "Boolean"
1143 }
1144 }
1145 },
1146 "onRemove": {
1147 "type": {
1148 "name": "func"
1149 },
1150 "required": false,
1151 "description": "点击移除的回调",
1152 "docblock": "点击移除的回调",
1153 "params": [],
1154 "returns": null
1155 },
1156 "className": {
1157 "type": {
1158 "name": "string"
1159 },
1160 "required": false,
1161 "description": "自定义class",
1162 "docblock": "自定义class"
1163 },
1164 "style": {
1165 "type": {
1166 "name": "object"
1167 },
1168 "required": false,
1169 "description": "自定义内联样式",
1170 "docblock": "自定义内联样式",
1171 "properties": []
1172 },
1173 "autoUpload": {
1174 "type": {
1175 "name": "bool"
1176 },
1177 "required": false,
1178 "description": "自动上传",
1179 "defaultValue": {
1180 "value": "true",
1181 "computed": false
1182 },
1183 "docblock": "自动上传"
1184 },
1185 "progressProps": {
1186 "type": {
1187 "name": "object"
1188 },
1189 "required": false,
1190 "description": "透传给Progress props",
1191 "docblock": "透传给Progress props",
1192 "properties": []
1193 },
1194 "isPreview": {
1195 "type": {
1196 "name": "bool"
1197 },
1198 "required": false,
1199 "description": "是否为预览态",
1200 "docblock": "是否为预览态"
1201 },
1202 "renderPreview": {
1203 "type": {
1204 "name": "func"
1205 },
1206 "required": false,
1207 "description": "预览态模式下渲染的内容",
1208 "docblock": "预览态模式下渲染的内容\n@param {number} value 评分值",
1209 "params": [
1210 {
1211 "name": "value",
1212 "description": "评分值",
1213 "type": {
1214 "name": "number"
1215 }
1216 }
1217 ],
1218 "returns": null
1219 },
1220 "fileKeyName": {
1221 "type": {
1222 "name": "string"
1223 },
1224 "required": false,
1225 "description": "文件对象的 key name",
1226 "docblock": "文件对象的 key name\n@version 1.21",
1227 "version": {
1228 "value": "1.21",
1229 "computed": false
1230 }
1231 },
1232 "fileNameRender": {
1233 "type": {
1234 "name": "func"
1235 },
1236 "required": false,
1237 "description": "list 的自定义文件名渲染",
1238 "docblock": "list 的自定义文件名渲染\n@param {Object} file 文件\n@return {Node} react node",
1239 "params": [
1240 {
1241 "name": "file",
1242 "description": "文件",
1243 "type": {
1244 "name": "Object"
1245 }
1246 }
1247 ],
1248 "returns": {
1249 "description": "react node",
1250 "type": {
1251 "name": "Node"
1252 }
1253 }
1254 },
1255 "actionRender": {
1256 "type": {
1257 "name": "func"
1258 },
1259 "required": false,
1260 "description": "操作区域额外渲染",
1261 "docblock": "操作区域额外渲染\n@param {Object} file 文件\n@return {Node} react node",
1262 "params": [
1263 {
1264 "name": "file",
1265 "description": "文件",
1266 "type": {
1267 "name": "Object"
1268 }
1269 }
1270 ],
1271 "returns": {
1272 "description": "react node",
1273 "type": {
1274 "name": "Node"
1275 }
1276 }
1277 },
1278 "previewOnFileName": {
1279 "type": {
1280 "name": "bool"
1281 },
1282 "required": false,
1283 "description": "点击文件名时触发 onPreview",
1284 "defaultValue": {
1285 "value": "false",
1286 "computed": false
1287 },
1288 "docblock": "点击文件名时触发 onPreview\n@version 1.24",
1289 "version": {
1290 "value": "1.24",
1291 "computed": false
1292 }
1293 },
1294 "onPreview": {
1295 "type": {
1296 "name": "func"
1297 },
1298 "required": false,
1299 "description": "点击图片回调",
1300 "defaultValue": {
1301 "value": "func.noop",
1302 "computed": true
1303 },
1304 "docblock": "点击图片回调",
1305 "params": [],
1306 "returns": null
1307 },
1308 "onCancel": {
1309 "type": {
1310 "name": "func"
1311 },
1312 "required": false,
1313 "description": "取消上传的回调",
1314 "docblock": "取消上传的回调",
1315 "params": [],
1316 "returns": null
1317 },
1318 "itemRender": {
1319 "type": {
1320 "name": "func"
1321 },
1322 "required": false,
1323 "description": "自定义成功和失败的列表渲染方式",
1324 "docblock": "自定义成功和失败的列表渲染方式\n@param {File} file 文件对象\n@param {Object} obj {remove: 删除回调}\n@retuns {ReactNode} React元素\n@version 1.21",
1325 "params": [
1326 {
1327 "name": "file",
1328 "description": "文件对象",
1329 "type": {
1330 "name": "File"
1331 }
1332 },
1333 {
1334 "name": "obj",
1335 "description": "{remove: 删除回调}",
1336 "type": {
1337 "name": "Object"
1338 }
1339 }
1340 ],
1341 "returns": null,
1342 "version": {
1343 "value": "1.21",
1344 "computed": false
1345 }
1346 },
1347 "reUpload": {
1348 "type": {
1349 "name": "bool"
1350 },
1351 "required": false,
1352 "description": "选择新文件上传并替换",
1353 "docblock": "选择新文件上传并替换\n@version 1.24",
1354 "version": {
1355 "value": "1.24",
1356 "computed": false
1357 }
1358 },
1359 "showDownload": {
1360 "type": {
1361 "name": "bool"
1362 },
1363 "required": false,
1364 "description": "展示下载按钮",
1365 "defaultValue": {
1366 "value": "true",
1367 "computed": false
1368 },
1369 "docblock": "展示下载按钮\n@version 1.24",
1370 "version": {
1371 "value": "1.24",
1372 "computed": false
1373 }
1374 }
1375 },
1376 "methods": [],
1377 "description": "继承 Upload 的 API,除非特别说明"
1378 },
1379 {
1380 "name": "Dragger",
1381 "props": {
1382 "prefix": {
1383 "type": {
1384 "name": "string"
1385 },
1386 "required": false,
1387 "description": "样式前缀",
1388 "defaultValue": {
1389 "value": "'next-'",
1390 "computed": false
1391 },
1392 "docblock": "样式前缀"
1393 }
1394 },
1395 "methods": [],
1396 "description": "IE10+ 支持。继承 Upload 的 API,除非特别说明"
1397 },
1398 {
1399 "name": "Selecter",
1400 "props": {
1401 "disabled": {
1402 "type": {
1403 "name": "bool"
1404 },
1405 "required": false,
1406 "description": "是否禁用上传功能",
1407 "docblock": "是否禁用上传功能"
1408 },
1409 "multiple": {
1410 "type": {
1411 "name": "bool"
1412 },
1413 "required": false,
1414 "description": "是否支持多选文件,`ie10+` 支持。开启后按住 ctrl 可选择多个文件",
1415 "defaultValue": {
1416 "value": "false",
1417 "computed": false
1418 },
1419 "docblock": "是否支持多选文件,`ie10+` 支持。开启后按住 ctrl 可选择多个文件"
1420 },
1421 "webkitdirectory": {
1422 "type": {
1423 "name": "bool"
1424 },
1425 "required": false,
1426 "description": "是否支持上传文件夹,仅在 chorme 下生效",
1427 "docblock": "是否支持上传文件夹,仅在 chorme 下生效"
1428 },
1429 "capture": {
1430 "type": {
1431 "name": "string"
1432 },
1433 "required": false,
1434 "description": "调用系统设备媒体",
1435 "docblock": "调用系统设备媒体"
1436 },
1437 "dragable": {
1438 "type": {
1439 "name": "bool"
1440 },
1441 "required": false,
1442 "description": "是否支持拖拽上传,`ie10+` 支持。",
1443 "docblock": "是否支持拖拽上传,`ie10+` 支持。"
1444 },
1445 "accept": {
1446 "type": {
1447 "name": "string"
1448 },
1449 "required": false,
1450 "description": "接受上传的文件类型 (image/png, image/jpg, .doc, .ppt) 详见 [input accept attribute](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/Input#attr-accept)",
1451 "docblock": "接受上传的文件类型 (image/png, image/jpg, .doc, .ppt) 详见 [input accept attribute](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/Input#attr-accept)"
1452 },
1453 "onSelect": {
1454 "type": {
1455 "name": "func"
1456 },
1457 "required": false,
1458 "description": "文件选择回调",
1459 "defaultValue": {
1460 "value": "func.noop",
1461 "computed": true
1462 },
1463 "docblock": "文件选择回调",
1464 "params": [],
1465 "returns": null
1466 },
1467 "onDragOver": {
1468 "type": {
1469 "name": "func"
1470 },
1471 "required": false,
1472 "description": "拖拽经过回调",
1473 "defaultValue": {
1474 "value": "func.noop",
1475 "computed": true
1476 },
1477 "docblock": "拖拽经过回调",
1478 "params": [],
1479 "returns": null
1480 },
1481 "onDragLeave": {
1482 "type": {
1483 "name": "func"
1484 },
1485 "required": false,
1486 "description": "拖拽离开回调",
1487 "defaultValue": {
1488 "value": "func.noop",
1489 "computed": true
1490 },
1491 "docblock": "拖拽离开回调",
1492 "params": [],
1493 "returns": null
1494 },
1495 "onDrop": {
1496 "type": {
1497 "name": "func"
1498 },
1499 "required": false,
1500 "description": "拖拽完成回调",
1501 "defaultValue": {
1502 "value": "func.noop",
1503 "computed": true
1504 },
1505 "docblock": "拖拽完成回调",
1506 "params": [],
1507 "returns": null
1508 }
1509 },
1510 "methods": [
1511 {
1512 "name": "onClick",
1513 "docblock": "点击上传按钮\n@return {void}",
1514 "modifiers": [],
1515 "params": [],
1516 "returns": {
1517 "description": null,
1518 "type": {
1519 "name": "void"
1520 }
1521 },
1522 "description": "点击上传按钮"
1523 },
1524 {
1525 "name": "onKeyDown",
1526 "docblock": "键盘事件\n@param {SyntheticEvent} e\n@return {void}",
1527 "modifiers": [],
1528 "params": [
1529 {
1530 "name": "e",
1531 "description": null,
1532 "type": {
1533 "name": "SyntheticEvent"
1534 }
1535 }
1536 ],
1537 "returns": {
1538 "description": null,
1539 "type": {
1540 "name": "void"
1541 }
1542 },
1543 "description": "键盘事件"
1544 },
1545 {
1546 "name": "onDrop",
1547 "docblock": "拖拽\n@param {SyntheticEvent} e\n@return {void}",
1548 "modifiers": [],
1549 "params": [
1550 {
1551 "name": "e",
1552 "description": null,
1553 "type": {
1554 "name": "SyntheticEvent"
1555 }
1556 }
1557 ],
1558 "returns": {
1559 "description": null,
1560 "type": {
1561 "name": "void"
1562 }
1563 },
1564 "description": "拖拽"
1565 }
1566 ],
1567 "description": "[底层能力] 可自定义样式的文件选择器"
1568 }
1569 ]
1570}
\No newline at end of file