ant-design-vue/components/select/index.en-US.md

4.2 KiB

API

<a-select>
  <a-select-option value="lucy">lucy</a-select-option>
</a-select>

Select props

Property Description Type Default
allowClear Show clear button. boolean false
autoFocus Get focus by default boolean false
defaultActiveFirstOption Whether active first option by default boolean true
defaultValue Initial selected option. string|number|string[]|number[] -
disabled Whether disabled select boolean false
dropdownClassName className of dropdown menu string -
dropdownMatchSelectWidth Whether dropdown's with is same with select. boolean true
dropdownStyle style of dropdown menu object -
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 or function(inputValue, option) true
firstActiveValue Value of action option by default string|string[] -
getPopupContainer Parent Node which the selector should be rendered to. Default to body. When position issues happen, try to modify it into scrollable content and position it relative. Example function(triggerNode) () => document.body
labelInValue whether to embed label in value, turn the format of value from string to {key: string, label: vNodes} boolean false
maxTagCount Max tag count to show number -
maxTagPlaceholder Placeholder for not showing tags slot/function(omittedValues) -
mode Set mode of Select 'multiple' | 'tags' | 'combobox' -
notFoundContent Specify content to show when no result matches.. string|slot 'Not Found'
optionFilterProp Which prop value of option will be used for filter if filterOption is true string value
optionLabelProp Which prop value of option will render as content of select. string children
placeholder Placeholder of select string|slot -
showSearch Whether show search input in single mode. boolean false
showArrow Whether to show the drop-down arrow boolean true
size Size of Select input. default large small string default
tokenSeparators Separator used to tokenize on tag/multiple mode string[]
value(v-model) Current selected option. string|number|string[]|number[] -

events

Events Name Description Arguments
blur Called when blur function
change Called when select an option or input value change, or value of input is changed in combobox mode function(value, option:Option/Array<Option>)
deselect Called when a option is deselected, the params are option's value (or key) . only called for multiple or tags, effective in multiple or tags mode only. function(value, option:Option)
focus Called when focus function
inputKeydown Called when key pressed function
mouseenter Called when mouse enter function
mouseleave Called when mouse leave function
popupScroll Called when dropdown scrolls function
search Callback function that is fired when input changed. function(value: string)
select Called when a option is selected, the params are option's value (or key) and option instance. function(value, option:Option)

Select Methods

Name Description
blur() Remove focus
focus() Get focus

Option props

Property Description Type Default
disabled Disable this option boolean false
key Same usage as value. If Vue request you to set this property, you can set it to value of option, and then omit value property. string
title title of Select after select this Option string -
value default to filter with this property string|number -

OptGroup props

Property Description Type Default
key string -
label Group label string|slot -