Select选择器
下拉选择器。
何时使用
- 弹出一个下拉菜单给用户选择操作,用于代替原生的选择器,或者需要一个更优雅的多选器时。
- 当选项少时(少于 5 项),建议直接将选项平铺,使用 Radio 是更好的选择。
Examples
Select API#
| 属性 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| Bordered | 属性切换边框样式。 | Boolean | true |
| EnableVirtualization | 属性Whether to enable virtualization feature or not, only works for .NET 5 and higher | Boolean | false |
| DataSource | 属性该组件的数据源。 | IEnumerable<TItem> | -- |
| SelectOptions | 属性用于手动呈现选择选项。 | RenderFragment | -- |
| ChildContent | 属性Used for rendering select options manually, alias for AntDesign.Select`2.SelectOptions. |
RenderFragment | -- |
| DataSourceEqualityComparer | 属性将在 DataSource 更改检测期间使用的 EqualityComparer。如果没有设置比较器,将使用默认的 .Net。 | IEqualityComparer<TItem> | -- |
| DefaultActiveFirstOption | 属性激活第一个未停用的项目。 | Boolean | -- |
| DisabledName | 属性用作禁用指示器的属性的名称。 | String | -- |
| DropdownMatchSelectWidth | 属性将匹配下拉宽度。如果 true,则匹配下拉列表中最宽项的宽度。如果是 string,匹配字符串值的宽度(例如:250px) |
OneOf<Boolean, String> | true |
| DropdownMaxWidth | 属性不允许下拉宽度超过此处规定的值(例如“768px”) | String | auto |
| GroupName | 属性用作组指示符的属性的名称。如果设置了该值,条目将按组显示。使用额外的 AntDesign.SelectBase`2.SortByGroup 和 AntDesign.SelectBase`2.SortByLabel。 |
String | -- |
| IgnoreItemChanges | 属性用于提高速度。如果您希望更改标签名称、组名称或禁用指示器,请禁用此属性。 | Boolean | true |
| ItemTemplate | 属性用于自定义项目样式。 | RenderFragment<TItem> | -- |
| NotFoundContent | 属性指定在没有结果匹配时显示的内容。 | RenderFragment | -- |
| OnBlur | 属性模糊时调用。 | Action | -- |
| OnCreateCustomTag | 属性创建自定义标记时调用。 | Action<String> | -- |
| OnDataSourceChanged | 属性当数据源对象/引用更改时调用。如果数据源中的值发生更改,它不会触发。 | Action | -- |
| OnDropdownVisibleChange | 属性当下拉列表可见性发生变化时调用。 | Action<Boolean> | -- |
| OnSearch | 属性输入更改时触发的回调函数。 | Action<String> | -- |
| PopupContainerMaxHeight | 属性 | String | -- |
| ShowArrowIcon | 属性是否显示下拉箭头 | Boolean | true |
| TokenSeparators | 属性定义哪些字符将被视为新创建标签的标记分隔符。仅使用键盘创建新标签时很有用。 | Char[] | -- |
| ValueChanged | 属性用于双向绑定。 | EventCallback<TItemValue> | -- |
| Value | 属性获取或设置选定的值。 | TItemValue | -- |
| LabelProperty | 属性指定 option 对象中的 label 属性。如果使用此属性,则不应使用 Obsolete 将在未来的版本中删除。 |
Func<TItem, String> | -- |
| ValueProperty | 属性指定 option 对象中的 value 属性。如果使用此属性,则不应使用 Obsolete 将在未来的版本中删除。 |
Func<TItem, TItemValue> | -- |
| DisabledPredicate | 属性为禁用的选项指定谓词 | Func<TItem, Boolean> | -- |
| DefaultValue | 属性当 Mode = default 时使用 - 该值在初始化期间和在 Forms 中按下 Reset 按钮时使用。 | TItemValue | -- |
| ListboxStyle | 属性 | String | -- |
| FilterExpression | 属性Custom filter expression to filter options based on search value. | Func<SelectOptionItem<TItemValue, TItem>, String, Boolean> | -- |
| BoundaryAdjustMode | 属性叠加调整策略(例如浏览器调整大小时) | TriggerBoundaryAdjustMode | -- |
| AllowClear | 属性显示清除按钮。如果 AntDesign.AntInputComponentBase`1.Value 类型默认值也在 SelectOption 列表中,则无效,除非与 AntDesign.SelectBase`2.ValueOnClear 一起使用代码>。 |
Boolean | -- |
| AutoClearSearchValue | 属性选择项目时是否清除当前搜索。 | Boolean | -- |
| Disabled | 属性选择组件是否被禁用。 | Boolean | -- |
| Mode | 属性设置选择模式 - 默认 |多个 |标签 | SelectMode | -- |
| EnableSearch | 属性指示搜索功能是否处于活动状态。对于模式标签始终为真。 | Boolean | -- |
| SearchDebounceMilliseconds | 属性延迟搜索输入事件的处理,直到用户停止键入预定的时间。默认为 250 毫秒。 | Int32 | -- |
| Loading | 属性显示加载指示器。您必须自己编写加载逻辑。 | Boolean | -- |
| Open | 属性下拉菜单的受控打开状态。 | Boolean | -- |
| OpenChanged | 属性打开状态更改时调用的回调函数。 | EventCallback<Boolean> | -- |
| Placeholder | 属性选择的占位符。 | String | -- |
| OnFocus | 属性焦点时调用。 | EventCallback | -- |
| AutoFocus | 属性自动对焦。 | Boolean | -- |
| SortByGroup | 属性用作组指示符的属性的名称。如果设置了该值,条目将按组显示。使用额外的 SortByGroup 和 SortByLabel。 | SortDirection | -- |
| SortByLabel | 属性按标签值对项目进行排序。无 |升序 |降序 | SortDirection | -- |
| HideSelected | 属性选中时隐藏选中的项目。 | Boolean | -- |
| ValuesChanged | 属性用于双向绑定。 | EventCallback<IEnumerable<TItemValue>> | -- |
| SuffixIcon | 属性自定义后缀图标。 | RenderFragment | -- |
| PrefixIcon | 属性自定义前缀图标。 | RenderFragment | -- |
| AccessKey | 属性accesskey 全局属性。 | String | -- |
| DefaultValues | 属性Mode = multiple | 时使用tags - 这些值在初始化期间和在 Forms 中按下 Reset 按钮时使用。 | IEnumerable<TItemValue> | -- |
| OnClearSelected | 属性当用户清除选择时调用。 | EventCallback | -- |
| Unbound | 属性设置了 ElementReference 的 ChildElement 以避免包装 div。 | RenderFragment<ForwardRef> | -- |
| OnSelectedItemChanged | 属性当所选项目更改时调用。 | EventCallback<TItem> | -- |
| OnSelectedItemsChanged | 属性当所选项目更改时调用。 | EventCallback<IEnumerable<TItem>> | -- |
| Values | 属性获取或设置选定的值。 | IEnumerable<TItemValue> | -- |
| CustomTagLabelToValue | 属性将自定义标签(字符串)转换为 TItemValue 类型。 | Func<String, TItemValue> | -- |
| MaxTagTextLength | 属性标签的长度(字符数)。仅适用于 Mode = "multiple" 或 Mode = "tags" | Int32 | -- |
| LabelInValue | 属性是否在值中嵌入标签,将值的格式从 TItemValue 转换为字符串(JSON),例如{ "value": TItemValue, "label": "标签值" } | Boolean | -- |
| MaxTagCount | 属性要显示的最大标签数。响应式会降低渲染性能。 | OneOf<Int32, ResponsiveTag> | -- |
| ValueOnClear | 属性当按下清除按钮时,值将设置为 ValueOnClear 中设置的值 | TItemValue | -- |
| ItemLabel | 属性指定 option 对象中的 label 属性。如果使用此属性,则不应使用 AntDesign.SelectBase'2.LabelName |
Func<TItem, String> | -- |
| ItemValue | 属性指定 option 对象中的 value 属性。如果使用此属性,则不应使用 AntDesign.SelectBase'2.ValueName |
Func<TItem, TItemValue> | -- |
| LabelName | 属性用于标签的属性的名称。 | String | -- |
| ValueName | 属性要用于该值的属性的名称。 | String | -- |
| OnMouseEnter | 属性鼠标进入时调用。 | Action | -- |
| OnMouseLeave | 属性鼠标离开时调用。 | Action | -- |
| PopupContainerSelector | 属性使用它来修复覆盖问题,例如#区域 | String | -- |
| DropdownRender | 属性自定义下拉内容。上下文是原始内容。 | RenderFragment<RenderFragment> | -- |
| LabelTemplate | 属性用于自定义标签样式。 | RenderFragment<TItem> | -- |
| MaxTagPlaceholder | 属性隐藏标签的占位符。如果与 ResponsiveTag.Responsive 一起使用,请实现您自己的处理逻辑。 | RenderFragment<IEnumerable<TItem>> | -- |
| ShowSearchIcon | 属性是否在单一模式下显示搜索输入。 | Boolean | -- |
| Placement | 属性叠加层的放置。默认为 AntDesign.Placement.BottomLeft。 |
Placement | Placement.BottomLeft |
| ValidationMessages | FormItem 的验证消息 | String[] | -- |
| AdditionalAttributes | 属性获取或设置将应用于所创建元素的附加属性的集合。 | IReadOnlyDictionary<String, Object> | -- |
| ValueExpression | 属性标识绑定值的表达式。 | Expression<Func<TItemValue>> | -- |
| ValuesExpression | 属性标识可枚举绑定值的表达式。 | Expression<Func<IEnumerable<TItemValue>>> | -- |
| Size | 属性The size of the input box. Note: in the context of a form, `InputSize.Large` is used. Available: `InputSize.Large` `InputSize.Default` `InputSize.Small` | InputSize | InputSize.Default |
| CultureInfo | 属性将字符串转换为值和将值转换为字符串时将使用什么文化对 InputNumber 组件有用。 | CultureInfo | CultureInfo.CurrentCulture |
| Id | 属性组件 HTML 的 ID | String | Uniquely Generated ID |
| Class | 属性为 DOM 元素指定一个或多个类名。 | String | -- |
| Style | 属性指定 DOM 元素的内联样式。 | String | -- |
| RefBack | 属性一个 ForwardRef 实例。您可以使用 AntDesign.ForwardRef.Current 获取对内部 DOM 的引用。 |
ForwardRef | -- |
SelectOption API#
| 属性 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| Disabled | 属性Disable this option The parameter should only be used if the SelectOption was created directly. | Boolean | -- |
| Label | 属性Label of Select after selecting this Option The parameter should only be used if the SelectOption was created directly. | String | -- |
| Value | 属性Value of Select after selecting this Option The parameter should only be used if the SelectOption was created directly. | TItemValue | -- |
| Item | 属性 | TItem | -- |
| ChildContent | 属性Optional child content of the SelectOption, used as label template for the option. If provided it will be used for rendering the option content (when ItemTemplate is not present) and it will be assigned to the underlying SelectOptionItem.LabelTemplate so the Select's selected-item display can reuse it when Select.LabelTemplate is not set. | RenderFragment<TItem> | -- |
| Id | 属性组件 HTML 的 ID | String | Uniquely Generated ID |
| Class | 属性为 DOM 元素指定一个或多个类名。 | String | -- |
| Style | 属性指定 DOM 元素的内联样式。 | String | -- |
| RefBack | 属性一个 ForwardRef 实例。您可以使用 AntDesign.ForwardRef.Current 获取对内部 DOM 的引用。 |
ForwardRef | -- |
EnumSelect API#
| 属性 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| Value | 属性 | TEnum | -- |
| Values | 属性 | IEnumerable<TEnum> | -- |
| Bordered | 属性切换边框样式。 | Boolean | true |
| EnableVirtualization | 属性Whether to enable virtualization feature or not, only works for .NET 5 and higher | Boolean | false |
| DataSource | 属性该组件的数据源。 | IEnumerable<TEnum> | -- |
| SelectOptions | 属性用于手动呈现选择选项。 | RenderFragment | -- |
| ChildContent | 属性Used for rendering select options manually, alias for AntDesign.Select`2.SelectOptions. |
RenderFragment | -- |
| DataSourceEqualityComparer | 属性将在 DataSource 更改检测期间使用的 EqualityComparer。如果没有设置比较器,将使用默认的 .Net。 | IEqualityComparer<TEnum> | -- |
| DefaultActiveFirstOption | 属性激活第一个未停用的项目。 | Boolean | -- |
| DisabledName | 属性用作禁用指示器的属性的名称。 | String | -- |
| DropdownMatchSelectWidth | 属性将匹配下拉宽度。如果 true,则匹配下拉列表中最宽项的宽度。如果是 string,匹配字符串值的宽度(例如:250px) |
OneOf<Boolean, String> | true |
| DropdownMaxWidth | 属性不允许下拉宽度超过此处规定的值(例如“768px”) | String | auto |
| GroupName | 属性用作组指示符的属性的名称。如果设置了该值,条目将按组显示。使用额外的 AntDesign.SelectBase`2.SortByGroup 和 AntDesign.SelectBase`2.SortByLabel。 |
String | -- |
| IgnoreItemChanges | 属性用于提高速度。如果您希望更改标签名称、组名称或禁用指示器,请禁用此属性。 | Boolean | true |
| ItemTemplate | 属性用于自定义项目样式。 | RenderFragment<TEnum> | -- |
| NotFoundContent | 属性指定在没有结果匹配时显示的内容。 | RenderFragment | -- |
| OnBlur | 属性模糊时调用。 | Action | -- |
| OnCreateCustomTag | 属性创建自定义标记时调用。 | Action<String> | -- |
| OnDataSourceChanged | 属性当数据源对象/引用更改时调用。如果数据源中的值发生更改,它不会触发。 | Action | -- |
| OnDropdownVisibleChange | 属性当下拉列表可见性发生变化时调用。 | Action<Boolean> | -- |
| OnSearch | 属性输入更改时触发的回调函数。 | Action<String> | -- |
| PopupContainerMaxHeight | 属性 | String | -- |
| ShowArrowIcon | 属性是否显示下拉箭头 | Boolean | true |
| TokenSeparators | 属性定义哪些字符将被视为新创建标签的标记分隔符。仅使用键盘创建新标签时很有用。 | Char[] | -- |
| ValueChanged | 属性用于双向绑定。 | EventCallback<TEnum> | -- |
| LabelProperty | 属性指定 option 对象中的 label 属性。如果使用此属性,则不应使用 Obsolete 将在未来的版本中删除。 |
Func<TEnum, String> | -- |
| ValueProperty | 属性指定 option 对象中的 value 属性。如果使用此属性,则不应使用 Obsolete 将在未来的版本中删除。 |
Func<TEnum, TEnum> | -- |
| DisabledPredicate | 属性为禁用的选项指定谓词 | Func<TEnum, Boolean> | -- |
| DefaultValue | 属性当 Mode = default 时使用 - 该值在初始化期间和在 Forms 中按下 Reset 按钮时使用。 | TEnum | -- |
| ListboxStyle | 属性 | String | -- |
| FilterExpression | 属性Custom filter expression to filter options based on search value. | Func<SelectOptionItem<TEnum, TEnum>, String, Boolean> | -- |
| BoundaryAdjustMode | 属性叠加调整策略(例如浏览器调整大小时) | TriggerBoundaryAdjustMode | -- |
| AllowClear | 属性显示清除按钮。如果 AntDesign.AntInputComponentBase`1.Value 类型默认值也在 SelectOption 列表中,则无效,除非与 AntDesign.SelectBase`2.ValueOnClear 一起使用代码>。 |
Boolean | -- |
| AutoClearSearchValue | 属性选择项目时是否清除当前搜索。 | Boolean | -- |
| Disabled | 属性选择组件是否被禁用。 | Boolean | -- |
| Mode | 属性设置选择模式 - 默认 |多个 |标签 | SelectMode | -- |
| EnableSearch | 属性指示搜索功能是否处于活动状态。对于模式标签始终为真。 | Boolean | -- |
| SearchDebounceMilliseconds | 属性延迟搜索输入事件的处理,直到用户停止键入预定的时间。默认为 250 毫秒。 | Int32 | -- |
| Loading | 属性显示加载指示器。您必须自己编写加载逻辑。 | Boolean | -- |
| Open | 属性下拉菜单的受控打开状态。 | Boolean | -- |
| OpenChanged | 属性打开状态更改时调用的回调函数。 | EventCallback<Boolean> | -- |
| Placeholder | 属性选择的占位符。 | String | -- |
| OnFocus | 属性焦点时调用。 | EventCallback | -- |
| AutoFocus | 属性自动对焦。 | Boolean | -- |
| SortByGroup | 属性用作组指示符的属性的名称。如果设置了该值,条目将按组显示。使用额外的 SortByGroup 和 SortByLabel。 | SortDirection | -- |
| SortByLabel | 属性按标签值对项目进行排序。无 |升序 |降序 | SortDirection | -- |
| HideSelected | 属性选中时隐藏选中的项目。 | Boolean | -- |
| ValuesChanged | 属性用于双向绑定。 | EventCallback<IEnumerable<TEnum>> | -- |
| SuffixIcon | 属性自定义后缀图标。 | RenderFragment | -- |
| PrefixIcon | 属性自定义前缀图标。 | RenderFragment | -- |
| AccessKey | 属性accesskey 全局属性。 | String | -- |
| DefaultValues | 属性Mode = multiple | 时使用tags - 这些值在初始化期间和在 Forms 中按下 Reset 按钮时使用。 | IEnumerable<TEnum> | -- |
| OnClearSelected | 属性当用户清除选择时调用。 | EventCallback | -- |
| Unbound | 属性设置了 ElementReference 的 ChildElement 以避免包装 div。 | RenderFragment<ForwardRef> | -- |
| OnSelectedItemChanged | 属性当所选项目更改时调用。 | EventCallback<TEnum> | -- |
| OnSelectedItemsChanged | 属性当所选项目更改时调用。 | EventCallback<IEnumerable<TEnum>> | -- |
| CustomTagLabelToValue | 属性将自定义标签(字符串)转换为 TItemValue 类型。 | Func<String, TEnum> | -- |
| MaxTagTextLength | 属性标签的长度(字符数)。仅适用于 Mode = "multiple" 或 Mode = "tags" | Int32 | -- |
| LabelInValue | 属性是否在值中嵌入标签,将值的格式从 TItemValue 转换为字符串(JSON),例如{ "value": TItemValue, "label": "标签值" } | Boolean | -- |
| MaxTagCount | 属性要显示的最大标签数。响应式会降低渲染性能。 | OneOf<Int32, ResponsiveTag> | -- |
| ValueOnClear | 属性当按下清除按钮时,值将设置为 ValueOnClear 中设置的值 | TEnum | -- |
| ItemLabel | 属性指定 option 对象中的 label 属性。如果使用此属性,则不应使用 AntDesign.SelectBase'2.LabelName |
Func<TEnum, String> | -- |
| ItemValue | 属性指定 option 对象中的 value 属性。如果使用此属性,则不应使用 AntDesign.SelectBase'2.ValueName |
Func<TEnum, TEnum> | -- |
| LabelName | 属性用于标签的属性的名称。 | String | -- |
| ValueName | 属性要用于该值的属性的名称。 | String | -- |
| OnMouseEnter | 属性鼠标进入时调用。 | Action | -- |
| OnMouseLeave | 属性鼠标离开时调用。 | Action | -- |
| PopupContainerSelector | 属性使用它来修复覆盖问题,例如#区域 | String | -- |
| DropdownRender | 属性自定义下拉内容。上下文是原始内容。 | RenderFragment<RenderFragment> | -- |
| LabelTemplate | 属性用于自定义标签样式。 | RenderFragment<TEnum> | -- |
| MaxTagPlaceholder | 属性隐藏标签的占位符。如果与 ResponsiveTag.Responsive 一起使用,请实现您自己的处理逻辑。 | RenderFragment<IEnumerable<TEnum>> | -- |
| ShowSearchIcon | 属性是否在单一模式下显示搜索输入。 | Boolean | -- |
| Placement | 属性叠加层的放置。默认为 AntDesign.Placement.BottomLeft。 |
Placement | Placement.BottomLeft |
| ValidationMessages | FormItem 的验证消息 | String[] | -- |
| AdditionalAttributes | 属性获取或设置将应用于所创建元素的附加属性的集合。 | IReadOnlyDictionary<String, Object> | -- |
| ValueExpression | 属性标识绑定值的表达式。 | Expression<Func<TEnum>> | -- |
| ValuesExpression | 属性标识可枚举绑定值的表达式。 | Expression<Func<IEnumerable<TEnum>>> | -- |
| Size | 属性The size of the input box. Note: in the context of a form, `InputSize.Large` is used. Available: `InputSize.Large` `InputSize.Default` `InputSize.Small` | InputSize | InputSize.Default |
| CultureInfo | 属性将字符串转换为值和将值转换为字符串时将使用什么文化对 InputNumber 组件有用。 | CultureInfo | CultureInfo.CurrentCulture |
| Id | 属性组件 HTML 的 ID | String | Uniquely Generated ID |
| Class | 属性为 DOM 元素指定一个或多个类名。 | String | -- |
| Style | 属性指定 DOM 元素的内联样式。 | String | -- |
| RefBack | 属性一个 ForwardRef 实例。您可以使用 AntDesign.ForwardRef.Current 获取对内部 DOM 的引用。 |
ForwardRef | -- |