@dt-frames/ui 2.0.24 → 4.0.1

package/dist/es/components/tree/src/types/index.ts

@@ -0,0 +1,788 @@
+import type { Recordable } from '@dt-frames/core'
+import type { TreeData, TreeKey, TreeNode, TreeNodeData, ElTooltipProps } from 'element-plus'
+import type { Component, ComputedRef, CSSProperties, Ref, VNode } from 'vue'
+
+type TreeActionType = {
+	/**
+	 * 按钮名称
+	 */
+	label?: string
+	/**
+	 * 是否显示label
+	 */
+	showLabel?: boolean
+	/**
+	 * 图标tooltip样式设置
+	 */
+	toolTipProps?: ElTooltipProps
+	/**
+	 * 按钮颜色
+	 */
+	color?: string
+	/**
+	 * 按钮class
+	 */
+	class?: string
+	/**
+	 * 是否禁用
+	 */
+	disabled?: boolean | ((row: Recordable) => boolean) | Ref<boolean>
+	/**
+	 * 是否显示
+	 */
+	show?: boolean | ((row: Recordable) => boolean)
+	/**
+	 * 按钮图标
+	 */
+	icon?: string | Component
+	/**
+	 * 图标大小
+	 */
+	iconSize?: number
+	/**
+	 * 按钮权限
+	 */
+	auth?: string
+
+	/**
+	 * 按钮点击事件
+	 */
+	onClick?: (...args: any) => any
+}
+
+/**
+ * 在官方文档的基础上 新添加的属性
+ */
+type ExtraTreeType = {
+	/**
+	 * 标题
+	 */
+	title?: string
+	/**
+	 * 是否显示右侧快捷操作树的功能
+	 * @default true
+	 */
+	enableToolbar?: boolean
+	/**
+	 * 工具条的位置
+	 */
+	toolbarPos?: 'left' | 'right'
+	/**
+	 * 是否显示过滤条件
+	 * @default true
+	 */
+	enableFilter?: boolean
+	/**
+	 * 节点右侧的操作按钮
+	 */
+	buttons?: (node: any) => TreeActionType[]
+	/**
+	 * 是否仅仅在悬浮时候才显示buttons
+	 * @default true
+	 */
+	hoverButtons?: boolean
+}
+
+/**
+ * element-plus虚拟化树形控件的属性
+ * 地址：https://element-plus.org/zh-CN/component/tree
+ */
+type TreeType = {
+	/**
+	 * 展示数据
+	 */
+	data?:
+		| Array<{ [key: string]: any }>
+		| Ref<Array<{ [key: string]: any }>>
+		| ComputedRef<Array<{ [key: string]: any }>>
+	/**
+	 * 内容为空的时候展示的文本
+	 */
+	emptyText?: string
+	/**
+	 * 每个树节点用来作为唯一标识的属性，整棵树应该是唯一的
+	 */
+	nodeKey?: string
+	/**
+	 * 配置选项，具体看下表
+	 */
+	props?: {
+		/**
+		 * 指定节点标签为节点对象的某个属性值
+		 */
+		label?: string | ((data: any, node: any) => string)
+		/**
+		 * 指定子树为节点对象的某个属性值
+		 */
+		children?: string
+		/**
+		 * 指定节点选择框是否禁用为节点对象的某个属性值
+		 */
+		disabled?: string | ((data: any, node: any) => boolean)
+		/**
+		 * 指定节点是否为叶子节点，仅在指定了 lazy 属性的情况下生效
+		 */
+		isLeaf?: string | ((data: any, node: any) => boolean)
+		/**
+		 * 自定义节点类名
+		 */
+		class?: string | ((data: any, node: any) => boolean)
+	}
+	/**
+	 * 是否在第一次展开某个树节点后才渲染其子节点
+	 * @default true
+	 */
+	renderAfterExpand?: boolean
+	/**
+	 * 加载子树数据的方法，仅当 lazy 属性为true 时生效
+	 */
+	load?: (node: any, resolve?: (data: any) => void, reject?: (data: any) => void) => void
+	/**
+	 * 树节点的内容区的渲染 Function
+	 */
+	renderContent?: (h: any, { node, data, store }: any) => void
+	/**
+	 * 是否默认展开所有节点
+	 * @default false
+	 */
+	defaultExpandAll?: boolean
+	/**
+	 * 是否在点击节点的时候展开或者收缩节点， 默认值为 true，如果为 false，则只有点箭头图标的时候才会展开或者收缩节点
+	 * @default true
+	 */
+	expandOnClickNode?: boolean
+	/**
+	 * 是否在点击节点的时候选中节点，默认值为 false，即只有在点击复选框时才会选中节点。
+	 * @default false
+	 */
+	checkOnClickNode?: boolean
+	/**
+	 * 点击叶节点(最后一个子节点)时是否选中或取消选中节点。
+	 * @default true
+	 */
+	checkOnClickLeaf?: boolean
+	/**
+	 * 展开子节点的时候是否自动展开父节点
+	 * @default true
+	 */
+	autoExpandParent?: boolean
+	/**
+	 * 默认展开的节点的 key 的数组
+	 */
+	defaultExpandedKeys?: Array<string | number>
+	/**
+	 * 节点是否可被选择
+	 * @default false
+	 */
+	showCheckbox?: boolean
+	/**
+	 * 在显示复选框的情况下，是否严格的遵循父子不互相关联的做法
+	 * @default false
+	 */
+	checkStrictly?: boolean
+	/**
+	 * 默认勾选的节点的 key 的数组
+	 */
+	defaultCheckedKeys?: Array<string | number>
+	/**
+	 * 当前选中的节点
+	 */
+	currentNodeKey?: string | number
+	/**
+	 * 对树节点进行筛选时执行的方法， 返回 false 则表示这个节点会被隐藏
+	 */
+	filterNodeMethod?: (value: string, data: any, node: any) => boolean
+	/**
+	 * 是否每次只打开一个同级树节点展开
+	 * @default false
+	 */
+	accordion?: boolean
+	/**
+	 * 相邻级节点间的水平缩进，单位为像素
+	 * @default 18
+	 */
+	indent?: number
+	/**
+	 * 自定义树节点图标组件
+	 */
+	icon?: string | Component
+	/**
+	 * 是否懒加载子节点，需与 load 方法结合使用
+	 * @default false
+	 */
+	lazy?: boolean
+	/**
+	 * 是否开启拖拽节点功能
+	 * @default false
+	 */
+	draggable?: boolean
+	/**
+	 * 判断节点能否被拖拽 如果返回 false ，节点不能被拖动
+	 */
+	allowDrag?: (node: any) => boolean
+	/**
+	 * 拖拽时判定目标节点能否成为拖动目标位置。 如果返回 false ，拖动节点不能被拖放到目标节点。 type 参数有三种情况：'prev'、'inner' 和 'next'，分别表示放置在目标节点前、插入至目标节点和放置在目标节点后
+	 */
+	allowDrop?: (draggingNode: any, dropNode: any, type: string) => boolean
+	/**
+	 * 当节点被点击的时候触发
+	 *
+	 * @description
+	 * 		四个参数：对应于节点点击的节点对象，TreeNode 的 node 属性, TreeNode和事件对象
+	 */
+	onNodeClick?: (dom: Element, node: any, nodes: any[], e: any) => void
+	/**
+	 * 当某一节点被鼠标右键点击时会触发该事件
+	 *
+	 * @description
+	 * 		共四个参数，依次为：event、传递给 data 属性的数组中该节点所对应的对象、节点对应的 Node、节点组件本身。
+	 */
+	onNodeContextmenu?: (e: any, node: any, dom: Element, d: any) => ContextMenuItem[]
+	/**
+	 * 当复选框被点击的时候触发
+	 *
+	 * @description
+	 * 		共三个参数，依次为：传递给 data 属性的数组中该节点所对应的对象、节点本身是否被选中、节点的子树中是否有被选中的节点
+	 */
+	onCheckChange?: (node: any, checked: boolean, childrenHasChecked: boolean) => void
+	/**
+	 * 点击节点复选框之后触发
+	 *
+	 * @description
+	 * 		共两个参数，依次为：传递给 data 属性的数组中该节点所对应的对象、树目前的选中状态对象，包含
+	 * 		checkedNodes、checkedKeys、halfCheckedNodes、halfCheckedKeys 四个属性
+	 */
+	onCheck?: (node: any, status: any) => void
+	/**
+	 * 当前选中节点变化时触发的事件
+	 *
+	 * @description
+	 * 		共两个参数，依次为：当前节点的数据，当前节点的 Node 对象
+	 */
+	onCurrentChange?: (node: any, nodeComponent: any) => void
+	/**
+	 * 节点被展开时触发的事件
+	 *
+	 * @description
+	 * 		共三个参数，依次为：传递给 data 属性的数组中该节点所对应的对象、节点对应的 Node、节点组件本身
+	 */
+	onNodeExpand?: (node: any, nodeComponent: any, dom: Element) => void
+	/**
+	 * 节点被关闭时触发的事件
+	 *
+	 * @description
+	 * 		共三个参数，依次为：传递给 data 属性的数组中该节点所对应的对象、节点对应的 Node、节点组件本身
+	 */
+	onNodeCollapse?: (node: any, nodeComponent: any, dom: Element) => void
+	/**
+	 * 节点开始拖拽时触发的事件
+	 *
+	 * @description
+	 * 		共两个参数，依次为：被拖拽节点对应的 Node、event
+	 */
+	onNodeDragStart?: (node: any, e: any) => void
+	/**
+	 * 拖拽进入其他节点时触发的事件
+	 *
+	 * @description
+	 * 		共三个参数，依次为：被拖拽节点对应的 Node、所进入节点对应的 Node、event
+	 */
+	onNodeDragEnter?: (draggingNode: any, dropNode: any, e: any) => void
+	/**
+	 * 拖拽离开某个节点时触发的事件
+	 *
+	 * @description
+	 * 		共三个参数，依次为：被拖拽节点对应的 Node、所离开节点对应的 Node、event
+	 */
+	onNodeDragLeave?: (draggingNode: any, dropNode: any, e: any) => void
+	/**
+	 * 在拖拽节点时触发的事件（类似浏览器的 mouseover 事件）
+	 *
+	 * @description
+	 * 		共三个参数，依次为：被拖拽节点对应的 Node、当前进入节点对应的 Node、event
+	 */
+	onNodeDragOver?: (draggingNode: any, dropNode: any, e: any) => void
+	/**
+	 * 拖拽结束时（可能未成功）触发的事件
+	 *
+	 * @description
+	 * 		共四个参数，依次为：被拖拽节点对应的 Node、结束拖拽时最后进入的节点（可能为空）、被拖拽节点的放置位置（before、after、inner）、event
+	 */
+	onNodeDragEnd?: (draggingNode: any, dropNode: any, dropPosition: string, e: any) => void
+	/**
+	 * 拖拽成功完成时触发的事件
+	 *
+	 * @description
+	 * 		共四个参数，依次为：被拖拽节点对应的 Node、结束拖拽时最后进入的节点、被拖拽节点的放置位置（before、after、inner）、event
+	 */
+	onNodeDrop?: (draggingNode: any, dropNode: any, dropPosition: string, e: any) => void
+
+	/**
+	 * 当数据为空时自定义的内容
+	 */
+	emptySlot?: () => Component | string | VNode | number
+
+	[key: string]: any
+}
+
+/**
+ * element-plus虚拟化树形控件的属性
+ * 地址：https://element-plus.org/zh-CN/component/tree-v2
+ */
+type VirtualTreeType = {
+	/**
+	 * 展示数据
+	 */
+	data?:
+		| Array<{ [key: string]: any }>
+		| Ref<Array<{ [key: string]: any }>>
+		| ComputedRef<Array<{ [key: string]: any }>>
+	/**
+	 * 内容为空的时候展示的文本
+	 */
+	emptyText?: string
+	/**
+	 * 配置选项，具体看下表
+	 */
+	props?: {
+		/**
+		 * 每个树节点用来作为唯一标识的属性，在整棵树中应该是唯一的
+		 * @default id
+		 */
+		value?: string
+		/**
+		 * 指定节点标签为节点对象的某个属性值
+		 * @default label
+		 */
+		label?: string
+		/**
+		 * 指定子树为节点对象的某个属性值
+		 * @default children
+		 */
+		children?: string
+		/**
+		 * 指定节点选择框是否禁用为节点对象的某个属性值
+		 * @default disabled
+		 */
+		disabled?: string
+		/**
+		 * 自定义节点类名
+		 */
+		class?:
+			| string
+			| ((data: TreeNodeData, node: TreeNode) => string | { [key: string]: boolean })
+	}
+	/**
+	 * 是否高亮当前选中节点
+	 * @default true
+	 */
+	highlightCurrent?: boolean
+	/**
+	 * 是否在点击节点的时候展开或者收缩节点， 默认值为 true，如果为 false，则只有点箭头图标的时候才会展开或者收缩节点
+	 * @default true
+	 */
+	expandOnClickNode?: boolean
+	/**
+	 * 是否在点击节点的时候选中节点，默认值为 false，即只有在点击复选框时才会选中节点
+	 * @default false
+	 */
+	checkOnClickNode?: boolean
+	/**
+	 * 点击叶节点(最后一个子节点)时是否检查或取消节点
+	 * @default true
+	 */
+	checkOnClickLeaf?: boolean
+	/**
+	 * 默认展开的节点的 key 的数组
+	 */
+	defaultExpandedKeys?: Array<string | number>
+	/**
+	 * 节点是否可被选择
+	 * @default false
+	 */
+	showCheckbox?: boolean
+	/**
+	 * 在显示复选框的情况下，是否严格的遵循父子不互相关联的做法
+	 * @default false
+	 */
+	checkStrictly?: boolean
+	/**
+	 * 默认勾选的节点的 key 的数组
+	 */
+	defaultCheckedKeys?: Array<string | number>
+	/**
+	 * 当前选中的节点
+	 */
+	currentNodeKey?: string | number
+	/**
+	 * 对树节点进行筛选时执行的方法，返回 true 表示这个节点可以显示， 返回 false 则表示这个节点会被隐藏
+	 */
+	filterMethod?: (query: string, data: TreeNodeData, node: TreeNode) => boolean
+	/**
+	 * 相邻级节点间的水平缩进，单位为像素
+	 * @default 16
+	 */
+	indent?: number
+	/**
+	 * 自定义树节点图标组件
+	 */
+	icon?: string | Component
+	/**
+	 * 自定义树节点的高度
+	 * @default 26
+	 */
+	itemSize?: number
+	/**
+	 * 总是显示滚动条
+	 * @default false
+	 */
+	scrollbarAlwaysOn?: boolean
+	/**
+	 * tree 的高度
+	 * @default 200
+	 */
+	height?: number
+	/**
+	 * 当节点被点击的时候触发
+	 */
+	onNodeClick?: (data: TreeNodeData, node: TreeNode, e: MouseEvent) => void
+	/**
+	 * 拖放到节点时触发器
+	 */
+	onNodeDrop?: (data: TreeNodeData, node: TreeNode, e: DragEvent) => void
+	/**
+	 * 当某一节点被鼠标右键点击时会触发该事件
+	 */
+	onNodeContextmenu?: (e: Event, data: TreeNodeData, node: TreeNode) => ContextMenuItem[]
+	/**
+	 * 当复选框被点击的时候触发
+	 */
+	onCheckChange?: (data: TreeNodeData, checked: boolean) => void
+	/**
+	 * 点击节点复选框之后触发
+	 */
+	onCheck?: (
+		data: TreeNodeData,
+		info: {
+			checkedKeys: TreeKey[]
+			checkedNodes: TreeData
+			halfCheckedKeys: TreeKey[]
+			halfCheckedNodes: TreeData
+		}
+	) => void
+	/**
+	 * 当前选中节点变化时触发的事件
+	 */
+	onCurrentChange?: (data: TreeNodeData, node: TreeNode) => void
+	/**
+	 * 节点被展开时触发的事件
+	 */
+	onNodeExpand?: (data: TreeNodeData, node: TreeNode) => void
+	/**
+	 * 节点被关闭时触发的事件
+	 */
+	onNodeCollapse?: (data: TreeNodeData, node: TreeNode) => void
+
+	[key: string]: any
+}
+
+/**
+ * 批量暴露的方法
+ */
+type CommonTreeRef = {
+	/**
+	 * 设置树的相关属性
+	 */
+	setProps: (props: TreeType | VirtualTreeType) => void
+	/**
+	 * 选中|取消选中所有复选框
+	 */
+	checkAll: (checkAll: boolean) => void
+	/**
+	 * 展开所有的树节点
+	 */
+	expandAll: (expandAll: boolean) => void
+}
+
+/**
+ * 暴露的方法
+ */
+type TreeRef = {
+	/**
+	 * 过滤所有树节点，过滤后的节点将被隐藏
+	 *
+	 * @description 接收一个参数并指定为 filter-node-method 属性的第一个参数
+	 */
+	filter: (value: string) => void
+	/**
+	 * 为节点设置新数据，只有当设置 node-key 属性的时候才可用
+	 *
+	 * @description
+	 * 		(key, data) 接收两个参数: 1. 节点的 key 2. 新数据
+	 */
+	updateKeyChildren: (key: string, data: any) => void
+	/**
+	 * 如果节点可以被选中，(show-checkbox 为 true), 本方法将返回当前选中节点的数组
+	 *
+	 * @description
+	 * 		(leafOnly, includeHalfChecked) 接收两个布尔类型参数: 1. 默认值为 false. 若参数为 true,
+	 * 		它将返回当前选中节点的子节点 2. 默认值为 false. 如果参数为 true, 返回值包含半选中节点数据
+	 */
+	getCheckedNodes: (leafOnly?: boolean, includeHalfChecked?: boolean) => any[]
+	/**
+	 * 设置目前选中的节点，使用此方法必须设置 node-key 属性
+	 *
+	 * @description
+	 * 		(nodes, leafOnly) 接收两个参数: 1. 要选中的节点对象构成的数组 2. 布尔类型的值 如果设置为
+	 * 		true，将只设置选中的叶子节点状态。 默认值是 false.
+	 */
+	setCheckedNodes: (nodes: any[], leafOnly?: boolean) => void
+	/**
+	 * 若节点可用被选中 (show-checkbox 为 true), 它将返回当前选中节点 key 的数组
+	 *
+	 * @description
+	 * 		(leafOnly) 接收一个布尔类型参数，默认为 false. 若参数为 true, 它将返回当前选中节点的子节点
+	 */
+	getCheckedKeys: (leafOnly?: boolean) => string[]
+	/**
+	 * 设置目前选中的节点，使用此方法必须设置 node-key 属性
+	 *
+	 * @description
+	 * 		(keys, leafOnly) 接收两个参数: 1. 一个需要被选中的多节点 key 的数组 2. 布尔类型的值 如果
+	 * 		设置为 true，将只设置选中的叶子节点状态。 默认值是 false.
+	 */
+	setCheckedKeys: (keys: string[], leafOnly?: boolean) => void
+	/**
+	 * 设置节点是否被选中, 使用此方法必须设置 node-key 属性
+	 *
+	 * @description
+	 * 		(key/data, checked, deep) 接收三个参数: 1. 要选中的节点的 key 或者数据 2. 一个布尔类型参数表明是否选中. 3. 一个布尔类型的参数，用于指示是否为深层（deep）操作（注意：check-strictly 必须为 false）
+	 */
+	setChecked: (key: string | any, checked: boolean, deep?: boolean) => void
+	/**
+	 * 如果节点可用被选中 (show-checkbox 为 true), 它将返回当前半选中的节点组成的数组
+	 */
+	getHalfCheckedNodes: () => any[]
+	/**
+	 * 若节点可被选中(show-checkbox 为 true)，则返回目前半选中的节点的 key 所组成的数组
+	 */
+	getHalfCheckedKeys: () => string[]
+	/**
+	 * 返回当前被选中节点的数据 (如果没有则返回 null)
+	 */
+	getCurrentKey: () => any
+	/**
+	 * 返回当前被选中节点的数据 (如果没有则返回 null)
+	 */
+	getCurrentNode: () => any
+	/**
+	 * 通过 key 设置某个节点的当前选中状态，使用此方法必须设置 node-key  属性
+	 *
+	 * @description
+	 * 		(key, shouldAutoExpandParent=true) 1. 待被选节点的 key， 如果为 null, 取消当前选
+	 * 		中的节点 2. 是否展开父节点
+	 */
+	setCurrentKey: (key: string | null, shouldAutoExpandParent?: boolean) => void
+	/**
+	 * 设置节点为选中状态，使用此方法必须设置 node-key 属性
+	 *
+	 * @description
+	 * 		(node, shouldAutoExpandParent=true) 1. 待被选中的节点 2. 是否展开父节点
+	 */
+	setCurrentNode: (node: any, shouldAutoExpandParent?: boolean) => void
+	/**
+	 * 根据 data 或者 key 拿到 Tree 组件中的 node
+	 *
+	 * @description
+	 * 		(data) 节点的 data 或 key
+	 */
+	getNode: (data: any) => any
+	/**
+	 * 删除 Tree 中的一个节点，使用此方法必须设置 node-key 属性
+	 *
+	 * @description
+	 * 		(data) 要删除的节点的 data 或者 node 对象
+	 */
+	remove: (data: any) => void
+	/**
+	 * 为 Tree 中的一个节点追加一个子节点
+	 *
+	 * @description
+	 * 		(data, parentNode) 1. 要追加的子节点的 data 2. 父节点的 data, key 或 node
+	 */
+	append: (data: any, parentNode: any) => void
+	/**
+	 * 在 Tree 中给定节点前插入一个节点
+	 *
+	 * @description
+	 * 		(data, refNode) 1. 要增加的节点的 data 2. 参考节点的 data, key 或 node
+	 */
+	insertBefore: (data: any, refNode: any) => void
+	/**
+	 * 在 Tree 中给定节点后插入一个节点
+	 *
+	 * @description
+	 * 		(data, refNode) 1. 要增加的节点的 data 2. 参考节点的 data, key 或 node
+	 */
+	insertAfter: (data: any, refNode: any) => void
+} & CommonTreeRef
+
+type VirtualTreeRef = {
+	/**
+	 * 过滤所有树节点，过滤后的节点将被隐藏
+	 */
+	filter: (query: string) => void
+	/**
+	 * 如果节点可以被选中，(show-checkbox 为 true), 本方法将返回当前选中节点的数组
+	 */
+	getCheckedNodes: (leafOnly: boolean) => void
+	/**
+	 * 若节点可用被选中 (show-checkbox 为 true), 它将返回当前选中节点 key 的数组
+	 */
+	getCheckedKeys: (leafOnly: boolean) => void
+	/**
+	 * 通过 keys 设置目前勾选的节点
+	 */
+	setCheckedKeys: (keys: TreeKey[]) => void
+	/**
+	 * 通过 key 设置某个节点的勾选状态
+	 */
+	setChecked: (key: TreeKey, checked: boolean) => void
+	/**
+	 * 设置当前展开的节点
+	 */
+	setExpandedKeys: (keys: TreeKey[]) => void
+	/**
+	 * 如果节点可用被选中 (show-checkbox 为 true), 它将返回当前半选中的节点组成的数组
+	 */
+	getHalfCheckedNodes: () => void
+	/**
+	 * 若节点可被选中(show-checkbox 为 true)，则返回目前半选中的节点的 key 所组成的数组
+	 */
+	getHalfCheckedKeys: () => void
+	/**
+	 * 获取当前被选中节点的 key，若没有节点被选中则返回 undefined
+	 */
+	getCurrentKey: () => void
+	/**
+	 * 获取当前被选中节点的 data，若没有节点被选中则返回 undefined
+	 */
+	getCurrentNode: () => void
+	/**
+	 * 通过 key 设置某个节点的当前选中状态
+	 */
+	setCurrentKey: (key: TreeKey) => void
+	/**
+	 * 通过 key 或 data 获取节点
+	 */
+	getNode: (data: TreeKey | TreeNodeData) => void
+	/**
+	 * 展开指定节点
+	 */
+	expandNode: (node: TreeNode) => void
+	/**
+	 * 折叠指定节点
+	 */
+	collapseNode: (node: TreeNode) => void
+	/**
+	 * 当数据量非常庞大的时候，总是使用响应式数据将导致性能表现不佳，所以我们提供一种显式设置的方式来避免此种情况
+	 */
+	setData: (data: TreeData) => void
+	/**
+	 * 滚动到给定位置
+	 */
+	scrollTo: (offset: number) => void
+	/**
+	 * 使用给定的滚动策略滚动至指定位置
+	 */
+	scrollToNode: (key: TreeKey, strategy?: 'auto' | 'smart' | 'center' | 'start' | 'end') => void
+} & CommonTreeRef
+
+type _TreeProp<TreeType, T> = {
+	type?: TreeType
+} & T
+
+type TreeProp =
+	| (_TreeProp<'virtual', VirtualTreeType> & ExtraTreeType)
+	| (_TreeProp<undefined | '', TreeType> & ExtraTreeType)
+
+type CheckKeys =
+	| KeyType[]
+	| {
+			checked: string[] | number[]
+			halfChecked: string[] | number[]
+	  }
+
+interface TreeState {
+	expandedKeys: TreeKey[]
+	selectedKeys: TreeKey[]
+	checkedKeys: TreeKey[]
+	checkStrictly: boolean
+}
+
+export interface ContextMenuItem {
+	label: string
+	icon?: string | Component
+	hidden?: boolean
+	disabled?: boolean
+	handler?: Function
+	divider?: boolean
+	children?: ContextMenuItem[]
+}
+
+/**
+ * 树的右键组件传值参数
+ */
+type TreeContextMenuType = {
+	/**
+	 * 右键弹框宽度
+	 * @default 106
+	 */
+	width: number
+	/**
+	 * 鼠标事件对象
+	 */
+	customEvent: Event
+	/**
+	 * 弹框样式
+	 */
+	styles: CSSProperties
+	/**
+	 * 是否显示图标
+	 * @default true
+	 */
+	showIcon?: boolean
+	/**
+	 * 位置信息
+	 */
+	axis: {
+		x: number
+		y: number
+	}
+	/**
+	 * 右键事件
+	 */
+	items: ContextMenuItem[]
+	/**
+	 * 节点
+	 */
+	node: Recordable
+}
+
+type ItemContentProps = {
+	showIcon: boolean | undefined
+	item: ContextMenuItem
+	handler: Function
+}
+
+export type {
+	TreeType,
+	TreeRef,
+	VirtualTreeType,
+	VirtualTreeRef,
+	TreeProp,
+	TreeState,
+	CheckKeys,
+	TreeContextMenuType,
+	ItemContentProps
+}