@alifd/next/lib/drawer/api-schema.json

A configurable component library for web built on React.

{
  "name": "Drawer",
  "props": {
    "width": {
      "type": {
        "name": "union",
        "value": [
          {
            "name": "number"
          },
          {
            "name": "string"
          }
        ]
      },
      "required": false,
      "description": "宽度，仅在 placement是 left right 的时候生效",
      "docblock": "宽度，仅在 placement是 left right 的时候生效"
    },
    "height": {
      "type": {
        "name": "union",
        "value": [
          {
            "name": "number"
          },
          {
            "name": "string"
          }
        ]
      },
      "required": false,
      "description": "高度，仅在 placement是 top bottom 的时候生效",
      "docblock": "高度，仅在 placement是 top bottom 的时候生效"
    },
    "closeable": {
      "type": {
        "name": "union",
        "value": [
          {
            "name": "string"
          },
          {
            "name": "bool"
          }
        ]
      },
      "required": false,
      "description": "[废弃]同closeMode, 控制对话框关闭的方式，值可以为字符串或者布尔值，其中字符串是由以下值组成：\n**close** 表示点击关闭按钮可以关闭对话框\n**mask** 表示点击遮罩区域可以关闭对话框\n**esc** 表示按下 esc 键可以关闭对话框\n如 'close' 或 'close,esc,mask'\n如果设置为 true，则以上关闭方式全部生效\n如果设置为 false，则以上关闭方式全部失效",
      "defaultValue": {
        "value": "true",
        "computed": false
      },
      "docblock": "[废弃]同closeMode, 控制对话框关闭的方式，值可以为字符串或者布尔值，其中字符串是由以下值组成：\n**close** 表示点击关闭按钮可以关闭对话框\n**mask** 表示点击遮罩区域可以关闭对话框\n**esc** 表示按下 esc 键可以关闭对话框\n如 'close' 或 'close,esc,mask'\n如果设置为 true，则以上关闭方式全部生效\n如果设置为 false，则以上关闭方式全部失效"
    },
    "cache": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "隐藏时是否保留子节点，不销毁",
      "docblock": "隐藏时是否保留子节点，不销毁"
    },
    "closeMode": {
      "type": {
        "name": "union",
        "value": [
          {
            "name": "arrayOf",
            "value": {
              "name": "enum",
              "value": [
                {
                  "value": "'close'",
                  "computed": false
                },
                {
                  "value": "'mask'",
                  "computed": false
                },
                {
                  "value": "'esc'",
                  "computed": false
                }
              ]
            }
          },
          {
            "name": "enum",
            "value": [
              {
                "value": "'close'",
                "computed": false
              },
              {
                "value": "'mask'",
                "computed": false
              },
              {
                "value": "'esc'",
                "computed": false
              }
            ]
          }
        ]
      },
      "required": false,
      "description": "[推荐]控制对话框关闭的方式，值可以为字符串或者数组，其中字符串、数组均为以下值的枚举：\n**close** 表示点击关闭按钮可以关闭对话框\n**mask** 表示点击遮罩区域可以关闭对话框\n**esc** 表示按下 esc 键可以关闭对话框\n如 'close' 或 ['close','esc','mask'], []",
      "docblock": "[推荐]控制对话框关闭的方式，值可以为字符串或者数组，其中字符串、数组均为以下值的枚举：\n**close** 表示点击关闭按钮可以关闭对话框\n**mask** 表示点击遮罩区域可以关闭对话框\n**esc** 表示按下 esc 键可以关闭对话框\n如 'close' 或 ['close','esc','mask'], []\n@version 1.21",
      "version": {
        "value": "1.21",
        "computed": false
      }
    },
    "onClose": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "对话框关闭时触发的回调函数",
      "defaultValue": {
        "value": "() => {}",
        "computed": false
      },
      "docblock": "对话框关闭时触发的回调函数\n@param {String} trigger 关闭触发行为的描述字符串\n@param {Object} event 关闭时事件对象",
      "params": [
        {
          "name": "trigger",
          "description": "关闭触发行为的描述字符串",
          "type": {
            "name": "String"
          }
        },
        {
          "name": "event",
          "description": "关闭时事件对象",
          "type": {
            "name": "Object"
          }
        }
      ],
      "returns": null
    },
    "afterOpen": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "[v2废弃]对话框打开后的回调函数",
      "docblock": "[v2废弃]对话框打开后的回调函数",
      "params": [],
      "returns": null
    },
    "placement": {
      "type": {
        "name": "enum",
        "value": [
          {
            "value": "'top'",
            "computed": false
          },
          {
            "value": "'right'",
            "computed": false
          },
          {
            "value": "'bottom'",
            "computed": false
          },
          {
            "value": "'left'",
            "computed": false
          }
        ]
      },
      "required": false,
      "description": "位于页面的位置",
      "defaultValue": {
        "value": "'right'",
        "computed": false
      },
      "docblock": "位于页面的位置"
    },
    "title": {
      "type": {
        "name": "node"
      },
      "required": false,
      "description": "标题",
      "docblock": "标题"
    },
    "headerStyle": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "header上的样式",
      "docblock": "header上的样式",
      "properties": []
    },
    "bodyStyle": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "body上的样式",
      "docblock": "body上的样式",
      "properties": []
    },
    "visible": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否显示",
      "docblock": "是否显示"
    },
    "hasMask": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否显示遮罩",
      "defaultValue": {
        "value": "true",
        "computed": false
      },
      "docblock": "是否显示遮罩"
    },
    "animation": {
      "type": {
        "name": "union",
        "value": [
          {
            "name": "object"
          },
          {
            "name": "bool"
          }
        ]
      },
      "required": false,
      "description": "显示隐藏时动画的播放方式，支持 { in: 'enter-class', out: 'leave-class' } 的对象参数，如果设置为 false，则不播放动画。 请参考 Animate 组件的文档获取可用的动画名",
      "docblock": "显示隐藏时动画的播放方式，支持 { in: 'enter-class', out: 'leave-class' } 的对象参数，如果设置为 false，则不播放动画。 请参考 Animate 组件的文档获取可用的动画名\n@default { in: 'expandInDown', out: 'expandOutUp' }",
      "defaultValue": {
        "value": "{ in: 'expandInDown', out: 'expandOutUp' }",
        "computed": false
      }
    },
    "v2": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "开启 v2",
      "docblock": "开启 v2"
    },
    "afterClose": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "[v2] 弹窗关闭后的回调",
      "docblock": "[v2] 弹窗关闭后的回调",
      "params": [],
      "returns": null
    }
  },
  "methods": [
    {
      "name": "show",
      "docblock": "\n  创建对话框\n  @exportName show\n  @param {Object} config 配置项\n  @returns {Object} 包含有 hide 方法，可用来关闭对话框\n ",
      "description": "创建对话框",
      "modifiers": [
        "static"
      ],
      "params": [
        {
          "name": "config",
          "description": "配置项",
          "type": {
            "type": "NameExpression",
            "name": "Object"
          }
        }
      ],
      "returns": {
        "description": "包含有 hide 方法，可用来关闭对话框",
        "type": {
          "type": "NameExpression",
          "name": "Object"
        }
      }
    }
  ],
  "description": "继承 Overlay.Popup 的 API，除非特别说明",
  "subComponents": []
}