ez-react-antd 0.1.0 → 0.1.1

package/dist/RemoteTree/RemoteTree.d.ts

@@ -1,62 +1,103 @@
 import { default as React } from 'react';
-import { ConfigContext } from '../ConfigProvider';
+import { EzAntdConfig } from '../ConfigProvider';
+/**
+ * RemoteTree 组件属性接口
+ * 用于配置远程数据树形组件的行为和交互
+ */
 export interface RemoteTreeProp {
-    /** 需要参数才发起请求  */
-    needQueryParam?: boolean;
-    /** 数据请求接口 */
+    /** API 接口地址，用于获取树形数据 */
     api: string;
-    /** 查询参数 */
+    /** 是否需要查询参数才发起请求，默认 false */
+    needQueryParam?: boolean;
+    /** 查询参数对象，传递给 API 请求 */
     queryParam?: {
         [key: string]: any;
     } | null;
-    /** 默认参数 */
+    /** 默认参数，会与 queryParam 合并后发送 */
     defaultParam?: {
         [key: string]: any;
     };
-    /** 选项显示的字段key */
+    /** 节点标签字段名，默认 'name' */
     labelKey?: string;
-    /** 选中字段的值key */
+    /** 节点值字段名，默认 'id' */
     valueKey?: string;
-    /** 当加载子数据时,应该返回加载参数 */
+    /** 是否显示顶部搜索框 */
+    showSearch?: boolean;
+    /** 是否显示顶部添加按钮 */
+    showAdd?: boolean;
+    /** 是否显示节点的添加子级按钮 */
+    showAddSon?: boolean;
+    /** 是否显示节点的编辑按钮 */
+    showEdit?: boolean;
+    /** 是否显示节点的删除按钮 */
+    showDelete?: boolean;
+    /** 顶部添加按钮的文本，默认 '新增' */
+    addMenuName?: string;
+    /**
+     * 加载子节点数据时的参数生成函数
+     * @param node 当前节点数据
+     * @returns 返回请求子节点数据的参数对象
+     */
     onLoadSonData?: (node: any) => {
         [key: string]: any;
     };
-    /** 显示添加下级按钮 */
-    showAddSon?: boolean;
-    /** 显示删除按钮 */
-    showDelete?: boolean;
-    /** 显示编辑按钮 */
-    showEdit?: boolean;
-    /** 显示搜索框 */
-    showSearch?: boolean;
-    /** 显示添加按钮 */
-    showAdd?: boolean;
-    /** 当点击添加按钮时事件, 参数1是node节点, 参数2是成功回调函数 */
-    onClickAddSon?: (node: any, call: (sourceData: any) => void) => void;
-    /** 当点击删除按钮时事件, 参数1是node节点, 参数2是成功回调函数 */
-    onClickDelete?: (node: any, call: () => void) => void;
-    /** 当点击编辑按钮时事件, 参数1是node节点, 参数2是成功回调函数,回调时应携带修改节点信息 */
-    onClickEdit?: (node: any, call: (newNode: any) => void) => void;
-    /** 当点击添加按钮时事件, 参数1是node节点, 参数2是成功回调函数,回调时应携带新增节点信息 */
-    onClickAdd?: (call: (sourceData: any) => void) => void;
-    /** 回车搜索回调 */
-    onSearch?: (value: any) => void;
-    /** 节点选中回调 */
+    /**
+     * 节点选中事件回调
+     * @param value 选中的节点值或原始数据（取决于 returnSourceData）
+     */
     onSelect?: (value: any) => void;
-    /** 选中时返回原始数据 */
+    /**
+     * 搜索框回车事件回调
+     * @param value 搜索关键字
+     */
+    onSearch?: (value: any) => void;
+    /**
+     * 点击顶部添加按钮事件
+     * @param callback 成功回调函数，调用时传入新增的节点数据
+     */
+    onClickAdd?: (callback: (sourceData: any) => void) => void;
+    /**
+     * 点击节点添加子级按钮事件
+     * @param node 当前节点的原始数据
+     * @param callback 成功回调函数，调用时传入新增的子节点数据
+     */
+    onClickAddSon?: (node: any, callback: (sourceData: any) => void) => void;
+    /**
+     * 点击节点编辑按钮事件
+     * @param node 当前节点的原始数据
+     * @param callback 成功回调函数，调用时传入更新后的节点数据
+     */
+    onClickEdit?: (node: any, callback: (newNode: any) => void) => void;
+    /**
+     * 点击节点删除按钮事件
+     * @param node 当前节点的原始数据
+     * @param callback 成功回调函数，删除成功后调用
+     */
+    onClickDelete?: (node: any, callback: () => void) => void;
+    /** 选中节点时是否返回原始数据，false 则返回 valueKey 对应的值 */
     returnSourceData?: boolean;
-    /** 标题渲染函数, 返回react node */
+    /**
+     * 自定义节点标题渲染函数
+     * @param value 节点的原始数据
+     * @returns React 节点
+     */
     titleRender?: (value: any) => any;
-    /** 新增菜单名称 */
-    addMenuName?: string;
 }
