AutoComplete
AutoComplete
Autocomplete function of input field.
가져오기import{ AutoComplete }from"antd"; |
- Components Overview
- General
- Layout
- Navigation
- Data Entry
- Data Display
- Feedback
- Other
가져오기import{ AutoComplete }from"antd"; |
The differences with Select are:
Common props ref：Common props
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| allowClear | Show clear button | boolean | { clearIcon?: ReactNode } | false | 5.8.0: Support Object type |
| autoFocus | If get focus when component mounted | boolean | false | |
| backfill | If backfill selected item the input when using keyboard | boolean | false | |
| children (for customize input element) | Customize input element | HTMLInputElement | HTMLTextAreaElement | React.ReactElement<InputProps> | <Input /> | |
| children (for dataSource) | Data source to auto complete | React.ReactElement<OptionProps> | Array<React.ReactElement<OptionProps>> | - | |
| defaultActiveFirstOption | Whether active first option by default | boolean | true | |
| defaultOpen | Initial open state of dropdown | boolean | - | |
| defaultValue | Initial selected option | string | - | |
| disabled | Whether disabled select | boolean | false | |
| dropdownRender | Customize dropdown content | (menus: ReactNode) => ReactNode | - | 4.24.0 |
| popupClassName | The className of dropdown menu | string | - | 4.23.0 |
| popupMatchSelectWidth | Determine whether the dropdown menu and the select input are the same width. Default set min-width same as input. Will ignore when value less than select width. false will disable virtual scroll | boolean | number | true | |
| filterOption | If true, filter options by input, if function, filter options against it. The function will receive two arguments, inputValue and option, if the function returns true, the option will be included in the filtered set; Otherwise, it will be excluded | boolean | function(inputValue, option) | true | |
| getPopupContainer | Parent node of the dropdown. Default to body, if you encountered positioning problems during scroll, try changing to the scrollable area and position relative to it. Example | function(triggerNode) | () => document.body | |
| notFoundContent | Specify content to show when no result matches | ReactNode | - | |
| open | Controlled open state of dropdown | boolean | - | |
| options | Select options. Will get better perf than jsx definition | { label, value }[] | - | |
| placeholder | The placeholder of input | string | - | |
| status | Set validation status | 'error' | 'warning' | - | 4.19.0 |
| value | Selected option | string | - | |
| variant | Variants of input | outlined | borderless | filled | outlined | 5.13.0 |
| onBlur | Called when leaving the component | function() | - | |
| onChange | Called when selecting an option or changing an input value | function(value) | - | |
| onDropdownVisibleChange | Call when dropdown open | function(open) | - | |
| onFocus | Called when entering the component | function() | - | |
| onSearch | Called when searching items | function(value) | - | |
| onSelect | Called when a option is selected. param is option's value and option instance | function(value, option) | - | |
| onClear | Called when clear | function | - | 4.6.0 |
| Name | Description | Version |
|---|---|---|
| blur() | Remove focus | |
| focus() | Get focus |
| 토큰 이름 | 설명 | 타입 | 기본값 |
|---|---|---|---|
| activeBorderColor | 激活态边框色 | string | #1677ff |
| activeOutlineColor | 激活态 outline 颜色 | string | rgba(5, 145, 255, 0.1) |
| clearBg | 지우기 버튼의 배경색 | string | #ffffff |
| hoverBorderColor | 悬浮态边框色 | string | #4096ff |
| multipleItemBg | 다중 선택 태그의 배경색 | string | rgba(0, 0, 0, 0.06) |
| multipleItemBorderColor | 다중 선택 태그의 테두리 색상 | string | transparent |
| multipleItemBorderColorDisabled | 비활성화된 경우 다중 선택 태그의 테두리 색상 | string | transparent |
| multipleItemColorDisabled | 비활성화된 경우 다중 선택 태그의 텍스트 색상 | string | rgba(0, 0, 0, 0.25) |
| multipleItemHeight | 다중 선택 태그의 높이 | number | 24 |
| multipleItemHeightLG | 큰 크기의 다중 선택 태그의 높이 | number | 32 |
| multipleItemHeightSM | 작은 크기의 다중 선택 태그의 높이 | number | 16 |
| multipleSelectorBgDisabled | 비활성화된 경우 다중 선택기의 배경색 | string | rgba(0, 0, 0, 0.04) |
| optionActiveBg | 옵션이 활성화된 경우 배경색 | string | rgba(0, 0, 0, 0.04) |
| optionFontSize | 옵션의 글꼴 크기 | number | 14 |
| optionHeight | 옵션의 높이 | number | 32 |
| optionLineHeight | 옵션의 줄 높이 | undefined | LineHeight<string | number> | 1.5714285714285714 |
| optionPadding | 옵션의 패딩 | undefined | Padding<string | number> | 5px 12px |
| optionSelectedBg | 옵션이 선택된 경우 배경색 | string | #e6f4ff |
| optionSelectedColor | 옵션이 선택된 경우 텍스트 색상 | string | rgba(0, 0, 0, 0.88) |
| optionSelectedFontWeight | 옵션이 선택된 경우 글꼴 두께 | undefined | FontWeight | 600 |
| selectorBg | 선택기의 배경색 | string | #ffffff |
| showArrowPaddingInlineEnd | 화살표의 인라인 끝 패딩 | number | 18 |
| singleItemHeightLG | 큰 크기의 단일 선택된 항목의 높이 | number | 40 |
| zIndexPopup | 드롭다운의 z-index | number | 1050 |
Please use onChange to manage control state. onSearch is used for searching input which is not the same as onChange. Besides, clicking on the option will not trigger the onSearch event.
The AutoComplete component is essentially an extension of the Input form element. When the options property is empty, displaying empty text could mislead the user into believing the component is not operational, when in fact they are still able to input text. To avoid confusion, the open property will not display the drop-down menu when set to true and in combination with an empty options property. The open property must be used in conjunction with the options property.
