当前位置:   article > 正文

React TreeSelect 组件使用和优化

react treeselect

1、自定义折叠和展开图标

此时就要用到switcherIcon属性,以下是antd中对switcherIcon属性的描述,

switcherIcon自定义树节点的展开/折叠图标ReactNode | ((props: AntTreeNodeProps) => ReactNode)-

具体使用如下:

  1. import { DownOutlined } from '@ant-design/icons';
  2. ...
  3. <TreeSelect
  4. switcherIcon={<DownOutlined />}
  5. ...
  6. />

2、如何在title后添加任意组件

例如添加Rate组件,其实就是 treeData 数据中title定义为ReactNode类型,

 代码如下

  1. const desc = ['terrible', 'bad', 'normal', 'good', 'wonderful'];
  2. [{
  3. key: '重量', selectable: false, value: '重量',
  4. title: (
  5. <span style={{ color: '#212529' }} >
  6. 重量
  7. </span><Rate style={{marginLeft:'18px'}} tooltips={desc} value="3" /></>
  8. ),}]

3、如何优化展开或者收缩功能,使用更人性化

用户反馈每次点击前面的收缩和展开按钮,位置太小,体验很不好,要是能点击当前行的任意位置都可以展开和收缩,那该多好,效果如下图所示

但是看了Antd 中TreeSelect组件,若不做调整优化,只有点击收缩图标才能展开或者收缩,体验很不好

 例如上图看到的效果,点击文字却不能收缩或者展开,用户想要的效果是这样的,点击的一级节点任意位置都可以收缩或者展开,同时也可以搜索,搜索就要用到TreeSelect的onSearch属性

 想要实现上述效果,要用到的组件TreeSelct组件的onTreeExpand、treeExpandedKeys

  1. <TreeSelect
  2. onSelect={(value) => {
  3. props.onChange && props.onChange(value);
  4. }}
  5. // 搜索框输入值后触发,需过滤后数据并展开
  6. onSearch={(value) => {
  7. filterSearchValue(value);
  8. }}
  9. style={{
  10. width: '100%',
  11. }}
  12. onTreeExpand={(data) => {
  13. setExpandedKeys([...(data || [])]);
  14. }}
  15. // 点击文本展开或者收缩
  16. onClick={(event) => {
  17. ...
  18. }}
  19. treeExpandedKeys={expandedKeys}
  20. value={value}
  21. dropdownStyle={{
  22. maxHeight: 400,
  23. overflow: 'auto',
  24. }}
  25. treeData={unitTreeData}
  26. placeholder="Please select"
  27. // treeDefaultExpandAll // 是否默认展开
  28. onChange={onChange}
  29. />
  30. </>

下面我来下antd 中TreeSelect有哪些属性,

