UNPKG

43.4 kBJSONView Raw
1{
2 "name": "Select",
3 "props": {
4 "size": {
5 "type": {
6 "name": "enum",
7 "value": [
8 {
9 "value": "'small'",
10 "computed": false
11 },
12 {
13 "value": "'medium'",
14 "computed": false
15 },
16 {
17 "value": "'large'",
18 "computed": false
19 }
20 ]
21 },
22 "required": false,
23 "description": "选择器尺寸",
24 "defaultValue": {
25 "value": "'medium'",
26 "computed": false
27 },
28 "docblock": "选择器尺寸"
29 },
30 "value": {
31 "type": {
32 "name": "any"
33 },
34 "required": false,
35 "description": "当前值,用于受控模式",
36 "docblock": "当前值,用于受控模式"
37 },
38 "defaultValue": {
39 "type": {
40 "name": "any"
41 },
42 "required": false,
43 "description": "初始的默认值",
44 "docblock": "初始的默认值"
45 },
46 "placeholder": {
47 "type": {
48 "name": "string"
49 },
50 "required": false,
51 "description": "没有值的时候的占位符",
52 "docblock": "没有值的时候的占位符"
53 },
54 "autoWidth": {
55 "type": {
56 "name": "bool"
57 },
58 "required": false,
59 "description": "下拉菜单是否与选择器对齐",
60 "defaultValue": {
61 "value": "true",
62 "computed": false
63 },
64 "docblock": "下拉菜单是否与选择器对齐"
65 },
66 "label": {
67 "type": {
68 "name": "node"
69 },
70 "required": false,
71 "description": "自定义内联 label",
72 "docblock": "自定义内联 label"
73 },
74 "hasClear": {
75 "type": {
76 "name": "bool"
77 },
78 "required": false,
79 "description": "是否有清除按钮(单选模式有效)",
80 "docblock": "是否有清除按钮(单选模式有效)"
81 },
82 "state": {
83 "type": {
84 "name": "enum",
85 "value": [
86 {
87 "value": "'error'",
88 "computed": false
89 },
90 {
91 "value": "'loading'",
92 "computed": false
93 },
94 {
95 "value": "'success'",
96 "computed": false
97 },
98 {
99 "value": "'warning'",
100 "computed": false
101 }
102 ]
103 },
104 "required": false,
105 "description": "校验状态",
106 "docblock": "校验状态"
107 },
108 "readOnly": {
109 "type": {
110 "name": "bool"
111 },
112 "required": false,
113 "description": "是否只读,只读模式下可以展开弹层但不能选",
114 "docblock": "是否只读,只读模式下可以展开弹层但不能选"
115 },
116 "disabled": {
117 "type": {
118 "name": "bool"
119 },
120 "required": false,
121 "description": "是否禁用选择器",
122 "docblock": "是否禁用选择器"
123 },
124 "visible": {
125 "type": {
126 "name": "bool"
127 },
128 "required": false,
129 "description": "当前弹层是否显示",
130 "docblock": "当前弹层是否显示"
131 },
132 "defaultVisible": {
133 "type": {
134 "name": "bool"
135 },
136 "required": false,
137 "description": "弹层初始化是否显示",
138 "docblock": "弹层初始化是否显示"
139 },
140 "onVisibleChange": {
141 "type": {
142 "name": "func"
143 },
144 "required": false,
145 "description": "弹层显示或隐藏时触发的回调",
146 "defaultValue": {
147 "value": "func.noop",
148 "computed": true
149 },
150 "docblock": "弹层显示或隐藏时触发的回调\n@param {Boolean} visible 弹层是否显示\n@param {String} type 触发弹层显示或隐藏的来源 fromContent 表示由Dropdown内容触发; fromTrigger 表示由trigger的点击触发; docClick 表示由document的点击触发",
151 "params": [
152 {
153 "name": "visible",
154 "description": "弹层是否显示",
155 "type": {
156 "name": "Boolean"
157 }
158 },
159 {
160 "name": "type",
161 "description": "触发弹层显示或隐藏的来源 fromContent 表示由Dropdown内容触发; fromTrigger 表示由trigger的点击触发; docClick 表示由document的点击触发",
162 "type": {
163 "name": "String"
164 }
165 }
166 ],
167 "returns": null
168 },
169 "popupContainer": {
170 "type": {
171 "name": "any"
172 },
173 "required": false,
174 "description": "弹层挂载的容器节点",
175 "docblock": "弹层挂载的容器节点"
176 },
177 "popupClassName": {
178 "type": {
179 "name": "any"
180 },
181 "required": false,
182 "description": "弹层的 className",
183 "docblock": "弹层的 className"
184 },
185 "popupStyle": {
186 "type": {
187 "name": "object"
188 },
189 "required": false,
190 "description": "弹层的内联样式",
191 "docblock": "弹层的内联样式",
192 "properties": []
193 },
194 "popupProps": {
195 "type": {
196 "name": "object"
197 },
198 "required": false,
199 "description": "添加到弹层上的属性",
200 "defaultValue": {
201 "value": "{}",
202 "computed": false
203 },
204 "docblock": "添加到弹层上的属性",
205 "properties": []
206 },
207 "followTrigger": {
208 "type": {
209 "name": "bool"
210 },
211 "required": false,
212 "description": "是否跟随滚动",
213 "docblock": "是否跟随滚动"
214 },
215 "popupContent": {
216 "type": {
217 "name": "node"
218 },
219 "required": false,
220 "description": "自定义弹层的内容",
221 "docblock": "自定义弹层的内容"
222 },
223 "menuProps": {
224 "type": {
225 "name": "object"
226 },
227 "required": false,
228 "description": "添加到菜单上的属性",
229 "docblock": "添加到菜单上的属性\n@version 1.18",
230 "properties": [],
231 "version": {
232 "value": "1.18",
233 "computed": false
234 }
235 },
236 "filterLocal": {
237 "type": {
238 "name": "bool"
239 },
240 "required": false,
241 "description": "是否使用本地过滤,在数据源为远程的时候需要关闭此项",
242 "defaultValue": {
243 "value": "true",
244 "computed": false
245 },
246 "docblock": "是否使用本地过滤,在数据源为远程的时候需要关闭此项"
247 },
248 "filter": {
249 "type": {
250 "name": "func"
251 },
252 "required": false,
253 "description": "本地过滤方法,返回一个 Boolean 值确定是否保留",
254 "defaultValue": {
255 "value": "filter",
256 "computed": true
257 },
258 "docblock": "本地过滤方法,返回一个 Boolean 值确定是否保留\n@param {String} key 搜索关键字\n@param {Object} item 渲染节点的item\n@return {Boolean} 是否匹配",
259 "params": [
260 {
261 "name": "key",
262 "description": "搜索关键字",
263 "type": {
264 "name": "String"
265 }
266 },
267 {
268 "name": "item",
269 "description": "渲染节点的item",
270 "type": {
271 "name": "Object"
272 }
273 }
274 ],
275 "returns": {
276 "description": "是否匹配",
277 "type": {
278 "name": "Boolean"
279 }
280 }
281 },
282 "defaultHighlightKey": {
283 "type": {
284 "name": "string"
285 },
286 "required": false,
287 "description": "默认高亮的 key,不要和 autoHighlightFirstItem 同时使用",
288 "defaultValue": {
289 "value": "null",
290 "computed": false
291 },
292 "docblock": "默认高亮的 key,不要和 autoHighlightFirstItem 同时使用"
293 },
294 "highlightKey": {
295 "type": {
296 "name": "string"
297 },
298 "required": false,
299 "description": "高亮 key,不要和 autoHighlightFirstItem 同时使用,用于受控模式",
300 "docblock": "高亮 key,不要和 autoHighlightFirstItem 同时使用,用于受控模式"
301 },
302 "onToggleHighlightItem": {
303 "type": {
304 "name": "func"
305 },
306 "required": false,
307 "description": "键盘上下键切换菜单高亮选项的回调",
308 "defaultValue": {
309 "value": "func.noop",
310 "computed": true
311 },
312 "docblock": "键盘上下键切换菜单高亮选项的回调",
313 "params": [],
314 "returns": null
315 },
316 "autoHighlightFirstItem": {
317 "type": {
318 "name": "bool"
319 },
320 "required": false,
321 "description": "自动高亮第一个元素",
322 "defaultValue": {
323 "value": "true",
324 "computed": false
325 },
326 "docblock": "自动高亮第一个元素"
327 },
328 "useVirtual": {
329 "type": {
330 "name": "bool"
331 },
332 "required": false,
333 "description": "是否开启虚拟滚动模式",
334 "docblock": "是否开启虚拟滚动模式"
335 },
336 "dataSource": {
337 "type": {
338 "name": "arrayOf",
339 "value": {
340 "name": "union",
341 "value": [
342 {
343 "name": "shape",
344 "value": {
345 "value": {
346 "name": "any",
347 "required": false
348 },
349 "label": {
350 "name": "any",
351 "required": false
352 },
353 "disabled": {
354 "name": "bool",
355 "required": false
356 },
357 "children": {
358 "name": "array",
359 "required": false
360 }
361 }
362 },
363 {
364 "name": "bool"
365 },
366 {
367 "name": "number"
368 },
369 {
370 "name": "string"
371 }
372 ]
373 }
374 },
375 "required": false,
376 "description": "传入的数据源,可以动态渲染子项,详见 [dataSource的使用](#dataSource的使用)",
377 "docblock": "传入的数据源,可以动态渲染子项,详见 [dataSource的使用](#dataSource的使用)"
378 },
379 "itemRender": {
380 "type": {
381 "name": "func"
382 },
383 "required": false,
384 "description": "渲染 MenuItem 内容的方法",
385 "docblock": "渲染 MenuItem 内容的方法\n@param {Object} item 渲染节点的item\n@param {String} searchValue 搜索关键字(如果开启搜索)\n@return {ReactNode} item node",
386 "params": [
387 {
388 "name": "item",
389 "description": "渲染节点的item",
390 "type": {
391 "name": "Object"
392 }
393 },
394 {
395 "name": "searchValue",
396 "description": "搜索关键字(如果开启搜索)",
397 "type": {
398 "name": "String"
399 }
400 }
401 ],
402 "returns": {
403 "description": "item node",
404 "type": {
405 "name": "ReactNode"
406 }
407 }
408 },
409 "mode": {
410 "type": {
411 "name": "enum",
412 "value": [
413 {
414 "value": "'single'",
415 "computed": false
416 },
417 {
418 "value": "'multiple'",
419 "computed": false
420 },
421 {
422 "value": "'tag'",
423 "computed": false
424 }
425 ]
426 },
427 "required": false,
428 "description": "选择器模式",
429 "defaultValue": {
430 "value": "'single'",
431 "computed": false
432 },
433 "docblock": "选择器模式"
434 },
435 "notFoundContent": {
436 "type": {
437 "name": "node"
438 },
439 "required": false,
440 "description": "弹层内容为空的文案",
441 "docblock": "弹层内容为空的文案"
442 },
443 "isPreview": {
444 "type": {
445 "name": "bool"
446 },
447 "required": false,
448 "description": "是否为预览态",
449 "docblock": "是否为预览态"
450 },
451 "renderPreview": {
452 "type": {
453 "name": "func"
454 },
455 "required": false,
456 "description": "预览态模式下渲染的内容",
457 "docblock": "预览态模式下渲染的内容\n@param {number} value 评分值",
458 "params": [
459 {
460 "name": "value",
461 "description": "评分值",
462 "type": {
463 "name": "number"
464 }
465 }
466 ],
467 "returns": null
468 },
469 "showDataSourceChildren": {
470 "type": {
471 "name": "bool"
472 },
473 "required": false,
474 "description": "是否展示 dataSource 中 children",
475 "docblock": "是否展示 dataSource 中 children"
476 },
477 "onChange": {
478 "type": {
479 "name": "func"
480 },
481 "required": false,
482 "description": "Select发生改变时触发的回调",
483 "docblock": "Select发生改变时触发的回调\n@param {*} value 选中的值\n@param {String} actionType 触发的方式, 'itemClick', 'enter', 'tag'\n@param {*} item 选中的值的对象数据 (useDetailValue=false有效)",
484 "params": [
485 {
486 "name": "value",
487 "description": "选中的值",
488 "type": {
489 "name": "mixed"
490 }
491 },
492 {
493 "name": "actionType",
494 "description": "触发的方式, 'itemClick', 'enter', 'tag'",
495 "type": {
496 "name": "String"
497 }
498 },
499 {
500 "name": "item",
501 "description": "选中的值的对象数据 (useDetailValue=false有效)",
502 "type": {
503 "name": "mixed"
504 }
505 }
506 ],
507 "returns": null
508 },
509 "hasBorder": {
510 "type": {
511 "name": "bool"
512 },
513 "required": false,
514 "description": "是否有边框",
515 "docblock": "是否有边框"
516 },
517 "hasArrow": {
518 "type": {
519 "name": "bool"
520 },
521 "required": false,
522 "description": "是否有下拉箭头",
523 "defaultValue": {
524 "value": "true",
525 "computed": false
526 },
527 "docblock": "是否有下拉箭头"
528 },
529 "showSearch": {
530 "type": {
531 "name": "bool"
532 },
533 "required": false,
534 "description": "展开后是否能搜索(tag 模式下固定为true)",
535 "defaultValue": {
536 "value": "false",
537 "computed": false
538 },
539 "docblock": "展开后是否能搜索(tag 模式下固定为true)"
540 },
541 "onSearch": {
542 "type": {
543 "name": "func"
544 },
545 "required": false,
546 "description": "当搜索框值变化时回调",
547 "defaultValue": {
548 "value": "func.noop",
549 "computed": true
550 },
551 "docblock": "当搜索框值变化时回调\n@param {String} value 数据",
552 "params": [
553 {
554 "name": "value",
555 "description": "数据",
556 "type": {
557 "name": "String"
558 }
559 }
560 ],
561 "returns": null
562 },
563 "onSearchClear": {
564 "type": {
565 "name": "func"
566 },
567 "required": false,
568 "description": "当搜索框值被(选择、弹窗关闭)导致清空时候的回调",
569 "defaultValue": {
570 "value": "func.noop",
571 "computed": true
572 },
573 "docblock": "当搜索框值被(选择、弹窗关闭)导致清空时候的回调\n@param {String} actionType 触发的方式, 'select'(选择清空), 'popupClose'(弹窗关闭清空)",
574 "params": [
575 {
576 "name": "actionType",
577 "description": "触发的方式, 'select'(选择清空), 'popupClose'(弹窗关闭清空)",
578 "type": {
579 "name": "String"
580 }
581 }
582 ],
583 "returns": null
584 },
585 "hasSelectAll": {
586 "type": {
587 "name": "union",
588 "value": [
589 {
590 "name": "bool"
591 },
592 {
593 "name": "string"
594 }
595 ]
596 },
597 "required": false,
598 "description": "多选模式下是否有全选功能",
599 "docblock": "多选模式下是否有全选功能"
600 },
601 "fillProps": {
602 "type": {
603 "name": "string"
604 },
605 "required": false,
606 "description": "填充到选择框里的值的 key\b\b",
607 "docblock": "填充到选择框里的值的 key\b\b"
608 },
609 "useDetailValue": {
610 "type": {
611 "name": "bool"
612 },
613 "required": false,
614 "description": "value 使用对象类型 `{value, label}`, 同时 onChange 第一个参数返回也修改为 dataSource 中的对象",
615 "docblock": "value 使用对象类型 `{value, label}`, 同时 onChange 第一个参数返回也修改为 dataSource 中的对象"
616 },
617 "cacheValue": {
618 "type": {
619 "name": "bool"
620 },
621 "required": false,
622 "description": "dataSource 变化的时是否保留已选的内容",
623 "defaultValue": {
624 "value": "true",
625 "computed": false
626 },
627 "docblock": "dataSource 变化的时是否保留已选的内容"
628 },
629 "valueRender": {
630 "type": {
631 "name": "func"
632 },
633 "required": false,
634 "description": "渲染 Select 展现内容的方法",
635 "defaultValue": {
636 "value": "item => `item.label || item.value`",
637 "computed": false
638 },
639 "docblock": "渲染 Select 展现内容的方法\n@param {Object} item 渲染节点的item\n@return {ReactNode} 展现内容\n@default item => `item.label || item.value`",
640 "params": [
641 {
642 "name": "item",
643 "description": "渲染节点的item",
644 "type": {
645 "name": "Object"
646 }
647 }
648 ],
649 "returns": {
650 "description": "展现内容",
651 "type": {
652 "name": "ReactNode"
653 }
654 }
655 },
656 "searchValue": {
657 "type": {
658 "name": "string"
659 },
660 "required": false,
661 "description": "受控搜索值,一般不需要设置",
662 "docblock": "受控搜索值,一般不需要设置\n@type {[type]}"
663 },
664 "tagInline": {
665 "type": {
666 "name": "bool"
667 },
668 "required": false,
669 "description": "是否一行显示,仅在 mode 为 multiple 的时候生效",
670 "defaultValue": {
671 "value": "false",
672 "computed": false
673 },
674 "docblock": "是否一行显示,仅在 mode 为 multiple 的时候生效\n@version 1.15",
675 "version": {
676 "value": "1.15",
677 "computed": false
678 }
679 },
680 "tagClosable": {
681 "type": {
682 "name": "bool"
683 },
684 "required": false,
685 "description": "tag 是否可关闭",
686 "defaultValue": {
687 "value": "true",
688 "computed": false
689 },
690 "docblock": "tag 是否可关闭\n@version 1.20",
691 "version": {
692 "value": "1.20",
693 "computed": false
694 }
695 },
696 "adjustTagSize": {
697 "type": {
698 "name": "bool"
699 },
700 "required": false,
701 "description": "tag 尺寸是否和 select 保持一致(mode=multiple/tag 模式生效),默认false",
702 "defaultValue": {
703 "value": "false",
704 "computed": false
705 },
706 "docblock": "tag 尺寸是否和 select 保持一致(mode=multiple/tag 模式生效),默认false\n@version 1.24",
707 "version": {
708 "value": "1.24",
709 "computed": false
710 }
711 },
712 "maxTagCount": {
713 "type": {
714 "name": "number"
715 },
716 "required": false,
717 "description": "最多显示多少个 tag",
718 "docblock": "最多显示多少个 tag\n@version 1.15",
719 "version": {
720 "value": "1.15",
721 "computed": false
722 }
723 },
724 "maxTagPlaceholder": {
725 "type": {
726 "name": "func"
727 },
728 "required": false,
729 "description": "隐藏多余 tag 时显示的内容,在 maxTagCount 生效时起作用",
730 "docblock": "隐藏多余 tag 时显示的内容,在 maxTagCount 生效时起作用\n@param {object} selectedValues 当前已选中的元素\n@param {object} totalValues 总待选元素\n@version 1.15",
731 "params": [
732 {
733 "name": "selectedValues",
734 "description": "当前已选中的元素",
735 "type": {
736 "name": "object"
737 }
738 },
739 {
740 "name": "totalValues",
741 "description": "总待选元素",
742 "type": {
743 "name": "object"
744 }
745 }
746 ],
747 "returns": null,
748 "version": {
749 "value": "1.15",
750 "computed": false
751 }
752 },
753 "hiddenSelected": {
754 "type": {
755 "name": "bool"
756 },
757 "required": false,
758 "description": "选择后是否立即隐藏菜单 (mode=multiple/tag 模式生效)",
759 "docblock": "选择后是否立即隐藏菜单 (mode=multiple/tag 模式生效)"
760 },
761 "onRemove": {
762 "type": {
763 "name": "func"
764 },
765 "required": false,
766 "description": "tag 删除回调",
767 "defaultValue": {
768 "value": "func.noop",
769 "computed": true
770 },
771 "docblock": "tag 删除回调\n@param {object} item 渲染节点的item",
772 "params": [
773 {
774 "name": "item",
775 "description": "渲染节点的item",
776 "type": {
777 "name": "object"
778 }
779 }
780 ],
781 "returns": null
782 },
783 "onFocus": {
784 "type": {
785 "name": "func"
786 },
787 "required": false,
788 "description": "焦点事件",
789 "defaultValue": {
790 "value": "func.noop",
791 "computed": true
792 },
793 "docblock": "焦点事件",
794 "params": [],
795 "returns": null
796 },
797 "onBlur": {
798 "type": {
799 "name": "func"
800 },
801 "required": false,
802 "description": "失去焦点事件",
803 "defaultValue": {
804 "value": "func.noop",
805 "computed": true
806 },
807 "docblock": "失去焦点事件",
808 "params": [],
809 "returns": null
810 },
811 "popupAutoFocus": {
812 "type": {
813 "name": "bool"
814 },
815 "required": false,
816 "description": "展开下拉菜单时是否自动焦点到弹层",
817 "defaultValue": {
818 "value": "false",
819 "computed": false
820 },
821 "docblock": "展开下拉菜单时是否自动焦点到弹层"
822 }
823 },
824 "methods": [
825 {
826 "name": "handleMenuSelect",
827 "docblock": "Menu.Item onSelect\n@private\n@param {Array<string>} keys\n@",
828 "modifiers": [],
829 "params": [
830 {
831 "name": "keys",
832 "description": null,
833 "type": {
834 "name": "Array"
835 }
836 },
837 {
838 "name": "item"
839 }
840 ],
841 "returns": null,
842 "description": "Menu.Item onSelect"
843 },
844 {
845 "name": "handleSingleSelect",
846 "docblock": "单选模式",
847 "modifiers": [],
848 "params": [
849 {
850 "name": "key"
851 },
852 {
853 "name": "triggerType"
854 }
855 ],
856 "returns": null,
857 "description": "单选模式"
858 },
859 {
860 "name": "handleMultipleSelect",
861 "docblock": "多选模式 multiple/tag",
862 "modifiers": [],
863 "params": [
864 {
865 "name": "keys"
866 },
867 {
868 "name": "triggerType"
869 },
870 {
871 "name": "key"
872 },
873 {
874 "name": "keepSearchValue"
875 }
876 ],
877 "returns": null,
878 "description": "多选模式 multiple/tag"
879 },
880 {
881 "name": "handleSearch",
882 "docblock": "Handle search input change event\n@param {String} value search text\n@param {Event} e change Event",
883 "modifiers": [],
884 "params": [
885 {
886 "name": "value",
887 "description": "search text",
888 "type": {
889 "name": "String"
890 }
891 },
892 {
893 "name": "e",
894 "description": "change Event",
895 "type": {
896 "name": "Event"
897 }
898 }
899 ],
900 "returns": null,
901 "description": "Handle search input change event"
902 },
903 {
904 "name": "handleTagClose",
905 "docblock": "Handle Tag close event\n@param {Object} item\n@return {Boolean} false return false to prevent auto close\n----\nIt MUST be multiple mode, needn't additional judgement",
906 "modifiers": [],
907 "params": [
908 {
909 "name": "item",
910 "description": null,
911 "type": {
912 "name": "Object"
913 }
914 }
915 ],
916 "returns": {
917 "description": "false return false to prevent auto close\n----\nIt MUST be multiple mode, needn't additional judgement",
918 "type": {
919 "name": "Boolean"
920 }
921 },
922 "description": "Handle Tag close event"
923 },
924 {
925 "name": "handleDeleteTag",
926 "docblock": "Handle BACKSPACE key event\n@param {Event} e keyDown event\n---\nIt MUST be multiple mode",
927 "modifiers": [],
928 "params": [
929 {
930 "name": "e",
931 "description": "keyDown event\n---\nIt MUST be multiple mode",
932 "type": {
933 "name": "Event"
934 }
935 }
936 ],
937 "returns": null,
938 "description": "Handle BACKSPACE key event"
939 },
940 {
941 "name": "handleSelectAll",
942 "docblock": "Handle SelectAll span click event\n@param {Event} e click event",
943 "modifiers": [],
944 "params": [
945 {
946 "name": "e",
947 "description": "click event",
948 "type": {
949 "name": "Event"
950 }
951 }
952 ],
953 "returns": null,
954 "description": "Handle SelectAll span click event"
955 },
956 {
957 "name": "renderValues",
958 "docblock": "如果用户是自定义的弹层,则直接以 value 为准,不再校验 dataSource\nTODO: 2.0 中 value 接受 string/object{value,label} 两种类型的数据,自动做识别,可以避免用户去转换,也和 date-picker 对齐\n此外 onChange 第一个参数根据 api 来控制类型是 [string] 还是 [object{value,label}]\n@param {object} props",
959 "modifiers": [],
960 "params": [],
961 "returns": null,
962 "description": "如果用户是自定义的弹层,则直接以 value 为准,不再校验 dataSource\nTODO: 2.0 中 value 接受 string/object{value,label} 两种类型的数据,自动做识别,可以避免用户去转换,也和 date-picker 对齐\n此外 onChange 第一个参数根据 api 来控制类型是 [string] 还是 [object{value,label}]"
963 },
964 {
965 "name": "handleWrapClick",
966 "docblock": "1. fix flash while click <label/>\n2. fix onBlur while has clear\n@returns",
967 "modifiers": [],
968 "params": [
969 {
970 "name": "e"
971 }
972 ],
973 "returns": null,
974 "description": "1. fix flash while click <label/>\n2. fix onBlur while has clear"
975 },
976 {
977 "name": "renderExtraNode",
978 "docblock": "render arrow\n@param {object} props\n@param {function} [clickHandler]",
979 "modifiers": [],
980 "params": [],
981 "returns": null,
982 "description": "render arrow"
983 },
984 {
985 "name": "renderSelect",
986 "docblock": "选择器\n@override\n@param {object} props",
987 "modifiers": [],
988 "params": [],
989 "returns": null,
990 "description": "选择器"
991 },
992 {
993 "name": "renderMenuHeader",
994 "docblock": "渲染弹层的 header 内容\n@override\n@param {object} props",
995 "modifiers": [],
996 "params": [],
997 "returns": null,
998 "description": "渲染弹层的 header 内容"
999 }
1000 ],
1001 "subComponents": [
1002 {
1003 "name": "AutoComplete",
1004 "props": {
1005 "size": {
1006 "type": {
1007 "name": "enum",
1008 "value": [
1009 {
1010 "value": "'small'",
1011 "computed": false
1012 },
1013 {
1014 "value": "'medium'",
1015 "computed": false
1016 },
1017 {
1018 "value": "'large'",
1019 "computed": false
1020 }
1021 ]
1022 },
1023 "required": false,
1024 "description": "选择器尺寸",
1025 "defaultValue": {
1026 "value": "'medium'",
1027 "computed": false
1028 },
1029 "docblock": "选择器尺寸"
1030 },
1031 "value": {
1032 "type": {
1033 "name": "union",
1034 "value": [
1035 {
1036 "name": "string"
1037 },
1038 {
1039 "name": "number"
1040 }
1041 ]
1042 },
1043 "required": false,
1044 "description": "当前值,用于受控模式",
1045 "docblock": "当前值,用于受控模式"
1046 },
1047 "defaultValue": {
1048 "type": {
1049 "name": "union",
1050 "value": [
1051 {
1052 "name": "string"
1053 },
1054 {
1055 "name": "number"
1056 }
1057 ]
1058 },
1059 "required": false,
1060 "description": "初始化的默认值",
1061 "docblock": "初始化的默认值"
1062 },
1063 "placeholder": {
1064 "type": {
1065 "name": "string"
1066 },
1067 "required": false,
1068 "description": "没有值的时候的占位符",
1069 "docblock": "没有值的时候的占位符"
1070 },
1071 "autoWidth": {
1072 "type": {
1073 "name": "bool"
1074 },
1075 "required": false,
1076 "description": "下拉菜单是否与选择器对齐",
1077 "defaultValue": {
1078 "value": "true",
1079 "computed": false
1080 },
1081 "docblock": "下拉菜单是否与选择器对齐"
1082 },
1083 "label": {
1084 "type": {
1085 "name": "node"
1086 },
1087 "required": false,
1088 "description": "自定义内联 label",
1089 "docblock": "自定义内联 label"
1090 },
1091 "hasClear": {
1092 "type": {
1093 "name": "bool"
1094 },
1095 "required": false,
1096 "description": "是否有清除按钮(单选模式有效)",
1097 "docblock": "是否有清除按钮(单选模式有效)"
1098 },
1099 "state": {
1100 "type": {
1101 "name": "enum",
1102 "value": [
1103 {
1104 "value": "'error'",
1105 "computed": false
1106 },
1107 {
1108 "value": "'loading'",
1109 "computed": false
1110 },
1111 {
1112 "value": "'success'",
1113 "computed": false
1114 },
1115 {
1116 "value": "'warning'",
1117 "computed": false
1118 }
1119 ]
1120 },
1121 "required": false,
1122 "description": "校验状态",
1123 "docblock": "校验状态"
1124 },
1125 "readOnly": {
1126 "type": {
1127 "name": "bool"
1128 },
1129 "required": false,
1130 "description": "是否只读,只读模式下可以展开弹层但不能选",
1131 "docblock": "是否只读,只读模式下可以展开弹层但不能选"
1132 },
1133 "disabled": {
1134 "type": {
1135 "name": "bool"
1136 },
1137 "required": false,
1138 "description": "是否禁用选择器",
1139 "docblock": "是否禁用选择器"
1140 },
1141 "visible": {
1142 "type": {
1143 "name": "bool"
1144 },
1145 "required": false,
1146 "description": "当前弹层是否显示",
1147 "docblock": "当前弹层是否显示"
1148 },
1149 "defaultVisible": {
1150 "type": {
1151 "name": "bool"
1152 },
1153 "required": false,
1154 "description": "弹层初始化是否显示",
1155 "docblock": "弹层初始化是否显示"
1156 },
1157 "onVisibleChange": {
1158 "type": {
1159 "name": "func"
1160 },
1161 "required": false,
1162 "description": "弹层显示或隐藏时触发的回调",
1163 "defaultValue": {
1164 "value": "func.noop",
1165 "computed": true
1166 },
1167 "docblock": "弹层显示或隐藏时触发的回调\n@param {Boolean} visible 弹层是否显示\n@param {String} type 触发弹层显示或隐藏的来源 fromContent 表示由Dropdown内容触发; fromTrigger 表示由trigger的点击触发; docClick 表示由document的点击触发",
1168 "params": [
1169 {
1170 "name": "visible",
1171 "description": "弹层是否显示",
1172 "type": {
1173 "name": "Boolean"
1174 }
1175 },
1176 {
1177 "name": "type",
1178 "description": "触发弹层显示或隐藏的来源 fromContent 表示由Dropdown内容触发; fromTrigger 表示由trigger的点击触发; docClick 表示由document的点击触发",
1179 "type": {
1180 "name": "String"
1181 }
1182 }
1183 ],
1184 "returns": null
1185 },
1186 "popupContainer": {
1187 "type": {
1188 "name": "any"
1189 },
1190 "required": false,
1191 "description": "弹层挂载的容器节点",
1192 "docblock": "弹层挂载的容器节点"
1193 },
1194 "popupClassName": {
1195 "type": {
1196 "name": "any"
1197 },
1198 "required": false,
1199 "description": "弹层的 className",
1200 "docblock": "弹层的 className"
1201 },
1202 "popupStyle": {
1203 "type": {
1204 "name": "object"
1205 },
1206 "required": false,
1207 "description": "弹层的内联样式",
1208 "docblock": "弹层的内联样式",
1209 "properties": []
1210 },
1211 "popupProps": {
1212 "type": {
1213 "name": "object"
1214 },
1215 "required": false,
1216 "description": "添加到弹层上的属性",
1217 "defaultValue": {
1218 "value": "{}",
1219 "computed": false
1220 },
1221 "docblock": "添加到弹层上的属性",
1222 "properties": []
1223 },
1224 "followTrigger": {
1225 "type": {
1226 "name": "bool"
1227 },
1228 "required": false,
1229 "description": "是否跟随滚动",
1230 "docblock": "是否跟随滚动"
1231 },
1232 "popupContent": {
1233 "type": {
1234 "name": "node"
1235 },
1236 "required": false,
1237 "description": "自定义弹层的内容",
1238 "docblock": "自定义弹层的内容"
1239 },
1240 "menuProps": {
1241 "type": {
1242 "name": "object"
1243 },
1244 "required": false,
1245 "description": "添加到菜单上的属性",
1246 "docblock": "添加到菜单上的属性\n@version 1.18",
1247 "properties": [],
1248 "version": {
1249 "value": "1.18",
1250 "computed": false
1251 }
1252 },
1253 "filterLocal": {
1254 "type": {
1255 "name": "bool"
1256 },
1257 "required": false,
1258 "description": "是否使用本地过滤,在数据源为远程的时候需要关闭此项",
1259 "defaultValue": {
1260 "value": "true",
1261 "computed": false
1262 },
1263 "docblock": "是否使用本地过滤,在数据源为远程的时候需要关闭此项"
1264 },
1265 "filter": {
1266 "type": {
1267 "name": "func"
1268 },
1269 "required": false,
1270 "description": "本地过滤方法,返回一个 Boolean 值确定是否保留",
1271 "defaultValue": {
1272 "value": "filter",
1273 "computed": true
1274 },
1275 "docblock": "本地过滤方法,返回一个 Boolean 值确定是否保留\n@param {String} key 搜索关键字\n@param {Object} item 渲染节点的item\n@return {Boolean} 是否匹配",
1276 "params": [
1277 {
1278 "name": "key",
1279 "description": "搜索关键字",
1280 "type": {
1281 "name": "String"
1282 }
1283 },
1284 {
1285 "name": "item",
1286 "description": "渲染节点的item",
1287 "type": {
1288 "name": "Object"
1289 }
1290 }
1291 ],
1292 "returns": {
1293 "description": "是否匹配",
1294 "type": {
1295 "name": "Boolean"
1296 }
1297 }
1298 },
1299 "defaultHighlightKey": {
1300 "type": {
1301 "name": "string"
1302 },
1303 "required": false,
1304 "description": "默认高亮的 key,不要和 autoHighlightFirstItem 同时使用",
1305 "defaultValue": {
1306 "value": "null",
1307 "computed": false
1308 },
1309 "docblock": "默认高亮的 key,不要和 autoHighlightFirstItem 同时使用"
1310 },
1311 "highlightKey": {
1312 "type": {
1313 "name": "string"
1314 },
1315 "required": false,
1316 "description": "高亮 key,不要和 autoHighlightFirstItem 同时使用,用于受控模式",
1317 "docblock": "高亮 key,不要和 autoHighlightFirstItem 同时使用,用于受控模式"
1318 },
1319 "onToggleHighlightItem": {
1320 "type": {
1321 "name": "func"
1322 },
1323 "required": false,
1324 "description": "键盘上下键切换菜单高亮选项的回调",
1325 "defaultValue": {
1326 "value": "func.noop",
1327 "computed": true
1328 },
1329 "docblock": "键盘上下键切换菜单高亮选项的回调",
1330 "params": [],
1331 "returns": null
1332 },
1333 "autoHighlightFirstItem": {
1334 "type": {
1335 "name": "bool"
1336 },
1337 "required": false,
1338 "description": "自动高亮第一个元素",
1339 "defaultValue": {
1340 "value": "true",
1341 "computed": false
1342 },
1343 "docblock": "自动高亮第一个元素"
1344 },
1345 "useVirtual": {
1346 "type": {
1347 "name": "bool"
1348 },
1349 "required": false,
1350 "description": "是否开启虚拟滚动模式",
1351 "docblock": "是否开启虚拟滚动模式"
1352 },
1353 "dataSource": {
1354 "type": {
1355 "name": "arrayOf",
1356 "value": {
1357 "name": "union",
1358 "value": [
1359 {
1360 "name": "shape",
1361 "value": {
1362 "value": {
1363 "name": "string",
1364 "required": false
1365 },
1366 "label": {
1367 "name": "any",
1368 "required": false
1369 },
1370 "disabled": {
1371 "name": "bool",
1372 "required": false
1373 },
1374 "children": {
1375 "name": "array",
1376 "required": false
1377 }
1378 }
1379 },
1380 {
1381 "name": "string"
1382 }
1383 ]
1384 }
1385 },
1386 "required": false,
1387 "description": "传入的数据源,可以动态渲染子项",
1388 "docblock": "传入的数据源,可以动态渲染子项"
1389 },
1390 "itemRender": {
1391 "type": {
1392 "name": "func"
1393 },
1394 "required": false,
1395 "description": "渲染 MenuItem 内容的方法",
1396 "docblock": "渲染 MenuItem 内容的方法\n@param {Object} item 渲染节点的 item\n@return {ReactNode} item node",
1397 "params": [
1398 {
1399 "name": "item",
1400 "description": "渲染节点的 item",
1401 "type": {
1402 "name": "Object"
1403 }
1404 }
1405 ],
1406 "returns": {
1407 "description": "item node",
1408 "type": {
1409 "name": "ReactNode"
1410 }
1411 }
1412 },
1413 "isPreview": {
1414 "type": {
1415 "name": "bool"
1416 },
1417 "required": false,
1418 "description": "是否为预览态",
1419 "docblock": "是否为预览态"
1420 },
1421 "renderPreview": {
1422 "type": {
1423 "name": "func"
1424 },
1425 "required": false,
1426 "description": "预览态模式下渲染的内容",
1427 "docblock": "预览态模式下渲染的内容\n@param {number} value 评分值",
1428 "params": [
1429 {
1430 "name": "value",
1431 "description": "评分值",
1432 "type": {
1433 "name": "number"
1434 }
1435 }
1436 ],
1437 "returns": null
1438 },
1439 "onChange": {
1440 "type": {
1441 "name": "func"
1442 },
1443 "required": false,
1444 "description": "Select发生改变时触发的回调",
1445 "docblock": "Select发生改变时触发的回调\n@param {*} value 选中的值\n@param {String} actionType 触发的方式, 'itemClick', 'enter', 'change'\n@param {*} item 选中的值的对象数据",
1446 "params": [
1447 {
1448 "name": "value",
1449 "description": "选中的值",
1450 "type": {
1451 "name": "mixed"
1452 }
1453 },
1454 {
1455 "name": "actionType",
1456 "description": "触发的方式, 'itemClick', 'enter', 'change'",
1457 "type": {
1458 "name": "String"
1459 }
1460 },
1461 {
1462 "name": "item",
1463 "description": "选中的值的对象数据",
1464 "type": {
1465 "name": "mixed"
1466 }
1467 }
1468 ],
1469 "returns": null
1470 },
1471 "fillProps": {
1472 "type": {
1473 "name": "string"
1474 },
1475 "required": false,
1476 "description": "填充到选择框里的值的 key\b\b,默认是 value",
1477 "defaultValue": {
1478 "value": "'value'",
1479 "computed": false
1480 },
1481 "docblock": "填充到选择框里的值的 key\b\b,默认是 value"
1482 }
1483 },
1484 "methods": [
1485 {
1486 "name": "handleTriggerKeyDown",
1487 "docblock": "Handle trigger keydown event\n@param {Event} e",
1488 "modifiers": [],
1489 "params": [
1490 {
1491 "name": "e",
1492 "description": null,
1493 "type": {
1494 "name": "Event"
1495 }
1496 }
1497 ],
1498 "returns": null,
1499 "description": "Handle trigger keydown event"
1500 },
1501 {
1502 "name": "renderSelect",
1503 "docblock": "选择器\n@override\n@param {object} props",
1504 "modifiers": [],
1505 "params": [
1506 {
1507 "name": "props",
1508 "description": null,
1509 "type": {
1510 "name": "object"
1511 }
1512 }
1513 ],
1514 "returns": null,
1515 "description": "选择器"
1516 }
1517 ]
1518 },
1519 {
1520 "name": "OptionGroup",
1521 "props": {
1522 "label": {
1523 "type": {
1524 "name": "node"
1525 },
1526 "required": false,
1527 "description": "设置分组的文案",
1528 "docblock": "设置分组的文案"
1529 }
1530 },
1531 "methods": []
1532 },
1533 {
1534 "name": "Option",
1535 "props": {
1536 "value": {
1537 "type": {
1538 "name": "any"
1539 },
1540 "required": true,
1541 "description": "选项值",
1542 "docblock": "选项值"
1543 },
1544 "disabled": {
1545 "type": {
1546 "name": "bool"
1547 },
1548 "required": false,
1549 "description": "是否禁用",
1550 "docblock": "是否禁用"
1551 }
1552 },
1553 "methods": []
1554 }
1555 ]
1556}
\No newline at end of file