@v-c/tree 1.1.2 → 1.2.0

package/dist/MotionTreeNode.js

@@ -112,7 +112,6 @@ var MotionTreeNode = /* @__PURE__ */ defineComponent((props) => {
 			default: void 0
 		},
 		motion: {
-			type: Object,
 			required: false,
 			default: void 0
 		},
@@ -146,7 +145,6 @@ var MotionTreeNode = /* @__PURE__ */ defineComponent((props) => {
 			default: void 0
 		},
 		eventKey: {
-			type: [String, Number],
 			required: false,
 			default: void 0
 		},
@@ -166,7 +164,6 @@ var MotionTreeNode = /* @__PURE__ */ defineComponent((props) => {
 			default: void 0
 		},
 		id: {
-			type: [String, Number],
 			required: false,
 			default: void 0
 		},
@@ -201,16 +198,9 @@ var MotionTreeNode = /* @__PURE__ */ defineComponent((props) => {
 			default: void 0
 		},
 		title: {
-			type: [
-				Object,
-				Function,
-				String,
-				Number,
-				null,
-				Boolean,
-				Array
-			],
+			type: Function,
 			required: false,
+			skipCheck: true,
 			default: void 0
 		},
 		dragOver: {
@@ -248,7 +238,6 @@ var MotionTreeNode = /* @__PURE__ */ defineComponent((props) => {
 			default: void 0
 		},
 		onMouseMove: {
-			type: Function,
 			required: false,
 			default: void 0
 		},
@@ -278,41 +267,18 @@ var MotionTreeNode = /* @__PURE__ */ defineComponent((props) => {
 			default: void 0
 		},
 		icon: {
-			type: [
-				Object,
-				Function,
-				String,
-				Number,
-				null,
-				Boolean,
-				Array
-			],
+			type: Function,
 			required: false,
+			skipCheck: true,
 			default: void 0
 		},
 		switcherIcon: {
-			type: [
-				Object,
-				Function,
-				String,
-				Number,
-				null,
-				Boolean,
-				Array
-			],
+			type: Function,
 			required: false,
+			skipCheck: true,
 			default: void 0
 		},
 		children: {
-			type: [
-				Object,
-				Function,
-				String,
-				Number,
-				null,
-				Boolean,
-				Array
-			],
 			required: false,
 			default: void 0
 		}

package/dist/NodeList.js

@@ -245,20 +245,12 @@ var NodeList = /* @__PURE__ */ defineComponent((props, { attrs, expose }) => {
 			required: false,
 			default: void 0
 		},
-		dragOverNodeKey: {
-			type: [
-				String,
-				Number,
-				null
-			],
-			required: true
-		},
+		dragOverNodeKey: { required: true },
 		dropPosition: {
 			type: [Number, null],
 			required: true
 		},
 		motion: {
-			type: Object,
 			required: false,
 			default: void 0
 		},

package/dist/Tree.js

@@ -82,12 +82,7 @@ var Tree = /* @__PURE__ */ defineComponent((props, { slots, attrs, expose }) =>
 		return keys;
 	};
 	const expandedKeys = shallowRef(getInitExpandedKeys());
-	/**
-	* Set the uncontrolled `expandedKeys`. Guarded centrally so a controlled
-	* `expandedKeys` is never clobbered — the watcher below owns it in that case.
-	*/
 	const setExpandedKeys = (keys) => {
-		if (props.expandedKeys !== void 0) return;
 		expandedKeys.value = keys;
 	};
 	watch(() => props.expandedKeys, () => {
@@ -202,6 +197,7 @@ var Tree = /* @__PURE__ */ defineComponent((props, { slots, attrs, expose }) =>
 		return flattenNodes.value.find(({ key }) => key === activeKey.value) || null;
 	});
 	const scrollTo = (scroll) => {
+		if (scroll && typeof scroll === "object" && "autoExpand" in scroll && scroll.autoExpand && props.expandedKeys === void 0) setExpandedKeys(arrAdd(expandedKeys.value, scroll.key));
 		listRef.value?.scrollTo(scroll);
 	};
 	expose({
@@ -480,7 +476,7 @@ var Tree = /* @__PURE__ */ defineComponent((props, { slots, attrs, expose }) =>
 			let newExpandedKeys = [...expandedKeys.value];
 			const entity = getEntity(keyEntities.value, nodeProps.eventKey);
 			if (entity && (entity.children || []).length) newExpandedKeys = arrAdd(expandedKeys.value, nodeProps.eventKey);
-			setExpandedKeys(newExpandedKeys);
+			if (props.expandedKeys === void 0) setExpandedKeys(newExpandedKeys);
 			props.onExpand?.(newExpandedKeys, {
 				node: convertNodePropsToEventData(nodeProps),
 				expanded: true,
@@ -792,11 +788,6 @@ var Tree = /* @__PURE__ */ defineComponent((props, { slots, attrs, expose }) =>
 			default: void 0
 		},
 		activeKey: {
-			type: [
-				String,
-				Number,
-				null
-			],
 			required: false,
 			default: void 0
 		},
@@ -826,16 +817,9 @@ var Tree = /* @__PURE__ */ defineComponent((props, { slots, attrs, expose }) =>
 			default: void 0
 		},
 		icon: {
-			type: [
-				Object,
-				Function,
-				String,
-				Number,
-				null,
-				Boolean,
-				Array
-			],
+			type: Function,
 			required: false,
+			skipCheck: true,
 			default: void 0
 		},
 		selectable: {
@@ -859,16 +843,9 @@ var Tree = /* @__PURE__ */ defineComponent((props, { slots, attrs, expose }) =>
 			default: void 0
 		},
 		checkable: {
-			type: [
-				Boolean,
-				Object,
-				Function,
-				String,
-				Number,
-				null,
-				Array
-			],
+			type: Boolean,
 			required: false,
+			skipCheck: true,
 			default: void 0
 		},
 		checkStrictly: {
@@ -1071,21 +1048,13 @@ var Tree = /* @__PURE__ */ defineComponent((props, { slots, attrs, expose }) =>
 			default: void 0
 		},
 		motion: {
-			type: Object,
 			required: false,
 			default: void 0
 		},
 		switcherIcon: {
-			type: [
-				Object,
-				Function,
-				String,
-				Number,
-				null,
-				Boolean,
-				Array
-			],
+			type: Function,
 			required: false,
+			skipCheck: true,
 			default: void 0
 		},
 		height: {

package/dist/TreeNode.js

@@ -27,6 +27,7 @@ var TreeNode = /* @__PURE__ */ defineComponent((props, { attrs }) => {
 		if (typeof props.selectable === "boolean") return props.selectable;
 		return context.selectable;
 	});
+	const isUnselectable = computed(() => !context.checkable && !isSelectable.value);
 	const hasChildren = computed(() => {
 		const { children } = getEntity(context.keyEntities, props.eventKey) || {};
 		return Boolean((children || []).length);
@@ -225,6 +226,7 @@ var TreeNode = /* @__PURE__ */ defineComponent((props, { attrs }) => {
 			"aria-disabled": isDisabled.value,
 			"class": clsx(props.className, `${context.prefixCls}-treenode`, context.classNames?.item, {
 				[`${context.prefixCls}-treenode-disabled`]: isDisabled.value,
+				[`${context.prefixCls}-treenode-unselectable`]: isUnselectable.value,
 				[`${context.prefixCls}-treenode-switcher-${props.expanded ? "open" : "close"}`]: !memoizedIsLeaf.value,
 				[`${context.prefixCls}-treenode-checkbox-checked`]: props.checked,
 				[`${context.prefixCls}-treenode-checkbox-indeterminate`]: props.halfChecked,
@@ -270,7 +272,6 @@ var TreeNode = /* @__PURE__ */ defineComponent((props, { attrs }) => {
 }, {
 	props: {
 		eventKey: {
-			type: [String, Number],
 			required: false,
 			default: void 0
 		},
@@ -290,7 +291,6 @@ var TreeNode = /* @__PURE__ */ defineComponent((props, { attrs }) => {
 			default: void 0
 		},
 		id: {
-			type: [String, Number],
 			required: false,
 			default: void 0
 		},
@@ -330,16 +330,9 @@ var TreeNode = /* @__PURE__ */ defineComponent((props, { attrs }) => {
 			default: void 0
 		},
 		title: {
-			type: [
-				Object,
-				Function,
-				String,
-				Number,
-				null,
-				Boolean,
-				Array
-			],
+			type: Function,
 			required: false,
+			skipCheck: true,
 			default: void 0
 		},
 		dragOver: {
@@ -386,7 +379,6 @@ var TreeNode = /* @__PURE__ */ defineComponent((props, { attrs }) => {
 			default: void 0
 		},
 		onMouseMove: {
-			type: Function,
 			required: false,
 			default: void 0
 		},
@@ -416,41 +408,18 @@ var TreeNode = /* @__PURE__ */ defineComponent((props, { attrs }) => {
 			default: void 0
 		},
 		icon: {
-			type: [
-				Object,
-				Function,
-				String,
-				Number,
-				null,
-				Boolean,
-				Array
-			],
+			type: Function,
 			required: false,
+			skipCheck: true,
 			default: void 0
 		},
 		switcherIcon: {
-			type: [
-				Object,
-				Function,
-				String,
-				Number,
-				null,
-				Boolean,
-				Array
-			],
+			type: Function,
 			required: false,
+			skipCheck: true,
 			default: void 0
 		},
 		children: {
-			type: [
-				Object,
-				Function,
-				String,
-				Number,
-				null,
-				Boolean,
-				Array
-			],
 			required: false,
 			default: void 0
 		}

package/dist/hooks/useTree.d.ts

@@ -0,0 +1,9 @@
+import { MaybeRefOrGetter } from 'vue';
+import { BasicDataNode, DataEntity, DataNode, FieldNames, Key } from '../interface';
+export interface UseTreeConfig {
+    fieldNames?: MaybeRefOrGetter<FieldNames | undefined>;
+}
+export interface TreeInstance<TreeDataType extends DataNode | BasicDataNode = DataNode> {
+    getPath: (key: Key) => DataEntity<TreeDataType>[];
+}
+export default function useTree<TreeDataType extends DataNode | BasicDataNode = DataNode>(treeData: MaybeRefOrGetter<TreeDataType[]>, config?: UseTreeConfig): TreeInstance<TreeDataType>;

package/dist/hooks/useTree.js

@@ -0,0 +1,23 @@
+import getEntity from "../utils/keyUtil.js";
+import { convertDataToEntities } from "../utils/treeUtil.js";
+import { computed, toValue } from "vue";
+//#region src/hooks/useTree.ts
+function useTree(treeData, config = {}) {
+	const { fieldNames } = config;
+	const keyEntities = computed(() => {
+		const { keyEntities } = convertDataToEntities(toValue(treeData), { fieldNames: toValue(fieldNames) });
+		return keyEntities;
+	});
+	const getPath = (key) => {
+		const path = [];
+		let entity = getEntity(keyEntities.value, key);
+		while (entity) {
+			path.unshift(entity);
+			entity = entity.parent;
+		}
+		return path;
+	};
+	return { getPath };
+}
+//#endregion
+export { useTree as default };

package/dist/index.d.ts

@@ -1,12 +1,13 @@
+import { TreeInstance, UseTreeConfig, default as useTree } from './hooks/useTree';
 import { BasicDataNode, DataEntity, DataNode, EventDataNode, FieldNames, FlattenNode, IconType, Key, KeyEntities, ScrollTo, TreeNodeProps } from './interface';
 import { ExpandAction, TreeProps, TreeRef, default as Tree } from './Tree';
 import { default as TreeNode } from './TreeNode';
 export { UnstableContextKey } from './contextTypes';
-export { TreeNode };
+export { TreeNode, useTree };
 export { arrAdd, arrDel, calcDropPosition, calcSelectedKeys, conductExpandParent, getDragChildrenKeys, isFirstChild, isLastChild, parseCheckedKeys, posToArr } from './util.ts';
 export { conductCheck } from './utils/conductUtil';
 export { convertDataToEntities, convertTreeToData, fillFieldNames, flattenTreeData } from './utils/treeUtil';
-export type { BasicDataNode, DataEntity, DataNode, EventDataNode, ExpandAction, FieldNames, FlattenNode, IconType, Key, KeyEntities, ScrollTo, TreeNodeProps, TreeProps, TreeRef, };
+export type { BasicDataNode, DataEntity, DataNode, EventDataNode, ExpandAction, FieldNames, FlattenNode, IconType, Key, KeyEntities, ScrollTo, TreeInstance, TreeNodeProps, TreeProps, TreeRef, UseTreeConfig, };
 type TreeType = typeof Tree & {
     TreeNode: typeof TreeNode;
 };

package/dist/index.js

@@ -4,8 +4,9 @@ import TreeNode from "./TreeNode.js";
 import { arrAdd, arrDel, calcDropPosition, calcSelectedKeys, conductExpandParent, getDragChildrenKeys, isFirstChild, isLastChild, parseCheckedKeys, posToArr } from "./util.js";
 import { conductCheck } from "./utils/conductUtil.js";
 import Tree from "./Tree.js";
+import useTree from "./hooks/useTree.js";
 //#region src/index.ts
 var ExportTree = Tree;
 ExportTree.TreeNode = TreeNode;
 //#endregion
-export { TreeNode, UnstableContextKey, arrAdd, arrDel, calcDropPosition, calcSelectedKeys, conductCheck, conductExpandParent, convertDataToEntities, convertTreeToData, ExportTree as default, fillFieldNames, flattenTreeData, getDragChildrenKeys, isFirstChild, isLastChild, parseCheckedKeys, posToArr };
+export { TreeNode, UnstableContextKey, arrAdd, arrDel, calcDropPosition, calcSelectedKeys, conductCheck, conductExpandParent, convertDataToEntities, convertTreeToData, ExportTree as default, fillFieldNames, flattenTreeData, getDragChildrenKeys, isFirstChild, isLastChild, parseCheckedKeys, posToArr, useTree };

package/dist/interface.d.ts

@@ -1,8 +1,18 @@
 import { MouseEventHandler } from '@v-c/util/dist/EventInterface';
 import { Key as VCKey, VueNode } from '@v-c/util/dist/type';
+import { ScrollTo as VirtualListScrollTo } from '@v-c/virtual-list';
 import { CSSProperties, VNode } from 'vue';
-export type { ScrollTo } from '@v-c/virtual-list';
 export type Key = VCKey;
+type VirtualListScrollConfig = Exclude<NonNullable<Parameters<VirtualListScrollTo>[0]>, number>;
+type ScrollTarget = Extract<VirtualListScrollConfig, {
+    key: Key;
+}>;
+type TreeScrollConfig = (Exclude<VirtualListScrollConfig, ScrollTarget> & {
+    autoExpand?: never;
+}) | (ScrollTarget & {
+    autoExpand?: boolean;
+});
+export type ScrollTo = (scroll?: number | TreeScrollConfig | null) => void;
 /**
  * Typescript not support `bigint` as index type yet.
  * We use this to mark the `bigint` type is for `Key` usage.
@@ -120,3 +130,4 @@ export interface FieldNames {
     key?: string;
     children?: string;
 }
+export {};

package/dist/util.d.ts

@@ -5,8 +5,8 @@ export interface AllowDropOptions<TreeDataType extends BasicDataNode = DataNode>
     dropPosition: -1 | 0 | 1;
 }
 export type AllowDrop<TreeDataType extends BasicDataNode = DataNode> = (options: AllowDropOptions<TreeDataType>) => boolean;
-export declare function arrDel(list: Key[], value: Key): import('packages/util/dist/type').Key[];
-export declare function arrAdd(list: Key[], value: Key): import('packages/util/dist/type').Key[];
+export declare function arrDel(list: Key[], value: Key): VCKey[];
+export declare function arrAdd(list: Key[], value: Key): VCKey[];
 export declare function posToArr(pos: string): string[];
 export declare function getDragChildrenKeys<TreeDataType extends BasicDataNode = DataNode>(dragNodeKey: Key, keyEntities: KeyEntities<TreeDataType>): Key[];
 export declare function isLastChild<TreeDataType extends BasicDataNode = DataNode>(treeNodeEntity: DataEntity<TreeDataType>): boolean;
@@ -25,7 +25,7 @@ export declare function calcDropPosition<TreeDataType extends BasicDataNode = Da
 };
 export declare function calcSelectedKeys(selectedKeys: Key[], { multiple }: {
     multiple?: boolean;
-}): import('packages/util/dist/type').Key[] | undefined;
+}): VCKey[] | undefined;
 export declare function parseCheckedKeys(keys: Key[] | {
     checked: Key[];
     halfChecked: Key[];

package/dist/utils/treeUtil.d.ts

@@ -1,7 +1,7 @@
 import { BasicDataNode, DataEntity, DataNode, EventDataNode, FieldNames, FlattenNode, GetKey, Key, KeyEntities, NodeElement, TreeNodeProps } from '../interface';
 export declare function getPosition(level: string | number, index: number): string;
 export declare function isTreeNode(node: NodeElement): boolean;
-export declare function getKey(key: Key, pos: string): import('packages/util/dist/type').Key;
+export declare function getKey(key: Key, pos: string): any;
 export declare function fillFieldNames(fieldNames?: FieldNames): Required<FieldNames>;
 export declare function warningWithoutKey(treeData: DataNode[], fieldNames: FieldNames): void;
 export declare function convertTreeToData(rootNodes: any): DataNode[];
@@ -47,7 +47,7 @@ export interface TreeNodeRequiredProps<TreeDataType extends BasicDataNode = Data
     keyEntities: KeyEntities<TreeDataType>;
 }
 export declare function getTreeNodeProps<TreeDataType extends BasicDataNode = DataNode>(key: Key, { expandedKeys, selectedKeys, loadedKeys, loadingKeys, checkedKeys, halfCheckedKeys, dragOverNodeKey, dropPosition, keyEntities, }: TreeNodeRequiredProps<TreeDataType>): {
-    eventKey: import('packages/util/dist/type').Key;
+    eventKey: VCKey;
     expanded: boolean;
     selected: boolean;
     loaded: boolean;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@v-c/tree",
   "type": "module",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "",
   "publishConfig": {
     "access": "public"
@@ -35,7 +35,7 @@
   },
   "dependencies": {
     "@v-c/util": "^1.1.0",
-    "@v-c/virtual-list": "^1.1.0"
+    "@v-c/virtual-list": "^1.1.1"
   },
   "scripts": {
     "build": "vite build",