Ant Design Blazor
TreeSelect树选择
树型选择控件。
何时使用
类似 Select 的选择控件，可选择的数据结构是一个树形结构时，可以使用 TreeSelect，例如公司层级、学科系统、分类目录等等。
Examples
最简单的用法。
多选的树选择。
使用勾选框实现多选功能。
使用Selectable="false"来标记节点不可选择。
注意：也可以使用
SelectableExpression来动态设置节点是否可选择。
使用ShowCheckedStrategy配置如何显示勾选项的输出结果。
注意：仅当TreeCheckable="true"且TreeCheckStrictly="false"时有效。
多项选择搜索使用。
使用 DataSource 把 IEnumerable
使用CheckableExpression来动态设置节点是否可勾选。
注意：也可以使用
Checkable="false"来标记节点不可勾选。
使用 DropdownRender 对下拉菜单进行自由扩展。
TreeSelect API#
| 属性 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| Multiple | 属性是否允许多选 | Boolean | false unless TreeCheckable is true |
| TreeCheckable | 属性是否能够选择树节点，这将选择该节点下的所有叶子。 | Boolean | false |
| TreeCheckStrictly | 属性精确检查 treeNode；父树节点和子树节点没有关联 | Boolean | -- |
| ShowCheckedStrategy | 属性指定当 TreeCheckable 为 true 且 TreeCheckStrictly 为 false 时如何显示选中的值 | TreeCheckedStrategy | -- |
| CheckOnClickNode | 属性是否在用户单击树节点时选中复选框。 | Boolean | -- |
| OnBlur | 属性组件失去焦点时执行的回调 | Action | -- |
| TitleTemplate | 属性获取或设置模板以呈现树节点的标题 | RenderFragment<TreeNode<TItem>> | -- |
| TitleIconTemplate | 属性自定义图标模板 | RenderFragment<TreeNode<TItem>> | -- |
| Nodes | 属性要在树中渲染的节点。使用 this 或 AntDesign.TreeSelect'2.DataSource |
TreeNode`1[] | -- |
| DataSource | 属性树的数据源。可以是任何自定义对象类型的列表，方法是提供用于获取 children、leafs、titles 等的表达式。使用 this 或 AntDesign.TreeSelect'2.ChildContent |
IEnumerable<TItem> | -- |
| ChildContent | 属性使用此选项可设置树的内容。使用 this 或 AntDesign.TreeSelect'2.DataSource |
RenderFragment | -- |
| TreeDefaultExpandAll | 属性是否默认展开所有节点 | Boolean | -- |
| TreeDefaultExpandParent | 属性是否默认展开父节点 | Boolean | -- |
| TreeDefaultExpandedKeys | 属性设置默认展开树节点的键 | String[] | -- |
| ExpandOnClickNode | 属性单击树状节点时是否展开父节点 | Boolean | -- |
| SearchExpression | 属性用于指示节点是否与搜索匹配的函数 | Func<TreeNode<TItem>, Boolean> | -- |
| OnSearch | 属性用户搜索值时执行的回调 | EventCallback<String> | -- |
| MatchedStyle | 属性设置匹配文本的样式 | String | -- |
| MatchedClass | 属性设置匹配文本的类 | String | -- |
| RootValue | 属性根节点的值 | String | 0 |
| DropdownMatchSelectWidth | 属性判断下拉菜单和select input是否等宽。默认设置最小宽度与输入相同。当值小于选择宽度时将忽略。 false 将禁用虚拟滚动 | OneOf<Boolean, String> | -- |
| DropdownMaxWidth | 属性下拉列表的最大宽度 | String | auto |
| PopupContainerMaxHeight | 属性下拉列表的最大高度 | String | 256px |
| ShowIcon | 属性显示树节点图标图标 | Boolean | -- |
| ShowLeafIcon | 属性是否显示叶图标 | Boolean | -- |
| TreeAttributes | 属性设置树的属性 | IDictionary<String, Object> | -- |
| OnNodeLoadDelayAsync | 属性加载 Tree 节点时执行的 Callback | EventCallback<TreeEventArgs<TItem>> | -- |
| OnTreeNodeSelect | 属性选择树节点时执行的回调 | EventCallback<TreeEventArgs<TItem>> | -- |
| TitleExpression | 属性指定返回节点文本的方法。 | Func<TreeNode<TItem>, String> | -- |
| DropdownStyle | 属性设置下拉菜单的样式 | String | -- |
| ShowTreeLine | 属性是否在树中显示线 | Boolean | false |
| KeyExpression | 属性指定返回节点键的方法。 | Func<TreeNode<TItem>, String> | -- |
| IconExpression | 属性指定返回节点图标的方法。 | Func<TreeNode<TItem>, String> | -- |
| IsLeafExpression | 属性指定返回表达式是否为叶节点的方法。 | Func<TreeNode<TItem>, Boolean> | -- |
| ChildrenExpression | 属性指定返回节点子节点的方法 | Func<TreeNode<TItem>, IEnumerable<TItem>> | -- |
| DisabledExpression | 属性指定返回禁用节点的方法 | Func<TreeNode<TItem>, Boolean> | -- |
| CheckableExpression | 属性指定返回可勾选节点的方法 | Func<TreeNode<TItem>, Boolean> | -- |
| SelectableExpression | 属性指定返回可选择节点的方法 | Func<TreeNode<TItem>, Boolean> | -- |
| ExpandedKeys | 属性(controlled) 展开指定的树节点 | String[] | -- |
| Value | 属性所选值 | TItemValue | -- |
| Values | 属性所选值 | IEnumerable<TItemValue> | -- |
| BoundaryAdjustMode | 属性叠加调整策略（例如浏览器调整大小时） | TriggerBoundaryAdjustMode | -- |
| AllowClear | 属性显示清除按钮。如果 AntDesign.AntInputComponentBase`1.Value 类型默认值也在 SelectOption 列表中，则无效，除非与 AntDesign.SelectBase`2.ValueOnClear。 |
Boolean | -- |
| AutoClearSearchValue | 属性选择项目时是否清除当前搜索。 | Boolean | -- |
| Disabled | 属性选择组件是否被禁用。 | Boolean | -- |
| Mode | 属性设置选择模式 - 默认 |多个 |标签 | String | -- |
| 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 | -- |
| ValueChanged | 属性用于双向绑定。 | EventCallback<TItemValue> | -- |
| ValuesChanged | 属性用于双向绑定。 | EventCallback<IEnumerable<TItemValue>> | -- |
| SuffixIcon | 属性自定义后缀图标。 | RenderFragment | -- |
| PrefixIcon | 属性自定义前缀图标。 | RenderFragment | -- |
| AccessKey | 属性accesskey 全局属性。 | String | -- |
| DefaultValues | 属性Mode = multiple | 时使用tags - 这些值在初始化期间和在 Forms 中按下 Reset 按钮时使用。 | IEnumerable<TItemValue> | -- |
| OnClearSelected | 属性当用户清除选择时调用。 | EventCallback | -- |
| OnSelectedItemChanged | 属性当所选项目更改时调用。 | EventCallback<TItem> | -- |
| OnSelectedItemsChanged | 属性当所选项目更改时调用。 | EventCallback<IEnumerable<TItem>> | -- |
| CustomTagLabelToValue | 属性将自定义标签（字符串）转换为 TItemValue 类型。 | Func<String, TItemValue> | -- |
| SelectOptions | 属性用于手动呈现选择选项。 | RenderFragment | -- |
| 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 | -- |
| ShowArrowIcon | 属性 | Boolean | -- |
| ValidationMessages | FormItem 的验证消息 | String[] | -- |
| AdditionalAttributes | 属性获取或设置将应用于所创建元素的附加属性的集合。 | IReadOnlyDictionary<String, Object> | -- |
| ValueExpression | 属性标识绑定值的表达式。 | Expression<Func<TItemValue>> | -- |
| ValuesExpression | 属性标识可枚举绑定值的表达式。 | Expression<Func<IEnumerable<TItemValue>>> | -- |
| Size | 属性输入框的大小。注意：在表单的上下文中，使用“大”尺寸。可用：`大``默认``小` | String | AntSizeLDSType.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 | -- |
| 方法签名 | 返回类型 | 描述 |
|---|---|---|
| CheckAll() | void | 检查所有节点 |
| UncheckAll() | void | 取消选中所有节点 |
| SelectAll() | void | 选择所有节点 |
| DeselectAll() | void | 取消选择所有节点 |
| ExpandAll(Func<TreeNode<TItem>, Boolean> predicate, Boolean recursive) | void | 展开所有节点 |
| CollapseAll(Func<TreeNode<TItem>, Boolean> predicate, Boolean recursive) | void | 折叠所有节点 |
| GetNode(TItemValue key) | TreeNode<TItem> | 按键获取 TreeNode |