UNPKG

23.1 kBJSONView Raw
1{
2 "name": "Balloon",
3 "props": {
4 "className": {
5 "type": {
6 "name": "string"
7 },
8 "required": false,
9 "description": "自定义类名",
10 "docblock": "自定义类名"
11 },
12 "style": {
13 "type": {
14 "name": "object"
15 },
16 "required": false,
17 "description": "自定义内敛样式",
18 "docblock": "自定义内敛样式",
19 "properties": []
20 },
21 "children": {
22 "type": {
23 "name": "any"
24 },
25 "required": false,
26 "description": "浮层的内容",
27 "docblock": "浮层的内容"
28 },
29 "type": {
30 "type": {
31 "name": "enum",
32 "value": [
33 {
34 "value": "'normal'",
35 "computed": false
36 },
37 {
38 "value": "'primary'",
39 "computed": false
40 }
41 ]
42 },
43 "required": false,
44 "description": "样式类型",
45 "defaultValue": {
46 "value": "'normal'",
47 "computed": false
48 },
49 "docblock": "样式类型"
50 },
51 "title": {
52 "type": {
53 "name": "node"
54 },
55 "required": false,
56 "description": "标题",
57 "docblock": "标题\n@version 1.23",
58 "version": {
59 "value": "1.23",
60 "computed": false
61 }
62 },
63 "visible": {
64 "type": {
65 "name": "bool"
66 },
67 "required": false,
68 "description": "弹层当前显示的状态",
69 "docblock": "弹层当前显示的状态"
70 },
71 "defaultVisible": {
72 "type": {
73 "name": "bool"
74 },
75 "required": false,
76 "description": "弹层默认显示的状态",
77 "defaultValue": {
78 "value": "false",
79 "computed": false
80 },
81 "docblock": "弹层默认显示的状态"
82 },
83 "onVisibleChange": {
84 "type": {
85 "name": "func"
86 },
87 "required": false,
88 "description": "弹层在显示和隐藏触发的事件",
89 "defaultValue": {
90 "value": "func.noop",
91 "computed": true
92 },
93 "docblock": "弹层在显示和隐藏触发的事件\n@param {Boolean} visible 弹层是否隐藏和显示\n@param {String} type 触发弹层显示或隐藏的来源, closeClick 表示由自带的关闭按钮触发; fromTrigger 表示由trigger的点击触发; docClick 表示由document的点击触发",
94 "params": [
95 {
96 "name": "visible",
97 "description": "弹层是否隐藏和显示",
98 "type": {
99 "name": "Boolean"
100 }
101 },
102 {
103 "name": "type",
104 "description": "触发弹层显示或隐藏的来源, closeClick 表示由自带的关闭按钮触发; fromTrigger 表示由trigger的点击触发; docClick 表示由document的点击触发",
105 "type": {
106 "name": "String"
107 }
108 }
109 ],
110 "returns": null
111 },
112 "v2": {
113 "type": {
114 "name": "bool"
115 },
116 "required": false,
117 "description": "开启 v2 版本",
118 "docblock": "开启 v2 版本\n@version 1.25",
119 "version": {
120 "value": "1.25",
121 "computed": false
122 }
123 },
124 "arrowPointToCenter": {
125 "type": {
126 "name": "bool"
127 },
128 "required": false,
129 "description": "[v2] 箭头是否指向目标元素的中心",
130 "defaultValue": {
131 "value": "false",
132 "computed": false
133 },
134 "docblock": "[v2] 箭头是否指向目标元素的中心\n@version 1.25",
135 "version": {
136 "value": "1.25",
137 "computed": false
138 }
139 },
140 "placementOffset": {
141 "type": {
142 "name": "number"
143 },
144 "required": false,
145 "description": "[v2] 弹层偏离触发元素的像素值",
146 "docblock": "[v2] 弹层偏离触发元素的像素值"
147 },
148 "closable": {
149 "type": {
150 "name": "bool"
151 },
152 "required": false,
153 "description": "是否显示关闭按钮",
154 "defaultValue": {
155 "value": "true",
156 "computed": false
157 },
158 "docblock": "是否显示关闭按钮"
159 },
160 "align": {
161 "type": {
162 "name": "enum",
163 "value": [
164 {
165 "value": "'t'",
166 "computed": false,
167 "description": "上"
168 },
169 {
170 "value": "'r'",
171 "computed": false,
172 "description": "右"
173 },
174 {
175 "value": "'b'",
176 "computed": false,
177 "description": "下"
178 },
179 {
180 "value": "'l'",
181 "computed": false,
182 "description": "左"
183 },
184 {
185 "value": "'tl'",
186 "computed": false,
187 "description": "上左"
188 },
189 {
190 "value": "'tr'",
191 "computed": false,
192 "description": "上右"
193 },
194 {
195 "value": "'bl'",
196 "computed": false,
197 "description": "下左"
198 },
199 {
200 "value": "'br'",
201 "computed": false,
202 "description": "下右"
203 },
204 {
205 "value": "'lt'",
206 "computed": false,
207 "description": "左上"
208 },
209 {
210 "value": "'lb'",
211 "computed": false,
212 "description": "左下"
213 },
214 {
215 "value": "'rt'",
216 "computed": false,
217 "description": "右上"
218 },
219 {
220 "value": "'rb'",
221 "computed": false,
222 "description": "右下"
223 }
224 ]
225 },
226 "required": false,
227 "description": "弹出层位置",
228 "defaultValue": {
229 "value": "'b'",
230 "computed": false
231 },
232 "docblock": "弹出层位置\n@enumdesc 上, 右, 下, 左, 上左, 上右, 下左, 下右, 左上, 左下, 右上, 右下",
233 "value": [
234 {
235 "value": "'t'",
236 "computed": false,
237 "description": "上"
238 },
239 {
240 "value": "'r'",
241 "computed": false,
242 "description": "右"
243 },
244 {
245 "value": "'b'",
246 "computed": false,
247 "description": "下"
248 },
249 {
250 "value": "'l'",
251 "computed": false,
252 "description": "左"
253 },
254 {
255 "value": "'tl'",
256 "computed": false,
257 "description": "上左"
258 },
259 {
260 "value": "'tr'",
261 "computed": false,
262 "description": "上右"
263 },
264 {
265 "value": "'bl'",
266 "computed": false,
267 "description": "下左"
268 },
269 {
270 "value": "'br'",
271 "computed": false,
272 "description": "下右"
273 },
274 {
275 "value": "'lt'",
276 "computed": false,
277 "description": "左上"
278 },
279 {
280 "value": "'lb'",
281 "computed": false,
282 "description": "左下"
283 },
284 {
285 "value": "'rt'",
286 "computed": false,
287 "description": "右上"
288 },
289 {
290 "value": "'rb'",
291 "computed": false,
292 "description": "右下"
293 }
294 ]
295 },
296 "offset": {
297 "type": {
298 "name": "array"
299 },
300 "required": false,
301 "description": "弹层相对于trigger的定位的微调, 接收数组[hoz, ver], 表示弹层在 left / top 上的增量\ne.g. [100, 100] 表示往右(RTL 模式下是往左) 、下分布偏移100px",
302 "defaultValue": {
303 "value": "[0, 0]",
304 "computed": false
305 },
306 "docblock": "弹层相对于trigger的定位的微调, 接收数组[hoz, ver], 表示弹层在 left / top 上的增量\ne.g. [100, 100] 表示往右(RTL 模式下是往左) 、下分布偏移100px"
307 },
308 "trigger": {
309 "type": {
310 "name": "any"
311 },
312 "required": false,
313 "description": "触发元素",
314 "defaultValue": {
315 "value": "<span />",
316 "computed": false
317 },
318 "docblock": "触发元素"
319 },
320 "triggerType": {
321 "type": {
322 "name": "union",
323 "value": [
324 {
325 "name": "string"
326 },
327 {
328 "name": "array"
329 }
330 ]
331 },
332 "required": false,
333 "description": "触发行为\n鼠标悬浮, 鼠标点击('hover','click')或者它们组成的数组,如 ['hover', 'click'], 强烈不建议使用'focus',若弹窗内容有复杂交互请使用click",
334 "defaultValue": {
335 "value": "'hover'",
336 "computed": false
337 },
338 "docblock": "触发行为\n鼠标悬浮, 鼠标点击('hover','click')或者它们组成的数组,如 ['hover', 'click'], 强烈不建议使用'focus',若弹窗内容有复杂交互请使用click"
339 },
340 "onClose": {
341 "type": {
342 "name": "func"
343 },
344 "required": false,
345 "description": "任何visible为false时会触发的事件",
346 "defaultValue": {
347 "value": "func.noop",
348 "computed": true
349 },
350 "docblock": "任何visible为false时会触发的事件",
351 "params": [],
352 "returns": null
353 },
354 "autoAdjust": {
355 "type": {
356 "name": "bool"
357 },
358 "required": false,
359 "description": "[v2] 是否进行自动位置调整,默认自动开启。",
360 "docblock": "[v2] 是否进行自动位置调整,默认自动开启。\n@version 1.25",
361 "version": {
362 "value": "1.25",
363 "computed": false
364 }
365 },
366 "delay": {
367 "type": {
368 "name": "number"
369 },
370 "required": false,
371 "description": "弹层在触发以后的延时显示, 单位毫秒 ms",
372 "docblock": "弹层在触发以后的延时显示, 单位毫秒 ms"
373 },
374 "afterClose": {
375 "type": {
376 "name": "func"
377 },
378 "required": false,
379 "description": "浮层关闭后触发的事件, 如果有动画,则在动画结束后触发",
380 "defaultValue": {
381 "value": "func.noop",
382 "computed": true
383 },
384 "docblock": "浮层关闭后触发的事件, 如果有动画,则在动画结束后触发",
385 "params": [],
386 "returns": null
387 },
388 "autoFocus": {
389 "type": {
390 "name": "bool"
391 },
392 "required": false,
393 "description": "弹层出现后是否自动focus到内部第一个元素",
394 "defaultValue": {
395 "value": "true",
396 "computed": false
397 },
398 "docblock": "弹层出现后是否自动focus到内部第一个元素"
399 },
400 "safeNode": {
401 "type": {
402 "name": "string"
403 },
404 "required": false,
405 "description": "安全节点:对于triggetType为click的浮层,会在点击除了浮层外的其它区域时关闭浮层.safeNode用于添加不触发关闭的节点, 值可以是dom节点的id或者是节点的dom对象",
406 "defaultValue": {
407 "value": "undefined",
408 "computed": true
409 },
410 "docblock": "安全节点:对于triggetType为click的浮层,会在点击除了浮层外的其它区域时关闭浮层.safeNode用于添加不触发关闭的节点, 值可以是dom节点的id或者是节点的dom对象"
411 },
412 "safeId": {
413 "type": {
414 "name": "string"
415 },
416 "required": false,
417 "description": "用来指定safeNode节点的id,和safeNode配合使用",
418 "defaultValue": {
419 "value": "null",
420 "computed": false
421 },
422 "docblock": "用来指定safeNode节点的id,和safeNode配合使用"
423 },
424 "animation": {
425 "type": {
426 "name": "union",
427 "value": [
428 {
429 "name": "object"
430 },
431 {
432 "name": "bool"
433 }
434 ]
435 },
436 "required": false,
437 "description": "配置动画的播放方式,格式是{in: '', out: ''}, 常用的动画class请查看Animate组件文档",
438 "defaultValue": {
439 "value": "{\n in: 'zoomIn zoomInBig',\n out: 'zoomOut zoomOutBig',\n}",
440 "computed": false
441 },
442 "docblock": "配置动画的播放方式,格式是{in: '', out: ''}, 常用的动画class请查看Animate组件文档\n@param {String} in 进场动画\n@param {String} out 出场动画"
443 },
444 "cache": {
445 "type": {
446 "name": "bool"
447 },
448 "required": false,
449 "description": "弹层的dom节点关闭时是否删除",
450 "defaultValue": {
451 "value": "false",
452 "computed": false
453 },
454 "docblock": "弹层的dom节点关闭时是否删除"
455 },
456 "popupContainer": {
457 "type": {
458 "name": "any"
459 },
460 "required": false,
461 "description": "指定浮层渲染的父节点, 可以为节点id的字符串,也可以返回节点的函数。",
462 "docblock": "指定浮层渲染的父节点, 可以为节点id的字符串,也可以返回节点的函数。"
463 },
464 "popupStyle": {
465 "type": {
466 "name": "object"
467 },
468 "required": false,
469 "description": "弹层组件style,透传给Popup",
470 "defaultValue": {
471 "value": "{}",
472 "computed": false
473 },
474 "docblock": "弹层组件style,透传给Popup",
475 "properties": []
476 },
477 "popupClassName": {
478 "type": {
479 "name": "string"
480 },
481 "required": false,
482 "description": "弹层组件className,透传给Popup",
483 "defaultValue": {
484 "value": "''",
485 "computed": false
486 },
487 "docblock": "弹层组件className,透传给Popup"
488 },
489 "popupProps": {
490 "type": {
491 "name": "object"
492 },
493 "required": false,
494 "description": "弹层组件属性,透传给Popup",
495 "defaultValue": {
496 "value": "{}",
497 "computed": false
498 },
499 "docblock": "弹层组件属性,透传给Popup",
500 "properties": []
501 },
502 "followTrigger": {
503 "type": {
504 "name": "bool"
505 },
506 "required": false,
507 "description": "是否跟随滚动",
508 "docblock": "是否跟随滚动"
509 },
510 "id": {
511 "type": {
512 "name": "string"
513 },
514 "required": false,
515 "description": "弹层id, 传入值才会支持无障碍",
516 "docblock": "弹层id, 传入值才会支持无障碍"
517 }
518 },
519 "methods": [],
520 "subComponents": [
521 {
522 "name": "Tooltip",
523 "props": {
524 "prefix": {
525 "type": {
526 "name": "string"
527 },
528 "required": false,
529 "description": "样式类名的品牌前缀",
530 "defaultValue": {
531 "value": "'next-'",
532 "computed": false
533 },
534 "docblock": "样式类名的品牌前缀"
535 },
536 "className": {
537 "type": {
538 "name": "string"
539 },
540 "required": false,
541 "description": "自定义类名",
542 "docblock": "自定义类名"
543 },
544 "style": {
545 "type": {
546 "name": "object"
547 },
548 "required": false,
549 "description": "自定义内联样式",
550 "docblock": "自定义内联样式",
551 "properties": []
552 },
553 "children": {
554 "type": {
555 "name": "any"
556 },
557 "required": false,
558 "description": "tooltip的内容",
559 "docblock": "tooltip的内容"
560 },
561 "align": {
562 "type": {
563 "name": "enum",
564 "value": [
565 {
566 "value": "'t'",
567 "computed": false,
568 "description": "上"
569 },
570 {
571 "value": "'r'",
572 "computed": false,
573 "description": "右"
574 },
575 {
576 "value": "'b'",
577 "computed": false,
578 "description": "下"
579 },
580 {
581 "value": "'l'",
582 "computed": false,
583 "description": "左"
584 },
585 {
586 "value": "'tl'",
587 "computed": false,
588 "description": "上左"
589 },
590 {
591 "value": "'tr'",
592 "computed": false,
593 "description": "上右"
594 },
595 {
596 "value": "'bl'",
597 "computed": false,
598 "description": "下左"
599 },
600 {
601 "value": "'br'",
602 "computed": false,
603 "description": "下右"
604 },
605 {
606 "value": "'lt'",
607 "computed": false,
608 "description": "左上"
609 },
610 {
611 "value": "'lb'",
612 "computed": false,
613 "description": "左下"
614 },
615 {
616 "value": "'rt'",
617 "computed": false,
618 "description": "右上"
619 },
620 {
621 "value": "'rb'",
622 "computed": false,
623 "description": "右下"
624 }
625 ]
626 },
627 "required": false,
628 "description": "弹出层位置",
629 "defaultValue": {
630 "value": "'b'",
631 "computed": false
632 },
633 "docblock": "弹出层位置\n@enumdesc 上, 右, 下, 左, 上左, 上右, 下左, 下右, 左上, 左下, 右上, 右下",
634 "value": [
635 {
636 "value": "'t'",
637 "computed": false,
638 "description": "上"
639 },
640 {
641 "value": "'r'",
642 "computed": false,
643 "description": "右"
644 },
645 {
646 "value": "'b'",
647 "computed": false,
648 "description": "下"
649 },
650 {
651 "value": "'l'",
652 "computed": false,
653 "description": "左"
654 },
655 {
656 "value": "'tl'",
657 "computed": false,
658 "description": "上左"
659 },
660 {
661 "value": "'tr'",
662 "computed": false,
663 "description": "上右"
664 },
665 {
666 "value": "'bl'",
667 "computed": false,
668 "description": "下左"
669 },
670 {
671 "value": "'br'",
672 "computed": false,
673 "description": "下右"
674 },
675 {
676 "value": "'lt'",
677 "computed": false,
678 "description": "左上"
679 },
680 {
681 "value": "'lb'",
682 "computed": false,
683 "description": "左下"
684 },
685 {
686 "value": "'rt'",
687 "computed": false,
688 "description": "右上"
689 },
690 {
691 "value": "'rb'",
692 "computed": false,
693 "description": "右下"
694 }
695 ]
696 },
697 "trigger": {
698 "type": {
699 "name": "any"
700 },
701 "required": false,
702 "description": "触发元素",
703 "defaultValue": {
704 "value": "<span />",
705 "computed": false
706 },
707 "docblock": "触发元素"
708 },
709 "triggerType": {
710 "type": {
711 "name": "union",
712 "value": [
713 {
714 "name": "string"
715 },
716 {
717 "name": "array"
718 }
719 ]
720 },
721 "required": false,
722 "description": "触发行为\n鼠标悬浮, 鼠标点击('hover', 'click')或者它们组成的数组,如 ['hover', 'click'], 强烈不建议使用'focus',若有复杂交互,推荐使用triggerType为click的Balloon组件",
723 "defaultValue": {
724 "value": "'hover'",
725 "computed": false
726 },
727 "docblock": "触发行为\n鼠标悬浮, 鼠标点击('hover', 'click')或者它们组成的数组,如 ['hover', 'click'], 强烈不建议使用'focus',若有复杂交互,推荐使用triggerType为click的Balloon组件"
728 },
729 "popupStyle": {
730 "type": {
731 "name": "object"
732 },
733 "required": false,
734 "description": "弹层组件style,透传给Popup",
735 "docblock": "弹层组件style,透传给Popup",
736 "properties": []
737 },
738 "popupClassName": {
739 "type": {
740 "name": "string"
741 },
742 "required": false,
743 "description": "弹层组件className,透传给Popup",
744 "docblock": "弹层组件className,透传给Popup"
745 },
746 "popupProps": {
747 "type": {
748 "name": "object"
749 },
750 "required": false,
751 "description": "弹层组件属性,透传给Popup",
752 "docblock": "弹层组件属性,透传给Popup",
753 "properties": []
754 },
755 "pure": {
756 "type": {
757 "name": "bool"
758 },
759 "required": false,
760 "description": "是否pure render",
761 "docblock": "是否pure render"
762 },
763 "popupContainer": {
764 "type": {
765 "name": "any"
766 },
767 "required": false,
768 "description": "指定浮层渲染的父节点, 可以为节点id的字符串,也可以返回节点的函数。",
769 "docblock": "指定浮层渲染的父节点, 可以为节点id的字符串,也可以返回节点的函数。"
770 },
771 "followTrigger": {
772 "type": {
773 "name": "bool"
774 },
775 "required": false,
776 "description": "是否跟随滚动",
777 "docblock": "是否跟随滚动"
778 },
779 "id": {
780 "type": {
781 "name": "string"
782 },
783 "required": false,
784 "description": "弹层id, 传入值才会支持无障碍",
785 "docblock": "弹层id, 传入值才会支持无障碍"
786 },
787 "delay": {
788 "type": {
789 "name": "number"
790 },
791 "required": false,
792 "description": "如果需要让 Tooltip 内容可被点击,可以设置这个参数,例如 100",
793 "defaultValue": {
794 "value": "50",
795 "computed": false
796 },
797 "docblock": "如果需要让 Tooltip 内容可被点击,可以设置这个参数,例如 100"
798 },
799 "v2": {
800 "type": {
801 "name": "bool"
802 },
803 "required": false,
804 "description": "开启 v2 版本",
805 "docblock": "开启 v2 版本"
806 },
807 "arrowPointToCenter": {
808 "type": {
809 "name": "bool"
810 },
811 "required": false,
812 "description": "[v2] 箭头是否指向目标元素的中心",
813 "defaultValue": {
814 "value": "false",
815 "computed": false
816 },
817 "docblock": "[v2] 箭头是否指向目标元素的中心"
818 }
819 },
820 "methods": []
821 }
822 ]
823}
\No newline at end of file