ant-design/components/auto-complete/index.zh-CN.md
2017-09-01 11:33:11 +08:00

2.2 KiB
Raw Blame History

category subtitle type cols title
Components 自动完成 Data Entry 2 AutoComplete

输入框自动完成功能。

何时使用

需要自动完成时。

API

const dataSource = ['12345', '23456', '34567'];
<AutoComplete dataSource={dataSource} />
参数 说明 类型 默认值
dataSource 自动完成的数据源 DataSourceItemType[]
value 指定当前选中的条目 string|string[]|{ key: string, label: string|ReactNode }|Array<{ key: string, label: string|ReactNode }>
defaultValue 指定默认选中的条目 string|string[]|{ key: string, label: string|ReactNode }|Array<{ key: string, label: string|ReactNode}>
allowClear 支持清除, 单选模式有效 boolean false
onChange 选中 option或 input 的 value 变化时,调用此函数 function(value)
onSelect 被选中时调用,参数为选中项的 value 值 function(value, option)
onSearch 搜索补全项的时候调用 function(value)
disabled 是否禁用 boolean false
defaultActiveFirstOption 是否默认高亮第一个选项。 boolean true
placeholder 输入框提示 string -
children (自动完成的数据源) 自动完成的数据源 React.ReactElement / Array<React.ReactElement> -
children (自定义输入框) 自定义输入框 HTMLInputElement / HTMLTextAreaElement / React.ReactElement <Input />
optionLabelProp 回填到选择框的 Option 的属性值,默认是 Option 的子元素。比如在子元素需要高亮效果时,此值可以设为 value string children
filterOption 是否根据输入项进行筛选。当其为一个函数时,会接收 inputValue option 两个参数,当 option 符合筛选条件时,应返回 true,反之则返回 false boolean or function(inputValue, option) true
backfill 使用键盘选择选项的时候把选中项回填到输入框中 bollean false