AutoComplete
自动完成

输入框自动完成功能。
使用import{ AutoComplete }from"antd";

何时使用

  • 需要一个输入框而不是选择器。
  • 需要输入建议/辅助提示。

和 Select 的区别是:

  • AutoComplete 是一个带提示的文本输入框,用户可以自由输入,关键词是辅助输入
  • Select 是在限定的可选项中进行选择,关键词是选择

代码演示



基本使用,通过 options 设置自动完成的数据源。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

自定义输入组件。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

使用 status 为 AutoComplete 添加状态,可选 error 或者 warning

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code


自定义清除按钮

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

可以返回自定义的 Option label

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

不区分大小写的 AutoComplete

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

可选 outlined filled borderless 三种形态。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
5.13.0

API

通用属性参考:通用属性

参数说明类型默认值版本
allowClear支持清除boolean | { clearIcon?: ReactNode }false5.8.0: 支持对象形式
autoFocus自动获取焦点booleanfalse
backfill使用键盘选择选项的时候把选中项回填到输入框中booleanfalse
children (自动完成的数据源)自动完成的数据源,不能和自定义输入框同时配置React.ReactElement<OptionProps> | Array<React.ReactElement<OptionProps>>-
children (自定义输入框)自定义输入框,不能和自动完成的数据源同时配置HTMLInputElement | HTMLTextAreaElement | React.ReactElement<InputProps><Input />
defaultActiveFirstOption是否默认高亮第一个选项booleantrue
defaultOpen是否默认展开下拉菜单boolean-
defaultValue指定默认选中的条目string-
disabled是否禁用booleanfalse
dropdownRender自定义下拉框内容(menus: ReactNode) => ReactNode-4.24.0
popupClassName下拉菜单的 className 属性string-4.23.0
popupMatchSelectWidth下拉菜单和选择器同宽。默认将设置 min-width,当值小于选择框宽度时会被忽略。false 时会关闭虚拟滚动boolean | numbertrue
filterOption是否根据输入项进行筛选。当其为一个函数时,会接收 inputValue option 两个参数,当 option 符合筛选条件时,应返回 true,反之则返回 falseboolean | function(inputValue, option)true
getPopupContainer菜单渲染父节点。默认渲染到 body 上,如果你遇到菜单滚动定位问题,试试修改为滚动的区域,并相对其定位。示例function(triggerNode)() => document.body
notFoundContent当下拉列表为空时显示的内容ReactNode-
open是否展开下拉菜单boolean-
options数据化配置选项内容,相比 jsx 定义会获得更好的渲染性能{ label, value }[]-
placeholder输入框提示string-
status设置校验状态'error' | 'warning'-4.19.0
size控件大小large | middle | small-
value指定当前选中的条目string-
variant形态变体outlined | borderless | filledoutlined5.13.0
virtual设置 false 时关闭虚拟滚动booleantrue4.1.0
onBlur失去焦点时的回调function()-
onChange选中 option,或 input 的 value 变化时,调用此函数function(value)-
onDropdownVisibleChange展开下拉菜单的回调function(open)-
onFocus获得焦点时的回调function()-
onSearch搜索补全项的时候调用function(value)-
onSelect被选中时调用,参数为选中项的 value 值function(value, option)-
onClear清除内容时的回调function-4.6.0
onInputKeyDown按键按下时回调(event: KeyboardEvent) => void-
onPopupScroll下拉列表滚动时的回调(event: UIEvent) => void-

方法

名称描述版本
blur()移除焦点
focus()获取焦点

主题变量(Design Token)

组件 Token如何定制?

Token 名称描述类型默认值
activeBorderColor激活态边框色string#1677ff
activeOutlineColor激活态 outline 颜色stringrgba(5,145,255,0.1)
clearBg清空按钮背景色string#ffffff
hoverBorderColor悬浮态边框色string#4096ff
multipleItemBg多选标签背景色stringrgba(0,0,0,0.06)
multipleItemBorderColor多选标签边框色stringtransparent
multipleItemBorderColorDisabled多选标签禁用边框色stringtransparent
multipleItemColorDisabled多选标签禁用文本颜色stringrgba(0,0,0,0.25)
multipleItemHeight多选标签高度number24
multipleItemHeightLG大号多选标签高度number32
multipleItemHeightSM小号多选标签高度number16
multipleSelectorBgDisabled多选框禁用背景stringrgba(0,0,0,0.04)
optionActiveBg选项激活态时背景色stringrgba(0,0,0,0.04)
optionFontSize选项字体大小number14
optionHeight选项高度number32
optionLineHeight选项行高undefined | LineHeight<string | number>1.5714285714285714
optionPadding选项内间距undefined | Padding<string | number>5px 12px
optionSelectedBg选项选中时背景色string#e6f4ff
optionSelectedColor选项选中时文本颜色stringrgba(0,0,0,0.88)
optionSelectedFontWeight选项选中时文本字重undefined | FontWeight600
selectorBg选框背景色string#ffffff
showArrowPaddingInlineEnd箭头的行末内边距number18
singleItemHeightLG单选大号回填项高度number40
zIndexPopup下拉菜单 z-indexnumber1050

全局 Token如何定制?

FAQ

为何受控状态下使用 onSearch 无法输入中文?

请使用 onChange 进行受控管理。onSearch 触发于搜索输入,与 onChange 时机不同。此外,点击选项时也不会触发 onSearch 事件。

相关 issue:#18230 #17916

为何 options 为空时,受控 open 展开不会显示下拉菜单?

AutoComplete 组件本质上是 Input 输入框的一种扩展,当 options 为空时,显示空文本会让用户误以为该组件不可操作,实际上它仍然可以进行文本输入操作。因此,为了避免给用户带来困惑,当 options 为空时,open 属性为 true 也不会展示下拉菜单,需要与 options 属性配合使用。