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

A configurable component library for web built on React.

{
  "name": "Search",
  "props": {
    "size": {
      "type": {
        "name": "enum",
        "value": [
          {
            "value": "'large'",
            "computed": false,
            "description": "'大'"
          },
          {
            "value": "'medium'",
            "computed": false,
            "description": "'小'"
          }
        ]
      },
      "required": false,
      "description": "大小",
      "defaultValue": {
        "value": "'medium'",
        "computed": false
      },
      "docblock": "大小\n@enumdesc '大', '小'",
      "value": [
        {
          "value": "'large'",
          "computed": false,
          "description": "'大'"
        },
        {
          "value": "'medium'",
          "computed": false,
          "description": "'小'"
        }
      ]
    },
    "value": {
      "type": {
        "name": "union",
        "value": [
          {
            "name": "string"
          },
          {
            "name": "number"
          }
        ]
      },
      "required": false,
      "description": "搜索框数值",
      "docblock": "搜索框数值"
    },
    "defaultValue": {
      "type": {
        "name": "string"
      },
      "required": false,
      "description": "搜索框默认值",
      "docblock": "搜索框默认值"
    },
    "placeholder": {
      "type": {
        "name": "string"
      },
      "required": false,
      "description": "默认提示",
      "docblock": "默认提示"
    },
    "autoWidth": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "下拉菜单是否与选择器对齐",
      "defaultValue": {
        "value": "true",
        "computed": false
      },
      "docblock": "下拉菜单是否与选择器对齐"
    },
    "label": {
      "type": {
        "name": "node"
      },
      "required": false,
      "description": "自定义内联 label",
      "docblock": "自定义内联 label"
    },
    "hasClear": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否显示清除按钮",
      "defaultValue": {
        "value": "false",
        "computed": false
      },
      "docblock": "是否显示清除按钮"
    },
    "state": {
      "type": {
        "name": "enum",
        "value": [
          {
            "value": "'error'",
            "computed": false
          },
          {
            "value": "'loading'",
            "computed": false
          },
          {
            "value": "'success'",
            "computed": false
          },
          {
            "value": "'warning'",
            "computed": false
          }
        ]
      },
      "required": false,
      "description": "校验状态",
      "docblock": "校验状态"
    },
    "readOnly": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否只读，只读模式下可以展开弹层但不能选",
      "docblock": "是否只读，只读模式下可以展开弹层但不能选"
    },
    "disabled": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否禁用",
      "defaultValue": {
        "value": "false",
        "computed": false
      },
      "docblock": "是否禁用"
    },
    "visible": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "自定义渲染的的下拉框",
      "docblock": "自定义渲染的的下拉框"
    },
    "defaultVisible": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "弹层初始化是否显示",
      "docblock": "弹层初始化是否显示"
    },
    "onVisibleChange": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "弹层显示或隐藏时触发的回调",
      "defaultValue": {
        "value": "func.noop",
        "computed": true
      },
      "docblock": "弹层显示或隐藏时触发的回调\n@param {Boolean} visible 弹层是否显示\n@param {String} type 触发弹层显示或隐藏的来源 fromContent 表示由Dropdown内容触发； fromTrigger 表示由trigger的点击触发； docClick 表示由document的点击触发",
      "params": [
        {
          "name": "visible",
          "description": "弹层是否显示",
          "type": {
            "name": "Boolean"
          }
        },
        {
          "name": "type",
          "description": "触发弹层显示或隐藏的来源 fromContent 表示由Dropdown内容触发； fromTrigger 表示由trigger的点击触发； docClick 表示由document的点击触发",
          "type": {
            "name": "String"
          }
        }
      ],
      "returns": null
    },
    "popupContainer": {
      "type": {
        "name": "any"
      },
      "required": false,
      "description": "弹层挂载的容器节点",
      "docblock": "弹层挂载的容器节点"
    },
    "popupClassName": {
      "type": {
        "name": "any"
      },
      "required": false,
      "description": "弹层的 className",
      "docblock": "弹层的 className"
    },
    "popupStyle": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "弹层的内联样式",
      "docblock": "弹层的内联样式",
      "properties": []
    },
    "popupProps": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "添加到弹层上的属性",
      "defaultValue": {
        "value": "{}",
        "computed": false
      },
      "docblock": "添加到弹层上的属性",
      "properties": []
    },
    "followTrigger": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否跟随滚动",
      "docblock": "是否跟随滚动"
    },
    "popupContent": {
      "type": {
        "name": "node"
      },
      "required": false,
      "description": "自定义渲染的的下拉框",
      "docblock": "自定义渲染的的下拉框"
    },
    "menuProps": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "添加到菜单上的属性",
      "docblock": "添加到菜单上的属性\n@version 1.18",
      "properties": [],
      "version": {
        "value": "1.18",
        "computed": false
      }
    },
    "filterLocal": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否使用本地过滤，在数据源为远程的时候需要关闭此项",
      "defaultValue": {
        "value": "true",
        "computed": false
      },
      "docblock": "是否使用本地过滤，在数据源为远程的时候需要关闭此项"
    },
    "filter": {
      "type": {
        "name": "array"
      },
      "required": false,
      "description": "选择器",
      "defaultValue": {
        "value": "[]",
        "computed": false
      },
      "docblock": "选择器"
    },
    "defaultHighlightKey": {
      "type": {
        "name": "string"
      },
      "required": false,
      "description": "默认高亮的 key，不要和 autoHighlightFirstItem 同时使用",
      "defaultValue": {
        "value": "null",
        "computed": false
      },
      "docblock": "默认高亮的 key，不要和 autoHighlightFirstItem 同时使用"
    },
    "highlightKey": {
      "type": {
        "name": "string"
      },
      "required": false,
      "description": "高亮 key，不要和 autoHighlightFirstItem 同时使用，用于受控模式",
      "docblock": "高亮 key，不要和 autoHighlightFirstItem 同时使用，用于受控模式"
    },
    "onToggleHighlightItem": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "上下箭头切换选项的回调",
      "defaultValue": {
        "value": "func.noop",
        "computed": true
      },
      "docblock": "上下箭头切换选项的回调",
      "params": [],
      "returns": null
    },
    "autoHighlightFirstItem": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否自动高亮第一个元素",
      "defaultValue": {
        "value": "true",
        "computed": false
      },
      "docblock": "是否自动高亮第一个元素"
    },
    "useVirtual": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否开启虚拟滚动模式",
      "docblock": "是否开启虚拟滚动模式"
    },
    "dataSource": {
      "type": {
        "name": "array"
      },
      "required": false,
      "description": "搜索框下拉联想列表",
      "docblock": "搜索框下拉联想列表"
    },
    "itemRender": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "渲染 MenuItem 内容的方法",
      "docblock": "渲染 MenuItem 内容的方法\n@param {Object} item 渲染节点的 item\n@return {ReactNode} item node",
      "params": [
        {
          "name": "item",
          "description": "渲染节点的 item",
          "type": {
            "name": "Object"
          }
        }
      ],
      "returns": {
        "description": "item node",
        "type": {
          "name": "ReactNode"
        }
      }
    },
    "isPreview": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否为预览态",
      "docblock": "是否为预览态"
    },
    "renderPreview": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "预览态模式下渲染的内容",
      "docblock": "预览态模式下渲染的内容\n@param {number} value 评分值",
      "params": [
        {
          "name": "value",
          "description": "评分值",
          "type": {
            "name": "number"
          }
        }
      ],
      "returns": null
    },
    "onChange": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "输入关键字时的回掉",
      "defaultValue": {
        "value": "func.noop",
        "computed": true
      },
      "docblock": "输入关键字时的回掉\n@param {Object} value 输入值",
      "params": [
        {
          "name": "value",
          "description": "输入值",
          "type": {
            "name": "Object"
          }
        }
      ],
      "returns": null
    },
    "fillProps": {
      "type": {
        "name": "string"
      },
      "required": false,
      "description": "填充到输入框里的值的 key\b\b ，默认是value",
      "docblock": "填充到输入框里的值的 key\b\b ，默认是value"
    },
    "prefix": {
      "type": {
        "name": "string"
      },
      "required": false,
      "description": "样式前缀",
      "defaultValue": {
        "value": "'next-'",
        "computed": false
      },
      "docblock": "样式前缀"
    },
    "shape": {
      "type": {
        "name": "enum",
        "value": [
          {
            "value": "'normal'",
            "computed": false
          },
          {
            "value": "'simple'",
            "computed": false
          }
        ]
      },
      "required": false,
      "description": "形状",
      "defaultValue": {
        "value": "'normal'",
        "computed": false
      },
      "docblock": "形状"
    },
    "type": {
      "type": {
        "name": "enum",
        "value": [
          {
            "value": "'primary'",
            "computed": false
          },
          {
            "value": "'secondary'",
            "computed": false
          },
          {
            "value": "'normal'",
            "computed": false
          },
          {
            "value": "'dark'",
            "computed": false
          }
        ]
      },
      "required": false,
      "description": "类型 shape=normal: primary/secondary; shape=simple: normal/dark;",
      "defaultValue": {
        "value": "'normal'",
        "computed": false
      },
      "docblock": "类型 shape=normal: primary/secondary; shape=simple: normal/dark;"
    },
    "onSearch": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "点击搜索按钮触发的回调",
      "defaultValue": {
        "value": "func.noop",
        "computed": true
      },
      "docblock": "点击搜索按钮触发的回调\n@param {String} value 输入值\n@param {String} filterValue 选项值",
      "params": [
        {
          "name": "value",
          "description": "输入值",
          "type": {
            "name": "String"
          }
        },
        {
          "name": "filterValue",
          "description": "选项值",
          "type": {
            "name": "String"
          }
        }
      ],
      "returns": null
    },
    "defaultFilterValue": {
      "type": {
        "name": "string"
      },
      "required": false,
      "description": "选择器默认值",
      "docblock": "选择器默认值"
    },
    "filterValue": {
      "type": {
        "name": "string"
      },
      "required": false,
      "description": "选择器值",
      "docblock": "选择器值"
    },
    "onFilterChange": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "选择器发生变化时回调",
      "defaultValue": {
        "value": "func.noop",
        "computed": true
      },
      "docblock": "选择器发生变化时回调\n@param {Object} filter value",
      "params": [
        {
          "name": "filter",
          "description": "value",
          "type": {
            "name": "Object"
          }
        }
      ],
      "returns": null
    },
    "searchText": {
      "type": {
        "name": "node"
      },
      "required": false,
      "description": "button 的内容",
      "docblock": "button 的内容"
    },
    "style": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "自定义样式",
      "docblock": "自定义样式",
      "properties": []
    },
    "className": {
      "type": {
        "name": "string"
      },
      "required": false,
      "description": "样式名称",
      "docblock": "样式名称"
    },
    "filterProps": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "选择器的props",
      "docblock": "选择器的props",
      "properties": []
    },
    "buttonProps": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "按钮的额外属性",
      "defaultValue": {
        "value": "{}",
        "computed": false
      },
      "docblock": "按钮的额外属性",
      "properties": []
    },
    "hasIcon": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否显示搜索按钮",
      "defaultValue": {
        "value": "true",
        "computed": false
      },
      "docblock": "是否显示搜索按钮"
    },
    "icons": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "可配置的icons，包括 search 等",
      "defaultValue": {
        "value": "{}",
        "computed": false
      },
      "docblock": "可配置的icons，包括 search 等",
      "properties": []
    }
  },
  "methods": [],
  "description": "输入框部分继承 Select.AutoComplete 的能力，可以直接用AutoComplete 的 api",
  "subComponents": []
}