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

A configurable component library for web built on React.

{
  "name": "Radio",
  "props": {
    "className": {
      "type": {
        "name": "string"
      },
      "required": false,
      "description": "自定义类名",
      "docblock": "自定义类名"
    },
    "id": {
      "type": {
        "name": "string"
      },
      "required": false,
      "description": "组件input的id",
      "docblock": "组件input的id"
    },
    "style": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "自定义内敛样式",
      "docblock": "自定义内敛样式",
      "properties": []
    },
    "checked": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "设置radio是否选中",
      "docblock": "设置radio是否选中"
    },
    "defaultChecked": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "设置radio是否默认选中",
      "docblock": "设置radio是否默认选中"
    },
    "label": {
      "type": {
        "name": "node"
      },
      "required": false,
      "description": "通过属性配置label",
      "docblock": "通过属性配置label"
    },
    "onChange": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "状态变化时触发的事件",
      "defaultValue": {
        "value": "func.noop",
        "computed": true
      },
      "docblock": "状态变化时触发的事件\n@param {Boolean} checked 是否选中\n@param {Event} e Dom 事件对象",
      "params": [
        {
          "name": "checked",
          "description": "是否选中",
          "type": {
            "name": "Boolean"
          }
        },
        {
          "name": "e",
          "description": "Dom 事件对象",
          "type": {
            "name": "Event"
          }
        }
      ],
      "returns": null
    },
    "onMouseEnter": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "鼠标进入enter事件",
      "defaultValue": {
        "value": "func.noop",
        "computed": true
      },
      "docblock": "鼠标进入enter事件\n@param {Event} e Dom 事件对象",
      "params": [
        {
          "name": "e",
          "description": "Dom 事件对象",
          "type": {
            "name": "Event"
          }
        }
      ],
      "returns": null
    },
    "onMouseLeave": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "鼠标离开事件",
      "defaultValue": {
        "value": "func.noop",
        "computed": true
      },
      "docblock": "鼠标离开事件\n@param {Event} e Dom 事件对象",
      "params": [
        {
          "name": "e",
          "description": "Dom 事件对象",
          "type": {
            "name": "Event"
          }
        }
      ],
      "returns": null
    },
    "disabled": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "radio是否被禁用",
      "docblock": "radio是否被禁用"
    },
    "value": {
      "type": {
        "name": "union",
        "value": [
          {
            "name": "string"
          },
          {
            "name": "number"
          },
          {
            "name": "bool"
          }
        ]
      },
      "required": false,
      "description": "radio 的value",
      "docblock": "radio 的value"
    },
    "name": {
      "type": {
        "name": "string"
      },
      "required": false,
      "description": "name",
      "docblock": "name"
    },
    "isPreview": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否为预览态",
      "defaultValue": {
        "value": "false",
        "computed": false
      },
      "docblock": "是否为预览态"
    },
    "renderPreview": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "预览态模式下渲染的内容",
      "docblock": "预览态模式下渲染的内容\n@param {Boolean} checked 是否选中\n@param {Object} props 所有传入的参数\n@returns {reactNode} Element 渲染内容",
      "params": [
        {
          "name": "checked",
          "description": "是否选中",
          "type": {
            "name": "Boolean"
          }
        },
        {
          "name": "props",
          "description": "所有传入的参数",
          "type": {
            "name": "Object"
          }
        }
      ],
      "returns": {
        "description": "Element 渲染内容",
        "type": {
          "name": "reactNode"
        }
      }
    }
  },
  "methods": [],
  "order": 1,
  "subComponents": [
    {
      "name": "Group",
      "props": {
        "prefix": {
          "type": {
            "name": "string"
          },
          "required": false,
          "description": "样式类名的品牌前缀",
          "defaultValue": {
            "value": "'next-'",
            "computed": false
          },
          "docblock": "样式类名的品牌前缀"
        },
        "className": {
          "type": {
            "name": "string"
          },
          "required": false,
          "description": "自定义类名",
          "docblock": "自定义类名"
        },
        "style": {
          "type": {
            "name": "object"
          },
          "required": false,
          "description": "自定义内敛样式",
          "docblock": "自定义内敛样式",
          "properties": []
        },
        "name": {
          "type": {
            "name": "string"
          },
          "required": false,
          "description": "name",
          "docblock": "name"
        },
        "value": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "string"
              },
              {
                "name": "number"
              },
              {
                "name": "bool"
              }
            ]
          },
          "required": false,
          "description": "radio group的选中项的值",
          "docblock": "radio group的选中项的值"
        },
        "defaultValue": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "string"
              },
              {
                "name": "number"
              },
              {
                "name": "bool"
              }
            ]
          },
          "required": false,
          "description": "radio group的默认值",
          "docblock": "radio group的默认值"
        },
        "component": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "string"
              },
              {
                "name": "func"
              }
            ]
          },
          "required": false,
          "description": "设置标签类型",
          "defaultValue": {
            "value": "'div'",
            "computed": false
          },
          "docblock": "设置标签类型"
        },
        "onChange": {
          "type": {
            "name": "func"
          },
          "required": false,
          "description": "选中值改变时的事件",
          "defaultValue": {
            "value": "() => {}",
            "computed": false
          },
          "docblock": "选中值改变时的事件\n@param {String/Number} value 选中项的值\n@param {Event} e Dom 事件对象",
          "params": [
            {
              "name": "value",
              "description": "选中项的值",
              "type": {
                "name": "String/Number"
              }
            },
            {
              "name": "e",
              "description": "Dom 事件对象",
              "type": {
                "name": "Event"
              }
            }
          ],
          "returns": null
        },
        "disabled": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "表示radio被禁用",
          "docblock": "表示radio被禁用"
        },
        "shape": {
          "type": {
            "name": "enum",
            "value": [
              {
                "value": "'normal'",
                "computed": false,
                "description": "按钮状"
              },
              {
                "value": "'button'",
                "computed": false
              }
            ]
          },
          "required": false,
          "description": "可以设置成 button 展示形状",
          "docblock": "可以设置成 button 展示形状\n@enumdesc 按钮状",
          "value": [
            {
              "value": "'normal'",
              "computed": false,
              "description": "按钮状"
            },
            {
              "value": "'button'",
              "computed": false
            }
          ]
        },
        "size": {
          "type": {
            "name": "enum",
            "value": [
              {
                "value": "'large'",
                "computed": false,
                "description": "大"
              },
              {
                "value": "'medium'",
                "computed": false,
                "description": "中"
              },
              {
                "value": "'small'",
                "computed": false,
                "description": "小"
              }
            ]
          },
          "required": false,
          "description": "与 `shape` 属性配套使用，shape设为button时有效",
          "defaultValue": {
            "value": "'medium'",
            "computed": false
          },
          "docblock": "与 `shape` 属性配套使用，shape设为button时有效\n@enumdesc 大, 中, 小",
          "value": [
            {
              "value": "'large'",
              "computed": false,
              "description": "大"
            },
            {
              "value": "'medium'",
              "computed": false,
              "description": "中"
            },
            {
              "value": "'small'",
              "computed": false,
              "description": "小"
            }
          ]
        },
        "dataSource": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "arrayOf",
                "value": {
                  "name": "string"
                }
              },
              {
                "name": "arrayOf",
                "value": {
                  "name": "object"
                }
              }
            ]
          },
          "required": false,
          "description": "可选项列表, 数据项可为 String 或者 Object, 如 `['apple', 'pear', 'orange']` `[{label: 'apply', value: 'apple'}]`",
          "defaultValue": {
            "value": "[]",
            "computed": false
          },
          "docblock": "可选项列表, 数据项可为 String 或者 Object, 如 `['apple', 'pear', 'orange']` `[{label: 'apply', value: 'apple'}]`"
        },
        "children": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "arrayOf",
                "value": {
                  "name": "element"
                }
              },
              {
                "name": "element"
              }
            ]
          },
          "required": false,
          "description": "通过子元素方式设置内部radio",
          "docblock": "通过子元素方式设置内部radio"
        },
        "direction": {
          "type": {
            "name": "enum",
            "value": [
              {
                "value": "'hoz'",
                "computed": false
              },
              {
                "value": "'ver'",
                "computed": false
              }
            ]
          },
          "required": false,
          "description": "子项目的排列方式\n- hoz: 水平排列 (default)\n- ver: 垂直排列",
          "defaultValue": {
            "value": "'hoz'",
            "computed": false
          },
          "docblock": "子项目的排列方式\n- hoz: 水平排列 (default)\n- ver: 垂直排列"
        },
        "isPreview": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "是否为预览态",
          "defaultValue": {
            "value": "false",
            "computed": false
          },
          "docblock": "是否为预览态"
        },
        "renderPreview": {
          "type": {
            "name": "func"
          },
          "required": false,
          "description": "预览态模式下渲染的内容",
          "docblock": "预览态模式下渲染的内容\n@param {Object} previewed 预览值：{label: \"\", value: \"\"}\n@param {Object} props 所有传入的参数\n@returns {reactNode} Element 渲染内容",
          "params": [
            {
              "name": "previewed",
              "description": "预览值：{label: \"\", value: \"\"}",
              "type": {
                "name": "Object"
              }
            },
            {
              "name": "props",
              "description": "所有传入的参数",
              "type": {
                "name": "Object"
              }
            }
          ],
          "returns": {
            "description": "Element 渲染内容",
            "type": {
              "name": "reactNode"
            }
          }
        }
      },
      "methods": [],
      "order": 2
    }
  ]
}