| 1 | {
|
| 2 | "name": "Dropdown",
|
| 3 | "props": {
|
| 4 | "children": {
|
| 5 | "type": {
|
| 6 | "name": "node"
|
| 7 | },
|
| 8 | "required": false,
|
| 9 | "description": "弹层内容",
|
| 10 | "docblock": "弹层内容"
|
| 11 | },
|
| 12 | "visible": {
|
| 13 | "type": {
|
| 14 | "name": "bool"
|
| 15 | },
|
| 16 | "required": false,
|
| 17 | "description": "弹层当前是否显示",
|
| 18 | "docblock": "弹层当前是否显示"
|
| 19 | },
|
| 20 | "onRequestClose": {
|
| 21 | "type": {
|
| 22 | "name": "func"
|
| 23 | },
|
| 24 | "required": false,
|
| 25 | "description": "弹层请求关闭时触发事件的回调函数",
|
| 26 | "defaultValue": {
|
| 27 | "value": "func.noop",
|
| 28 | "computed": true
|
| 29 | },
|
| 30 | "docblock": "弹层请求关闭时触发事件的回调函数\n@param {String} type 弹层关闭的来源\n@param {Object} e DOM 事件",
|
| 31 | "params": [
|
| 32 | {
|
| 33 | "name": "type",
|
| 34 | "description": "弹层关闭的来源",
|
| 35 | "type": {
|
| 36 | "name": "String"
|
| 37 | }
|
| 38 | },
|
| 39 | {
|
| 40 | "name": "e",
|
| 41 | "description": "DOM 事件",
|
| 42 | "type": {
|
| 43 | "name": "Object"
|
| 44 | }
|
| 45 | }
|
| 46 | ],
|
| 47 | "returns": null
|
| 48 | },
|
| 49 | "target": {
|
| 50 | "type": {
|
| 51 | "name": "any"
|
| 52 | },
|
| 53 | "required": false,
|
| 54 | "description": "弹层定位的参照元素",
|
| 55 | "docblock": "弹层定位的参照元素\n@default target 属性，即触发元素",
|
| 56 | "defaultValue": {
|
| 57 | "value": "target 属性，即触发元素",
|
| 58 | "computed": false
|
| 59 | }
|
| 60 | },
|
| 61 | "align": {
|
| 62 | "type": {
|
| 63 | "name": "string"
|
| 64 | },
|
| 65 | "required": false,
|
| 66 | "description": "弹层相对于触发元素的定位, 详见 Overlay 的定位部分",
|
| 67 | "defaultValue": {
|
| 68 | "value": "'tl bl'",
|
| 69 | "computed": false
|
| 70 | },
|
| 71 | "docblock": "弹层相对于触发元素的定位, 详见 Overlay 的定位部分"
|
| 72 | },
|
| 73 | "offset": {
|
| 74 | "type": {
|
| 75 | "name": "array"
|
| 76 | },
|
| 77 | "required": false,
|
| 78 | "description": "弹层相对于trigger的定位的微调, 接收数组[hoz, ver], 表示弹层在 left / top 上的增量\ne.g. [100, 100] 表示往右(RTL 模式下是往左) 、下分布偏移100px",
|
| 79 | "defaultValue": {
|
| 80 | "value": "[0, 0]",
|
| 81 | "computed": false
|
| 82 | },
|
| 83 | "docblock": "弹层相对于trigger的定位的微调, 接收数组[hoz, ver], 表示弹层在 left / top 上的增量\ne.g. [100, 100] 表示往右(RTL 模式下是往左) 、下分布偏移100px"
|
| 84 | },
|
| 85 | "container": {
|
| 86 | "type": {
|
| 87 | "name": "any"
|
| 88 | },
|
| 89 | "required": false,
|
| 90 | "description": "渲染组件的容器，如果是函数需要返回 ref，如果是字符串则是该 DOM 的 id，也可以直接传入 DOM 节点",
|
| 91 | "docblock": "渲染组件的容器，如果是函数需要返回 ref，如果是字符串则是该 DOM 的 id，也可以直接传入 DOM 节点"
|
| 92 | },
|
| 93 | "hasMask": {
|
| 94 | "type": {
|
| 95 | "name": "bool"
|
| 96 | },
|
| 97 | "required": false,
|
| 98 | "description": "是否显示遮罩",
|
| 99 | "defaultValue": {
|
| 100 | "value": "false",
|
| 101 | "computed": false
|
| 102 | },
|
| 103 | "docblock": "是否显示遮罩"
|
| 104 | },
|
| 105 | "canCloseByEsc": {
|
| 106 | "type": {
|
| 107 | "name": "bool"
|
| 108 | },
|
| 109 | "required": false,
|
| 110 | "description": "是否支持 esc 按键关闭弹层",
|
| 111 | "defaultValue": {
|
| 112 | "value": "true",
|
| 113 | "computed": false
|
| 114 | },
|
| 115 | "docblock": "是否支持 esc 按键关闭弹层"
|
| 116 | },
|
| 117 | "canCloseByOutSideClick": {
|
| 118 | "type": {
|
| 119 | "name": "bool"
|
| 120 | },
|
| 121 | "required": false,
|
| 122 | "description": "点击弹层外的区域是否关闭弹层，不显示遮罩时生效",
|
| 123 | "defaultValue": {
|
| 124 | "value": "true",
|
| 125 | "computed": false
|
| 126 | },
|
| 127 | "docblock": "点击弹层外的区域是否关闭弹层，不显示遮罩时生效"
|
| 128 | },
|
| 129 | "canCloseByMask": {
|
| 130 | "type": {
|
| 131 | "name": "bool"
|
| 132 | },
|
| 133 | "required": false,
|
| 134 | "description": "点击遮罩区域是否关闭弹层，显示遮罩时生效",
|
| 135 | "defaultValue": {
|
| 136 | "value": "true",
|
| 137 | "computed": false
|
| 138 | },
|
| 139 | "docblock": "点击遮罩区域是否关闭弹层，显示遮罩时生效"
|
| 140 | },
|
| 141 | "beforeOpen": {
|
| 142 | "type": {
|
| 143 | "name": "func"
|
| 144 | },
|
| 145 | "required": false,
|
| 146 | "description": "弹层打开前触发事件的回调函数",
|
| 147 | "defaultValue": {
|
| 148 | "value": "func.noop",
|
| 149 | "computed": true
|
| 150 | },
|
| 151 | "docblock": "弹层打开前触发事件的回调函数",
|
| 152 | "params": [],
|
| 153 | "returns": null
|
| 154 | },
|
| 155 | "onOpen": {
|
| 156 | "type": {
|
| 157 | "name": "func"
|
| 158 | },
|
| 159 | "required": false,
|
| 160 | "description": "弹层打开时触发事件的回调函数",
|
| 161 | "defaultValue": {
|
| 162 | "value": "func.noop",
|
| 163 | "computed": true
|
| 164 | },
|
| 165 | "docblock": "弹层打开时触发事件的回调函数",
|
| 166 | "params": [],
|
| 167 | "returns": null
|
| 168 | },
|
| 169 | "afterOpen": {
|
| 170 | "type": {
|
| 171 | "name": "func"
|
| 172 | },
|
| 173 | "required": false,
|
| 174 | "description": "弹层打开后触发事件的回调函数, 如果有动画，则在动画结束后触发",
|
| 175 | "defaultValue": {
|
| 176 | "value": "func.noop",
|
| 177 | "computed": true
|
| 178 | },
|
| 179 | "docblock": "弹层打开后触发事件的回调函数, 如果有动画，则在动画结束后触发",
|
| 180 | "params": [],
|
| 181 | "returns": null
|
| 182 | },
|
| 183 | "beforeClose": {
|
| 184 | "type": {
|
| 185 | "name": "func"
|
| 186 | },
|
| 187 | "required": false,
|
| 188 | "description": "弹层关闭前触发事件的回调函数",
|
| 189 | "defaultValue": {
|
| 190 | "value": "func.noop",
|
| 191 | "computed": true
|
| 192 | },
|
| 193 | "docblock": "弹层关闭前触发事件的回调函数",
|
| 194 | "params": [],
|
| 195 | "returns": null
|
| 196 | },
|
| 197 | "onClose": {
|
| 198 | "type": {
|
| 199 | "name": "func"
|
| 200 | },
|
| 201 | "required": false,
|
| 202 | "description": "弹层关闭时触发事件的回调函数",
|
| 203 | "defaultValue": {
|
| 204 | "value": "func.noop",
|
| 205 | "computed": true
|
| 206 | },
|
| 207 | "docblock": "弹层关闭时触发事件的回调函数",
|
| 208 | "params": [],
|
| 209 | "returns": null
|
| 210 | },
|
| 211 | "afterClose": {
|
| 212 | "type": {
|
| 213 | "name": "func"
|
| 214 | },
|
| 215 | "required": false,
|
| 216 | "description": "弹层关闭后触发事件的回调函数, 如果有动画，则在动画结束后触发",
|
| 217 | "defaultValue": {
|
| 218 | "value": "func.noop",
|
| 219 | "computed": true
|
| 220 | },
|
| 221 | "docblock": "弹层关闭后触发事件的回调函数, 如果有动画，则在动画结束后触发",
|
| 222 | "params": [],
|
| 223 | "returns": null
|
| 224 | },
|
| 225 | "beforePosition": {
|
| 226 | "type": {
|
| 227 | "name": "func"
|
| 228 | },
|
| 229 | "required": false,
|
| 230 | "description": "弹层定位完成前触发的事件",
|
| 231 | "defaultValue": {
|
| 232 | "value": "func.noop",
|
| 233 | "computed": true
|
| 234 | },
|
| 235 | "docblock": "弹层定位完成前触发的事件",
|
| 236 | "params": [],
|
| 237 | "returns": null
|
| 238 | },
|
| 239 | "onPosition": {
|
| 240 | "type": {
|
| 241 | "name": "func"
|
| 242 | },
|
| 243 | "required": false,
|
| 244 | "description": "弹层定位完成时触发的事件",
|
| 245 | "defaultValue": {
|
| 246 | "value": "func.noop",
|
| 247 | "computed": true
|
| 248 | },
|
| 249 | "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 定位参照的容器节点",
|
| 250 | "params": [
|
| 251 | {
|
| 252 | "name": "config",
|
| 253 | "description": "定位的参数",
|
| 254 | "type": {
|
| 255 | "name": "Object"
|
| 256 | }
|
| 257 | },
|
| 258 | {
|
| 259 | "name": "config.align",
|
| 260 | "description": "对齐方式，如 ['cc', 'cc']（如果开启 needAdjust，可能和预先设置的 align 不同）",
|
| 261 | "type": {
|
| 262 | "name": "Array"
|
| 263 | }
|
| 264 | },
|
| 265 | {
|
| 266 | "name": "config.top",
|
| 267 | "description": "距离视口顶部距离",
|
| 268 | "type": {
|
| 269 | "name": "Number"
|
| 270 | }
|
| 271 | },
|
| 272 | {
|
| 273 | "name": "config.left",
|
| 274 | "description": "距离视口左侧距离",
|
| 275 | "type": {
|
| 276 | "name": "Number"
|
| 277 | }
|
| 278 | },
|
| 279 | {
|
| 280 | "name": "node",
|
| 281 | "description": "定位参照的容器节点",
|
| 282 | "type": {
|
| 283 | "name": "Object"
|
| 284 | }
|
| 285 | }
|
| 286 | ],
|
| 287 | "returns": null
|
| 288 | },
|
| 289 | "autoFocus": {
|
| 290 | "type": {
|
| 291 | "name": "bool"
|
| 292 | },
|
| 293 | "required": false,
|
| 294 | "description": "弹层打开时是否让其中的元素自动获取焦点",
|
| 295 | "docblock": "弹层打开时是否让其中的元素自动获取焦点"
|
| 296 | },
|
| 297 | "disableScroll": {
|
| 298 | "type": {
|
| 299 | "name": "bool"
|
| 300 | },
|
| 301 | "required": false,
|
| 302 | "description": "是否禁用页面滚动",
|
| 303 | "defaultValue": {
|
| 304 | "value": "false",
|
| 305 | "computed": false
|
| 306 | },
|
| 307 | "docblock": "是否禁用页面滚动"
|
| 308 | },
|
| 309 | "useCapture": {
|
| 310 | "type": {
|
| 311 | "name": "bool"
|
| 312 | },
|
| 313 | "required": false,
|
| 314 | "description": "是否在捕获阶段监听，适配 react 17 事件模型变更",
|
| 315 | "defaultValue": {
|
| 316 | "value": "true",
|
| 317 | "computed": false
|
| 318 | },
|
| 319 | "docblock": "是否在捕获阶段监听，适配 react 17 事件模型变更\n@version 1.25",
|
| 320 | "version": {
|
| 321 | "value": "1.25",
|
| 322 | "computed": false
|
| 323 | }
|
| 324 | },
|
| 325 | "cache": {
|
| 326 | "type": {
|
| 327 | "name": "bool"
|
| 328 | },
|
| 329 | "required": false,
|
| 330 | "description": "隐藏时是否保留子节点",
|
| 331 | "defaultValue": {
|
| 332 | "value": "false",
|
| 333 | "computed": false
|
| 334 | },
|
| 335 | "docblock": "隐藏时是否保留子节点"
|
| 336 | },
|
| 337 | "safeNode": {
|
| 338 | "type": {
|
| 339 | "name": "any"
|
| 340 | },
|
| 341 | "required": false,
|
| 342 | "description": "安全节点，当点击 document 的时候，如果包含该节点则不会关闭弹层，如果是函数需要返回 ref，如果是字符串则是该 DOM 的 id，也可以直接传入 DOM 节点，或者以上值组成的数组",
|
| 343 | "docblock": "安全节点，当点击 document 的时候，如果包含该节点则不会关闭弹层，如果是函数需要返回 ref，如果是字符串则是该 DOM 的 id，也可以直接传入 DOM 节点，或者以上值组成的数组"
|
| 344 | },
|
| 345 | "wrapperClassName": {
|
| 346 | "type": {
|
| 347 | "name": "string"
|
| 348 | },
|
| 349 | "required": false,
|
| 350 | "description": "弹层的根节点的样式类",
|
| 351 | "docblock": "弹层的根节点的样式类"
|
| 352 | },
|
| 353 | "wrapperStyle": {
|
| 354 | "type": {
|
| 355 | "name": "object"
|
| 356 | },
|
| 357 | "required": false,
|
| 358 | "description": "弹层的根节点的内联样式",
|
| 359 | "docblock": "弹层的根节点的内联样式",
|
| 360 | "properties": []
|
| 361 | },
|
| 362 | "animation": {
|
| 363 | "type": {
|
| 364 | "name": "union",
|
| 365 | "value": [
|
| 366 | {
|
| 367 | "name": "object"
|
| 368 | },
|
| 369 | {
|
| 370 | "name": "bool"
|
| 371 | }
|
| 372 | ]
|
| 373 | },
|
| 374 | "required": false,
|
| 375 | "description": "配置动画的播放方式，支持 { in: 'enter-class', out: 'leave-class' } 的对象参数，如果设置为 false，则不播放动画",
|
| 376 | "docblock": "配置动画的播放方式，支持 { in: 'enter-class', out: 'leave-class' } 的对象参数，如果设置为 false，则不播放动画\n@default { in: 'expandInDown', out: 'expandOutUp' }",
|
| 377 | "defaultValue": {
|
| 378 | "value": "{ in: 'expandInDown', out: 'expandOutUp' }",
|
| 379 | "computed": false
|
| 380 | }
|
| 381 | },
|
| 382 | "v2": {
|
| 383 | "type": {
|
| 384 | "name": "bool"
|
| 385 | },
|
| 386 | "required": false,
|
| 387 | "description": "开启 v2 版本",
|
| 388 | "docblock": "开启 v2 版本"
|
| 389 | },
|
| 390 | "points": {
|
| 391 | "type": {
|
| 392 | "name": "array"
|
| 393 | },
|
| 394 | "required": false,
|
| 395 | "description": "[v2] align 的数组形式，不能和 align 同时使用",
|
| 396 | "docblock": "[v2] align 的数组形式，不能和 align 同时使用\n@version 1.25",
|
| 397 | "version": {
|
| 398 | "value": "1.25",
|
| 399 | "computed": false
|
| 400 | }
|
| 401 | },
|
| 402 | "trigger": {
|
| 403 | "type": {
|
| 404 | "name": "node"
|
| 405 | },
|
| 406 | "required": false,
|
| 407 | "description": "触发弹层显示或者隐藏的元素",
|
| 408 | "docblock": "触发弹层显示或者隐藏的元素"
|
| 409 | },
|
| 410 | "triggerType": {
|
| 411 | "type": {
|
| 412 | "name": "union",
|
| 413 | "value": [
|
| 414 | {
|
| 415 | "name": "string"
|
| 416 | },
|
| 417 | {
|
| 418 | "name": "array"
|
| 419 | }
|
| 420 | ]
|
| 421 | },
|
| 422 | "required": false,
|
| 423 | "description": "触发弹层显示或隐藏的操作类型，可以是 'click'，'hover'，或者它们组成的数组，如 ['hover', 'click']",
|
| 424 | "defaultValue": {
|
| 425 | "value": "'hover'",
|
| 426 | "computed": false
|
| 427 | },
|
| 428 | "docblock": "触发弹层显示或隐藏的操作类型，可以是 'click'，'hover'，或者它们组成的数组，如 ['hover', 'click']"
|
| 429 | },
|
| 430 | "triggerClickKeycode": {
|
| 431 | "type": {
|
| 432 | "name": "union",
|
| 433 | "value": [
|
| 434 | {
|
| 435 | "name": "number"
|
| 436 | },
|
| 437 | {
|
| 438 | "name": "array"
|
| 439 | }
|
| 440 | ]
|
| 441 | },
|
| 442 | "required": false,
|
| 443 | "description": "当 triggerType 为 click 时才生效，可自定义触发弹层显示的键盘码",
|
| 444 | "defaultValue": {
|
| 445 | "value": "[KEYCODE.SPACE, KEYCODE.ENTER]",
|
| 446 | "computed": false
|
| 447 | },
|
| 448 | "docblock": "当 triggerType 为 click 时才生效，可自定义触发弹层显示的键盘码"
|
| 449 | },
|
| 450 | "defaultVisible": {
|
| 451 | "type": {
|
| 452 | "name": "bool"
|
| 453 | },
|
| 454 | "required": false,
|
| 455 | "description": "弹层默认是否显示",
|
| 456 | "defaultValue": {
|
| 457 | "value": "false",
|
| 458 | "computed": false
|
| 459 | },
|
| 460 | "docblock": "弹层默认是否显示"
|
| 461 | },
|
| 462 | "onVisibleChange": {
|
| 463 | "type": {
|
| 464 | "name": "func"
|
| 465 | },
|
| 466 | "required": false,
|
| 467 | "description": "弹层显示或隐藏时触发的回调函数",
|
| 468 | "defaultValue": {
|
| 469 | "value": "func.noop",
|
| 470 | "computed": true
|
| 471 | },
|
| 472 | "docblock": "弹层显示或隐藏时触发的回调函数\n@param {Boolean} visible 弹层是否显示\n@param {String} type 触发弹层显示或隐藏的来源 fromContent 表示由Dropdown内容触发； fromTrigger 表示由trigger的点击触发； docClick 表示由document的点击触发",
|
| 473 | "params": [
|
| 474 | {
|
| 475 | "name": "visible",
|
| 476 | "description": "弹层是否显示",
|
| 477 | "type": {
|
| 478 | "name": "Boolean"
|
| 479 | }
|
| 480 | },
|
| 481 | {
|
| 482 | "name": "type",
|
| 483 | "description": "触发弹层显示或隐藏的来源 fromContent 表示由Dropdown内容触发； fromTrigger 表示由trigger的点击触发； docClick 表示由document的点击触发",
|
| 484 | "type": {
|
| 485 | "name": "String"
|
| 486 | }
|
| 487 | }
|
| 488 | ],
|
| 489 | "returns": null
|
| 490 | },
|
| 491 | "disabled": {
|
| 492 | "type": {
|
| 493 | "name": "bool"
|
| 494 | },
|
| 495 | "required": false,
|
| 496 | "description": "设置此属性，弹层无法显示或隐藏",
|
| 497 | "defaultValue": {
|
| 498 | "value": "false",
|
| 499 | "computed": false
|
| 500 | },
|
| 501 | "docblock": "设置此属性，弹层无法显示或隐藏"
|
| 502 | },
|
| 503 | "delay": {
|
| 504 | "type": {
|
| 505 | "name": "number"
|
| 506 | },
|
| 507 | "required": false,
|
| 508 | "description": "弹层显示或隐藏的延时时间（以毫秒为单位），在 triggerType 被设置为 hover 时生效",
|
| 509 | "defaultValue": {
|
| 510 | "value": "200",
|
| 511 | "computed": false
|
| 512 | },
|
| 513 | "docblock": "弹层显示或隐藏的延时时间（以毫秒为单位），在 triggerType 被设置为 hover 时生效"
|
| 514 | },
|
| 515 | "canCloseByTrigger": {
|
| 516 | "type": {
|
| 517 | "name": "bool"
|
| 518 | },
|
| 519 | "required": false,
|
| 520 | "description": "trigger 是否可以关闭弹层",
|
| 521 | "defaultValue": {
|
| 522 | "value": "true",
|
| 523 | "computed": false
|
| 524 | },
|
| 525 | "docblock": "trigger 是否可以关闭弹层"
|
| 526 | },
|
| 527 | "followTrigger": {
|
| 528 | "type": {
|
| 529 | "name": "bool"
|
| 530 | },
|
| 531 | "required": false,
|
| 532 | "description": "是否跟随trigger滚动",
|
| 533 | "defaultValue": {
|
| 534 | "value": "false",
|
| 535 | "computed": false
|
| 536 | },
|
| 537 | "docblock": "是否跟随trigger滚动"
|
| 538 | },
|
| 539 | "placement": {
|
| 540 | "type": {
|
| 541 | "name": "string"
|
| 542 | },
|
| 543 | "required": false,
|
| 544 | "description": "[v2] 快捷位置，包含 'tl' | 't' | 'tr' | 'rt' | 'r' | 'rb' | 'bl' | 'b' | 'br' | 'lt' | 'l' | 'lb'",
|
| 545 | "docblock": "[v2] 快捷位置，包含 'tl' | 't' | 'tr' | 'rt' | 'r' | 'rb' | 'bl' | 'b' | 'br' | 'lt' | 'l' | 'lb'"
|
| 546 | },
|
| 547 | "placementOffset": {
|
| 548 | "type": {
|
| 549 | "name": "number"
|
| 550 | },
|
| 551 | "required": false,
|
| 552 | "description": "[v2] 弹层偏离触发元素的像素值",
|
| 553 | "docblock": "[v2] 弹层偏离触发元素的像素值"
|
| 554 | },
|
| 555 | "autoClose": {
|
| 556 | "type": {
|
| 557 | "name": "bool"
|
| 558 | },
|
| 559 | "required": false,
|
| 560 | "description": "开启后，children 不管是不是Menu，点击后都默认关掉弹层（2.x默认设置为true）",
|
| 561 | "defaultValue": {
|
| 562 | "value": "false",
|
| 563 | "computed": false
|
| 564 | },
|
| 565 | "docblock": "开启后，children 不管是不是Menu，点击后都默认关掉弹层（2.x默认设置为true）\n@version 1.23",
|
| 566 | "version": {
|
| 567 | "value": "1.23",
|
| 568 | "computed": false
|
| 569 | }
|
| 570 | }
|
| 571 | },
|
| 572 | "methods": [],
|
| 573 | "description": "继承 Popup 的 API，除非特别说明",
|
| 574 | "subComponents": []
|
| 575 | } |
| \ | No newline at end of file |