@ibiz-template/vue3-components 0.7.39 → 0.7.40

package/es/panel-component/nav-pos-index/nav-pos-index.controller.d.ts

@@ -5,19 +5,18 @@ import { NavTabsController } from '../nav-tabs/nav-tabs.controller';
 import { NavPosIndexState } from './nav-pos-index.state';
 import { NavBreadcrumbController } from '../nav-breadcrumb';
 /**
- * 导航占位控制器
- *
+ * @description 导航占位控制器
  * @export
  * @class NavPosIndexController
- * @extends {PanelItemController}
+ * @extends {PanelItemController<IPanelRawItem>}
  */
 export declare class NavPosIndexController extends PanelItemController<IPanelRawItem> {
     state: NavPosIndexState;
     /**
-     * 导航视图的modal
-     * @author lxm
-     * @date 2023-05-12 09:47:52
+     * @exposedoc
+     * @description 导航视图的modal
      * @type {{ [key: string]: IModal }}
+     * @memberof NavPosIndexController
      */
     viewModals: {
         [key: string]: IModal;
@@ -30,35 +29,34 @@ export declare class NavPosIndexController extends PanelItemController<IPanelRaw
      */
     router?: Router;
     /**
-     * 是否关闭后自动跳转上一个页面
-     * @author lxm
-     * @date 2023-05-25 08:43:49
+     * @exposedoc
+     * @description 是否关闭后自动跳转上一个页面
      * @type {boolean}
+     * @memberof NavPosIndexController
      */
     autoGoLast: boolean;
     /**
-     * 无缓存
-     * @author lxm
-     * @date 2024-04-22 04:12:41
-     * @readonly
+     * @exposedoc
+     * @description 禁止缓存
      * @type {boolean}
+     * @memberof NavPosIndexController
      */
     noCache: boolean;
     protected createState(): NavPosIndexState;
     setRouter(router: Router): void;
     /**
-     * 当前视图的路由层级，非路由模式不存在。
-     * @author lxm
-     * @date 2023-05-09 12:46:26
+     * @exposedoc
+     * @description 当前视图的路由层级，非路由模式不存在。
      * @readonly
+     * @type {(number | undefined)}
+     * @memberof NavPosIndexController
      */
     get routeDepth(): number | undefined;
     /**
-     * 导航标签页控制器
-     * @author lxm
-     * @date 2023-05-10 08:41:54
+     * @description 导航标签页控制器
      * @readonly
      * @type {(NavTabsController | undefined)}
+     * @memberof NavPosIndexController
      */
     get navTabs(): NavTabsController | undefined;
     /**
@@ -77,15 +75,14 @@ export declare class NavPosIndexController extends PanelItemController<IPanelRaw
      */
     get appmenu(): IAppMenuController | undefined;
     /**
-     * 自定义补充参数
-     *
-     * @author zk
-     * @date 2023-09-27 03:09:02
+     * @exposedoc
+     * @description 面板项参数
      * @type {IData}
-     * @memberof NavPosController
+     * @memberof NavPosIndexController
      */
     rawItemParams: IData;
     /**
+     * @exposedoc
      * @description 当前导航key
      * @type {string}
      * @memberof NavPosIndexController
@@ -93,76 +90,75 @@ export declare class NavPosIndexController extends PanelItemController<IPanelRaw
     currentKey: string;
     protected onInit(): Promise<void>;
     /**
-     * 改变显示视图
-     * @author lxm
-     * @date 2023-05-25 01:28:49
+     * @exposedoc
+     * @description 改变显示视图
      * @param {string} key
+     * @memberof NavPosIndexController
      */
     changeView(key: string): void;
     /**
-     * 路由变更,新视图进缓存并初始化，已有的就只切换。
-     * @author lxm
-     * @date 2023-05-25 03:07:07
-     * @param {{ currentKey: string; fullPath: string }} { currentKey }
-     * @return {*}
+     * @description 路由变更,新视图进缓存并初始化，已有的就只切换。
+     * @param {{
+     *     currentKey: string;
+     *     fullPath: string;
+     *   }} {
+     *     currentKey,
+     *     fullPath,
+     *   }
+     * @returns {*}  {void}
+     * @memberof NavPosIndexController
      */
     onRouteChange({ currentKey, fullPath, }: {
         currentKey: string;
         fullPath: string;
     }): void;
     /**
-     * 监听视图创建，获取并监听视图控制器
-     * @author lxm
-     * @date 2023-05-25 03:03:22
+     * @description 监听视图创建，获取并监听视图控制器
      * @param {EventBase} event
+     * @memberof NavPosIndexController
      */
     onViewCreated(event: EventBase): void;
     /**
-     * 删除单个缓存
-     * @author lxm
-     * @date 2023-05-09 02:19:09
+     * @exposedoc
+     * @description 删除单个缓存
      * @param {string} key
+     * @memberof NavPosIndexController
      */
     removeCache(key: string): void;
     /**
-     * 清空缓存
-     * @author lxm
-     * @date 2023-05-09 02:19:55
+     * @exposedoc
+     * @description 清空缓存
+     * @memberof NavPosIndexController
      */
     clearCache(): void;
     /**
-     * 关闭视图
-     * 走modal的dismiss,会走一遍视图内部的校验，不通过则不会关闭
-     * @author lxm
-     * @date 2023-05-25 03:10:23
-     * @param {string} keys
+     * @exposedoc
+     * @description 关闭视图
+     * @param {string[]} keys
+     * @returns {*}  {Promise<void>}
+     * @memberof NavPosIndexController
      */
     closeViewByKeys(keys: string[]): Promise<void>;
     /**
-     * 自身的dismiss相关操作
-     *
-     * @author chitanda
-     * @date 2023-07-12 22:07:09
+     * @description 自身的dismiss相关操作
      * @protected
      * @param {string} key
      * @param {IModalData} modal
-     * @return {*}
+     * @memberof NavPosIndexController
      */
     protected dismiss(key: string, modal: IModalData): void;
     /**
-     * 返回上一个页面或上一层空白路由
-     * @author lxm
-     * @date 2023-05-25 06:46:27
+     * @exposedoc
+     * @description 返回上一个页面或上一层空白路由
      * @protected
+     * @returns {*}  {void}
+     * @memberof NavPosIndexController
      */
     protected goLast(): void;
     /**
-     * 处理自定义补充参数 [{key:'name',value:'data'}] => {name:'data'}
-     *
-     * @author zk
-     * @date 2023-09-27 03:09:55
+     * @description 处理自定义补充参数 [{key:'name',value:'data'}] => {name:'data'}
      * @protected
-     * @memberof NavPosController
+     * @memberof NavPosIndexController
      */
     protected handleRawItemParams(): void;
 }

package/es/panel-component/nav-pos-index/nav-pos-index.controller.mjs

@@ -14,10 +14,10 @@ class NavPosIndexController extends PanelItemController {
   constructor() {
     super(...arguments);
     /**
-     * 导航视图的modal
-     * @author lxm
-     * @date 2023-05-12 09:47:52
+     * @exposedoc
+     * @description 导航视图的modal
      * @type {{ [key: string]: IModal }}
+     * @memberof NavPosIndexController
      */
     __publicField(this, "viewModals", {});
     /**
@@ -28,30 +28,28 @@ class NavPosIndexController extends PanelItemController {
      */
     __publicField(this, "router");
     /**
-     * 是否关闭后自动跳转上一个页面
-     * @author lxm
-     * @date 2023-05-25 08:43:49
+     * @exposedoc
+     * @description 是否关闭后自动跳转上一个页面
      * @type {boolean}
+     * @memberof NavPosIndexController
      */
     __publicField(this, "autoGoLast", true);
     /**
-     * 无缓存
-     * @author lxm
-     * @date 2024-04-22 04:12:41
-     * @readonly
+     * @exposedoc
+     * @description 禁止缓存
      * @type {boolean}
+     * @memberof NavPosIndexController
      */
     __publicField(this, "noCache", false);
     /**
-     * 自定义补充参数
-     *
-     * @author zk
-     * @date 2023-09-27 03:09:02
+     * @exposedoc
+     * @description 面板项参数
      * @type {IData}
-     * @memberof NavPosController
+     * @memberof NavPosIndexController
      */
     __publicField(this, "rawItemParams", {});
     /**
+     * @exposedoc
      * @description 当前导航key
      * @type {string}
      * @memberof NavPosIndexController
@@ -66,20 +64,20 @@ class NavPosIndexController extends PanelItemController {
     this.router = router;
   }
   /**
-   * 当前视图的路由层级，非路由模式不存在。
-   * @author lxm
-   * @date 2023-05-09 12:46:26
+   * @exposedoc
+   * @description 当前视图的路由层级，非路由模式不存在。
    * @readonly
+   * @type {(number | undefined)}
+   * @memberof NavPosIndexController
    */
   get routeDepth() {
     return this.panel.view.modal.routeDepth;
   }
   /**
-   * 导航标签页控制器
-   * @author lxm
-   * @date 2023-05-10 08:41:54
+   * @description 导航标签页控制器
    * @readonly
    * @type {(NavTabsController | undefined)}
+   * @memberof NavPosIndexController
    */
   get navTabs() {
     return this.panel.panelItems.nav_tabs;
@@ -109,10 +107,10 @@ class NavPosIndexController extends PanelItemController {
     this.noCache = this.rawItemParams.expcache === "NO_CACHE";
   }
   /**
-   * 改变显示视图
-   * @author lxm
-   * @date 2023-05-25 01:28:49
+   * @exposedoc
+   * @description 改变显示视图
    * @param {string} key
+   * @memberof NavPosIndexController
    */
   changeView(key) {
     var _a;
@@ -122,11 +120,16 @@ class NavPosIndexController extends PanelItemController {
     }
   }
   /**
-   * 路由变更,新视图进缓存并初始化，已有的就只切换。
-   * @author lxm
-   * @date 2023-05-25 03:07:07
-   * @param {{ currentKey: string; fullPath: string }} { currentKey }
-   * @return {*}
+   * @description 路由变更,新视图进缓存并初始化，已有的就只切换。
+   * @param {{
+   *     currentKey: string;
+   *     fullPath: string;
+   *   }} {
+   *     currentKey,
+   *     fullPath,
+   *   }
+   * @returns {*}  {void}
+   * @memberof NavPosIndexController
    */
   onRouteChange({
     currentKey,
@@ -182,21 +185,22 @@ class NavPosIndexController extends PanelItemController {
     }
   }
   /**
-   * 监听视图创建，获取并监听视图控制器
-   * @author lxm
-   * @date 2023-05-25 03:03:22
+   * @description 监听视图创建，获取并监听视图控制器
    * @param {EventBase} event
+   * @memberof NavPosIndexController
    */
   onViewCreated(event) {
     const { view } = event;
     const key = this.state.currentKey;
+    const viewKey = "".concat(view.model.codeName, "-").concat(view.id);
     if (this.navTabs) {
       this.navTabs.updateViewInfo(key, {
+        viewKey,
         caption: view.model.caption,
         sysImage: view.model.sysImage
       });
       view.evt.on("onViewInfoChange", ({ caption, dataInfo }) => {
-        this.navTabs.updateViewInfo(key, { caption, dataInfo });
+        this.navTabs.updateViewInfo(key, { viewKey, caption, dataInfo });
       });
     }
     if (this.navBreadcrumb) {
@@ -225,10 +229,10 @@ class NavPosIndexController extends PanelItemController {
     }
   }
   /**
-   * 删除单个缓存
-   * @author lxm
-   * @date 2023-05-09 02:19:09
+   * @exposedoc
+   * @description 删除单个缓存
    * @param {string} key
+   * @memberof NavPosIndexController
    */
   removeCache(key) {
     const index = this.state.cacheKeys.indexOf(key);
@@ -243,20 +247,20 @@ class NavPosIndexController extends PanelItemController {
     }
   }
   /**
-   * 清空缓存
-   * @author lxm
-   * @date 2023-05-09 02:19:55
+   * @exposedoc
+   * @description 清空缓存
+   * @memberof NavPosIndexController
    */
   clearCache() {
     this.state.cacheKeys = [this.currentKey];
     this.viewModals = {};
   }
   /**
-   * 关闭视图
-   * 走modal的dismiss,会走一遍视图内部的校验，不通过则不会关闭
-   * @author lxm
-   * @date 2023-05-25 03:10:23
-   * @param {string} keys
+   * @exposedoc
+   * @description 关闭视图
+   * @param {string[]} keys
+   * @returns {*}  {Promise<void>}
+   * @memberof NavPosIndexController
    */
   async closeViewByKeys(keys) {
     this.autoGoLast = false;
@@ -269,14 +273,11 @@ class NavPosIndexController extends PanelItemController {
     this.autoGoLast = true;
   }
   /**
-   * 自身的dismiss相关操作
-   *
-   * @author chitanda
-   * @date 2023-07-12 22:07:09
+   * @description 自身的dismiss相关操作
    * @protected
    * @param {string} key
    * @param {IModalData} modal
-   * @return {*}
+   * @memberof NavPosIndexController
    */
   dismiss(key, modal) {
     routerCallback.close(key, modal);
@@ -292,10 +293,11 @@ class NavPosIndexController extends PanelItemController {
     }
   }
   /**
-   * 返回上一个页面或上一层空白路由
-   * @author lxm
-   * @date 2023-05-25 06:46:27
+   * @exposedoc
+   * @description 返回上一个页面或上一层空白路由
    * @protected
+   * @returns {*}  {void}
+   * @memberof NavPosIndexController
    */
   goLast() {
     const lastKey = this.state.operateSort.pop();
@@ -318,12 +320,9 @@ class NavPosIndexController extends PanelItemController {
     }
   }
   /**
-   * 处理自定义补充参数 [{key:'name',value:'data'}] => {name:'data'}
-   *
-   * @author zk
-   * @date 2023-09-27 03:09:55
+   * @description 处理自定义补充参数 [{key:'name',value:'data'}] => {name:'data'}
    * @protected
-   * @memberof NavPosController
+   * @memberof NavPosIndexController
    */
   handleRawItemParams() {
     var _a;

package/es/panel-component/nav-pos-index/nav-pos-index.d.ts

@@ -3,11 +3,23 @@ import { IPanelRawItem } from '@ibiz/model-core';
 import { EventBase } from '@ibiz-template/runtime';
 import { NavPosIndexController } from './nav-pos-index.controller';
 import './nav-pos-index.scss';
+/**
+ * 首页导航占位
+ * @primary
+ * @description 首页中视图导航组件，使用keepAlive存储导航视图信息与缓存。
+ * @panelitemparams {name:expcache,parameterType:string,defaultvalue:-,description:当值为NO_CACHE时禁用缓存，即每次导航切换时都是重新绘制新的视图，否则使用keepAlive包裹绘制的导航视图}
+ */
 export declare const NavPosIndex: import("vue").DefineComponent<{
+    /**
+     * @description 导航占位模型数据
+     */
     modelData: {
         type: PropType<IPanelRawItem>;
         required: true;
     };
+    /**
+     * @description 导航占位控制器
+     */
     controller: {
         type: typeof NavPosIndexController;
         required: true;
@@ -17,10 +29,16 @@ export declare const NavPosIndex: import("vue").DefineComponent<{
     onViewCreated: (event: EventBase) => void;
     c: NavPosIndexController;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * @description 导航占位模型数据
+     */
     modelData: {
         type: PropType<IPanelRawItem>;
         required: true;
     };
+    /**
+     * @description 导航占位控制器
+     */
     controller: {
         type: typeof NavPosIndexController;
         required: true;

package/es/panel-component/nav-pos-index/nav-pos-index.mjs

@@ -8,10 +8,16 @@ import './nav-pos-index.css';
 const NavPosIndex = /* @__PURE__ */ defineComponent({
   name: "IBizNavPosIndex",
   props: {
+    /**
+     * @description 导航占位模型数据
+     */
     modelData: {
       type: Object,
       required: true
     },
+    /**
+     * @description 导航占位控制器
+     */
     controller: {
       type: NavPosIndexController,
       required: true

package/es/panel-component/nav-pos-index/nav-pos-index.state.d.ts

@@ -1,42 +1,39 @@
 import { INavViewMsg, PanelItemState } from '@ibiz-template/runtime';
 /**
- * 导航占位状态
- *
- * @author lxm
- * @date 2023-02-07 06:04:27
+ * @description 导航占位状态
  * @export
  * @class NavPosIndexState
  * @extends {PanelItemState}
  */
 export declare class NavPosIndexState extends PanelItemState {
     /**
-     * 当前导航视图标识
-     * @author lxm
-     * @date 2023-05-25 06:24:48
+     * @exposedoc
+     * @description 当前导航视图标识
      * @type {string}
+     * @memberof NavPosIndexState
      */
     currentKey: string;
     /**
-     * 缓存的视图标识
-     * @author lxm
-     * @date 2023-05-25 06:25:21
+     * @exposedoc
+     * @description 缓存的视图标识
      * @type {string[]}
+     * @memberof NavPosIndexState
      */
     cacheKeys: string[];
     /**
-     * 导航视图详细信息
-     * @author lxm
-     * @date 2023-05-25 07:07:05
-     * @type {INavViewMsg[]}
+     * @exposedoc
+     * @description 导航视图详细信息
+     * @type {{ [p: string]: INavViewMsg }}
+     * @memberof NavPosIndexState
      */
     navViewMsgs: {
         [p: string]: INavViewMsg;
     };
     /**
-     * 导航的视图的操作顺序
-     * @author lxm
-     * @date 2023-05-25 06:25:34
+     * @exposedoc
+     * @description 导航的视图的操作记录
      * @type {string[]}
+     * @memberof NavPosIndexState
      */
     operateSort: string[];
 }

package/es/panel-component/nav-pos-index/nav-pos-index.state.mjs

@@ -11,31 +11,31 @@ class NavPosIndexState extends PanelItemState {
   constructor() {
     super(...arguments);
     /**
-     * 当前导航视图标识
-     * @author lxm
-     * @date 2023-05-25 06:24:48
+     * @exposedoc
+     * @description 当前导航视图标识
      * @type {string}
+     * @memberof NavPosIndexState
      */
     __publicField(this, "currentKey", "");
     /**
-     * 缓存的视图标识
-     * @author lxm
-     * @date 2023-05-25 06:25:21
+     * @exposedoc
+     * @description 缓存的视图标识
      * @type {string[]}
+     * @memberof NavPosIndexState
      */
     __publicField(this, "cacheKeys", ["RouterShell"]);
     /**
-     * 导航视图详细信息
-     * @author lxm
-     * @date 2023-05-25 07:07:05
-     * @type {INavViewMsg[]}
+     * @exposedoc
+     * @description 导航视图详细信息
+     * @type {{ [p: string]: INavViewMsg }}
+     * @memberof NavPosIndexState
      */
     __publicField(this, "navViewMsgs", {});
     /**
-     * 导航的视图的操作顺序
-     * @author lxm
-     * @date 2023-05-25 06:25:34
+     * @exposedoc
+     * @description 导航的视图的操作记录
      * @type {string[]}
+     * @memberof NavPosIndexState
      */
     __publicField(this, "operateSort", []);
   }