UNPKG

16.8 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 "expandTriggerType": {
246 "type": {
247 "name": "enum",
248 "value": [
249 {
250 "value": "'click'",
251 "computed": false
252 },
253 {
254 "value": "'hover'",
255 "computed": false
256 }
257 ]
258 },
259 "required": false,
260 "description": "展开触发的方式",
261 "defaultValue": {
262 "value": "'click'",
263 "computed": false
264 },
265 "docblock": "展开触发的方式"
266 },
267 "useVirtual": {
268 "type": {
269 "name": "bool"
270 },
271 "required": false,
272 "description": "是否开启虚拟滚动",
273 "defaultValue": {
274 "value": "false",
275 "computed": false
276 },
277 "docblock": "是否开启虚拟滚动"
278 },
279 "multiple": {
280 "type": {
281 "name": "bool"
282 },
283 "required": false,
284 "description": "是否多选",
285 "defaultValue": {
286 "value": "false",
287 "computed": false
288 },
289 "docblock": "是否多选"
290 },
291 "changeOnSelect": {
292 "type": {
293 "name": "bool"
294 },
295 "required": false,
296 "description": "是否选中即发生改变, 该属性仅在单选模式下有效",
297 "defaultValue": {
298 "value": "false",
299 "computed": false
300 },
301 "docblock": "是否选中即发生改变, 该属性仅在单选模式下有效"
302 },
303 "canOnlyCheckLeaf": {
304 "type": {
305 "name": "bool"
306 },
307 "required": false,
308 "description": "是否只能勾选叶子项的checkbox,该属性仅在多选模式下有效",
309 "defaultValue": {
310 "value": "false",
311 "computed": false
312 },
313 "docblock": "是否只能勾选叶子项的checkbox,该属性仅在多选模式下有效"
314 },
315 "checkStrictly": {
316 "type": {
317 "name": "bool"
318 },
319 "required": false,
320 "description": "父子节点是否选中不关联",
321 "defaultValue": {
322 "value": "false",
323 "computed": false
324 },
325 "docblock": "父子节点是否选中不关联"
326 },
327 "listStyle": {
328 "type": {
329 "name": "object"
330 },
331 "required": false,
332 "description": "每列列表样式对象",
333 "docblock": "每列列表样式对象",
334 "properties": []
335 },
336 "listClassName": {
337 "type": {
338 "name": "string"
339 },
340 "required": false,
341 "description": "每列列表类名",
342 "docblock": "每列列表类名"
343 },
344 "displayRender": {
345 "type": {
346 "name": "func"
347 },
348 "required": false,
349 "description": "选择框单选时展示结果的自定义渲染函数",
350 "docblock": "选择框单选时展示结果的自定义渲染函数\n@param {Array} label 选中路径的文本数组\n@return {ReactNode} 渲染在选择框中的内容\n@default 单选时:labelPath => labelPath.join(' / ');多选时:labelPath => labelPath[labelPath.length - 1]",
351 "params": [
352 {
353 "name": "label",
354 "description": "选中路径的文本数组",
355 "type": {
356 "name": "Array"
357 }
358 }
359 ],
360 "returns": {
361 "description": "渲染在选择框中的内容",
362 "type": {
363 "name": "ReactNode"
364 }
365 },
366 "defaultValue": {
367 "value": "单选时:labelPath => labelPath.join(' / ');多选时:labelPath => labelPath[labelPath.length - 1]",
368 "computed": false
369 }
370 },
371 "itemRender": {
372 "type": {
373 "name": "func"
374 },
375 "required": false,
376 "description": "渲染 item 内容的方法",
377 "docblock": "渲染 item 内容的方法\n@param {Object} item 渲染节点的item\n@return {ReactNode} item node",
378 "params": [
379 {
380 "name": "item",
381 "description": "渲染节点的item",
382 "type": {
383 "name": "Object"
384 }
385 }
386 ],
387 "returns": {
388 "description": "item node",
389 "type": {
390 "name": "ReactNode"
391 }
392 }
393 },
394 "showSearch": {
395 "type": {
396 "name": "bool"
397 },
398 "required": false,
399 "description": "是否显示搜索框",
400 "defaultValue": {
401 "value": "false",
402 "computed": false
403 },
404 "docblock": "是否显示搜索框"
405 },
406 "filter": {
407 "type": {
408 "name": "func"
409 },
410 "required": false,
411 "description": "自定义搜索函数",
412 "defaultValue": {
413 "value": "根据路径所有节点的文本值模糊匹配",
414 "computed": false
415 },
416 "docblock": "自定义搜索函数\n@param {String} searchValue 搜索的关键字\n@param {Array} path 节点路径\n@return {Boolean} 是否匹配\n@default 根据路径所有节点的文本值模糊匹配",
417 "params": [
418 {
419 "name": "searchValue",
420 "description": "搜索的关键字",
421 "type": {
422 "name": "String"
423 }
424 },
425 {
426 "name": "path",
427 "description": "节点路径",
428 "type": {
429 "name": "Array"
430 }
431 }
432 ],
433 "returns": {
434 "description": "是否匹配",
435 "type": {
436 "name": "Boolean"
437 }
438 }
439 },
440 "resultRender": {
441 "type": {
442 "name": "func"
443 },
444 "required": false,
445 "description": "搜索结果自定义渲染函数",
446 "defaultValue": {
447 "value": "按照节点文本 a / b / c 的模式渲染",
448 "computed": false
449 },
450 "docblock": "搜索结果自定义渲染函数\n@param {String} searchValue 搜索的关键字\n@param {Array} path 匹配到的节点路径\n@return {ReactNode} 渲染的内容\n@default 按照节点文本 a / b / c 的模式渲染",
451 "params": [
452 {
453 "name": "searchValue",
454 "description": "搜索的关键字",
455 "type": {
456 "name": "String"
457 }
458 },
459 {
460 "name": "path",
461 "description": "匹配到的节点路径",
462 "type": {
463 "name": "Array"
464 }
465 }
466 ],
467 "returns": {
468 "description": "渲染的内容",
469 "type": {
470 "name": "ReactNode"
471 }
472 }
473 },
474 "resultAutoWidth": {
475 "type": {
476 "name": "bool"
477 },
478 "required": false,
479 "description": "搜索结果列表是否和选择框等宽",
480 "defaultValue": {
481 "value": "true",
482 "computed": false
483 },
484 "docblock": "搜索结果列表是否和选择框等宽"
485 },
486 "notFoundContent": {
487 "type": {
488 "name": "node"
489 },
490 "required": false,
491 "description": "无数据时显示内容",
492 "defaultValue": {
493 "value": "'Not Found'",
494 "computed": false
495 },
496 "docblock": "无数据时显示内容"
497 },
498 "loadData": {
499 "type": {
500 "name": "func"
501 },
502 "required": false,
503 "description": "异步加载数据函数",
504 "docblock": "异步加载数据函数\n@param {Object} data 当前点击异步加载的数据",
505 "params": [
506 {
507 "name": "data",
508 "description": "当前点击异步加载的数据",
509 "type": {
510 "name": "Object"
511 }
512 }
513 ],
514 "returns": null
515 },
516 "header": {
517 "type": {
518 "name": "node"
519 },
520 "required": false,
521 "description": "自定义下拉框头部",
522 "docblock": "自定义下拉框头部"
523 },
524 "footer": {
525 "type": {
526 "name": "node"
527 },
528 "required": false,
529 "description": "自定义下拉框底部",
530 "docblock": "自定义下拉框底部"
531 },
532 "defaultVisible": {
533 "type": {
534 "name": "bool"
535 },
536 "required": false,
537 "description": "初始下拉框是否显示",
538 "defaultValue": {
539 "value": "false",
540 "computed": false
541 },
542 "docblock": "初始下拉框是否显示"
543 },
544 "visible": {
545 "type": {
546 "name": "bool"
547 },
548 "required": false,
549 "description": "当前下拉框是否显示",
550 "docblock": "当前下拉框是否显示"
551 },
552 "onVisibleChange": {
553 "type": {
554 "name": "func"
555 },
556 "required": false,
557 "description": "下拉框显示或关闭时触发事件的回调函数",
558 "defaultValue": {
559 "value": "() => {}",
560 "computed": false
561 },
562 "docblock": "下拉框显示或关闭时触发事件的回调函数\n@param {Boolean} visible 是否显示\n@param {String} type 触发显示关闭的操作类型",
563 "params": [
564 {
565 "name": "visible",
566 "description": "是否显示",
567 "type": {
568 "name": "Boolean"
569 }
570 },
571 {
572 "name": "type",
573 "description": "触发显示关闭的操作类型",
574 "type": {
575 "name": "String"
576 }
577 }
578 ],
579 "returns": null
580 },
581 "popupStyle": {
582 "type": {
583 "name": "object"
584 },
585 "required": false,
586 "description": "下拉框自定义样式对象",
587 "docblock": "下拉框自定义样式对象",
588 "properties": []
589 },
590 "popupClassName": {
591 "type": {
592 "name": "string"
593 },
594 "required": false,
595 "description": "下拉框样式自定义类名",
596 "docblock": "下拉框样式自定义类名"
597 },
598 "popupContainer": {
599 "type": {
600 "name": "union",
601 "value": [
602 {
603 "name": "string"
604 },
605 {
606 "name": "func"
607 }
608 ]
609 },
610 "required": false,
611 "description": "下拉框挂载的容器节点",
612 "docblock": "下拉框挂载的容器节点"
613 },
614 "popupProps": {
615 "type": {
616 "name": "object"
617 },
618 "required": false,
619 "description": "透传到 Popup 的属性对象",
620 "defaultValue": {
621 "value": "{}",
622 "computed": false
623 },
624 "docblock": "透传到 Popup 的属性对象",
625 "properties": []
626 }
627 },
628 "methods": [],
629 "subComponents": []
630}
\No newline at end of file