@csr632/next/lib/dialog/api-schema.json

A configurable component library for web built on React.

{
  "name": "Dialog",
  "props": {
    "visible": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否显示",
      "defaultValue": {
        "value": "false",
        "computed": false
      },
      "docblock": "是否显示"
    },
    "title": {
      "type": {
        "name": "node"
      },
      "required": false,
      "description": "标题",
      "docblock": "标题"
    },
    "children": {
      "type": {
        "name": "node"
      },
      "required": false,
      "description": "内容",
      "docblock": "内容"
    },
    "footer": {
      "type": {
        "name": "union",
        "value": [
          {
            "name": "bool"
          },
          {
            "name": "node"
          }
        ]
      },
      "required": false,
      "description": "底部内容，设置为 false，则不进行显示",
      "docblock": "底部内容，设置为 false，则不进行显示\n@default [<Button type=\"primary\">确定</Button>, <Button>取消</Button>]",
      "defaultValue": {
        "value": "[<Button type=\"primary\">确定</Button>, <Button>取消</Button>]",
        "computed": false
      }
    },
    "footerAlign": {
      "type": {
        "name": "enum",
        "value": [
          {
            "value": "'left'",
            "computed": false
          },
          {
            "value": "'center'",
            "computed": false
          },
          {
            "value": "'right'",
            "computed": false
          }
        ]
      },
      "required": false,
      "description": "底部按钮的对齐方式",
      "defaultValue": {
        "value": "'right'",
        "computed": false
      },
      "docblock": "底部按钮的对齐方式"
    },
    "footerActions": {
      "type": {
        "name": "array"
      },
      "required": false,
      "description": "指定确定按钮和取消按钮是否存在以及如何排列,<br><br>**可选值**：\n['ok', 'cancel']（确认取消按钮同时存在，确认按钮在左）\n['cancel', 'ok']（确认取消按钮同时存在，确认按钮在右）\n['ok']（只存在确认按钮）\n['cancel']（只存在取消按钮）",
      "defaultValue": {
        "value": "['ok', 'cancel']",
        "computed": false
      },
      "docblock": "指定确定按钮和取消按钮是否存在以及如何排列,<br><br>**可选值**：\n['ok', 'cancel']（确认取消按钮同时存在，确认按钮在左）\n['cancel', 'ok']（确认取消按钮同时存在，确认按钮在右）\n['ok']（只存在确认按钮）\n['cancel']（只存在取消按钮）"
    },
    "onOk": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "在点击确定按钮时触发的回调函数",
      "defaultValue": {
        "value": "() => {}",
        "computed": false
      },
      "docblock": "在点击确定按钮时触发的回调函数\n@param {Object} event 点击事件对象",
      "params": [
        {
          "name": "event",
          "description": "点击事件对象",
          "type": {
            "name": "Object"
          }
        }
      ],
      "returns": null
    },
    "onCancel": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "在点击取消按钮时触发的回调函数",
      "defaultValue": {
        "value": "() => {}",
        "computed": false
      },
      "docblock": "在点击取消按钮时触发的回调函数\n@param {Object} event 点击事件对象",
      "params": [
        {
          "name": "event",
          "description": "点击事件对象",
          "type": {
            "name": "Object"
          }
        }
      ],
      "returns": null
    },
    "okProps": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "应用于确定按钮的属性对象",
      "defaultValue": {
        "value": "{}",
        "computed": false
      },
      "docblock": "应用于确定按钮的属性对象",
      "properties": []
    },
    "cancelProps": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "应用于取消按钮的属性对象",
      "defaultValue": {
        "value": "{}",
        "computed": false
      },
      "docblock": "应用于取消按钮的属性对象",
      "properties": []
    },
    "closeable": {
      "type": {
        "name": "union",
        "value": [
          {
            "name": "string"
          },
          {
            "name": "bool"
          }
        ]
      },
      "required": false,
      "description": "控制对话框关闭的方式，值可以为字符串或者布尔值，其中字符串是由以下值组成：\n**close** 表示点击关闭按钮可以关闭对话框\n**mask** 表示点击遮罩区域可以关闭对话框\n**esc** 表示按下 esc 键可以关闭对话框\n如 'close' 或 'close,esc,mask'\n如果设置为 true，则以上关闭方式全部生效\n如果设置为 false，则以上关闭方式全部失效",
      "defaultValue": {
        "value": "'esc,close'",
        "computed": false
      },
      "docblock": "控制对话框关闭的方式，值可以为字符串或者布尔值，其中字符串是由以下值组成：\n**close** 表示点击关闭按钮可以关闭对话框\n**mask** 表示点击遮罩区域可以关闭对话框\n**esc** 表示按下 esc 键可以关闭对话框\n如 'close' 或 'close,esc,mask'\n如果设置为 true，则以上关闭方式全部生效\n如果设置为 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
    },
    "afterClose": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "对话框关闭后触发的回调函数, 如果有动画，则在动画结束后触发",
      "defaultValue": {
        "value": "() => {}",
        "computed": false
      },
      "docblock": "对话框关闭后触发的回调函数, 如果有动画，则在动画结束后触发",
      "params": [],
      "returns": null
    },
    "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": "显示隐藏时动画的播放方式",
      "defaultValue": {
        "value": "{\n    in: 'fadeInDown',\n    out: 'fadeOutUp',\n}",
        "computed": false
      },
      "docblock": "显示隐藏时动画的播放方式\n@property {String} in 进场动画\n@property {String} out 出场动画"
    },
    "autoFocus": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "对话框弹出时是否自动获得焦点",
      "defaultValue": {
        "value": "false",
        "computed": false
      },
      "docblock": "对话框弹出时是否自动获得焦点"
    },
    "align": {
      "type": {
        "name": "union",
        "value": [
          {
            "name": "string"
          },
          {
            "name": "bool"
          }
        ]
      },
      "required": false,
      "description": "对话框对齐方式, 具体见Overlay文档",
      "defaultValue": {
        "value": "'cc cc'",
        "computed": false
      },
      "docblock": "对话框对齐方式, 具体见Overlay文档"
    },
    "isFullScreen": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "当对话框高度超过浏览器视口高度时，是否显示所有内容而不是出现滚动条以保证对话框完整显示在浏览器视口内，该属性仅在对话框垂直水平居中时生效，即 align 被设置为 'cc cc' 时",
      "defaultValue": {
        "value": "false",
        "computed": false
      },
      "docblock": "当对话框高度超过浏览器视口高度时，是否显示所有内容而不是出现滚动条以保证对话框完整显示在浏览器视口内，该属性仅在对话框垂直水平居中时生效，即 align 被设置为 'cc cc' 时"
    },
    "shouldUpdatePosition": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否在对话框重新渲染时及时更新对话框位置，一般用于对话框高度变化后依然能保证原来的对齐方式",
      "defaultValue": {
        "value": "false",
        "computed": false
      },
      "docblock": "是否在对话框重新渲染时及时更新对话框位置，一般用于对话框高度变化后依然能保证原来的对齐方式"
    },
    "minMargin": {
      "type": {
        "name": "number"
      },
      "required": false,
      "description": "对话框距离浏览器顶部和底部的最小间距，align 被设置为 'cc cc' 并且 isFullScreen 被设置为 true 时不生效",
      "defaultValue": {
        "value": "40",
        "computed": false
      },
      "docblock": "对话框距离浏览器顶部和底部的最小间距，align 被设置为 'cc cc' 并且 isFullScreen 被设置为 true 时不生效"
    },
    "overlayProps": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "透传到弹层组件的属性对象",
      "defaultValue": {
        "value": "{}",
        "computed": false
      },
      "docblock": "透传到弹层组件的属性对象",
      "properties": []
    },
    "locale": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "自定义国际化文案对象",
      "defaultValue": {
        "value": "zhCN.Dialog",
        "computed": true
      },
      "docblock": "自定义国际化文案对象\n@property {String} ok 确认按钮文案\n@property {String} cancel 取消按钮文案",
      "properties": [
        {
          "name": "ok",
          "description": "确认按钮文案",
          "type": {
            "name": "String"
          }
        },
        {
          "name": "cancel",
          "description": "取消按钮文案",
          "type": {
            "name": "String"
          }
        }
      ]
    },
    "height": {
      "type": {
        "name": "string"
      },
      "required": false,
      "description": "对话框的高度样式属性",
      "docblock": "对话框的高度样式属性"
    }
  },
  "methods": [
    {
      "name": "show",
      "docblock": "\n  创建对话框\n  @exportName show\n  @param {Object} config 配置项\n  @returns {Object} \b包含有 hide 方法，可用来关闭对话框\n ",
      "description": "创建对话框",
      "modifiers": [
        "static"
      ],
      "params": [
        {
          "name": "config",
          "description": "配置项",
          "type": {
            "type": "NameExpression",
            "name": "Object"
          }
        }
      ],
      "returns": {
        "description": "\b包含有 hide 方法，可用来关闭对话框",
        "type": {
          "type": "NameExpression",
          "name": "Object"
        }
      }
    },
    {
      "name": "alert",
      "docblock": "\n  创建警示对话框\n  @exportName alert\n  @param {Object} config 配置项\n  @returns {Object} \b包含有 hide 方法，可用来关闭对话框\n ",
      "description": "创建警示对话框",
      "modifiers": [
        "static"
      ],
      "params": [
        {
          "name": "config",
          "description": "配置项",
          "type": {
            "type": "NameExpression",
            "name": "Object"
          }
        }
      ],
      "returns": {
        "description": "\b包含有 hide 方法，可用来关闭对话框",
        "type": {
          "type": "NameExpression",
          "name": "Object"
        }
      }
    },
    {
      "name": "confirm",
      "docblock": "\n  创建确认对话框\n  @exportName confirm\n  @param {Object} config 配置项\n  @returns {Object} \b包含有 hide 方法，可用来关闭对话框\n ",
      "description": "创建确认对话框",
      "modifiers": [
        "static"
      ],
      "params": [
        {
          "name": "config",
          "description": "配置项",
          "type": {
            "type": "NameExpression",
            "name": "Object"
          }
        }
      ],
      "returns": {
        "description": "\b包含有 hide 方法，可用来关闭对话框",
        "type": {
          "type": "NameExpression",
          "name": "Object"
        }
      }
    }
  ],
  "subComponents": []
}