ant-design/components/select/index.zh-CN.md
二货爱吃白萝卜 8d7dd80120
docs: Update batch of docs & demos (#44509)
* docs: update select opt

* docs: update form deps demo

* docs: upload onChange

* docs: update form nest Form.List demo
2023-08-29 18:47:41 +08:00

11 KiB
Raw Blame History

category subtitle group title cover coverDark demo
Components 选择器 数据录入 Select https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*zo76T7KQx2UAAAAAAAAAAAAADrJ8AQ/original https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*5oPiTqPxGAUAAAAAAAAAAAAADrJ8AQ/original
cols
2

下拉选择器。

何时使用

  • 弹出一个下拉菜单给用户选择操作,用于代替原生的选择器,或者需要一个更优雅的多选器时。
  • 当选项少时(少于 5 项),建议直接将选项平铺,使用 Radio 是更好的选择。
  • 如果你在寻找一个可输可选的输入框,那你可能需要 AutoComplete

代码演示

基本使用 带搜索框 多选 三种大小 定制回填内容 带排序的搜索 标签 分组 联动 搜索框 获得选项的文本 自动分词 搜索用户 后缀图标 扩展菜单 隐藏已选择选项 无边框 自定义选择标签 响应式 maxTagCount 大数据 自定义状态 弹出位置 动态高度 4.0 Debug _InternalPanelDoNotUseOrYouWillBeFired 选项文本居中 翻转+偏移

API

通用属性参考:通用属性

Select props

参数 说明 类型 默认值 版本
allowClear 支持清除 boolean false
autoClearSearchValue 是否在选中项后清空搜索框,只在 modemultipletags 时有效 boolean true
autoFocus 默认获取焦点 boolean false
bordered 是否有边框 boolean true
clearIcon 自定义的多选框清空图标 ReactNode -
defaultActiveFirstOption 是否默认高亮第一个选项 boolean true
defaultOpen 是否默认展开下拉菜单 boolean -
defaultValue 指定默认选中的条目 string | string[] |
number | number[] |
LabeledValue | LabeledValue[]
-
disabled 是否禁用 boolean false
popupClassName 下拉菜单的 className 属性 string - 4.23.0
popupMatchSelectWidth 下拉菜单和选择器同宽。默认将设置 min-width当值小于选择框宽度时会被忽略。false 时会关闭虚拟滚动 boolean | number true 5.5.0
dropdownRender 自定义下拉框内容 (originNode: ReactNode) => ReactNode -
dropdownStyle 下拉菜单的 style 属性 CSSProperties -
fieldNames 自定义节点 label、value、options、groupLabel 的字段 object { label: label, value: value, options: options, groupLabel: label } 4.17.0groupLabel 在 5.6.0 新增)
filterOption 是否根据输入项进行筛选。当其为一个函数时,会接收 inputValue option 两个参数,当 option 符合筛选条件时,应返回 true反之则返回 false。示例 boolean | function(inputValue, option) true
filterSort 搜索时对筛选结果项的排序函数, 类似Array.sort里的 compareFunction (optionA: Option, optionB: Option) => number - 4.9.0
getPopupContainer 菜单渲染父节点。默认渲染到 body 上,如果你遇到菜单滚动定位问题,试试修改为滚动的区域,并相对其定位。示例 function(triggerNode) () => document.body
labelInValue 是否把每个选项的 label 包装到 value 中,会把 Select 的 value 类型从 string 变为 { value: string, label: ReactNode } 的格式 boolean false
listHeight 设置弹窗滚动高度 number 256
loading 加载中状态 boolean false
maxTagCount 最多显示多少个 tag响应式模式会对性能产生损耗 number | responsive - responsive: 4.10
maxTagPlaceholder 隐藏 tag 时显示的内容 ReactNode | function(omittedValues) -
maxTagTextLength 最大显示的 tag 文本长度 number -
menuItemSelectedIcon 自定义多选时当前选中的条目图标 ReactNode -
mode 设置 Select 的模式为多选或标签 multiple | tags -
notFoundContent 当下拉列表为空时显示的内容 ReactNode Not Found
open 是否展开下拉菜单 boolean -
optionFilterProp 搜索时过滤对应的 option 属性,如设置为 children 表示对内嵌内容进行搜索。若通过 options 属性配置选项内容,建议设置 optionFilterProp="label" 来对内容进行搜索。 string value
optionLabelProp 回填到选择框的 Option 的属性值,默认是 Option 的子元素。比如在子元素需要高亮效果时,此值可以设为 value示例 string children
options 数据化配置选项内容,相比 jsx 定义会获得更好的渲染性能 { label, value }[] -
placeholder 选择框默认文本 string -
placement 选择框弹出的位置 bottomLeft bottomRight topLeft topRight bottomLeft
removeIcon 自定义的多选框清除图标 ReactNode -
searchValue 控制搜索文本 string -
showSearch 配置是否可搜索 boolean 单选为 false多选为 true
size 选择框大小 large | middle | small middle
status 设置校验状态 'error' | 'warning' - 4.19.0
suffixIcon 自定义的选择框后缀图标。以防止图标被用于其他交互,替换的图标默认不会响应展开、收缩事件,可以通过添加 pointer-events: none 样式透传。 ReactNode <DownOutlined />
tagRender 自定义 tag 内容 render仅在 modemultipletags 时生效 (props) => ReactNode -
tokenSeparators 自动分词的分隔符,仅在 mode="tags" 时生效 string[] -
value 指定当前选中的条目多选时为一个数组。value 数组引用未变化时Select 不会更新) string | string[] |
number | number[] |
LabeledValue | LabeledValue[]
-
virtual 设置 false 时关闭虚拟滚动 boolean true 4.1.0
onBlur 失去焦点时回调 function -
onChange 选中 option或 input 的 value 变化时,调用此函数 function(value, option:Option | Array<Option>) -
onClear 清除内容时回调 function - 4.6.0
onDeselect 取消选中时调用,参数为选中项的 value (或 key) 值,仅在 multipletags 模式下生效 function(value: string | number | LabeledValue) -
onDropdownVisibleChange 展开下拉菜单的回调 function(open) -
onFocus 获得焦点时回调 function -
onInputKeyDown 按键按下时回调 function -
onMouseEnter 鼠标移入时回调 function -
onMouseLeave 鼠标移出时回调 function -
onPopupScroll 下拉列表滚动时的回调 function -
onSearch 文本框值变化时回调 function(value: string) -
onSelect 被选中时调用,参数为选中项的 value (或 key) 值 function(value: string | number | LabeledValue, option: Option) -

