bkui-vue 2.1.0-dev-beta.8 → 2.1.0-dev-beta.9

package/lib/tree/props.d.ts

@@ -19,6 +19,49 @@ export type TreeNode = {
  */
 export type DropType = 'child' | 'move' | 'sort';
 export type DisableDropHandler = (data: TreeNode, type: DropType, target: TreeNode) => boolean;
+export type TreeDataChangeTrigger = 'async' | 'drag';
+export type TreeDataChangePayload = {
+    trigger: TreeDataChangeTrigger;
+    data: TreeNode[];
+    node: TreeNode;
+    targetNode?: TreeNode;
+    parentNode?: TreeNode | null;
+    oldParentNode?: TreeNode | null;
+    dropType?: DropType;
+    sourceIndex?: number;
+    targetIndex?: number;
+};
+export type TreeDataChangeHandler = (payload: TreeDataChangePayload) => void;
+export type TreeCheckedPayload = {
+    checkedNodes: TreeNode[];
+    indeterminateNodes: TreeNode[];
+};
+export type TreeSelectedPayload = {
+    selected: boolean;
+    node: TreeNode;
+};
+export type TreeDropPayload = {
+    event: unknown;
+    element: HTMLElement;
+    targetNode: TreeNode;
+    sourceNode: TreeNode;
+    data: TreeNode[];
+    parentNode?: TreeNode | null;
+    oldParentNode?: TreeNode | null;
+    dropType?: DropType;
+    sourceIndex?: number;
+    targetIndex?: number;
+};
+export type TreeDragSortPayload = {
+    sourceNode: TreeNode;
+    targetNode: TreeNode;
+    data: TreeNode[];
+    parentNode?: TreeNode | null;
+    oldParentNode?: TreeNode | null;
+    dropType?: DropType;
+    sourceIndex?: number;
+    targetIndex?: number;
+};
 /**
  * Tree Prop: prefixIcon function
  * @param {} isRoot 是否为分跟节点
@@ -41,7 +84,7 @@ export declare const treeProps: {
     label: import("vue-types").VueTypeDef<any>;
     /**
      * 每个树节点用来作为唯一标识的属性，此标识应该是唯一的
-     * 如果设置系统会默认自动生成唯一id
+     * 启用拖拽、异步、受控选中/勾选等复杂能力时强烈建议显式设置
      */
     nodeKey: import("vue-types").VueTypeValidableDef<string> & {
         default: string;
@@ -102,6 +145,10 @@ export declare const treeProps: {
     prefixIcon: import("vue-types").VueTypeDef<any> & {
         default: any;
     };
+    /**
+     * 当树数据需要由外部接管更新时的统一回调
+     */
+    onDataChange: PropType<TreeDataChangeHandler>;
     /**
      * 异步加载节点数据配置
      * @param callback 请求数据回调函数，函数返回 Promise
@@ -268,13 +315,26 @@ export declare const treeProps: {
         default: boolean;
     };
     /**
-     * 在显示复选框的情况下，是否严格的遵循父子互相关联的做法
+     * 是否启用父子节点勾选联动
+     * true: 父子联动
+     * false: 父子不联动（语义与行业常见 checkStrictly 相反，为兼容历史行为暂保留）
      */
     checkStrictly: import("vue-types").VueTypeValidableDef<boolean> & {
         default: boolean;
     } & {
         default: boolean;
     };
+    /**
+     * 是否深度监听 props.data 变化
+     * - false (默认): 仅监听 props.data 引用变化，性能更优
+     * - true: 深度监听 props.data 内部节点变化（已废弃，将在下个主版本移除）
+     * @deprecated 请使用 onDataChange 回调更新数据，避免直接修改 props.data 内部节点
+     */
+    deepWatch: import("vue-types").VueTypeValidableDef<boolean> & {
+        default: boolean;
+    } & {
+        default: boolean;
+    };
     /**
      * 是否开启监听Tree节点进入Tree容器可视区域
      */

package/lib/tree/tree.d.ts

@@ -43,6 +43,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     prefixIcon: import("vue-types").VueTypeDef<any> & {
         default: any;
     };
+    onDataChange: import("vue").PropType<import("./props").TreeDataChangeHandler>;
     async: import("vue-types").VueTypeShape<{
         callback: (item: any, cb: any) => Promise<string | import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
             [key: string]: any;
@@ -139,10 +140,17 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     } & {
         default: boolean;
     };
+    deepWatch: import("vue-types").VueTypeValidableDef<boolean> & {
+        default: boolean;
+    } & {
+        default: boolean;
+    };
     intersectionObserver: import("vue-types").VueTypeDef<boolean | import("./props").IIntersectionObserver> & {
         default: boolean | (() => import("./props").IIntersectionObserver);
     };
 }>, () => JSX.Element, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    nodeAsyncLoad: (..._args: any[]) => boolean;
+    nodeAsyncLoadError: (..._args: any[]) => boolean;
     nodeClick: (..._args: any[]) => boolean;
     nodeCollapse: (..._args: any[]) => boolean;
     nodeExpand: (..._args: any[]) => boolean;
@@ -193,6 +201,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     prefixIcon: import("vue-types").VueTypeDef<any> & {
         default: any;
     };
+    onDataChange: import("vue").PropType<import("./props").TreeDataChangeHandler>;
     async: import("vue-types").VueTypeShape<{
         callback: (item: any, cb: any) => Promise<string | import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
             [key: string]: any;
@@ -289,10 +298,17 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     } & {
         default: boolean;
     };
+    deepWatch: import("vue-types").VueTypeValidableDef<boolean> & {
+        default: boolean;
+    } & {
+        default: boolean;
+    };
     intersectionObserver: import("vue-types").VueTypeDef<boolean | import("./props").IIntersectionObserver> & {
         default: boolean | (() => import("./props").IIntersectionObserver);
     };
 }>> & Readonly<{
+    onNodeAsyncLoad?: (...args: any[]) => any;
+    onNodeAsyncLoadError?: (...args: any[]) => any;
     onNodeChecked?: (...args: any[]) => any;
     onNodeClick?: (...args: any[]) => any;
     onNodeCollapse?: (...args: any[]) => any;
@@ -335,5 +351,6 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     nodeContentAction: any;
     keepSlotData: boolean;
     checkStrictly: boolean;
+    deepWatch: boolean;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
 export default _default;

package/lib/tree/use-node-action.d.ts

@@ -4,7 +4,7 @@ declare const _default: (props: TreePropTypes, ctx: any, flatData: IFlatData, _r
     renderTreeNode: (item: TreeNode, showTree?: boolean) => JSX.Element;
     handleTreeNodeClick: (item: TreeNode, e: MouseEvent, event?: string) => void;
     deepAutoOpen: () => void;
-    asyncNodeClick: (item: TreeNode) => Promise<boolean> | Promise<void | Record<string, unknown>>;
+    asyncNodeClick: (item: TreeNode) => Promise<boolean | Record<string, unknown>>;
     setNodeAction: (args: TreeNode | TreeNode[], action: string, value: unknown) => void;
     setNodeOpened: (item: TreeNode, isOpen?: any, e?: MouseEvent, fireEmit?: boolean) => void;
     setSelect: (nodes: TreeNode | TreeNode[], selected?: boolean, autoOpen?: boolean, triggerEvent?: boolean, event?: string) => void;

package/lib/tree/use-node-async.d.ts

@@ -1,6 +1,6 @@
 import { TreeNode } from './props';
-declare const _default: (props: any, flatData: any) => {
-    asyncNodeClick: (item: TreeNode) => Promise<boolean> | Promise<void | Record<string, unknown>>;
+declare const _default: (props: any, flatData: any, ctx?: any) => {
+    asyncNodeClick: (item: TreeNode) => Promise<boolean | Record<string, unknown>>;
     deepAutoOpen: () => void;
 };
 export default _default;

package/lib/tree/use-node-drag.d.ts

@@ -1,5 +1,5 @@
 import { TreePropTypes } from './props';
-declare const _default: (props: TreePropTypes, ctx: any, root?: any, flatData?: any) => {
+declare const _default: (props: TreePropTypes, ctx: any, root?: any, flatData?: any, options?: any) => {
     isDragging: import("vue").Ref<boolean, boolean>;
 };
 export default _default;

package/lib/tree/use-tree-init.d.ts

@@ -8,7 +8,7 @@ declare const _default: (props: TreePropTypes) => {
         schema: WeakMap<TreeNode, Record<string, unknown>> & Omit<WeakMap<TreeNode, Record<string, unknown>>, keyof WeakMap<any, any>>;
         levelLineSchema: {};
     };
-    asyncNodeClick: (item: TreeNode) => Promise<boolean> | Promise<void | Record<string, unknown>>;
+    asyncNodeClick: (item: TreeNode) => Promise<boolean | Record<string, unknown>>;
     deepAutoOpen: () => void;
     afterDataUpdate: (callFn: (d: any) => void) => void;
     registerNextLoop: (key: string, event: any, reset?: boolean) => void;

package/lib/tree/util.d.ts

@@ -1,4 +1,4 @@
-import { TreeNode, TreePropTypes } from './props';
+import { TreeDataChangePayload, TreeNode, TreePropTypes } from './props';
 export type IFlatData = {
     data: TreeNode[];
     schema: WeakMap<TreeNode, Record<string, unknown>>;
@@ -61,6 +61,28 @@ export declare const getNodeRowClass: (item: TreeNode, schema: WeakMap<TreeNode,
  * @param nodeValue 节点值
  */
 export declare const updateTreeNode: (path: string, treeData: TreeNode[], childKey: string, nodekey: string, nodeValue: Record<string, unknown>[]) => void;
+export declare const cloneTreeData: (treeData?: TreeNode[], childKey?: string) => TreeNode[];
+export declare const findNodeById: (treeData: TreeNode[], nodeId: string | number, nodeKey: string, childKey: string) => TreeNode | null;
+export declare const mutateTreeById: (treeData: TreeNode[], nodeId: string | number, nodeKey: string, childKey: string, updater: (node: TreeNode) => void) => TreeNode[];
+export declare const removeTreeNodeById: (treeData: TreeNode[], nodeId: string | number, nodeKey: string, childKey: string) => {
+    node: TreeNode | null;
+    data: TreeNode[];
+    parentNode: TreeNode | null;
+    index: number;
+};
+export declare const insertTreeNodeById: (treeData: TreeNode[], node: TreeNode, targetNodeId: string | number, nodeKey: string, childKey: string, options: {
+    dropType: 'child' | 'move' | 'sort';
+    willInsertAfter?: boolean;
+}) => {
+    data: TreeNode[];
+    parentNode: TreeNode | null;
+    targetNode: TreeNode | null;
+    index: number;
+};
+export declare const moveTreeNodeById: (treeData: TreeNode[], nodeId: string | number, targetNodeId: string | number, nodeKey: string, childKey: string, options: {
+    dropType: 'child' | 'move' | 'sort';
+    willInsertAfter?: boolean;
+}) => TreeDataChangePayload | null;
 /**
  * 根据路径更新指定节点Child-Data
  * @param path 节点路径

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bkui-vue",
-  "version": "2.1.0-dev-beta.8",
+  "version": "2.1.0-dev-beta.9",
   "workspaces": [
     "packages/**",
     "scripts/cli",
@@ -135,6 +135,7 @@
     "js-calendar": "~1.2.3",
     "json-formatter-js": "~2.3.4",
     "lodash": "~4.17.21",
+    "sortablejs": "~1.15.7",
     "tinycolor2": "~1.6.0",
     "vue-types": "~4.1.1"
   }