1 | {
|
2 | "name": "Dialog",
|
3 | "props": {
|
4 | "visible": {
|
5 | "type": {
|
6 | "name": "bool"
|
7 | },
|
8 | "required": false,
|
9 | "description": "是否显示",
|
10 | "defaultValue": {
|
11 | "value": "false",
|
12 | "computed": false
|
13 | },
|
14 | "docblock": "是否显示"
|
15 | },
|
16 | "title": {
|
17 | "type": {
|
18 | "name": "node"
|
19 | },
|
20 | "required": false,
|
21 | "description": "标题",
|
22 | "docblock": "标题"
|
23 | },
|
24 | "children": {
|
25 | "type": {
|
26 | "name": "node"
|
27 | },
|
28 | "required": false,
|
29 | "description": "内容",
|
30 | "docblock": "内容"
|
31 | },
|
32 | "footer": {
|
33 | "type": {
|
34 | "name": "union",
|
35 | "value": [
|
36 | {
|
37 | "name": "bool"
|
38 | },
|
39 | {
|
40 | "name": "node"
|
41 | }
|
42 | ]
|
43 | },
|
44 | "required": false,
|
45 | "description": "底部内容,设置为 false,则不进行显示",
|
46 | "docblock": "底部内容,设置为 false,则不进行显示\n@default [<Button type=\"primary\">确定</Button>, <Button>取消</Button>]",
|
47 | "defaultValue": {
|
48 | "value": "[<Button type=\"primary\">确定</Button>, <Button>取消</Button>]",
|
49 | "computed": false
|
50 | }
|
51 | },
|
52 | "footerAlign": {
|
53 | "type": {
|
54 | "name": "enum",
|
55 | "value": [
|
56 | {
|
57 | "value": "'left'",
|
58 | "computed": false
|
59 | },
|
60 | {
|
61 | "value": "'center'",
|
62 | "computed": false
|
63 | },
|
64 | {
|
65 | "value": "'right'",
|
66 | "computed": false
|
67 | }
|
68 | ]
|
69 | },
|
70 | "required": false,
|
71 | "description": "底部按钮的对齐方式",
|
72 | "defaultValue": {
|
73 | "value": "'right'",
|
74 | "computed": false
|
75 | },
|
76 | "docblock": "底部按钮的对齐方式"
|
77 | },
|
78 | "footerActions": {
|
79 | "type": {
|
80 | "name": "array"
|
81 | },
|
82 | "required": false,
|
83 | "description": "指定确定按钮和取消按钮是否存在以及如何排列,<br><br>**可选值**:\n['ok', 'cancel'](确认取消按钮同时存在,确认按钮在左)\n['cancel', 'ok'](确认取消按钮同时存在,确认按钮在右)\n['ok'](只存在确认按钮)\n['cancel'](只存在取消按钮)",
|
84 | "defaultValue": {
|
85 | "value": "['ok', 'cancel']",
|
86 | "computed": false
|
87 | },
|
88 | "docblock": "指定确定按钮和取消按钮是否存在以及如何排列,<br><br>**可选值**:\n['ok', 'cancel'](确认取消按钮同时存在,确认按钮在左)\n['cancel', 'ok'](确认取消按钮同时存在,确认按钮在右)\n['ok'](只存在确认按钮)\n['cancel'](只存在取消按钮)"
|
89 | },
|
90 | "onOk": {
|
91 | "type": {
|
92 | "name": "func"
|
93 | },
|
94 | "required": false,
|
95 | "description": "在点击确定按钮时触发的回调函数",
|
96 | "defaultValue": {
|
97 | "value": "() => {}",
|
98 | "computed": false
|
99 | },
|
100 | "docblock": "在点击确定按钮时触发的回调函数\n@param {Object} event 点击事件对象",
|
101 | "params": [
|
102 | {
|
103 | "name": "event",
|
104 | "description": "点击事件对象",
|
105 | "type": {
|
106 | "name": "Object"
|
107 | }
|
108 | }
|
109 | ],
|
110 | "returns": null
|
111 | },
|
112 | "onCancel": {
|
113 | "type": {
|
114 | "name": "func"
|
115 | },
|
116 | "required": false,
|
117 | "description": "在点击取消/关闭按钮时触发的回调函数",
|
118 | "defaultValue": {
|
119 | "value": "() => {}",
|
120 | "computed": false
|
121 | },
|
122 | "docblock": "在点击取消/关闭按钮时触发的回调函数\n@param {Object} event 点击事件对象, event.triggerType=esc|closeIcon 可区分点击来源",
|
123 | "params": [
|
124 | {
|
125 | "name": "event",
|
126 | "description": "点击事件对象, event.triggerType=esc|closeIcon 可区分点击来源",
|
127 | "type": {
|
128 | "name": "Object"
|
129 | }
|
130 | }
|
131 | ],
|
132 | "returns": null
|
133 | },
|
134 | "okProps": {
|
135 | "type": {
|
136 | "name": "object"
|
137 | },
|
138 | "required": false,
|
139 | "description": "应用于确定按钮的属性对象",
|
140 | "defaultValue": {
|
141 | "value": "{}",
|
142 | "computed": false
|
143 | },
|
144 | "docblock": "应用于确定按钮的属性对象",
|
145 | "properties": []
|
146 | },
|
147 | "cancelProps": {
|
148 | "type": {
|
149 | "name": "object"
|
150 | },
|
151 | "required": false,
|
152 | "description": "应用于取消按钮的属性对象",
|
153 | "defaultValue": {
|
154 | "value": "{}",
|
155 | "computed": false
|
156 | },
|
157 | "docblock": "应用于取消按钮的属性对象",
|
158 | "properties": []
|
159 | },
|
160 | "closeMode": {
|
161 | "type": {
|
162 | "name": "union",
|
163 | "value": [
|
164 | {
|
165 | "name": "arrayOf",
|
166 | "value": {
|
167 | "name": "enum",
|
168 | "value": [
|
169 | {
|
170 | "value": "'close'",
|
171 | "computed": false
|
172 | },
|
173 | {
|
174 | "value": "'mask'",
|
175 | "computed": false
|
176 | },
|
177 | {
|
178 | "value": "'esc'",
|
179 | "computed": false
|
180 | }
|
181 | ]
|
182 | }
|
183 | },
|
184 | {
|
185 | "name": "enum",
|
186 | "value": [
|
187 | {
|
188 | "value": "'close'",
|
189 | "computed": false
|
190 | },
|
191 | {
|
192 | "value": "'mask'",
|
193 | "computed": false
|
194 | },
|
195 | {
|
196 | "value": "'esc'",
|
197 | "computed": false
|
198 | }
|
199 | ]
|
200 | }
|
201 | ]
|
202 | },
|
203 | "required": false,
|
204 | "description": "[推荐]1.21.x 支持控制对话框关闭的方式,值可以为字符串或者数组,其中字符串、数组均为以下值的枚举:\n**close** 表示点击关闭按钮可以关闭对话框\n**mask** 表示点击遮罩区域可以关闭对话框\n**esc** 表示按下 esc 键可以关闭对话框\n如 'close' 或 ['close','esc','mask'], []",
|
205 | "docblock": "[推荐]1.21.x 支持控制对话框关闭的方式,值可以为字符串或者数组,其中字符串、数组均为以下值的枚举:\n**close** 表示点击关闭按钮可以关闭对话框\n**mask** 表示点击遮罩区域可以关闭对话框\n**esc** 表示按下 esc 键可以关闭对话框\n如 'close' 或 ['close','esc','mask'], []\n@version 1.21",
|
206 | "version": {
|
207 | "value": "1.21",
|
208 | "computed": false
|
209 | }
|
210 | },
|
211 | "cache": {
|
212 | "type": {
|
213 | "name": "bool"
|
214 | },
|
215 | "required": false,
|
216 | "description": "隐藏时是否保留子节点,不销毁 (低版本通过 overlayProps 实现)",
|
217 | "defaultValue": {
|
218 | "value": "false",
|
219 | "computed": false
|
220 | },
|
221 | "docblock": "隐藏时是否保留子节点,不销毁 (低版本通过 overlayProps 实现)\n@version 1.23",
|
222 | "version": {
|
223 | "value": "1.23",
|
224 | "computed": false
|
225 | }
|
226 | },
|
227 | "afterClose": {
|
228 | "type": {
|
229 | "name": "func"
|
230 | },
|
231 | "required": false,
|
232 | "description": "对话框关闭后触发的回调函数, 如果有动画,则在动画结束后触发",
|
233 | "defaultValue": {
|
234 | "value": "() => {}",
|
235 | "computed": false
|
236 | },
|
237 | "docblock": "对话框关闭后触发的回调函数, 如果有动画,则在动画结束后触发",
|
238 | "params": [],
|
239 | "returns": null
|
240 | },
|
241 | "hasMask": {
|
242 | "type": {
|
243 | "name": "bool"
|
244 | },
|
245 | "required": false,
|
246 | "description": "是否显示遮罩",
|
247 | "defaultValue": {
|
248 | "value": "true",
|
249 | "computed": false
|
250 | },
|
251 | "docblock": "是否显示遮罩"
|
252 | },
|
253 | "animation": {
|
254 | "type": {
|
255 | "name": "union",
|
256 | "value": [
|
257 | {
|
258 | "name": "object"
|
259 | },
|
260 | {
|
261 | "name": "bool"
|
262 | }
|
263 | ]
|
264 | },
|
265 | "required": false,
|
266 | "description": "显示隐藏时动画的播放方式,支持 { in: 'enter-class', out: 'leave-class' } 的对象参数,如果设置为 false,则不播放动画。 请参考 Animate 组件的文档获取可用的动画名",
|
267 | "defaultValue": {
|
268 | "value": "{ in: 'expandInDown', out: 'expandOutUp' }",
|
269 | "computed": false
|
270 | },
|
271 | "docblock": "显示隐藏时动画的播放方式,支持 { in: 'enter-class', out: 'leave-class' } 的对象参数,如果设置为 false,则不播放动画。 请参考 Animate 组件的文档获取可用的动画名\n@default { in: 'expandInDown', out: 'expandOutUp' }"
|
272 | },
|
273 | "autoFocus": {
|
274 | "type": {
|
275 | "name": "bool"
|
276 | },
|
277 | "required": false,
|
278 | "description": "对话框弹出时是否自动获得焦点",
|
279 | "defaultValue": {
|
280 | "value": "false",
|
281 | "computed": false
|
282 | },
|
283 | "docblock": "对话框弹出时是否自动获得焦点"
|
284 | },
|
285 | "overlayProps": {
|
286 | "type": {
|
287 | "name": "object"
|
288 | },
|
289 | "required": false,
|
290 | "description": "[v2废弃] 透传到弹层组件的属性对象",
|
291 | "defaultValue": {
|
292 | "value": "{}",
|
293 | "computed": false
|
294 | },
|
295 | "docblock": "[v2废弃] 透传到弹层组件的属性对象",
|
296 | "properties": []
|
297 | },
|
298 | "locale": {
|
299 | "type": {
|
300 | "name": "object"
|
301 | },
|
302 | "required": false,
|
303 | "description": "自定义国际化文案对象",
|
304 | "defaultValue": {
|
305 | "value": "zhCN.Dialog",
|
306 | "computed": true
|
307 | },
|
308 | "docblock": "自定义国际化文案对象\n@property {String} ok 确认按钮文案\n@property {String} cancel 取消按钮文案",
|
309 | "properties": [
|
310 | {
|
311 | "name": "ok",
|
312 | "description": "确认按钮文案",
|
313 | "type": {
|
314 | "name": "String"
|
315 | }
|
316 | },
|
317 | {
|
318 | "name": "cancel",
|
319 | "description": "取消按钮文案",
|
320 | "type": {
|
321 | "name": "String"
|
322 | }
|
323 | }
|
324 | ]
|
325 | },
|
326 | "popupContainer": {
|
327 | "type": {
|
328 | "name": "any"
|
329 | },
|
330 | "required": false,
|
331 | "description": "自定义弹窗挂载位置",
|
332 | "docblock": "自定义弹窗挂载位置"
|
333 | },
|
334 | "height": {
|
335 | "type": {
|
336 | "name": "union",
|
337 | "value": [
|
338 | {
|
339 | "name": "string"
|
340 | },
|
341 | {
|
342 | "name": "number"
|
343 | }
|
344 | ]
|
345 | },
|
346 | "required": false,
|
347 | "description": "对话框的高度样式属性",
|
348 | "docblock": "对话框的高度样式属性"
|
349 | },
|
350 | "v2": {
|
351 | "type": {
|
352 | "name": "bool"
|
353 | },
|
354 | "required": false,
|
355 | "description": "开启 v2 版本弹窗",
|
356 | "docblock": "开启 v2 版本弹窗"
|
357 | },
|
358 | "width": {
|
359 | "type": {
|
360 | "name": "union",
|
361 | "value": [
|
362 | {
|
363 | "name": "string"
|
364 | },
|
365 | {
|
366 | "name": "number"
|
367 | }
|
368 | ]
|
369 | },
|
370 | "required": false,
|
371 | "description": "[v2] 弹窗宽度",
|
372 | "docblock": "[v2] 弹窗宽度\n@version 1.25",
|
373 | "version": {
|
374 | "value": "1.25",
|
375 | "computed": false
|
376 | }
|
377 | },
|
378 | "top": {
|
379 | "type": {
|
380 | "name": "number"
|
381 | },
|
382 | "required": false,
|
383 | "description": "[v2] 弹窗上边距。默认 100,设置 centered=true 后默认 40",
|
384 | "docblock": "[v2] 弹窗上边距。默认 100,设置 centered=true 后默认 40\n@version 1.25",
|
385 | "version": {
|
386 | "value": "1.25",
|
387 | "computed": false
|
388 | }
|
389 | },
|
390 | "bottom": {
|
391 | "type": {
|
392 | "name": "number"
|
393 | },
|
394 | "required": false,
|
395 | "description": "[v2] 弹窗下边距",
|
396 | "defaultValue": {
|
397 | "value": "40",
|
398 | "computed": false
|
399 | },
|
400 | "docblock": "[v2] 弹窗下边距\n@version 1.25",
|
401 | "version": {
|
402 | "value": "1.25",
|
403 | "computed": false
|
404 | }
|
405 | },
|
406 | "closeIcon": {
|
407 | "type": {
|
408 | "name": "node"
|
409 | },
|
410 | "required": false,
|
411 | "description": "[v2] 定制关闭按钮 icon",
|
412 | "docblock": "[v2] 定制关闭按钮 icon\n@version 1.25",
|
413 | "version": {
|
414 | "value": "1.25",
|
415 | "computed": false
|
416 | }
|
417 | },
|
418 | "centered": {
|
419 | "type": {
|
420 | "name": "bool"
|
421 | },
|
422 | "required": false,
|
423 | "description": "[v2] 弹窗居中对齐",
|
424 | "defaultValue": {
|
425 | "value": "false",
|
426 | "computed": false
|
427 | },
|
428 | "docblock": "[v2] 弹窗居中对齐\n@version 1.25",
|
429 | "version": {
|
430 | "value": "1.25",
|
431 | "computed": false
|
432 | }
|
433 | },
|
434 | "overflowScroll": {
|
435 | "type": {
|
436 | "name": "bool"
|
437 | },
|
438 | "required": false,
|
439 | "description": "[v2] 对话框高度超过浏览器视口高度时,对话框是否展示滚动条。关闭此功后对话框会随高度撑开页面",
|
440 | "defaultValue": {
|
441 | "value": "true",
|
442 | "computed": false
|
443 | },
|
444 | "docblock": "[v2] 对话框高度超过浏览器视口高度时,对话框是否展示滚动条。关闭此功后对话框会随高度撑开页面\n@version 1.25",
|
445 | "version": {
|
446 | "value": "1.25",
|
447 | "computed": false
|
448 | }
|
449 | },
|
450 | "closeable": {
|
451 | "type": {
|
452 | "name": "union",
|
453 | "value": [
|
454 | {
|
455 | "name": "string"
|
456 | },
|
457 | {
|
458 | "name": "bool"
|
459 | }
|
460 | ]
|
461 | },
|
462 | "required": false,
|
463 | "description": "[废弃]同closeMode, 控制对话框关闭的方式,值可以为字符串或者布尔值,其中字符串是由以下值组成:\n**close** 表示点击关闭按钮可以关闭对话框\n**mask** 表示点击遮罩区域可以关闭对话框\n**esc** 表示按下 esc 键可以关闭对话框\n如 'close' 或 'close,esc,mask'\n如果设置为 true,则以上关闭方式全部生效\n如果设置为 false,则以上关闭方式全部失效",
|
464 | "defaultValue": {
|
465 | "value": "'esc,close'",
|
466 | "computed": false
|
467 | },
|
468 | "docblock": "[废弃]同closeMode, 控制对话框关闭的方式,值可以为字符串或者布尔值,其中字符串是由以下值组成:\n**close** 表示点击关闭按钮可以关闭对话框\n**mask** 表示点击遮罩区域可以关闭对话框\n**esc** 表示按下 esc 键可以关闭对话框\n如 'close' 或 'close,esc,mask'\n如果设置为 true,则以上关闭方式全部生效\n如果设置为 false,则以上关闭方式全部失效"
|
469 | },
|
470 | "onClose": {
|
471 | "type": {
|
472 | "name": "func"
|
473 | },
|
474 | "required": false,
|
475 | "description": "点击对话框关闭按钮时触发的回调函数",
|
476 | "defaultValue": {
|
477 | "value": "() => {}",
|
478 | "computed": false
|
479 | },
|
480 | "docblock": "点击对话框关闭按钮时触发的回调函数\n@param {String} trigger 关闭触发行为的描述字符串\n@param {Object} event 关闭时事件对象",
|
481 | "params": [
|
482 | {
|
483 | "name": "trigger",
|
484 | "description": "关闭触发行为的描述字符串",
|
485 | "type": {
|
486 | "name": "String"
|
487 | }
|
488 | },
|
489 | {
|
490 | "name": "event",
|
491 | "description": "关闭时事件对象",
|
492 | "type": {
|
493 | "name": "Object"
|
494 | }
|
495 | }
|
496 | ],
|
497 | "returns": null
|
498 | },
|
499 | "align": {
|
500 | "type": {
|
501 | "name": "union",
|
502 | "value": [
|
503 | {
|
504 | "name": "string"
|
505 | },
|
506 | {
|
507 | "name": "bool"
|
508 | }
|
509 | ]
|
510 | },
|
511 | "required": false,
|
512 | "description": "[v2废弃] 对话框对齐方式, 具体见Overlay文档",
|
513 | "defaultValue": {
|
514 | "value": "'cc cc'",
|
515 | "computed": false
|
516 | },
|
517 | "docblock": "[v2废弃] 对话框对齐方式, 具体见Overlay文档"
|
518 | },
|
519 | "isFullScreen": {
|
520 | "type": {
|
521 | "name": "bool"
|
522 | },
|
523 | "required": false,
|
524 | "description": "[v2废弃] 是否撑开页面。 v2 改用 overflowScroll",
|
525 | "defaultValue": {
|
526 | "value": "false",
|
527 | "computed": false
|
528 | },
|
529 | "docblock": "[v2废弃] 是否撑开页面。 v2 改用 overflowScroll"
|
530 | },
|
531 | "shouldUpdatePosition": {
|
532 | "type": {
|
533 | "name": "bool"
|
534 | },
|
535 | "required": false,
|
536 | "description": "[v2废弃] 是否在对话框重新渲染时及时更新对话框位置,一般用于对话框高度变化后依然能保证原来的对齐方式",
|
537 | "defaultValue": {
|
538 | "value": "false",
|
539 | "computed": false
|
540 | },
|
541 | "docblock": "[v2废弃] 是否在对话框重新渲染时及时更新对话框位置,一般用于对话框高度变化后依然能保证原来的对齐方式"
|
542 | },
|
543 | "minMargin": {
|
544 | "type": {
|
545 | "name": "number"
|
546 | },
|
547 | "required": false,
|
548 | "description": "[v2废弃] 对话框距离浏览器顶部和底部的最小间距,align 被设置为 'cc cc' 并且 isFullScreen 被设置为 true 时不生效",
|
549 | "defaultValue": {
|
550 | "value": "40",
|
551 | "computed": false
|
552 | },
|
553 | "docblock": "[v2废弃] 对话框距离浏览器顶部和底部的最小间距,align 被设置为 'cc cc' 并且 isFullScreen 被设置为 true 时不生效"
|
554 | }
|
555 | },
|
556 | "methods": [
|
557 | {
|
558 | "name": "show",
|
559 | "docblock": "\n 创建对话框\n @exportName show\n @param {Object} config 配置项\n @returns {Object} 包含有 hide 方法,可用来关闭对话框\n ",
|
560 | "description": "创建对话框",
|
561 | "modifiers": [
|
562 | "static"
|
563 | ],
|
564 | "params": [
|
565 | {
|
566 | "name": "config",
|
567 | "description": "配置项",
|
568 | "type": {
|
569 | "type": "NameExpression",
|
570 | "name": "Object"
|
571 | }
|
572 | }
|
573 | ],
|
574 | "returns": {
|
575 | "description": "包含有 hide 方法,可用来关闭对话框",
|
576 | "type": {
|
577 | "type": "NameExpression",
|
578 | "name": "Object"
|
579 | }
|
580 | }
|
581 | },
|
582 | {
|
583 | "name": "alert",
|
584 | "docblock": "\n 创建警示对话框\n @exportName alert\n @param {Object} config 配置项\n @returns {Object} 包含有 hide 方法,可用来关闭对话框\n ",
|
585 | "description": "创建警示对话框",
|
586 | "modifiers": [
|
587 | "static"
|
588 | ],
|
589 | "params": [
|
590 | {
|
591 | "name": "config",
|
592 | "description": "配置项",
|
593 | "type": {
|
594 | "type": "NameExpression",
|
595 | "name": "Object"
|
596 | }
|
597 | }
|
598 | ],
|
599 | "returns": {
|
600 | "description": "包含有 hide 方法,可用来关闭对话框",
|
601 | "type": {
|
602 | "type": "NameExpression",
|
603 | "name": "Object"
|
604 | }
|
605 | }
|
606 | },
|
607 | {
|
608 | "name": "confirm",
|
609 | "docblock": "\n 创建确认对话框\n @exportName confirm\n @param {Object} config 配置项\n @returns {Object} 包含有 hide 方法,可用来关闭对话框\n ",
|
610 | "description": "创建确认对话框",
|
611 | "modifiers": [
|
612 | "static"
|
613 | ],
|
614 | "params": [
|
615 | {
|
616 | "name": "config",
|
617 | "description": "配置项",
|
618 | "type": {
|
619 | "type": "NameExpression",
|
620 | "name": "Object"
|
621 | }
|
622 | }
|
623 | ],
|
624 | "returns": {
|
625 | "description": "包含有 hide 方法,可用来关闭对话框",
|
626 | "type": {
|
627 | "type": "NameExpression",
|
628 | "name": "Object"
|
629 | }
|
630 | }
|
631 | }
|
632 | ],
|
633 | "subComponents": []
|
634 | } |
\ | No newline at end of file |