+/**
+ * RemoteTree 组件状态接口
+ */
 export interface RemoteTreeState {
+    /** 树形数据数组 */
     treeDatas: Array<any>;
+    /** 数据加载状态 */
     loading: boolean;
 }
+/**
+ * 远程数据树形组件
+ * 支持异步加载数据、节点增删改、搜索等功能
+ */
 declare class RemoteTree extends React.Component<RemoteTreeProp, RemoteTreeState> {
-    static contextType: React.Context<import('..').EzAntdConfig>;
-    context: React.ContextType<typeof ConfigContext>;
+    /** 默认属性配置 */
     static defaultProps: {
         needQueryParam: boolean;
         labelKey: string;
@@ -69,33 +110,83 @@ declare class RemoteTree extends React.Component<RemoteTreeProp, RemoteTreeState
         returnSourceData: boolean;
         addMenuName: string;
     };
-    /** 节点key与节点数据映射 */
-    keyMapNode: any;
-    /** 节点key与上级key映射 */
-    keyMapParentKey: any;
-    /** 节点key与原始数据映射 */
-    keyMapSourceData: any;
+    static contextType: React.Context<EzAntdConfig>;
+    context: EzAntdConfig;
     constructor(props: RemoteTreeProp);
+    /** 节点 key 到树节点对象的映射，用于快速查找节点 */
+    keyMapNode: {
+        [key: string]: any;
+    };
+    /** 节点 key 到父节点 key 的映射，用于维护父子关系 */
+    keyMapParentKey: {
+        [key: string]: string;
+    };
+    /** 节点 key 到原始数据的映射，用于事件回调时获取完整数据 */
+    keyMapSourceData: {
+        [key: string]: any;
+    };
+    /**
+     * 处理节点选中事件
+     * @param keys 选中的节点 key 数组
+     */
     handleOnSelect(keys: any[]): void;
-    /** 处理添加 */
+    /**
+     * 处理添加子节点事件
+     * @param event 点击事件对象
+     * @param node 当前节点对象
+     */
     handleAddSon(event: any, node: any): void;
-    /** 处理添加 */
+    /**
+     * 处理顶部添加按钮点击事件
+     * 在根级别添加新节点
+     */
     handleAdd(): void;
-    /** 处理删除 */
+    /**
+     * 处理删除节点事件
+     * @param event 点击事件对象
+     * @param node 当前节点对象
+     */
     handleDelete(event: any, node: any): void;
-    /** 处理修改 */
+    /**
+     * 处理编辑节点事件
+     * @param event 点击事件对象
+     * @param node 当前节点对象
+     */
     handleEdit(event: any, node: any): void;
-    /** 根据原始数据创建树节点数据 */
-    createTreeDataBySourceData(sourceData: any): any;
-    /** 加载第一次数据 */
+    /**
+     * 根据原始数据创建树节点对象
+     * @param sourceData 原始数据对象
+     * @returns 树节点对象，包含 title、key、isLeaf 等属性
+     */
+    createTreeDataBySourceData(sourceData: any): {
+        title: any;
+        key: string;
+        isLeaf: any;
+    };
+    /**
+     * 加载根级别的树形数据
+     * 在组件挂载和查询参数变化时调用
+     */
     loadFirstData(): Promise<void>;
-    /** 加载子层数据 */
+    /**
+     * 异步加载子节点数据
+     * 当展开树节点时触发
+     * @param node 当前展开的节点对象
+     */
     loadSonData(node: any): Promise<void>;
     componentDidMount(): void;
     componentDidUpdate(prevProps: RemoteTreeProp): Promise<void>;
-    /** 处理搜索 */
+    /**
+     * 处理搜索框回车事件
+     * @param value 搜索关键字
+     */
     handleSearch(value: any): void;
-    /** 获取title, 返回react node */
+    /**
+     * 获取节点标题
+     * 支持自定义渲染函数
+     * @param node 节点对象
+     * @returns React 节点
+     */
     getTitle(node: any): any;
     render(): import("react/jsx-runtime").JSX.Element;
 }

