@ibiz-template/mob-vue3-components 0.0.55 → 0.7.41-alpha.7

package/es/panel-component/auth-sso/auth-sso.mjs

@@ -7,10 +7,16 @@ import './auth-sso.css';
 const AuthSso = /* @__PURE__ */ defineComponent({
   name: "IBizAuthSsO",
   props: {
+    /**
+     * @description 第三方登录组件模型数据
+     */
     modelData: {
       type: Object,
       required: true
     },
+    /**
+     * @description 第三方登录组件控制器
+     */
     controller: {
       type: PanelItemController,
       required: true

package/es/panel-component/auth-userinfo/auth-userinfo.d.ts

@@ -2,11 +2,23 @@ import { PropType } from 'vue';
 import './auth-userinfo.scss';
 import { IPanelRawItem } from '@ibiz/model-core';
 import { PanelItemController } from '@ibiz-template/runtime';
+/**
+ * 用户信息组件
+ * @description 用于显示当前登录用户的基本信息，如姓名，组织名等。
+ * @primary
+ *
+ */
 export declare const AuthUserinfo: import("vue").DefineComponent<{
+    /**
+     * @description 用户信息组件模型数据
+     */
     modelData: {
         type: PropType<IPanelRawItem>;
         required: true;
     };
+    /**
+     * @description 用户信息组件控制器
+     */
     controller: {
         type: typeof PanelItemController;
         required: true;
@@ -18,10 +30,16 @@ export declare const AuthUserinfo: import("vue").DefineComponent<{
     srfpersonname: any;
     srforgname: any;
 }, 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 PanelItemController;
         required: true;

package/es/panel-component/auth-userinfo/auth-userinfo.mjs

@@ -7,10 +7,16 @@ import { PanelItemController } from '@ibiz-template/runtime';
 const AuthUserinfo = /* @__PURE__ */ defineComponent({
   name: "IBizAuthUserinfo",
   props: {
+    /**
+     * @description 用户信息组件模型数据
+     */
     modelData: {
       type: Object,
       required: true
     },
+    /**
+     * @description 用户信息组件控制器
+     */
     controller: {
       type: PanelItemController,
       required: true

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

@@ -12,41 +12,33 @@ import { NavPosIndexState } from './nav-pos-index.state';
 export declare class NavPosIndexController extends PanelItemController<IPanelRawItem> {
     state: NavPosIndexState;
     /**
-     * 导航视图的modal
-     * @author lxm
-     * @date 2023-05-12 09:47:52
+     * @description 导航视图的modal
+     * @exposedoc
      * @type {{ [key: string]: IModal }}
      */
     viewModals: {
         [key: string]: IModal;
     };
     /**
-     * router对象
-     * @author lxm
-     * @date 2023-05-25 08:02:43
+     * @description router对象
      * @type {Router}
      */
     router?: Router;
     /**
-     * 是否关闭后自动跳转上一个页面
-     * @author lxm
-     * @date 2023-05-25 08:43:49
+     * @description 是否关闭后自动跳转上一个页面
+     * @exposedoc
      * @type {boolean}
      */
     autoGoLast: boolean;
     /**
-     * 自定义补充参数
-     *
-     * @author tony001
-     * @date 2025-01-21 16:01:25
+     * @description 自定义补充参数
+     * @exposedoc
      * @type {IData}
      */
     rawItemParams: IData;
     /**
-     * 无缓存
-     *
-     * @author tony001
-     * @date 2025-01-21 16:01:25
+     * @description 无缓存
+     * @exposedoc
      * @type {boolean}
      */
     noCache: boolean;
@@ -54,24 +46,21 @@ export declare class NavPosIndexController extends PanelItemController<IPanelRaw
     protected onInit(): Promise<void>;
     setRouter(router: Router): void;
     /**
-     * 当前视图的路由层级，非路由模式不存在。
-     * @author lxm
-     * @date 2023-05-09 12:46:26
+     * @description 当前视图的路由层级，非路由模式不存在。
+     * @exposedoc
      * @readonly
      */
     get routeDepth(): number | undefined;
     /**
-     * 应用菜单控制器
-     * @author lxm
-     * @date 2023-05-10 08:41:42
+     * @description 应用菜单控制器
+     * @exposedoc
      * @readonly
      * @type {(IAppMenuController | undefined)}
      */
     get appmenu(): IAppMenuController | undefined;
     /**
-     * 改变显示视图
-     * @author lxm
-     * @date 2023-05-25 01:28:49
+     * @description 改变显示视图
+     * @exposedoc
      * @param {string} key
      */
     changeView(key: string): void;
@@ -87,23 +76,19 @@ export declare class NavPosIndexController extends PanelItemController<IPanelRaw
         fullPath: string;
     }): void;
     /**
-     * 删除单个缓存
-     * @author lxm
-     * @date 2023-05-09 02:19:09
+     * @description 删除单个缓存
+     * @exposedoc
      * @param {string} key
      */
     removeCache(key: string): void;
     /**
-     * 清空缓存
-     * @author lxm
-     * @date 2023-05-09 02:19:55
+     * @description 清空缓存
+     * @exposedoc
      */
     clearCache(): void;
     /**
-     * 关闭视图
-     * 走modal的dismiss,会走一遍视图内部的校验，不通过则不会关闭
-     * @author lxm
-     * @date 2023-05-25 03:10:23
+     * @description 关闭视图
+     * @exposedoc
      * @param {string} keys
      */
     closeViewByKeys(keys: string[]): Promise<void>;
@@ -119,7 +104,8 @@ export declare class NavPosIndexController extends PanelItemController<IPanelRaw
      */
     protected dismiss(key: string, modal: IModalData): void;
     /**
-     * 返回上一个页面或上一层空白路由
+     * @description 返回上一个页面或上一层空白路由
+     * @exposedoc
      * @author lxm
      * @date 2023-05-25 06:46:27
      * @protected

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

@@ -14,39 +14,31 @@ class NavPosIndexController extends PanelItemController {
   constructor() {
     super(...arguments);
     /**
-     * 导航视图的modal
-     * @author lxm
-     * @date 2023-05-12 09:47:52
+     * @description 导航视图的modal
+     * @exposedoc
      * @type {{ [key: string]: IModal }}
      */
     __publicField(this, "viewModals", {});
     /**
-     * router对象
-     * @author lxm
-     * @date 2023-05-25 08:02:43
+     * @description router对象
      * @type {Router}
      */
     __publicField(this, "router");
     /**
-     * 是否关闭后自动跳转上一个页面
-     * @author lxm
-     * @date 2023-05-25 08:43:49
+     * @description 是否关闭后自动跳转上一个页面
+     * @exposedoc
      * @type {boolean}
      */
     __publicField(this, "autoGoLast", true);
     /**
-     * 自定义补充参数
-     *
-     * @author tony001
-     * @date 2025-01-21 16:01:25
+     * @description 自定义补充参数
+     * @exposedoc
      * @type {IData}
      */
     __publicField(this, "rawItemParams", {});
     /**
-     * 无缓存
-     *
-     * @author tony001
-     * @date 2025-01-21 16:01:25
+     * @description 无缓存
+     * @exposedoc
      * @type {boolean}
      */
     __publicField(this, "noCache", false);
@@ -64,18 +56,16 @@ class NavPosIndexController extends PanelItemController {
     this.router = router;
   }
   /**
-   * 当前视图的路由层级，非路由模式不存在。
-   * @author lxm
-   * @date 2023-05-09 12:46:26
+   * @description 当前视图的路由层级，非路由模式不存在。
+   * @exposedoc
    * @readonly
    */
   get routeDepth() {
     return this.panel.view.modal.routeDepth;
   }
   /**
-   * 应用菜单控制器
-   * @author lxm
-   * @date 2023-05-10 08:41:42
+   * @description 应用菜单控制器
+   * @exposedoc
    * @readonly
    * @type {(IAppMenuController | undefined)}
    */
@@ -83,9 +73,8 @@ class NavPosIndexController extends PanelItemController {
     return this.panel.getController("appmenu");
   }
   /**
-   * 改变显示视图
-   * @author lxm
-   * @date 2023-05-25 01:28:49
+   * @description 改变显示视图
+   * @exposedoc
    * @param {string} key
    */
   changeView(key) {
@@ -147,9 +136,8 @@ class NavPosIndexController extends PanelItemController {
     }
   }
   /**
-   * 删除单个缓存
-   * @author lxm
-   * @date 2023-05-09 02:19:09
+   * @description 删除单个缓存
+   * @exposedoc
    * @param {string} key
    */
   removeCache(key) {
@@ -165,19 +153,16 @@ class NavPosIndexController extends PanelItemController {
     }
   }
   /**
-   * 清空缓存
-   * @author lxm
-   * @date 2023-05-09 02:19:55
+   * @description 清空缓存
+   * @exposedoc
    */
   clearCache() {
     this.state.cacheKeys = [];
     this.viewModals = {};
   }
   /**
-   * 关闭视图
-   * 走modal的dismiss,会走一遍视图内部的校验，不通过则不会关闭
-   * @author lxm
-   * @date 2023-05-25 03:10:23
+   * @description 关闭视图
+   * @exposedoc
    * @param {string} keys
    */
   async closeViewByKeys(keys) {
@@ -208,7 +193,8 @@ class NavPosIndexController extends PanelItemController {
     }
   }
   /**
-   * 返回上一个页面或上一层空白路由
+   * @description 返回上一个页面或上一层空白路由
+   * @exposedoc
    * @author lxm
    * @date 2023-05-25 06:46:27
    * @protected

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

@@ -2,11 +2,23 @@ import { PropType } from 'vue';
 import { IPanelRawItem } from '@ibiz/model-core';
 import { NavPosIndexController } from './nav-pos-index.controller';
 import './nav-pos-index.scss';
+/**
+ * 首页导航占位
+ * @primary
+ * @description 首页中视图导航组件，存储导航视图信息与缓存。
+ * @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;
@@ -16,10 +28,16 @@ export declare const NavPosIndex: import("vue").DefineComponent<{
     c: NavPosIndexController;
     isActivated: import("vue").Ref<boolean>;
 }, 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

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

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

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

package/es/panel-component/panel-app-title/panel-app-title.controller.d.ts

@@ -12,14 +12,15 @@ export declare class PanelAppTitleController extends PanelItemController<IPanelR
     state: PanelAppTitleState;
     protected createState(): PanelAppTitleState;
     /**
-     * 面板控制器
-     *
+     * @description 面板控制器
+     * @exposedoc
      * @type {ViewLayoutPanelController}
      * @memberof PanelAppTitleController
      */
     panel: ViewLayoutPanelController;
     /**
      * @description 自定义补充参数
+     * @exposedoc
      * @type {IData}
      * @memberof PanelAppTitleController
      */

package/es/panel-component/panel-app-title/panel-app-title.controller.mjs

@@ -13,6 +13,7 @@ class PanelAppTitleController extends PanelItemController {
     super(...arguments);
     /**
      * @description 自定义补充参数
+     * @exposedoc
      * @type {IData}
      * @memberof PanelAppTitleController
      */

package/es/panel-component/panel-app-title/panel-app-title.d.ts

@@ -2,11 +2,22 @@ import { IPanelField } from '@ibiz/model-core';
 import { PropType } from 'vue';
 import { PanelAppTitleController } from './panel-app-title.controller';
 import './panel-app-title.scss';
+/**
+ * 应用标题
+ * @primary
+ * @description 用于绘制应用logo和应用标题，提供点击标题跳转首页的能力。
+ */
 export declare const PanelAppTitle: import("vue").DefineComponent<{
+    /**
+     * @description 应用标题模型数据
+     */
     modelData: {
         type: PropType<IPanelField>;
         required: true;
     };
+    /**
+     * @description 应用标题控制器
+     */
     controller: {
         type: typeof PanelAppTitleController;
         required: true;
@@ -19,10 +30,16 @@ export declare const PanelAppTitle: import("vue").DefineComponent<{
     handleClick: () => Promise<void>;
     isCollapse: import("vue").ComputedRef<any>;
 }, 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<IPanelField>;
         required: true;
     };
+    /**
+     * @description 应用标题控制器
+     */
     controller: {
         type: typeof PanelAppTitleController;
         required: true;

package/es/panel-component/panel-app-title/panel-app-title.mjs

@@ -8,10 +8,16 @@ import './panel-app-title.css';
 const PanelAppTitle = /* @__PURE__ */ defineComponent({
   name: "IBizPanelAppTitle",
   props: {
+    /**
+     * @description 应用标题模型数据
+     */
     modelData: {
       type: Object,
       required: true
     },
+    /**
+     * @description 应用标题控制器
+     */
     controller: {
       type: PanelAppTitleController,
       required: true

package/es/panel-component/panel-app-title/panel-app-title.state.d.ts

@@ -10,58 +10,44 @@ import { PanelItemState } from '@ibiz-template/runtime';
  */
 export declare class PanelAppTitleState extends PanelItemState {
     /**
-     * 应用标题
-     *
-     * @author chitanda
-     * @date 2023-07-20 17:07:22
+     * @description 应用标题
+     * @exposedoc
      * @type {string}
      */
     caption: string;
     /**
-     * 应用标题(收缩时)
-     *
-     * @author chitanda
-     * @date 2023-07-20 17:07:22
+     * @description  应用标题(收缩时)
+     * @exposedoc
      * @type {string}
      */
     caption2: string;
     /**
-     * 应用子标题
-     *
-     * @author chitanda
-     * @date 2023-07-20 17:07:22
+     * @description 应用子标题
+     * @exposedoc
      * @type {string}
      */
     subCaption?: string;
     /**
-     * 应用子标题(收缩时)
-     *
-     * @author chitanda
-     * @date 2023-07-20 17:07:22
+     * @description 应用子标题(收缩时)
+     * @exposedoc
      * @type {string}
      */
     subCaption2?: string;
     /**
-     * 应用 logo 图片地址
-     *
-     * @author chitanda
-     * @date 2023-07-20 17:07:11
+     * @description 应用 logo 图片地址
+     * @exposedoc
      * @type {string}
      */
     icon: string;
     /**
-     * 应用 logo 图片2地址(收缩时)
-     *
-     * @author chitanda
-     * @date 2023-07-20 17:07:11
+     * @description 应用 logo 图片2地址(收缩时)
+     * @exposedoc
      * @type {string}
      */
     icon2: string;
     /**
-     * 是否为 svg 图标
-     *
-     * @author chitanda
-     * @date 2023-07-20 17:07:26
+     * @description 是否为 svg 图标
+     * @exposedoc
      * @type {boolean}
      */
     isSvg: boolean;