1 | {
|
2 | "name": "Overlay",
|
3 | "props": {
|
4 | "children": {
|
5 | "type": {
|
6 | "name": "any"
|
7 | },
|
8 | "required": false,
|
9 | "description": "弹层内容",
|
10 | "docblock": "弹层内容"
|
11 | },
|
12 | "visible": {
|
13 | "type": {
|
14 | "name": "bool"
|
15 | },
|
16 | "required": false,
|
17 | "description": "是否显示弹层",
|
18 | "defaultValue": {
|
19 | "value": "false",
|
20 | "computed": false
|
21 | },
|
22 | "docblock": "是否显示弹层"
|
23 | },
|
24 | "onRequestClose": {
|
25 | "type": {
|
26 | "name": "func"
|
27 | },
|
28 | "required": false,
|
29 | "description": "弹层请求关闭时触发事件的回调函数",
|
30 | "defaultValue": {
|
31 | "value": "func.noop",
|
32 | "computed": true
|
33 | },
|
34 | "docblock": "弹层请求关闭时触发事件的回调函数\n@param {String} type 弹层关闭的来源\n@param {Object} e DOM 事件",
|
35 | "params": [
|
36 | {
|
37 | "name": "type",
|
38 | "description": "弹层关闭的来源",
|
39 | "type": {
|
40 | "name": "String"
|
41 | }
|
42 | },
|
43 | {
|
44 | "name": "e",
|
45 | "description": "DOM 事件",
|
46 | "type": {
|
47 | "name": "Object"
|
48 | }
|
49 | }
|
50 | ],
|
51 | "returns": null
|
52 | },
|
53 | "target": {
|
54 | "type": {
|
55 | "name": "any"
|
56 | },
|
57 | "required": false,
|
58 | "description": "弹层定位的参照元素",
|
59 | "defaultValue": {
|
60 | "value": "Position.VIEWPORT",
|
61 | "computed": true
|
62 | },
|
63 | "docblock": "弹层定位的参照元素"
|
64 | },
|
65 | "align": {
|
66 | "type": {
|
67 | "name": "string"
|
68 | },
|
69 | "required": false,
|
70 | "description": "弹层相对于参照元素的定位, 详见开发指南的[定位部分](#定位)",
|
71 | "defaultValue": {
|
72 | "value": "'tl bl'",
|
73 | "computed": false
|
74 | },
|
75 | "docblock": "弹层相对于参照元素的定位, 详见开发指南的[定位部分](#定位)"
|
76 | },
|
77 | "offset": {
|
78 | "type": {
|
79 | "name": "array"
|
80 | },
|
81 | "required": false,
|
82 | "description": "弹层相对于trigger的定位的微调, 接收数组[hoz, ver], 表示弹层在 left / top 上的增量\ne.g. [100, 100] 表示往右(RTL 模式下是往左) 、下分布偏移100px",
|
83 | "defaultValue": {
|
84 | "value": "[0, 0]",
|
85 | "computed": false
|
86 | },
|
87 | "docblock": "弹层相对于trigger的定位的微调, 接收数组[hoz, ver], 表示弹层在 left / top 上的增量\ne.g. [100, 100] 表示往右(RTL 模式下是往左) 、下分布偏移100px"
|
88 | },
|
89 | "container": {
|
90 | "type": {
|
91 | "name": "any"
|
92 | },
|
93 | "required": false,
|
94 | "description": "渲染组件的容器,如果是函数需要返回 ref,如果是字符串则是该 DOM 的 id,也可以直接传入 DOM 节点",
|
95 | "docblock": "渲染组件的容器,如果是函数需要返回 ref,如果是字符串则是该 DOM 的 id,也可以直接传入 DOM 节点"
|
96 | },
|
97 | "hasMask": {
|
98 | "type": {
|
99 | "name": "bool"
|
100 | },
|
101 | "required": false,
|
102 | "description": "是否显示遮罩",
|
103 | "defaultValue": {
|
104 | "value": "false",
|
105 | "computed": false
|
106 | },
|
107 | "docblock": "是否显示遮罩"
|
108 | },
|
109 | "canCloseByEsc": {
|
110 | "type": {
|
111 | "name": "bool"
|
112 | },
|
113 | "required": false,
|
114 | "description": "是否支持 esc 按键关闭弹层",
|
115 | "defaultValue": {
|
116 | "value": "true",
|
117 | "computed": false
|
118 | },
|
119 | "docblock": "是否支持 esc 按键关闭弹层"
|
120 | },
|
121 | "canCloseByOutSideClick": {
|
122 | "type": {
|
123 | "name": "bool"
|
124 | },
|
125 | "required": false,
|
126 | "description": "点击弹层外的区域是否关闭弹层,不显示遮罩时生效",
|
127 | "defaultValue": {
|
128 | "value": "true",
|
129 | "computed": false
|
130 | },
|
131 | "docblock": "点击弹层外的区域是否关闭弹层,不显示遮罩时生效"
|
132 | },
|
133 | "canCloseByMask": {
|
134 | "type": {
|
135 | "name": "bool"
|
136 | },
|
137 | "required": false,
|
138 | "description": "点击遮罩区域是否关闭弹层,显示遮罩时生效",
|
139 | "defaultValue": {
|
140 | "value": "true",
|
141 | "computed": false
|
142 | },
|
143 | "docblock": "点击遮罩区域是否关闭弹层,显示遮罩时生效"
|
144 | },
|
145 | "beforeOpen": {
|
146 | "type": {
|
147 | "name": "func"
|
148 | },
|
149 | "required": false,
|
150 | "description": "弹层打开前触发事件的回调函数",
|
151 | "defaultValue": {
|
152 | "value": "func.noop",
|
153 | "computed": true
|
154 | },
|
155 | "docblock": "弹层打开前触发事件的回调函数",
|
156 | "params": [],
|
157 | "returns": null
|
158 | },
|
159 | "onOpen": {
|
160 | "type": {
|
161 | "name": "func"
|
162 | },
|
163 | "required": false,
|
164 | "description": "弹层打开时触发事件的回调函数",
|
165 | "defaultValue": {
|
166 | "value": "func.noop",
|
167 | "computed": true
|
168 | },
|
169 | "docblock": "弹层打开时触发事件的回调函数",
|
170 | "params": [],
|
171 | "returns": null
|
172 | },
|
173 | "afterOpen": {
|
174 | "type": {
|
175 | "name": "func"
|
176 | },
|
177 | "required": false,
|
178 | "description": "弹层打开后触发事件的回调函数, 如果有动画,则在动画结束后触发",
|
179 | "defaultValue": {
|
180 | "value": "func.noop",
|
181 | "computed": true
|
182 | },
|
183 | "docblock": "弹层打开后触发事件的回调函数, 如果有动画,则在动画结束后触发",
|
184 | "params": [],
|
185 | "returns": null
|
186 | },
|
187 | "beforeClose": {
|
188 | "type": {
|
189 | "name": "func"
|
190 | },
|
191 | "required": false,
|
192 | "description": "弹层关闭前触发事件的回调函数",
|
193 | "defaultValue": {
|
194 | "value": "func.noop",
|
195 | "computed": true
|
196 | },
|
197 | "docblock": "弹层关闭前触发事件的回调函数",
|
198 | "params": [],
|
199 | "returns": null
|
200 | },
|
201 | "onClose": {
|
202 | "type": {
|
203 | "name": "func"
|
204 | },
|
205 | "required": false,
|
206 | "description": "弹层关闭时触发事件的回调函数",
|
207 | "defaultValue": {
|
208 | "value": "func.noop",
|
209 | "computed": true
|
210 | },
|
211 | "docblock": "弹层关闭时触发事件的回调函数",
|
212 | "params": [],
|
213 | "returns": null
|
214 | },
|
215 | "afterClose": {
|
216 | "type": {
|
217 | "name": "func"
|
218 | },
|
219 | "required": false,
|
220 | "description": "弹层关闭后触发事件的回调函数, 如果有动画,则在动画结束后触发",
|
221 | "defaultValue": {
|
222 | "value": "func.noop",
|
223 | "computed": true
|
224 | },
|
225 | "docblock": "弹层关闭后触发事件的回调函数, 如果有动画,则在动画结束后触发",
|
226 | "params": [],
|
227 | "returns": null
|
228 | },
|
229 | "beforePosition": {
|
230 | "type": {
|
231 | "name": "func"
|
232 | },
|
233 | "required": false,
|
234 | "description": "弹层定位完成前触发的事件",
|
235 | "defaultValue": {
|
236 | "value": "func.noop",
|
237 | "computed": true
|
238 | },
|
239 | "docblock": "弹层定位完成前触发的事件",
|
240 | "params": [],
|
241 | "returns": null
|
242 | },
|
243 | "onPosition": {
|
244 | "type": {
|
245 | "name": "func"
|
246 | },
|
247 | "required": false,
|
248 | "description": "弹层定位完成时触发的事件",
|
249 | "defaultValue": {
|
250 | "value": "func.noop",
|
251 | "computed": true
|
252 | },
|
253 | "docblock": "弹层定位完成时触发的事件\n@param {Object} config 定位的参数\n@param {Array} config.align 对齐方式,如 ['cc', 'cc'](如果开启 needAdjust,可能和预先设置的 align 不同)\n@param {Number} config.top 距离视口顶部距离\n@param {Number} config.left 距离视口左侧距离\n@param {Object} node 定位参照的容器节点",
|
254 | "params": [
|
255 | {
|
256 | "name": "config",
|
257 | "description": "定位的参数",
|
258 | "type": {
|
259 | "name": "Object"
|
260 | }
|
261 | },
|
262 | {
|
263 | "name": "config.align",
|
264 | "description": "对齐方式,如 ['cc', 'cc'](如果开启 needAdjust,可能和预先设置的 align 不同)",
|
265 | "type": {
|
266 | "name": "Array"
|
267 | }
|
268 | },
|
269 | {
|
270 | "name": "config.top",
|
271 | "description": "距离视口顶部距离",
|
272 | "type": {
|
273 | "name": "Number"
|
274 | }
|
275 | },
|
276 | {
|
277 | "name": "config.left",
|
278 | "description": "距离视口左侧距离",
|
279 | "type": {
|
280 | "name": "Number"
|
281 | }
|
282 | },
|
283 | {
|
284 | "name": "node",
|
285 | "description": "定位参照的容器节点",
|
286 | "type": {
|
287 | "name": "Object"
|
288 | }
|
289 | }
|
290 | ],
|
291 | "returns": null
|
292 | },
|
293 | "autoFocus": {
|
294 | "type": {
|
295 | "name": "bool"
|
296 | },
|
297 | "required": false,
|
298 | "description": "弹层打开时是否让其中的元素自动获取焦点",
|
299 | "defaultValue": {
|
300 | "value": "false",
|
301 | "computed": false
|
302 | },
|
303 | "docblock": "弹层打开时是否让其中的元素自动获取焦点"
|
304 | },
|
305 | "disableScroll": {
|
306 | "type": {
|
307 | "name": "bool"
|
308 | },
|
309 | "required": false,
|
310 | "description": "是否禁用页面滚动",
|
311 | "defaultValue": {
|
312 | "value": "false",
|
313 | "computed": false
|
314 | },
|
315 | "docblock": "是否禁用页面滚动"
|
316 | },
|
317 | "useCapture": {
|
318 | "type": {
|
319 | "name": "bool"
|
320 | },
|
321 | "required": false,
|
322 | "description": "是否在捕获阶段监听,适配 react 17 事件模型变更",
|
323 | "defaultValue": {
|
324 | "value": "true",
|
325 | "computed": false
|
326 | },
|
327 | "docblock": "是否在捕获阶段监听,适配 react 17 事件模型变更\n@version 1.25",
|
328 | "version": {
|
329 | "value": "1.25",
|
330 | "computed": false
|
331 | }
|
332 | },
|
333 | "cache": {
|
334 | "type": {
|
335 | "name": "bool"
|
336 | },
|
337 | "required": false,
|
338 | "description": "隐藏时是否保留子节点",
|
339 | "defaultValue": {
|
340 | "value": "false",
|
341 | "computed": false
|
342 | },
|
343 | "docblock": "隐藏时是否保留子节点"
|
344 | },
|
345 | "safeNode": {
|
346 | "type": {
|
347 | "name": "any"
|
348 | },
|
349 | "required": false,
|
350 | "description": "安全节点,当点击 document 的时候,如果包含该节点则不会关闭弹层,如果是函数需要返回 ref,如果是字符串则是该 DOM 的 id,也可以直接传入 DOM 节点,或者以上值组成的数组",
|
351 | "docblock": "安全节点,当点击 document 的时候,如果包含该节点则不会关闭弹层,如果是函数需要返回 ref,如果是字符串则是该 DOM 的 id,也可以直接传入 DOM 节点,或者以上值组成的数组"
|
352 | },
|
353 | "wrapperClassName": {
|
354 | "type": {
|
355 | "name": "string"
|
356 | },
|
357 | "required": false,
|
358 | "description": "弹层的根节点的样式类",
|
359 | "docblock": "弹层的根节点的样式类"
|
360 | },
|
361 | "wrapperStyle": {
|
362 | "type": {
|
363 | "name": "object"
|
364 | },
|
365 | "required": false,
|
366 | "description": "弹层的根节点的内联样式",
|
367 | "docblock": "弹层的根节点的内联样式",
|
368 | "properties": []
|
369 | },
|
370 | "animation": {
|
371 | "type": {
|
372 | "name": "union",
|
373 | "value": [
|
374 | {
|
375 | "name": "object"
|
376 | },
|
377 | {
|
378 | "name": "bool"
|
379 | }
|
380 | ]
|
381 | },
|
382 | "required": false,
|
383 | "description": "配置动画的播放方式,支持 { in: 'enter-class', out: 'leave-class' } 的对象参数,如果设置为 false,则不播放动画。 请参考 Animate 组件的文档获取可用的动画名",
|
384 | "docblock": "配置动画的播放方式,支持 { in: 'enter-class', out: 'leave-class' } 的对象参数,如果设置为 false,则不播放动画。 请参考 Animate 组件的文档获取可用的动画名\n@default { in: 'expandInDown', out: 'expandOutUp' }",
|
385 | "defaultValue": {
|
386 | "value": "{ in: 'expandInDown', out: 'expandOutUp' }",
|
387 | "computed": false
|
388 | }
|
389 | },
|
390 | "v2": {
|
391 | "type": {
|
392 | "name": "bool"
|
393 | },
|
394 | "required": false,
|
395 | "description": "开启 v2 版本",
|
396 | "docblock": "开启 v2 版本\n@version 1.25",
|
397 | "version": {
|
398 | "value": "1.25",
|
399 | "computed": false
|
400 | }
|
401 | },
|
402 | "points": {
|
403 | "type": {
|
404 | "name": "array"
|
405 | },
|
406 | "required": false,
|
407 | "description": "[v2] align 的数组形式,不能和 align 同时使用",
|
408 | "docblock": "[v2] align 的数组形式,不能和 align 同时使用\n@version 1.25",
|
409 | "version": {
|
410 | "value": "1.25",
|
411 | "computed": false
|
412 | }
|
413 | }
|
414 | },
|
415 | "methods": [
|
416 | {
|
417 | "name": "addDocumentEvents",
|
418 | "docblock": "document global event",
|
419 | "modifiers": [],
|
420 | "params": [],
|
421 | "returns": null,
|
422 | "description": "document global event"
|
423 | }
|
424 | ],
|
425 | "subComponents": [
|
426 | {
|
427 | "name": "Popup",
|
428 | "props": {
|
429 | "children": {
|
430 | "type": {
|
431 | "name": "node"
|
432 | },
|
433 | "required": false,
|
434 | "description": "弹层内容",
|
435 | "docblock": "弹层内容"
|
436 | },
|
437 | "visible": {
|
438 | "type": {
|
439 | "name": "bool"
|
440 | },
|
441 | "required": false,
|
442 | "description": "弹层当前是否显示",
|
443 | "docblock": "弹层当前是否显示"
|
444 | },
|
445 | "onRequestClose": {
|
446 | "type": {
|
447 | "name": "func"
|
448 | },
|
449 | "required": false,
|
450 | "description": "弹层请求关闭时触发事件的回调函数",
|
451 | "defaultValue": {
|
452 | "value": "func.noop",
|
453 | "computed": true
|
454 | },
|
455 | "docblock": "弹层请求关闭时触发事件的回调函数\n@param {String} type 弹层关闭的来源\n@param {Object} e DOM 事件",
|
456 | "params": [
|
457 | {
|
458 | "name": "type",
|
459 | "description": "弹层关闭的来源",
|
460 | "type": {
|
461 | "name": "String"
|
462 | }
|
463 | },
|
464 | {
|
465 | "name": "e",
|
466 | "description": "DOM 事件",
|
467 | "type": {
|
468 | "name": "Object"
|
469 | }
|
470 | }
|
471 | ],
|
472 | "returns": null
|
473 | },
|
474 | "target": {
|
475 | "type": {
|
476 | "name": "any"
|
477 | },
|
478 | "required": false,
|
479 | "description": "弹层定位的参照元素",
|
480 | "docblock": "弹层定位的参照元素\n@default target 属性,即触发元素",
|
481 | "defaultValue": {
|
482 | "value": "target 属性,即触发元素",
|
483 | "computed": false
|
484 | }
|
485 | },
|
486 | "align": {
|
487 | "type": {
|
488 | "name": "string"
|
489 | },
|
490 | "required": false,
|
491 | "description": "弹层相对于参照元素的定位, 详见开发指南的[定位部分](#定位)",
|
492 | "defaultValue": {
|
493 | "value": "'tl bl'",
|
494 | "computed": false
|
495 | },
|
496 | "docblock": "弹层相对于参照元素的定位, 详见开发指南的[定位部分](#定位)"
|
497 | },
|
498 | "offset": {
|
499 | "type": {
|
500 | "name": "array"
|
501 | },
|
502 | "required": false,
|
503 | "description": "弹层相对于trigger的定位的微调, 接收数组[hoz, ver], 表示弹层在 left / top 上的增量\ne.g. [100, 100] 表示往右(RTL 模式下是往左) 、下分布偏移100px",
|
504 | "defaultValue": {
|
505 | "value": "[0, 0]",
|
506 | "computed": false
|
507 | },
|
508 | "docblock": "弹层相对于trigger的定位的微调, 接收数组[hoz, ver], 表示弹层在 left / top 上的增量\ne.g. [100, 100] 表示往右(RTL 模式下是往左) 、下分布偏移100px"
|
509 | },
|
510 | "container": {
|
511 | "type": {
|
512 | "name": "any"
|
513 | },
|
514 | "required": false,
|
515 | "description": "渲染组件的容器,如果是函数需要返回 ref,如果是字符串则是该 DOM 的 id,也可以直接传入 DOM 节点",
|
516 | "docblock": "渲染组件的容器,如果是函数需要返回 ref,如果是字符串则是该 DOM 的 id,也可以直接传入 DOM 节点"
|
517 | },
|
518 | "hasMask": {
|
519 | "type": {
|
520 | "name": "bool"
|
521 | },
|
522 | "required": false,
|
523 | "description": "是否显示遮罩",
|
524 | "defaultValue": {
|
525 | "value": "false",
|
526 | "computed": false
|
527 | },
|
528 | "docblock": "是否显示遮罩"
|
529 | },
|
530 | "canCloseByEsc": {
|
531 | "type": {
|
532 | "name": "bool"
|
533 | },
|
534 | "required": false,
|
535 | "description": "是否支持 esc 按键关闭弹层",
|
536 | "defaultValue": {
|
537 | "value": "true",
|
538 | "computed": false
|
539 | },
|
540 | "docblock": "是否支持 esc 按键关闭弹层"
|
541 | },
|
542 | "canCloseByOutSideClick": {
|
543 | "type": {
|
544 | "name": "bool"
|
545 | },
|
546 | "required": false,
|
547 | "description": "点击弹层外的区域是否关闭弹层,不显示遮罩时生效",
|
548 | "defaultValue": {
|
549 | "value": "true",
|
550 | "computed": false
|
551 | },
|
552 | "docblock": "点击弹层外的区域是否关闭弹层,不显示遮罩时生效"
|
553 | },
|
554 | "canCloseByMask": {
|
555 | "type": {
|
556 | "name": "bool"
|
557 | },
|
558 | "required": false,
|
559 | "description": "点击遮罩区域是否关闭弹层,显示遮罩时生效",
|
560 | "defaultValue": {
|
561 | "value": "true",
|
562 | "computed": false
|
563 | },
|
564 | "docblock": "点击遮罩区域是否关闭弹层,显示遮罩时生效"
|
565 | },
|
566 | "beforeOpen": {
|
567 | "type": {
|
568 | "name": "func"
|
569 | },
|
570 | "required": false,
|
571 | "description": "弹层打开前触发事件的回调函数",
|
572 | "defaultValue": {
|
573 | "value": "func.noop",
|
574 | "computed": true
|
575 | },
|
576 | "docblock": "弹层打开前触发事件的回调函数",
|
577 | "params": [],
|
578 | "returns": null
|
579 | },
|
580 | "onOpen": {
|
581 | "type": {
|
582 | "name": "func"
|
583 | },
|
584 | "required": false,
|
585 | "description": "弹层打开时触发事件的回调函数",
|
586 | "defaultValue": {
|
587 | "value": "func.noop",
|
588 | "computed": true
|
589 | },
|
590 | "docblock": "弹层打开时触发事件的回调函数",
|
591 | "params": [],
|
592 | "returns": null
|
593 | },
|
594 | "afterOpen": {
|
595 | "type": {
|
596 | "name": "func"
|
597 | },
|
598 | "required": false,
|
599 | "description": "弹层打开后触发事件的回调函数, 如果有动画,则在动画结束后触发",
|
600 | "defaultValue": {
|
601 | "value": "func.noop",
|
602 | "computed": true
|
603 | },
|
604 | "docblock": "弹层打开后触发事件的回调函数, 如果有动画,则在动画结束后触发",
|
605 | "params": [],
|
606 | "returns": null
|
607 | },
|
608 | "beforeClose": {
|
609 | "type": {
|
610 | "name": "func"
|
611 | },
|
612 | "required": false,
|
613 | "description": "弹层关闭前触发事件的回调函数",
|
614 | "defaultValue": {
|
615 | "value": "func.noop",
|
616 | "computed": true
|
617 | },
|
618 | "docblock": "弹层关闭前触发事件的回调函数",
|
619 | "params": [],
|
620 | "returns": null
|
621 | },
|
622 | "onClose": {
|
623 | "type": {
|
624 | "name": "func"
|
625 | },
|
626 | "required": false,
|
627 | "description": "弹层关闭时触发事件的回调函数",
|
628 | "defaultValue": {
|
629 | "value": "func.noop",
|
630 | "computed": true
|
631 | },
|
632 | "docblock": "弹层关闭时触发事件的回调函数",
|
633 | "params": [],
|
634 | "returns": null
|
635 | },
|
636 | "afterClose": {
|
637 | "type": {
|
638 | "name": "func"
|
639 | },
|
640 | "required": false,
|
641 | "description": "弹层关闭后触发事件的回调函数, 如果有动画,则在动画结束后触发",
|
642 | "defaultValue": {
|
643 | "value": "func.noop",
|
644 | "computed": true
|
645 | },
|
646 | "docblock": "弹层关闭后触发事件的回调函数, 如果有动画,则在动画结束后触发",
|
647 | "params": [],
|
648 | "returns": null
|
649 | },
|
650 | "beforePosition": {
|
651 | "type": {
|
652 | "name": "func"
|
653 | },
|
654 | "required": false,
|
655 | "description": "弹层定位完成前触发的事件",
|
656 | "defaultValue": {
|
657 | "value": "func.noop",
|
658 | "computed": true
|
659 | },
|
660 | "docblock": "弹层定位完成前触发的事件",
|
661 | "params": [],
|
662 | "returns": null
|
663 | },
|
664 | "onPosition": {
|
665 | "type": {
|
666 | "name": "func"
|
667 | },
|
668 | "required": false,
|
669 | "description": "弹层定位完成时触发的事件",
|
670 | "defaultValue": {
|
671 | "value": "func.noop",
|
672 | "computed": true
|
673 | },
|
674 | "docblock": "弹层定位完成时触发的事件\n@param {Object} config 定位的参数\n@param {Array} config.align 对齐方式,如 ['cc', 'cc'](如果开启 needAdjust,可能和预先设置的 align 不同)\n@param {Number} config.top 距离视口顶部距离\n@param {Number} config.left 距离视口左侧距离\n@param {Object} node 定位参照的容器节点",
|
675 | "params": [
|
676 | {
|
677 | "name": "config",
|
678 | "description": "定位的参数",
|
679 | "type": {
|
680 | "name": "Object"
|
681 | }
|
682 | },
|
683 | {
|
684 | "name": "config.align",
|
685 | "description": "对齐方式,如 ['cc', 'cc'](如果开启 needAdjust,可能和预先设置的 align 不同)",
|
686 | "type": {
|
687 | "name": "Array"
|
688 | }
|
689 | },
|
690 | {
|
691 | "name": "config.top",
|
692 | "description": "距离视口顶部距离",
|
693 | "type": {
|
694 | "name": "Number"
|
695 | }
|
696 | },
|
697 | {
|
698 | "name": "config.left",
|
699 | "description": "距离视口左侧距离",
|
700 | "type": {
|
701 | "name": "Number"
|
702 | }
|
703 | },
|
704 | {
|
705 | "name": "node",
|
706 | "description": "定位参照的容器节点",
|
707 | "type": {
|
708 | "name": "Object"
|
709 | }
|
710 | }
|
711 | ],
|
712 | "returns": null
|
713 | },
|
714 | "autoFocus": {
|
715 | "type": {
|
716 | "name": "bool"
|
717 | },
|
718 | "required": false,
|
719 | "description": "弹层打开时是否让其中的元素自动获取焦点",
|
720 | "defaultValue": {
|
721 | "value": "false",
|
722 | "computed": false
|
723 | },
|
724 | "docblock": "弹层打开时是否让其中的元素自动获取焦点"
|
725 | },
|
726 | "disableScroll": {
|
727 | "type": {
|
728 | "name": "bool"
|
729 | },
|
730 | "required": false,
|
731 | "description": "是否禁用页面滚动",
|
732 | "defaultValue": {
|
733 | "value": "false",
|
734 | "computed": false
|
735 | },
|
736 | "docblock": "是否禁用页面滚动"
|
737 | },
|
738 | "useCapture": {
|
739 | "type": {
|
740 | "name": "bool"
|
741 | },
|
742 | "required": false,
|
743 | "description": "是否在捕获阶段监听,适配 react 17 事件模型变更",
|
744 | "defaultValue": {
|
745 | "value": "true",
|
746 | "computed": false
|
747 | },
|
748 | "docblock": "是否在捕获阶段监听,适配 react 17 事件模型变更\n@version 1.25",
|
749 | "version": {
|
750 | "value": "1.25",
|
751 | "computed": false
|
752 | }
|
753 | },
|
754 | "cache": {
|
755 | "type": {
|
756 | "name": "bool"
|
757 | },
|
758 | "required": false,
|
759 | "description": "隐藏时是否保留子节点",
|
760 | "defaultValue": {
|
761 | "value": "false",
|
762 | "computed": false
|
763 | },
|
764 | "docblock": "隐藏时是否保留子节点"
|
765 | },
|
766 | "safeNode": {
|
767 | "type": {
|
768 | "name": "any"
|
769 | },
|
770 | "required": false,
|
771 | "description": "安全节点,当点击 document 的时候,如果包含该节点则不会关闭弹层,如果是函数需要返回 ref,如果是字符串则是该 DOM 的 id,也可以直接传入 DOM 节点,或者以上值组成的数组",
|
772 | "docblock": "安全节点,当点击 document 的时候,如果包含该节点则不会关闭弹层,如果是函数需要返回 ref,如果是字符串则是该 DOM 的 id,也可以直接传入 DOM 节点,或者以上值组成的数组"
|
773 | },
|
774 | "wrapperClassName": {
|
775 | "type": {
|
776 | "name": "string"
|
777 | },
|
778 | "required": false,
|
779 | "description": "弹层的根节点的样式类",
|
780 | "docblock": "弹层的根节点的样式类"
|
781 | },
|
782 | "wrapperStyle": {
|
783 | "type": {
|
784 | "name": "object"
|
785 | },
|
786 | "required": false,
|
787 | "description": "弹层的根节点的内联样式",
|
788 | "docblock": "弹层的根节点的内联样式",
|
789 | "properties": []
|
790 | },
|
791 | "animation": {
|
792 | "type": {
|
793 | "name": "union",
|
794 | "value": [
|
795 | {
|
796 | "name": "object"
|
797 | },
|
798 | {
|
799 | "name": "bool"
|
800 | }
|
801 | ]
|
802 | },
|
803 | "required": false,
|
804 | "description": "配置动画的播放方式,支持 { in: 'enter-class', out: 'leave-class' } 的对象参数,如果设置为 false,则不播放动画。 请参考 Animate 组件的文档获取可用的动画名",
|
805 | "docblock": "配置动画的播放方式,支持 { in: 'enter-class', out: 'leave-class' } 的对象参数,如果设置为 false,则不播放动画。 请参考 Animate 组件的文档获取可用的动画名\n@default { in: 'expandInDown', out: 'expandOutUp' }",
|
806 | "defaultValue": {
|
807 | "value": "{ in: 'expandInDown', out: 'expandOutUp' }",
|
808 | "computed": false
|
809 | }
|
810 | },
|
811 | "v2": {
|
812 | "type": {
|
813 | "name": "bool"
|
814 | },
|
815 | "required": false,
|
816 | "description": "开启 v2 版本",
|
817 | "docblock": "开启 v2 版本"
|
818 | },
|
819 | "points": {
|
820 | "type": {
|
821 | "name": "array"
|
822 | },
|
823 | "required": false,
|
824 | "description": "[v2] align 的数组形式,不能和 align 同时使用",
|
825 | "docblock": "[v2] align 的数组形式,不能和 align 同时使用\n@version 1.25",
|
826 | "version": {
|
827 | "value": "1.25",
|
828 | "computed": false
|
829 | }
|
830 | },
|
831 | "trigger": {
|
832 | "type": {
|
833 | "name": "element"
|
834 | },
|
835 | "required": false,
|
836 | "description": "触发弹层显示或隐藏的元素",
|
837 | "docblock": "触发弹层显示或隐藏的元素"
|
838 | },
|
839 | "triggerType": {
|
840 | "type": {
|
841 | "name": "union",
|
842 | "value": [
|
843 | {
|
844 | "name": "string"
|
845 | },
|
846 | {
|
847 | "name": "array"
|
848 | }
|
849 | ]
|
850 | },
|
851 | "required": false,
|
852 | "description": "触发弹层显示或隐藏的操作类型,可以是 'click','hover','focus',或者它们组成的数组,如 ['hover', 'focus']",
|
853 | "defaultValue": {
|
854 | "value": "'hover'",
|
855 | "computed": false
|
856 | },
|
857 | "docblock": "触发弹层显示或隐藏的操作类型,可以是 'click','hover','focus',或者它们组成的数组,如 ['hover', 'focus']"
|
858 | },
|
859 | "triggerClickKeycode": {
|
860 | "type": {
|
861 | "name": "union",
|
862 | "value": [
|
863 | {
|
864 | "name": "number"
|
865 | },
|
866 | {
|
867 | "name": "array"
|
868 | }
|
869 | ]
|
870 | },
|
871 | "required": false,
|
872 | "description": "当 triggerType 为 click 时才生效,可自定义触发弹层显示的键盘码",
|
873 | "defaultValue": {
|
874 | "value": "[KEYCODE.SPACE, KEYCODE.ENTER]",
|
875 | "computed": false
|
876 | },
|
877 | "docblock": "当 triggerType 为 click 时才生效,可自定义触发弹层显示的键盘码"
|
878 | },
|
879 | "defaultVisible": {
|
880 | "type": {
|
881 | "name": "bool"
|
882 | },
|
883 | "required": false,
|
884 | "description": "弹层默认是否显示",
|
885 | "defaultValue": {
|
886 | "value": "false",
|
887 | "computed": false
|
888 | },
|
889 | "docblock": "弹层默认是否显示"
|
890 | },
|
891 | "onVisibleChange": {
|
892 | "type": {
|
893 | "name": "func"
|
894 | },
|
895 | "required": false,
|
896 | "description": "弹层显示或隐藏时触发的回调函数",
|
897 | "defaultValue": {
|
898 | "value": "func.noop",
|
899 | "computed": true
|
900 | },
|
901 | "docblock": "弹层显示或隐藏时触发的回调函数\n@param {Boolean} visible 弹层是否显示\n@param {String} type 触发弹层显示或隐藏的来源 fromTrigger 表示由trigger的点击触发; docClick 表示由document的点击触发\n@param {Object} e DOM事件",
|
902 | "params": [
|
903 | {
|
904 | "name": "visible",
|
905 | "description": "弹层是否显示",
|
906 | "type": {
|
907 | "name": "Boolean"
|
908 | }
|
909 | },
|
910 | {
|
911 | "name": "type",
|
912 | "description": "触发弹层显示或隐藏的来源 fromTrigger 表示由trigger的点击触发; docClick 表示由document的点击触发",
|
913 | "type": {
|
914 | "name": "String"
|
915 | }
|
916 | },
|
917 | {
|
918 | "name": "e",
|
919 | "description": "DOM事件",
|
920 | "type": {
|
921 | "name": "Object"
|
922 | }
|
923 | }
|
924 | ],
|
925 | "returns": null
|
926 | },
|
927 | "disabled": {
|
928 | "type": {
|
929 | "name": "bool"
|
930 | },
|
931 | "required": false,
|
932 | "description": "设置此属性,弹层无法显示或隐藏",
|
933 | "defaultValue": {
|
934 | "value": "false",
|
935 | "computed": false
|
936 | },
|
937 | "docblock": "设置此属性,弹层无法显示或隐藏"
|
938 | },
|
939 | "delay": {
|
940 | "type": {
|
941 | "name": "number"
|
942 | },
|
943 | "required": false,
|
944 | "description": "弹层显示或隐藏的延时时间(以毫秒为单位),在 triggerType 被设置为 hover 时生效",
|
945 | "defaultValue": {
|
946 | "value": "200",
|
947 | "computed": false
|
948 | },
|
949 | "docblock": "弹层显示或隐藏的延时时间(以毫秒为单位),在 triggerType 被设置为 hover 时生效"
|
950 | },
|
951 | "canCloseByTrigger": {
|
952 | "type": {
|
953 | "name": "bool"
|
954 | },
|
955 | "required": false,
|
956 | "description": "trigger 是否可以关闭弹层",
|
957 | "defaultValue": {
|
958 | "value": "true",
|
959 | "computed": false
|
960 | },
|
961 | "docblock": "trigger 是否可以关闭弹层"
|
962 | },
|
963 | "followTrigger": {
|
964 | "type": {
|
965 | "name": "bool"
|
966 | },
|
967 | "required": false,
|
968 | "description": "是否跟随trigger滚动",
|
969 | "defaultValue": {
|
970 | "value": "false",
|
971 | "computed": false
|
972 | },
|
973 | "docblock": "是否跟随trigger滚动"
|
974 | },
|
975 | "placement": {
|
976 | "type": {
|
977 | "name": "string"
|
978 | },
|
979 | "required": false,
|
980 | "description": "[v2] 快捷位置,包含 'tl' | 't' | 'tr' | 'rt' | 'r' | 'rb' | 'bl' | 'b' | 'br' | 'lt' | 'l' | 'lb'",
|
981 | "docblock": "[v2] 快捷位置,包含 'tl' | 't' | 'tr' | 'rt' | 'r' | 'rb' | 'bl' | 'b' | 'br' | 'lt' | 'l' | 'lb'"
|
982 | },
|
983 | "placementOffset": {
|
984 | "type": {
|
985 | "name": "number"
|
986 | },
|
987 | "required": false,
|
988 | "description": "[v2] 弹层偏离触发元素的像素值",
|
989 | "docblock": "[v2] 弹层偏离触发元素的像素值"
|
990 | }
|
991 | },
|
992 | "methods": [],
|
993 | "description": "继承 Overlay 的 API,除非特别说明"
|
994 | }
|
995 | ]
|
996 | } |
\ | No newline at end of file |