UNPKG

19.4 kBJSONView Raw
1{
2 "name": "CascaderSelect",
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 "placeholder": {
31 "type": {
32 "name": "string"
33 },
34 "required": false,
35 "description": "选择框占位符",
36 "docblock": "选择框占位符"
37 },
38 "disabled": {
39 "type": {
40 "name": "bool"
41 },
42 "required": false,
43 "description": "是否禁用",
44 "defaultValue": {
45 "value": "false",
46 "computed": false
47 },
48 "docblock": "是否禁用"
49 },
50 "hasArrow": {
51 "type": {
52 "name": "bool"
53 },
54 "required": false,
55 "description": "是否有下拉箭头",
56 "defaultValue": {
57 "value": "true",
58 "computed": false
59 },
60 "docblock": "是否有下拉箭头"
61 },
62 "hasBorder": {
63 "type": {
64 "name": "bool"
65 },
66 "required": false,
67 "description": "是否有边框",
68 "defaultValue": {
69 "value": "true",
70 "computed": false
71 },
72 "docblock": "是否有边框"
73 },
74 "hasClear": {
75 "type": {
76 "name": "bool"
77 },
78 "required": false,
79 "description": "是否有清除按钮",
80 "defaultValue": {
81 "value": "false",
82 "computed": false
83 },
84 "docblock": "是否有清除按钮"
85 },
86 "label": {
87 "type": {
88 "name": "node"
89 },
90 "required": false,
91 "description": "自定义内联 label",
92 "docblock": "自定义内联 label"
93 },
94 "readOnly": {
95 "type": {
96 "name": "bool"
97 },
98 "required": false,
99 "description": "是否只读,只读模式下可以展开弹层但不能选",
100 "docblock": "是否只读,只读模式下可以展开弹层但不能选"
101 },
102 "dataSource": {
103 "type": {
104 "name": "arrayOf",
105 "value": {
106 "name": "object"
107 }
108 },
109 "required": false,
110 "description": "数据源,结构可参考下方说明",
111 "defaultValue": {
112 "value": "[]",
113 "computed": false
114 },
115 "docblock": "数据源,结构可参考下方说明"
116 },
117 "defaultValue": {
118 "type": {
119 "name": "union",
120 "value": [
121 {
122 "name": "string"
123 },
124 {
125 "name": "arrayOf",
126 "value": {
127 "name": "string"
128 }
129 }
130 ]
131 },
132 "required": false,
133 "description": "(非受控)默认值",
134 "defaultValue": {
135 "value": "null",
136 "computed": false
137 },
138 "docblock": "(非受控)默认值"
139 },
140 "value": {
141 "type": {
142 "name": "union",
143 "value": [
144 {
145 "name": "string"
146 },
147 {
148 "name": "arrayOf",
149 "value": {
150 "name": "string"
151 }
152 }
153 ]
154 },
155 "required": false,
156 "description": "(受控)当前值",
157 "docblock": "(受控)当前值"
158 },
159 "onChange": {
160 "type": {
161 "name": "func"
162 },
163 "required": false,
164 "description": "选中值改变时触发的回调函数",
165 "docblock": "选中值改变时触发的回调函数\n@param {String|Array} value 选中的值,单选时返回单个值,多选时返回数组\n@param {Object|Array} data 选中的数据,包括 value 和 label,单选时返回单个值,多选时返回数组,父子节点选中关联时,同时选中,只返回父节点\n@param {Object} extra 额外参数\n@param {Array} extra.selectedPath 单选时选中的数据的路径\n@param {Boolean} extra.checked 多选时当前的操作是选中还是取消选中\n@param {Object} extra.currentData 多选时当前操作的数据\n@param {Array} extra.checkedData 多选时所有被选中的数据\n@param {Array} extra.indeterminateData 多选时半选的数据",
166 "params": [
167 {
168 "name": "value",
169 "description": "选中的值,单选时返回单个值,多选时返回数组",
170 "type": {
171 "name": "union",
172 "value": [
173 "String",
174 "Array"
175 ]
176 }
177 },
178 {
179 "name": "data",
180 "description": "选中的数据,包括 value 和 label,单选时返回单个值,多选时返回数组,父子节点选中关联时,同时选中,只返回父节点",
181 "type": {
182 "name": "union",
183 "value": [
184 "Object",
185 "Array"
186 ]
187 }
188 },
189 {
190 "name": "extra",
191 "description": "额外参数",
192 "type": {
193 "name": "Object"
194 }
195 },
196 {
197 "name": "extra.selectedPath",
198 "description": "单选时选中的数据的路径",
199 "type": {
200 "name": "Array"
201 }
202 },
203 {
204 "name": "extra.checked",
205 "description": "多选时当前的操作是选中还是取消选中",
206 "type": {
207 "name": "Boolean"
208 }
209 },
210 {
211 "name": "extra.currentData",
212 "description": "多选时当前操作的数据",
213 "type": {
214 "name": "Object"
215 }
216 },
217 {
218 "name": "extra.checkedData",
219 "description": "多选时所有被选中的数据",
220 "type": {
221 "name": "Array"
222 }
223 },
224 {
225 "name": "extra.indeterminateData",
226 "description": "多选时半选的数据",
227 "type": {
228 "name": "Array"
229 }
230 }
231 ],
232 "returns": null
233 },
234 "defaultExpandedValue": {
235 "type": {
236 "name": "arrayOf",
237 "value": {
238 "name": "string"
239 }
240 },
241 "required": false,
242 "description": "默认展开值,如果不设置,组件内部会根据 defaultValue/value 进行自动设置",
243 "docblock": "默认展开值,如果不设置,组件内部会根据 defaultValue/value 进行自动设置"
244 },
245 "expandedValue": {
246 "type": {
247 "name": "arrayOf",
248 "value": {
249 "name": "string"
250 }
251 },
252 "required": false,
253 "description": "(受控)当前展开值",
254 "docblock": "(受控)当前展开值"
255 },
256 "expandTriggerType": {
257 "type": {
258 "name": "enum",
259 "value": [
260 {
261 "value": "'click'",
262 "computed": false
263 },
264 {
265 "value": "'hover'",
266 "computed": false
267 }
268 ]
269 },
270 "required": false,
271 "description": "展开触发的方式",
272 "defaultValue": {
273 "value": "'click'",
274 "computed": false
275 },
276 "docblock": "展开触发的方式"
277 },
278 "useVirtual": {
279 "type": {
280 "name": "bool"
281 },
282 "required": false,
283 "description": "是否开启虚拟滚动",
284 "defaultValue": {
285 "value": "false",
286 "computed": false
287 },
288 "docblock": "是否开启虚拟滚动"
289 },
290 "multiple": {
291 "type": {
292 "name": "bool"
293 },
294 "required": false,
295 "description": "是否多选",
296 "defaultValue": {
297 "value": "false",
298 "computed": false
299 },
300 "docblock": "是否多选"
301 },
302 "changeOnSelect": {
303 "type": {
304 "name": "bool"
305 },
306 "required": false,
307 "description": "是否选中即发生改变, 该属性仅在单选模式下有效",
308 "defaultValue": {
309 "value": "false",
310 "computed": false
311 },
312 "docblock": "是否选中即发生改变, 该属性仅在单选模式下有效"
313 },
314 "canOnlyCheckLeaf": {
315 "type": {
316 "name": "bool"
317 },
318 "required": false,
319 "description": "是否只能勾选叶子项的checkbox,该属性仅在多选模式下有效",
320 "defaultValue": {
321 "value": "false",
322 "computed": false
323 },
324 "docblock": "是否只能勾选叶子项的checkbox,该属性仅在多选模式下有效"
325 },
326 "checkStrictly": {
327 "type": {
328 "name": "bool"
329 },
330 "required": false,
331 "description": "父子节点是否选中不关联",
332 "defaultValue": {
333 "value": "false",
334 "computed": false
335 },
336 "docblock": "父子节点是否选中不关联"
337 },
338 "listStyle": {
339 "type": {
340 "name": "object"
341 },
342 "required": false,
343 "description": "每列列表样式对象",
344 "docblock": "每列列表样式对象",
345 "properties": []
346 },
347 "listClassName": {
348 "type": {
349 "name": "string"
350 },
351 "required": false,
352 "description": "每列列表类名",
353 "docblock": "每列列表类名"
354 },
355 "displayRender": {
356 "type": {
357 "name": "func"
358 },
359 "required": false,
360 "description": "选择框单选时展示结果的自定义渲染函数",
361 "docblock": "选择框单选时展示结果的自定义渲染函数\n@param {Array} label 选中路径的文本数组\n@return {ReactNode} 渲染在选择框中的内容\n@default 单选时:labelPath => labelPath.join(' / ');多选时:labelPath => labelPath[labelPath.length - 1]",
362 "params": [
363 {
364 "name": "label",
365 "description": "选中路径的文本数组",
366 "type": {
367 "name": "Array"
368 }
369 }
370 ],
371 "returns": {
372 "description": "渲染在选择框中的内容",
373 "type": {
374 "name": "ReactNode"
375 }
376 },
377 "defaultValue": {
378 "value": "单选时:labelPath => labelPath.join(' / ');多选时:labelPath => labelPath[labelPath.length - 1]",
379 "computed": false
380 }
381 },
382 "itemRender": {
383 "type": {
384 "name": "func"
385 },
386 "required": false,
387 "description": "渲染 item 内容的方法",
388 "docblock": "渲染 item 内容的方法\n@param {Object} item 渲染节点的item\n@return {ReactNode} item node",
389 "params": [
390 {
391 "name": "item",
392 "description": "渲染节点的item",
393 "type": {
394 "name": "Object"
395 }
396 }
397 ],
398 "returns": {
399 "description": "item node",
400 "type": {
401 "name": "ReactNode"
402 }
403 }
404 },
405 "showSearch": {
406 "type": {
407 "name": "bool"
408 },
409 "required": false,
410 "description": "是否显示搜索框",
411 "defaultValue": {
412 "value": "false",
413 "computed": false
414 },
415 "docblock": "是否显示搜索框"
416 },
417 "filter": {
418 "type": {
419 "name": "func"
420 },
421 "required": false,
422 "description": "自定义搜索函数",
423 "defaultValue": {
424 "value": "根据路径所有节点的文本值模糊匹配",
425 "computed": false
426 },
427 "docblock": "自定义搜索函数\n@param {String} searchValue 搜索的关键字\n@param {Array} path 节点路径\n@return {Boolean} 是否匹配\n@default 根据路径所有节点的文本值模糊匹配",
428 "params": [
429 {
430 "name": "searchValue",
431 "description": "搜索的关键字",
432 "type": {
433 "name": "String"
434 }
435 },
436 {
437 "name": "path",
438 "description": "节点路径",
439 "type": {
440 "name": "Array"
441 }
442 }
443 ],
444 "returns": {
445 "description": "是否匹配",
446 "type": {
447 "name": "Boolean"
448 }
449 }
450 },
451 "onSearch": {
452 "type": {
453 "name": "func"
454 },
455 "required": false,
456 "description": "当搜索框值变化时回调",
457 "docblock": "当搜索框值变化时回调\n@param {String} value 数据\n@version 1.23",
458 "params": [
459 {
460 "name": "value",
461 "description": "数据",
462 "type": {
463 "name": "String"
464 }
465 }
466 ],
467 "returns": null,
468 "version": {
469 "value": "1.23",
470 "computed": false
471 }
472 },
473 "resultRender": {
474 "type": {
475 "name": "func"
476 },
477 "required": false,
478 "description": "搜索结果自定义渲染函数",
479 "defaultValue": {
480 "value": "按照节点文本 a / b / c 的模式渲染",
481 "computed": false
482 },
483 "docblock": "搜索结果自定义渲染函数\n@param {String} searchValue 搜索的关键字\n@param {Array} path 匹配到的节点路径\n@return {ReactNode} 渲染的内容\n@default 按照节点文本 a / b / c 的模式渲染",
484 "params": [
485 {
486 "name": "searchValue",
487 "description": "搜索的关键字",
488 "type": {
489 "name": "String"
490 }
491 },
492 {
493 "name": "path",
494 "description": "匹配到的节点路径",
495 "type": {
496 "name": "Array"
497 }
498 }
499 ],
500 "returns": {
501 "description": "渲染的内容",
502 "type": {
503 "name": "ReactNode"
504 }
505 }
506 },
507 "resultAutoWidth": {
508 "type": {
509 "name": "bool"
510 },
511 "required": false,
512 "description": "搜索结果列表是否和选择框等宽",
513 "defaultValue": {
514 "value": "true",
515 "computed": false
516 },
517 "docblock": "搜索结果列表是否和选择框等宽"
518 },
519 "notFoundContent": {
520 "type": {
521 "name": "node"
522 },
523 "required": false,
524 "description": "无数据时显示内容",
525 "defaultValue": {
526 "value": "'Not Found'",
527 "computed": false
528 },
529 "docblock": "无数据时显示内容"
530 },
531 "loadData": {
532 "type": {
533 "name": "func"
534 },
535 "required": false,
536 "description": "异步加载数据函数",
537 "docblock": "异步加载数据函数\n@param {Object} data 当前点击异步加载的数据",
538 "params": [
539 {
540 "name": "data",
541 "description": "当前点击异步加载的数据",
542 "type": {
543 "name": "Object"
544 }
545 }
546 ],
547 "returns": null
548 },
549 "header": {
550 "type": {
551 "name": "node"
552 },
553 "required": false,
554 "description": "自定义下拉框头部",
555 "docblock": "自定义下拉框头部"
556 },
557 "footer": {
558 "type": {
559 "name": "node"
560 },
561 "required": false,
562 "description": "自定义下拉框底部",
563 "docblock": "自定义下拉框底部"
564 },
565 "defaultVisible": {
566 "type": {
567 "name": "bool"
568 },
569 "required": false,
570 "description": "初始下拉框是否显示",
571 "defaultValue": {
572 "value": "false",
573 "computed": false
574 },
575 "docblock": "初始下拉框是否显示"
576 },
577 "visible": {
578 "type": {
579 "name": "bool"
580 },
581 "required": false,
582 "description": "当前下拉框是否显示",
583 "docblock": "当前下拉框是否显示"
584 },
585 "onVisibleChange": {
586 "type": {
587 "name": "func"
588 },
589 "required": false,
590 "description": "下拉框显示或关闭时触发事件的回调函数",
591 "defaultValue": {
592 "value": "() => {}",
593 "computed": false
594 },
595 "docblock": "下拉框显示或关闭时触发事件的回调函数\n@param {Boolean} visible 是否显示\n@param {String} type 触发显示关闭的操作类型, fromTrigger 表示由trigger的点击触发; docClick 表示由document的点击触发",
596 "params": [
597 {
598 "name": "visible",
599 "description": "是否显示",
600 "type": {
601 "name": "Boolean"
602 }
603 },
604 {
605 "name": "type",
606 "description": "触发显示关闭的操作类型, fromTrigger 表示由trigger的点击触发; docClick 表示由document的点击触发",
607 "type": {
608 "name": "String"
609 }
610 }
611 ],
612 "returns": null
613 },
614 "popupStyle": {
615 "type": {
616 "name": "object"
617 },
618 "required": false,
619 "description": "下拉框自定义样式对象",
620 "docblock": "下拉框自定义样式对象",
621 "properties": []
622 },
623 "popupClassName": {
624 "type": {
625 "name": "string"
626 },
627 "required": false,
628 "description": "下拉框样式自定义类名",
629 "docblock": "下拉框样式自定义类名"
630 },
631 "popupContainer": {
632 "type": {
633 "name": "any"
634 },
635 "required": false,
636 "description": "下拉框挂载的容器节点",
637 "docblock": "下拉框挂载的容器节点"
638 },
639 "popupProps": {
640 "type": {
641 "name": "object"
642 },
643 "required": false,
644 "description": "透传到 Popup 的属性对象",
645 "defaultValue": {
646 "value": "{}",
647 "computed": false
648 },
649 "docblock": "透传到 Popup 的属性对象",
650 "properties": []
651 },
652 "followTrigger": {
653 "type": {
654 "name": "bool"
655 },
656 "required": false,
657 "description": "是否跟随滚动",
658 "docblock": "是否跟随滚动"
659 },
660 "isPreview": {
661 "type": {
662 "name": "bool"
663 },
664 "required": false,
665 "description": "是否为预览态",
666 "docblock": "是否为预览态"
667 },
668 "renderPreview": {
669 "type": {
670 "name": "func"
671 },
672 "required": false,
673 "description": "预览态模式下渲染的内容",
674 "docblock": "预览态模式下渲染的内容\n@param {Array<data>} value 选择值 { label: , value:}",
675 "params": [
676 {
677 "name": "value",
678 "description": "选择值 { label: , value:}",
679 "type": {
680 "name": "Array"
681 }
682 }
683 ],
684 "returns": null
685 },
686 "immutable": {
687 "type": {
688 "name": "bool"
689 },
690 "required": false,
691 "description": "是否是不可变数据",
692 "defaultValue": {
693 "value": "false",
694 "computed": false
695 },
696 "docblock": "是否是不可变数据\n@version 1.23",
697 "version": {
698 "value": "1.23",
699 "computed": false
700 }
701 }
702 },
703 "methods": [
704 {
705 "name": "refreshValueDataCache",
706 "docblock": "刷新值数据缓存,删除无效值\n@param {Arrary | String} curValue 当前值",
707 "modifiers": [],
708 "params": [
709 {
710 "name": "curValue",
711 "description": "当前值",
712 "type": {
713 "name": "union",
714 "value": [
715 "Arrary",
716 "String"
717 ]
718 }
719 }
720 ],
721 "returns": null,
722 "description": "刷新值数据缓存,删除无效值"
723 }
724 ],
725 "subComponents": []
726}
\No newline at end of file