element-plus
Version:
A Component Library for Vue 3
37 lines (36 loc) • 1.92 kB
TypeScript
import type { SetupContext } from 'vue';
import type { treeEmits } from '../virtual-tree';
import type { CheckboxValueType } from 'element-plus/es/components/checkbox';
import type { Tree, TreeData, TreeKey, TreeNode, TreeNodeData, TreeProps } from '../types';
export declare function useTree(props: TreeProps, emit: SetupContext<typeof treeEmits>['emit']): {
tree: import("vue").ShallowRef<Tree | undefined>;
flattenTree: import("vue").ComputedRef<TreeNode[]>;
isNotEmpty: import("vue").ComputedRef<boolean>;
getKey: (node: TreeNodeData) => TreeKey;
getChildren: (node: TreeNodeData) => TreeNodeData[];
toggleExpand: (node: TreeNode) => void;
toggleCheckbox: (node: TreeNode, isChecked: CheckboxValueType, nodeClick?: boolean) => void;
isExpanded: (node: TreeNode) => boolean;
isChecked: (node: TreeNode) => boolean;
isIndeterminate: (node: TreeNode) => boolean;
isDisabled: (node: TreeNode) => boolean;
isCurrent: (node: TreeNode) => boolean;
isForceHiddenExpandIcon: (node: TreeNode) => boolean;
handleNodeClick: (node: TreeNode, e: MouseEvent) => void;
handleNodeCheck: (node: TreeNode, checked: CheckboxValueType) => void;
getCurrentNode: () => TreeNodeData | undefined;
getCurrentKey: () => TreeKey | undefined;
setCurrentKey: (key: TreeKey) => void;
getCheckedKeys: (leafOnly?: boolean) => TreeKey[];
getCheckedNodes: (leafOnly?: boolean) => TreeNodeData[];
getHalfCheckedKeys: () => TreeKey[];
getHalfCheckedNodes: () => TreeNodeData[];
setChecked: (key: TreeKey, isChecked: boolean) => void;
setCheckedKeys: (keys: TreeKey[]) => void;
filter: (query: string) => void;
setData: (data: TreeData) => void;
getNode: (data: TreeKey | TreeNodeData) => TreeNode | undefined;
expandNode: (node: TreeNode) => void;
collapseNode: (node: TreeNode) => void;
setExpandedKeys: (keys: TreeKey[]) => void;
};