参数说明类型默认值版本
allowClear显示清除按钮booleanfalse
autoClearSearchValue当多选模式下值被选择,自动清空搜索框booleantrue
bordered是否显示边框booleantrue
defaultValue指定默认选中的条目string | string[]-
disabled是否禁用booleanfalse
popupClassName下拉菜单的 className 属性string-4.23.0
dropdownMatchSelectWidth下拉菜单和选择器同宽。默认将设置 min-width,当值小于选择框宽度时会被忽略。false 时会关闭虚拟滚动boolean | numbertrue
dropdownRender自定义下拉框内容(originNode: ReactNode, props) => ReactNode-
dropdownStyle下拉菜单的样式object-
fieldNames自定义节点 label、value、children 的字段object{ label: label, value: value, children: children }4.17.0
filterTreeNode是否根据输入项进行筛选,默认用 treeNodeFilterProp 的值作为要筛选的 TreeNode 的属性值boolean | function(inputValue: string, treeNode: TreeNode) (函数需要返回 bool 值)function
getPopupContainer菜单渲染父节点。默认渲染到 body 上,如果你遇到菜单滚动定位问题,试试修改为滚动的区域,并相对其定位。示例function(triggerNode)() => document.body
labelInValue是否把每个选项的 label 包装到 value 中,会把 value 类型从 string 变为 {value: string, label: ReactNode, halfChecked(treeCheckStrictly 时有效): string[] } 的格式booleanfalse
listHeight设置弹窗滚动高度number256
loadData异步加载数据function(node)-
maxTagCount最多显示多少个 tag,响应式模式会对性能产生损耗number | responsive-responsive: 4.10
maxTagPlaceholder隐藏 tag 时显示的内容ReactNode | function(omittedValues)-
multiple支持多选(当设置 treeCheckable 时自动变为 true)booleanfalse
notFoundContent当下拉列表为空时显示的内容ReactNodeNot Found
placeholder选择框默认文字string-
placement选择框弹出的位置bottomLeft bottomRight topLeft topRightbottomLeft
searchValue搜索框的值,可以通过 onSearch 获取用户输入string-
showArrow是否显示 suffixIcon,单选模式下默认 trueboolean-
showCheckedStrategy配置 treeCheckable 时,定义选中项回填的方式。TreeSelect.SHOW_ALL: 显示所有选中节点(包括父节点)。TreeSelect.SHOW_PARENT: 只显示父节点(当父节点下所有子节点都选中时)。 默认只显示子节点TreeSelect.SHOW_ALL | TreeSelect.SHOW_PARENT | TreeSelect.SHOW_CHILDTreeSelect.SHOW_CHILD
showSearch是否支持搜索框boolean单选:false | 多选:true
size选择框大小large | middle | small-
status设置校验状态'error' | 'warning'-4.19.0
suffixIcon自定义的选择框后缀图标, 多选模式下必须同时设置 showArrow 为 trueReactNode-
switcherIcon自定义树节点的展开/折叠图标ReactNode | ((props: AntTreeNodeProps) => ReactNode)-renderProps: 4.20.0
tagRender自定义 tag 内容,多选时生效(props) => ReactNode-
treeCheckable显示 Checkboxbooleanfalse
treeCheckStrictlycheckable 状态下节点选择完全受控(父子节点选中状态不再关联),会使得 labelInValue 强制为 truebooleanfalse
treeDatatreeNodes 数据,如果设置则不需要手动构造 TreeNode 节点(value 在整个树范围内唯一)array<{value, title, children, [disabled, disableCheckbox, selectable, checkable]}>[]
treeDataSimpleMode使用简单格式的 treeData,具体设置参考可设置的类型 (此时 treeData 应变为这样的数据结构: [{id:1, pId:0, value:'1', title:"test1",...},...], pId 是父节点的 id)boolean | object<{ id: string, pId: string, rootPId: string }>false
treeDefaultExpandAll默认展开所有树节点booleanfalse
treeDefaultExpandedKeys默认展开的树节点string[]-
treeExpandAction点击节点 title 时的展开逻辑,可选:false | click | doubleClickstring | booleanfalse4.21.0
treeExpandedKeys设置展开的树节点string[]-
treeIcon是否展示 TreeNode title 前的图标,没有默认样式,如设置为 true,需要自行定义图标相关样式booleanfalse
treeLine是否展示线条样式,请参考 Tree - showLineboolean | objectfalse4.17.0
treeLoadedKeys(受控)已经加载的节点,需要配合 loadData 使用string[][]
treeNodeFilterProp输入项过滤对应的 treeNode 属性stringvalue
treeNodeLabelProp作为显示的 prop 设置stringtitle
value指定当前选中的条目string | string[]-
virtual设置 false 时关闭虚拟滚动booleantrue4.1.0
onChange选中树节点时调用此函数function(value, label, extra)-
onDropdownVisibleChange展开下拉菜单的回调function(open)-
onSearch文本框值变化时的回调function(value: string)-
onSelect被选中时调用function(value, node, extra)-
onTreeExpand展示节点时调用function(expandedKeys)-

Tree 方法#

名称描述版本
blur()移除焦点
focus()获取焦点

TreeNode props#

建议使用 treeData 来代替 TreeNode,免去手工构造麻烦

参数说明类型默认值版本
checkable当树为 Checkbox 时,设置独立节点是否展示 Checkboxboolean-
disableCheckbox禁掉 Checkboxbooleanfalse
disabled是否禁用booleanfalse
isLeaf是否是叶子节点booleanfalse
key此项必须设置(其值在整个树范围内唯一)string-
selectable是否可选booleantrue
title树节点显示的内容ReactNode---
value默认根据此属性值进行筛选(其值在整个树范围内唯一)string-

 参考:树选择 TreeSelect - Ant Design

核心就是treeExpandedKeys可控,用户自定义treeExpandedKeys,若是需要源码的可以私信留言。

关键词:TreeSelect 、Antd、树形控件、React

本文内容由网友自发贡献,转载请注明出处:https://www.wpsshop.cn/w/不正经/article/detail/94815
推荐阅读
相关标签
  

闽ICP备14008679号