package/dist/RemoteTree/RemoteTree.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RemoteTree.d.ts","sourceRoot":"","sources":["../../src/RemoteTree/RemoteTree.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAI1B,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAMlD,MAAM,WAAW,cAAc;IAC3B,iBAAiB;IACjB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,aAAa;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW;IACX,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,IAAI,CAAC;IAC3C,WAAW;IACX,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IACtC,iBAAiB;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,uBAAuB;IACvB,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IACtD,eAAe;IACf,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,aAAa;IACb,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,aAAa;IACb,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,YAAY;IACZ,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,aAAa;IACb,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,yCAAyC;IACzC,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,UAAU,EAAE,GAAG,KAAK,IAAI,KAAK,IAAI,CAAC;IACrE,yCAAyC;IACzC,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC;IACtD,sDAAsD;IACtD,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,KAAK,IAAI,CAAC;IAChE,sDAAsD;IACtD,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,UAAU,EAAE,GAAG,KAAK,IAAI,KAAK,IAAI,CAAC;IACvD,aAAa;IACb,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,CAAC;IAChC,aAAa;IACb,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,CAAC;IAChC,gBAAgB;IAChB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,2BAA2B;IAC3B,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG,CAAC;IAClC,aAAa;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,eAAe;IAC5B,SAAS,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;IACtB,OAAO,EAAE,OAAO,CAAC;CACpB;AAED,cAAM,UAAW,SAAQ,KAAK,CAAC,SAAS,CAAC,cAAc,EAAE,eAAe,CAAC;IACrE,MAAM,CAAC,WAAW,2CAAiB;IAC3B,OAAO,EAAE,KAAK,CAAC,WAAW,CAAC,OAAO,aAAa,CAAC,CAAC;IAEzD,MAAM,CAAC,YAAY;;;;;;;;;;;MAWjB;IAEF,mBAAmB;IACnB,UAAU,EAAE,GAAG,CAAM;IACrB,oBAAoB;IACpB,eAAe,EAAE,GAAG,CAAM;IAC1B,mBAAmB;IACnB,gBAAgB,EAAE,GAAG,CAAM;gBAEf,KAAK,EAAE,cAAc;IAiBjC,cAAc,CAAC,IAAI,EAAE,GAAG,EAAE;IAsB1B,WAAW;IACX,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG;IAmBlC,WAAW;IACX,SAAS;IAaT,WAAW;IACX,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG;IA4BlC,WAAW;IACX,UAAU,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG;IAWhC,oBAAoB;IACpB,0BAA0B,CAAC,UAAU,EAAE,GAAG;IAU1C,cAAc;IACR,aAAa;IAwCnB,aAAa;IACP,WAAW,CAAC,IAAI,EAAE,GAAG;IA+C3B,iBAAiB;IAIX,kBAAkB,CAAC,SAAS,EAAE,cAAc;IAOlD,WAAW;IACX,YAAY,CAAC,KAAK,EAAE,GAAG;IAMvB,4BAA4B;IAC5B,QAAQ,CAAC,IAAI,EAAE,GAAG;IAQlB,MAAM;CA4ET;AAED,eAAe,UAAU,CAAC"}
+{"version":3,"file":"RemoteTree.d.ts","sourceRoot":"","sources":["../../src/RemoteTree/RemoteTree.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAQ1B,OAAO,EAAiB,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAChE,OAAO,cAAc,CAAC;AAItB;;;GAGG;AACH,MAAM,WAAW,cAAc;IAE7B,wBAAwB;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,6BAA6B;IAC7B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,wBAAwB;IACxB,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,IAAI,CAAC;IAC3C,+BAA+B;IAC/B,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAGtC,wBAAwB;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qBAAqB;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAGlB,gBAAgB;IAChB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iBAAiB;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,oBAAoB;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,kBAAkB;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,kBAAkB;IAClB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,wBAAwB;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IAGrB;;;;OAIG;IACH,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IACtD;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,CAAC;IAChC;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,CAAC;IAChC;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,UAAU,EAAE,GAAG,KAAK,IAAI,KAAK,IAAI,CAAC;IAC3D;;;;OAIG;IACH,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,GAAG,KAAK,IAAI,KAAK,IAAI,CAAC;IACzE;;;;OAIG;IACH,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,KAAK,IAAI,CAAC;IACpE;;;;OAIG;IACH,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC;IAG1D,4CAA4C;IAC5C,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;;OAIG;IACH,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,aAAa;IACb,SAAS,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;IACtB,aAAa;IACb,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;;GAGG;AACH,cAAM,UAAW,SAAQ,KAAK,CAAC,SAAS,CAAC,cAAc,EAAE,eAAe,CAAC;IACvE,aAAa;IACb,MAAM,CAAC,YAAY;;;;;;;;;;;MAWjB;IACF,MAAM,CAAC,WAAW,8BAAiB;IAC3B,OAAO,EAAE,YAAY,CAAC;gBAElB,KAAK,EAAE,cAAc;IAiBjC,gCAAgC;IAChC,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAM;IACxC,mCAAmC;IACnC,eAAe,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAM;IAChD,oCAAoC;IACpC,gBAAgB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAM;IAE9C;;;OAGG;IACH,cAAc,CAAC,IAAI,EAAE,GAAG,EAAE;IAsB1B;;;;OAIG;IACH,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG;IAmBlC;;;OAGG;IACH,SAAS;IAaT;;;;OAIG;IACH,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG;IA4BlC;;;;OAIG;IACH,UAAU,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG;IAWhC;;;;OAIG;IACH,0BAA0B,CAAC,UAAU,EAAE,GAAG;;;;;IAU1C;;;OAGG;IACG,aAAa;IA+BnB;;;;OAIG;IACG,WAAW,CAAC,IAAI,EAAE,GAAG;IA6C3B,iBAAiB;IAIX,kBAAkB,CAAC,SAAS,EAAE,cAAc;IAOlD;;;OAGG;IACH,YAAY,CAAC,KAAK,EAAE,GAAG;IAMvB;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,GAAG;IAQlB,MAAM;CA4EP;AAED,eAAe,UAAU,CAAC"}