UNPKG

17.6 kBJSONView Raw
1{
2 "name": "TreeSelect",
3 "props": {
4 "children": {
5 "type": {
6 "name": "node"
7 },
8 "required": false,
9 "description": "树节点",
10 "docblock": "树节点"
11 },
12 "size": {
13 "type": {
14 "name": "enum",
15 "value": [
16 {
17 "value": "'small'",
18 "computed": false
19 },
20 {
21 "value": "'medium'",
22 "computed": false
23 },
24 {
25 "value": "'large'",
26 "computed": false
27 }
28 ]
29 },
30 "required": false,
31 "description": "选择框大小",
32 "defaultValue": {
33 "value": "'medium'",
34 "computed": false
35 },
36 "docblock": "选择框大小"
37 },
38 "placeholder": {
39 "type": {
40 "name": "string"
41 },
42 "required": false,
43 "description": "选择框占位符",
44 "docblock": "选择框占位符"
45 },
46 "disabled": {
47 "type": {
48 "name": "bool"
49 },
50 "required": false,
51 "description": "是否禁用",
52 "defaultValue": {
53 "value": "false",
54 "computed": false
55 },
56 "docblock": "是否禁用"
57 },
58 "hasArrow": {
59 "type": {
60 "name": "bool"
61 },
62 "required": false,
63 "description": "是否有下拉箭头",
64 "defaultValue": {
65 "value": "true",
66 "computed": false
67 },
68 "docblock": "是否有下拉箭头"
69 },
70 "hasBorder": {
71 "type": {
72 "name": "bool"
73 },
74 "required": false,
75 "description": "是否有边框",
76 "defaultValue": {
77 "value": "true",
78 "computed": false
79 },
80 "docblock": "是否有边框"
81 },
82 "hasClear": {
83 "type": {
84 "name": "bool"
85 },
86 "required": false,
87 "description": "是否有清空按钮",
88 "defaultValue": {
89 "value": "false",
90 "computed": false
91 },
92 "docblock": "是否有清空按钮"
93 },
94 "label": {
95 "type": {
96 "name": "node"
97 },
98 "required": false,
99 "description": "自定义内联 label",
100 "docblock": "自定义内联 label"
101 },
102 "readOnly": {
103 "type": {
104 "name": "bool"
105 },
106 "required": false,
107 "description": "是否只读,只读模式下可以展开弹层但不能选择",
108 "docblock": "是否只读,只读模式下可以展开弹层但不能选择"
109 },
110 "autoWidth": {
111 "type": {
112 "name": "bool"
113 },
114 "required": false,
115 "description": "下拉框是否与选择器对齐",
116 "defaultValue": {
117 "value": "true",
118 "computed": false
119 },
120 "docblock": "下拉框是否与选择器对齐"
121 },
122 "dataSource": {
123 "type": {
124 "name": "arrayOf",
125 "value": {
126 "name": "object"
127 }
128 },
129 "required": false,
130 "description": "数据源,该属性优先级高于 children",
131 "docblock": "数据源,该属性优先级高于 children"
132 },
133 "preserveNonExistentValue": {
134 "type": {
135 "name": "bool"
136 },
137 "required": false,
138 "description": "value/defaultValue 在 dataSource 中不存在时,是否展示",
139 "defaultValue": {
140 "value": "false",
141 "computed": false
142 },
143 "docblock": "value/defaultValue 在 dataSource 中不存在时,是否展示\n@version 1.25",
144 "version": {
145 "value": "1.25",
146 "computed": false
147 }
148 },
149 "value": {
150 "type": {
151 "name": "union",
152 "value": [
153 {
154 "name": "string"
155 },
156 {
157 "name": "object"
158 },
159 {
160 "name": "arrayOf",
161 "value": {
162 "name": "any"
163 }
164 }
165 ]
166 },
167 "required": false,
168 "description": "(受控)当前值",
169 "docblock": "(受控)当前值"
170 },
171 "defaultValue": {
172 "type": {
173 "name": "union",
174 "value": [
175 {
176 "name": "string"
177 },
178 {
179 "name": "object"
180 },
181 {
182 "name": "arrayOf",
183 "value": {
184 "name": "any"
185 }
186 }
187 ]
188 },
189 "required": false,
190 "description": "(非受控)默认值",
191 "defaultValue": {
192 "value": "null",
193 "computed": false
194 },
195 "docblock": "(非受控)默认值"
196 },
197 "onChange": {
198 "type": {
199 "name": "func"
200 },
201 "required": false,
202 "description": "选中值改变时触发的回调函数",
203 "defaultValue": {
204 "value": "() => {}",
205 "computed": false
206 },
207 "docblock": "选中值改变时触发的回调函数\n@param {String|Array} value 选中的值,单选时返回单个值,多选时返回数组\n@param {Object|Array} data 选中的数据,包括 value, label, pos, key属性,单选时返回单个值,多选时返回数组,父子节点选中关联时,同时选中,只返回父节点",
208 "params": [
209 {
210 "name": "value",
211 "description": "选中的值,单选时返回单个值,多选时返回数组",
212 "type": {
213 "name": "union",
214 "value": [
215 "String",
216 "Array"
217 ]
218 }
219 },
220 {
221 "name": "data",
222 "description": "选中的数据,包括 value, label, pos, key属性,单选时返回单个值,多选时返回数组,父子节点选中关联时,同时选中,只返回父节点",
223 "type": {
224 "name": "union",
225 "value": [
226 "Object",
227 "Array"
228 ]
229 }
230 }
231 ],
232 "returns": null
233 },
234 "tagInline": {
235 "type": {
236 "name": "bool"
237 },
238 "required": false,
239 "description": "是否一行显示,仅在 multiple 和 treeCheckable 为 true 时生效",
240 "defaultValue": {
241 "value": "false",
242 "computed": false
243 },
244 "docblock": "是否一行显示,仅在 multiple 和 treeCheckable 为 true 时生效\n@version 1.25",
245 "version": {
246 "value": "1.25",
247 "computed": false
248 }
249 },
250 "maxTagPlaceholder": {
251 "type": {
252 "name": "func"
253 },
254 "required": false,
255 "description": "隐藏多余 tag 时显示的内容,在 tagInline 生效时起作用",
256 "docblock": "隐藏多余 tag 时显示的内容,在 tagInline 生效时起作用\n@param {Object[]} selectedValues 当前已选中的元素\n@param {Object[]} totalValues 总待选元素\n@returns {reactNode}\n@version 1.25",
257 "params": [
258 {
259 "name": "selectedValues",
260 "description": "当前已选中的元素",
261 "type": {
262 "name": "Array"
263 }
264 },
265 {
266 "name": "totalValues",
267 "description": "总待选元素",
268 "type": {
269 "name": "Array"
270 }
271 }
272 ],
273 "returns": {
274 "description": null,
275 "type": {
276 "name": "reactNode"
277 }
278 },
279 "version": {
280 "value": "1.25",
281 "computed": false
282 }
283 },
284 "showSearch": {
285 "type": {
286 "name": "bool"
287 },
288 "required": false,
289 "description": "是否显示搜索框",
290 "defaultValue": {
291 "value": "false",
292 "computed": false
293 },
294 "docblock": "是否显示搜索框"
295 },
296 "onSearch": {
297 "type": {
298 "name": "func"
299 },
300 "required": false,
301 "description": "在搜索框中输入时触发的回调函数",
302 "defaultValue": {
303 "value": "() => {}",
304 "computed": false
305 },
306 "docblock": "在搜索框中输入时触发的回调函数\n@param {String} keyword 输入的关键字",
307 "params": [
308 {
309 "name": "keyword",
310 "description": "输入的关键字",
311 "type": {
312 "name": "String"
313 }
314 }
315 ],
316 "returns": null
317 },
318 "notFoundContent": {
319 "type": {
320 "name": "node"
321 },
322 "required": false,
323 "description": "无数据时显示内容",
324 "defaultValue": {
325 "value": "'Not Found'",
326 "computed": false
327 },
328 "docblock": "无数据时显示内容"
329 },
330 "multiple": {
331 "type": {
332 "name": "bool"
333 },
334 "required": false,
335 "description": "是否支持多选",
336 "defaultValue": {
337 "value": "false",
338 "computed": false
339 },
340 "docblock": "是否支持多选"
341 },
342 "treeCheckable": {
343 "type": {
344 "name": "bool"
345 },
346 "required": false,
347 "description": "下拉框中的树是否支持勾选节点的复选框",
348 "defaultValue": {
349 "value": "false",
350 "computed": false
351 },
352 "docblock": "下拉框中的树是否支持勾选节点的复选框"
353 },
354 "treeCheckStrictly": {
355 "type": {
356 "name": "bool"
357 },
358 "required": false,
359 "description": "下拉框中的树勾选节点复选框是否完全受控(父子节点选中状态不再关联)",
360 "defaultValue": {
361 "value": "false",
362 "computed": false
363 },
364 "docblock": "下拉框中的树勾选节点复选框是否完全受控(父子节点选中状态不再关联)"
365 },
366 "treeCheckedStrategy": {
367 "type": {
368 "name": "enum",
369 "value": [
370 {
371 "value": "'all'",
372 "computed": false,
373 "description": "返回所有选中的节点"
374 },
375 {
376 "value": "'parent'",
377 "computed": false,
378 "description": "父子节点都选中时只返回父节点"
379 },
380 {
381 "value": "'child'",
382 "computed": false,
383 "description": "父子节点都选中时只返回子节点"
384 }
385 ]
386 },
387 "required": false,
388 "description": "定义选中时回填的方式",
389 "defaultValue": {
390 "value": "'parent'",
391 "computed": false
392 },
393 "docblock": "定义选中时回填的方式\n@enumdesc 返回所有选中的节点, 父子节点都选中时只返回父节点, 父子节点都选中时只返回子节点",
394 "value": [
395 {
396 "value": "'all'",
397 "computed": false,
398 "description": "返回所有选中的节点"
399 },
400 {
401 "value": "'parent'",
402 "computed": false,
403 "description": "父子节点都选中时只返回父节点"
404 },
405 {
406 "value": "'child'",
407 "computed": false,
408 "description": "父子节点都选中时只返回子节点"
409 }
410 ]
411 },
412 "treeDefaultExpandAll": {
413 "type": {
414 "name": "bool"
415 },
416 "required": false,
417 "description": "下拉框中的树是否默认展开所有节点",
418 "defaultValue": {
419 "value": "false",
420 "computed": false
421 },
422 "docblock": "下拉框中的树是否默认展开所有节点"
423 },
424 "treeDefaultExpandedKeys": {
425 "type": {
426 "name": "arrayOf",
427 "value": {
428 "name": "string"
429 }
430 },
431 "required": false,
432 "description": "下拉框中的树默认展开节点key的数组",
433 "defaultValue": {
434 "value": "[]",
435 "computed": false
436 },
437 "docblock": "下拉框中的树默认展开节点key的数组"
438 },
439 "treeLoadData": {
440 "type": {
441 "name": "func"
442 },
443 "required": false,
444 "description": "下拉框中的树异步加载数据的函数,使用请参考[Tree的异步加载数据Demo](https://fusion.design/pc/component/basic/tree#%E5%BC%82%E6%AD%A5%E5%8A%A0%E8%BD%BD%E6%95%B0%E6%8D%AE)",
445 "docblock": "下拉框中的树异步加载数据的函数,使用请参考[Tree的异步加载数据Demo](https://fusion.design/pc/component/basic/tree#%E5%BC%82%E6%AD%A5%E5%8A%A0%E8%BD%BD%E6%95%B0%E6%8D%AE)\n@param {ReactElement} node 被点击展开的节点",
446 "params": [
447 {
448 "name": "node",
449 "description": "被点击展开的节点",
450 "type": {
451 "name": "ReactElement"
452 }
453 }
454 ],
455 "returns": null
456 },
457 "treeProps": {
458 "type": {
459 "name": "object"
460 },
461 "required": false,
462 "description": "透传到 Tree 的属性对象",
463 "defaultValue": {
464 "value": "{}",
465 "computed": false
466 },
467 "docblock": "透传到 Tree 的属性对象",
468 "properties": []
469 },
470 "defaultVisible": {
471 "type": {
472 "name": "bool"
473 },
474 "required": false,
475 "description": "初始下拉框是否显示",
476 "defaultValue": {
477 "value": "false",
478 "computed": false
479 },
480 "docblock": "初始下拉框是否显示"
481 },
482 "visible": {
483 "type": {
484 "name": "bool"
485 },
486 "required": false,
487 "description": "当前下拉框是否显示",
488 "docblock": "当前下拉框是否显示"
489 },
490 "onVisibleChange": {
491 "type": {
492 "name": "func"
493 },
494 "required": false,
495 "description": "下拉框显示或关闭时触发事件的回调函数",
496 "defaultValue": {
497 "value": "() => {}",
498 "computed": false
499 },
500 "docblock": "下拉框显示或关闭时触发事件的回调函数\n@param {Boolean} visible 是否显示\n@param {String} type 触发显示关闭的操作类型",
501 "params": [
502 {
503 "name": "visible",
504 "description": "是否显示",
505 "type": {
506 "name": "Boolean"
507 }
508 },
509 {
510 "name": "type",
511 "description": "触发显示关闭的操作类型",
512 "type": {
513 "name": "String"
514 }
515 }
516 ],
517 "returns": null
518 },
519 "popupStyle": {
520 "type": {
521 "name": "object"
522 },
523 "required": false,
524 "description": "下拉框自定义样式对象",
525 "docblock": "下拉框自定义样式对象",
526 "properties": []
527 },
528 "popupClassName": {
529 "type": {
530 "name": "string"
531 },
532 "required": false,
533 "description": "下拉框样式自定义类名",
534 "docblock": "下拉框样式自定义类名"
535 },
536 "popupContainer": {
537 "type": {
538 "name": "any"
539 },
540 "required": false,
541 "description": "下拉框挂载的容器节点",
542 "docblock": "下拉框挂载的容器节点"
543 },
544 "popupProps": {
545 "type": {
546 "name": "object"
547 },
548 "required": false,
549 "description": "透传到 Popup 的属性对象",
550 "docblock": "透传到 Popup 的属性对象",
551 "properties": []
552 },
553 "followTrigger": {
554 "type": {
555 "name": "bool"
556 },
557 "required": false,
558 "description": "是否跟随滚动",
559 "docblock": "是否跟随滚动"
560 },
561 "isPreview": {
562 "type": {
563 "name": "bool"
564 },
565 "required": false,
566 "description": "是否为预览态",
567 "docblock": "是否为预览态"
568 },
569 "renderPreview": {
570 "type": {
571 "name": "func"
572 },
573 "required": false,
574 "description": "预览态模式下渲染的内容",
575 "docblock": "预览态模式下渲染的内容\n@param {Array<data>} value 选择值 { label: , value:}",
576 "params": [
577 {
578 "name": "value",
579 "description": "选择值 { label: , value:}",
580 "type": {
581 "name": "Array"
582 }
583 }
584 ],
585 "returns": null
586 },
587 "useVirtual": {
588 "type": {
589 "name": "bool"
590 },
591 "required": false,
592 "description": "是否开启虚拟滚动",
593 "defaultValue": {
594 "value": "false",
595 "computed": false
596 },
597 "docblock": "是否开启虚拟滚动"
598 },
599 "immutable": {
600 "type": {
601 "name": "bool"
602 },
603 "required": false,
604 "description": "是否是不可变数据",
605 "docblock": "是否是不可变数据\n@version 1.23",
606 "version": {
607 "value": "1.23",
608 "computed": false
609 }
610 }
611 },
612 "methods": [
613 {
614 "name": "renderMaxTagPlaceholder",
615 "docblock": "TreeSelect 无法直接使用 Select 的 maxTagPlaceholder 逻辑\nSelect 的 totalValue 是所有 leaf 节点,TreeSelect 的 totalValue 受 treeCheckedStrategy 和 treeCheckStrictly 影响\n\ntreeCheckStrictly = true: totalValue 为所有节点\n\ntreeCheckStrictly = false: 根据 treeCheckedStrategy 判断\n treeCheckedStrategy = 'all': totalValue 为所有节点\n treeCheckedStrategy = 'parent': totalValue 无意义,不返回\n treeCheckedStrategy = 'child': totalValue 为所有 leaf 节点",
616 "modifiers": [],
617 "params": [
618 {
619 "name": "value"
620 },
621 {
622 "name": "totalValue"
623 }
624 ],
625 "returns": null,
626 "description": "TreeSelect 无法直接使用 Select 的 maxTagPlaceholder 逻辑\nSelect 的 totalValue 是所有 leaf 节点,TreeSelect 的 totalValue 受 treeCheckedStrategy 和 treeCheckStrictly 影响\n\ntreeCheckStrictly = true: totalValue 为所有节点\n\ntreeCheckStrictly = false: 根据 treeCheckedStrategy 判断\n treeCheckedStrategy = 'all': totalValue 为所有节点\n treeCheckedStrategy = 'parent': totalValue 无意义,不返回\n treeCheckedStrategy = 'child': totalValue 为所有 leaf 节点"
627 }
628 ],
629 "subComponents": []
630}
\No newline at end of file