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

A configurable component library for web built on React.

{
  "name": "Loading",
  "props": {
    "prefix": {
      "type": {
        "name": "string"
      },
      "required": false,
      "description": "样式前缀",
      "defaultValue": {
        "value": "'next-'",
        "computed": false
      },
      "docblock": "样式前缀"
    },
    "tip": {
      "type": {
        "name": "any"
      },
      "required": false,
      "description": "自定义内容，可以传入string或reactElement",
      "docblock": "自定义内容，可以传入string或reactElement"
    },
    "tipAlign": {
      "type": {
        "name": "enum",
        "value": [
          {
            "value": "'right'",
            "computed": false,
            "description": "出现在动画右边"
          },
          {
            "value": "'bottom'",
            "computed": false,
            "description": "出现在动画下面"
          }
        ]
      },
      "required": false,
      "description": "自定义内容位置",
      "defaultValue": {
        "value": "'bottom'",
        "computed": false
      },
      "docblock": "自定义内容位置\n@enumdesc 出现在动画右边, 出现在动画下面",
      "value": [
        {
          "value": "'right'",
          "computed": false,
          "description": "出现在动画右边"
        },
        {
          "value": "'bottom'",
          "computed": false,
          "description": "出现在动画下面"
        }
      ]
    },
    "visible": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "loading 状态, 默认 true",
      "defaultValue": {
        "value": "true",
        "computed": false
      },
      "docblock": "loading 状态, 默认 true"
    },
    "onVisibleChange": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "全屏模式下，loading弹层请求关闭时触发的回调函数",
      "defaultValue": {
        "value": "func.noop",
        "computed": true
      },
      "docblock": "全屏模式下，loading弹层请求关闭时触发的回调函数\n@param {String} type 弹层关闭的来源\n@param {Object} e DOM 事件",
      "params": [
        {
          "name": "type",
          "description": "弹层关闭的来源",
          "type": {
            "name": "String"
          }
        },
        {
          "name": "e",
          "description": "DOM 事件",
          "type": {
            "name": "Object"
          }
        }
      ],
      "returns": null
    },
    "className": {
      "type": {
        "name": "string"
      },
      "required": false,
      "description": "自定义class",
      "docblock": "自定义class"
    },
    "style": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "自定义内联样式",
      "docblock": "自定义内联样式",
      "properties": []
    },
    "size": {
      "type": {
        "name": "enum",
        "value": [
          {
            "value": "'large'",
            "computed": false,
            "description": "大号"
          },
          {
            "value": "'medium'",
            "computed": false,
            "description": "中号"
          }
        ]
      },
      "required": false,
      "description": "设置动画尺寸",
      "defaultValue": {
        "value": "'large'",
        "computed": false
      },
      "docblock": "设置动画尺寸\n@description 仅仅对默认动画效果起作用\n@enumdesc 大号, 中号",
      "value": [
        {
          "value": "'large'",
          "computed": false,
          "description": "大号"
        },
        {
          "value": "'medium'",
          "computed": false,
          "description": "中号"
        }
      ]
    },
    "indicator": {
      "type": {
        "name": "any"
      },
      "required": false,
      "description": "自定义动画",
      "docblock": "自定义动画"
    },
    "color": {
      "type": {
        "name": "string"
      },
      "required": false,
      "description": "动画颜色",
      "docblock": "动画颜色"
    },
    "fullScreen": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "全屏展示",
      "docblock": "全屏展示"
    },
    "disableScroll": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "当点击 document 的时候，如果包含该节点则不会关闭弹层，\n如果是函数需要返回 ref，如果是字符串则是该 DOM 的 id，也可以直接传入 DOM 节点，或者以上值组成的数组\n是否禁用滚动，仅在 fullScreen 模式下生效",
      "defaultValue": {
        "value": "false",
        "computed": false
      },
      "docblock": "当点击 document 的时候，如果包含该节点则不会关闭弹层，\n如果是函数需要返回 ref，如果是字符串则是该 DOM 的 id，也可以直接传入 DOM 节点，或者以上值组成的数组\n是否禁用滚动，仅在 fullScreen 模式下生效"
    },
    "safeNode": {
      "type": {
        "name": "any"
      },
      "required": false,
      "description": "安全节点，fullScreen时有效，",
      "docblock": "安全节点，fullScreen时有效，"
    },
    "children": {
      "type": {
        "name": "any"
      },
      "required": false,
      "description": "子元素",
      "docblock": "子元素"
    }
  },
  "methods": [],
  "subComponents": []
}