注意,如果发现下拉菜单跟随页面滚动,或者需要在其他弹层中触发 Select请尝试使用 getPopupContainer={triggerNode => triggerNode.parentElement} 将下拉弹层渲染节点固定在触发器的父元素中。

Select Methods

名称 说明 版本
blur() 取消焦点
focus() 获取焦点

Option props

参数 说明 类型 默认值 版本
className Option 器类名 string -
disabled 是否禁用 boolean false
title 选项上的原生 title 提示 string -
value 默认根据此属性值进行筛选 string | number -

OptGroup props

参数 说明 类型 默认值 版本
key Key string -
label 组名 string | React.Element -

Design Token

FAQ

mode="tags" 模式下为何搜索有时会出现两个相同选项?

这一般是 options 中的 labelvalue 不同导致的,你可以通过 optionFilterProp="label" 将过滤设置为展示值以避免这种情况。

点击 dropdownRender 里的元素,下拉菜单不会自动消失?

你可以使用受控模式,手动设置 open 属性:codesandbox

反过来希望点击 dropdownRender 里元素不消失该怎么办?

Select 当失去焦点时会关闭下拉框,如果你可以通过阻止默认行为避免丢失焦点导致的关闭:

<Select
  dropdownRender={() => (
    <div
      onMouseDown={(e) => {
        e.preventDefault();
        e.stopPropagation();
      }}
    >
      Some Content
    </div>
  )}
/>

自定义 Option 样式导致滚动异常怎么办?

这是由于虚拟滚动默认选项高度为 24px,如果你的选项高度小于该值则需要通过 listItemHeight 属性调整,而 listHeight 用于设置滚动容器高度:

<Select listItemHeight={10} listHeight={250} />

注意:listItemHeightlistHeight 为内部属性,如无必要,请勿修改该值。

为何无障碍测试会报缺失 aria- 属性?

Select 无障碍辅助元素仅在弹窗展开时创建,因而当你在进行无障碍检测时请先打开下拉后再进行测试。对于 aria-labelaria-labelledby 属性缺失警告,请自行为 Select 组件添加相应无障碍属性。

Select 虚拟滚动会模拟无障碍绑定元素。如果需要读屏器完整获取全部列表,你可以设置 virtual={false} 关闭虚拟滚动,无障碍选项将会绑定到真实元素上。