@ibiz-template/vue3-components 0.7.40-alpha.9 → 0.7.41-alpha.0

package/es/panel-component/index-actions/index-actions.d.ts

@@ -2,11 +2,23 @@ import { PanelContainerController } from '@ibiz-template/vue3-util';
 import { IPanelContainer } from '@ibiz/model-core';
 import { PropType } from 'vue';
 import './index-actions.scss';
+/**
+ * 首页行为容器组件
+ * @description 用于包裹首页预定义布局中的四个预定义按钮组件。
+ * @param {IPanelContainer} props
+ * @returns
+ */
 export declare const IndexActions: import("vue").DefineComponent<{
+    /**
+     * @description 首页行为容器组件模型数据
+     */
     modelData: {
         type: PropType<IPanelContainer>;
         required: true;
     };
+    /**
+     * @description 首页行为容器组件控制器
+     */
     controller: {
         type: typeof PanelContainerController;
         required: true;
@@ -16,10 +28,16 @@ export declare const IndexActions: import("vue").DefineComponent<{
     classArr: import("vue").ComputedRef<(string | false)[]>;
     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<IPanelContainer>;
         required: true;
     };
+    /**
+     * @description 首页行为容器组件控制器
+     */
     controller: {
         type: typeof PanelContainerController;
         required: true;

package/es/panel-component/index-actions/index-actions.mjs

@@ -1,4 +1,4 @@
-import { isVNode, defineComponent, computed, createVNode, resolveComponent } from 'vue';
+import { isVNode, computed, resolveComponent, createVNode, defineComponent } from 'vue';
 import { PanelContainerController, useNamespace } from '@ibiz-template/vue3-util';
 import './index-actions.css';
 
@@ -9,10 +9,16 @@ function _isSlot(s) {
 const IndexActions = /* @__PURE__ */ defineComponent({
   name: "IBizIndexActions",
   props: {
+    /**
+     * @description 首页行为容器组件模型数据
+     */
     modelData: {
       type: Object,
       required: true
     },
+    /**
+     * @description 首页行为容器组件控制器
+     */
     controller: {
       type: PanelContainerController,
       required: true

package/es/panel-component/index-blank-placeholder/index-blank-placeholder.controller.d.ts

@@ -13,24 +13,24 @@ export declare class IndexBlankPlaceholderController extends PanelItemController
     state: IndexBlankPlaceholderState;
     protected createState(): IndexBlankPlaceholderState;
     /**
-     * 当前视图路由层级
-     *
+     * @description 当前视图路由层级
+     * @exposedoc
      * @readonly
      * @type {(number | undefined)}
      * @memberof IndexBlankPlaceholderController
      */
     get routeDepth(): number | undefined;
     /**
-     * 应用菜单
-     *
+     * @description 应用菜单
+     * @exposedoc
      * @readonly
      * @type {(AppMenuController | undefined)}
      * @memberof IndexBlankPlaceholderController
      */
     get appmenu(): AppMenuController | undefined;
     /**
-     * 首页导航栏
-     *
+     * @description 首页导航栏
+     * @exposedoc
      * @readonly
      * @type {(NavPosIndexController | undefined)}
      * @memberof IndexBlankPlaceholderController
@@ -45,8 +45,8 @@ export declare class IndexBlankPlaceholderController extends PanelItemController
      */
     protected onInit(): Promise<void>;
     /**
-     * 设置显示状态
-     *
+     * @description 设置显示状态
+     * @exposedoc
      * @param {boolean} state
      * @memberof IndexBlankPlaceholderController
      */

package/es/panel-component/index-blank-placeholder/index-blank-placeholder.controller.mjs

@@ -8,8 +8,8 @@ class IndexBlankPlaceholderController extends PanelItemController {
     return new IndexBlankPlaceholderState((_a = this.parent) == null ? void 0 : _a.state);
   }
   /**
-   * 当前视图路由层级
-   *
+   * @description 当前视图路由层级
+   * @exposedoc
    * @readonly
    * @type {(number | undefined)}
    * @memberof IndexBlankPlaceholderController
@@ -18,8 +18,8 @@ class IndexBlankPlaceholderController extends PanelItemController {
     return this.panel.view.modal.routeDepth;
   }
   /**
-   * 应用菜单
-   *
+   * @description 应用菜单
+   * @exposedoc
    * @readonly
    * @type {(AppMenuController | undefined)}
    * @memberof IndexBlankPlaceholderController
@@ -28,8 +28,8 @@ class IndexBlankPlaceholderController extends PanelItemController {
     return this.panel.getController("appmenu");
   }
   /**
-   * 首页导航栏
-   *
+   * @description 首页导航栏
+   * @exposedoc
    * @readonly
    * @type {(NavPosIndexController | undefined)}
    * @memberof IndexBlankPlaceholderController
@@ -63,8 +63,8 @@ class IndexBlankPlaceholderController extends PanelItemController {
     });
   }
   /**
-   * 设置显示状态
-   *
+   * @description 设置显示状态
+   * @exposedoc
    * @param {boolean} state
    * @memberof IndexBlankPlaceholderController
    */

package/es/panel-component/index-blank-placeholder/index-blank-placeholder.d.ts

@@ -2,11 +2,22 @@ import { IPanelContainer } from '@ibiz/model-core';
 import { PropType } from 'vue';
 import { IndexBlankPlaceholderController } from './index-blank-placeholder.controller';
 import './index-blank-placeholder.scss';
+/**
+ * 空白占位
+ * @primary
+ * @description 首页空白占位组件，当菜单未进行导航时，首页显示此容器内的内容。
+ */
 export declare const IndexBlankPlaceholder: import("vue").DefineComponent<{
+    /**
+     * @description 空白占位模型数据
+     */
     modelData: {
         type: PropType<IPanelContainer>;
         required: true;
     };
+    /**
+     * @description 空白占位控制器
+     */
     controller: {
         type: PropType<IndexBlankPlaceholderController>;
         required: true;
@@ -15,10 +26,16 @@ export declare const IndexBlankPlaceholder: import("vue").DefineComponent<{
     ns: import("@ibiz-template/core").Namespace;
     classArr: import("vue").ComputedRef<(string | false)[]>;
 }, 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<IPanelContainer>;
         required: true;
     };
+    /**
+     * @description 空白占位控制器
+     */
     controller: {
         type: PropType<IndexBlankPlaceholderController>;
         required: true;

package/es/panel-component/index-blank-placeholder/index-blank-placeholder.mjs

@@ -1,4 +1,4 @@
-import { isVNode, defineComponent, computed, createVNode, resolveComponent } from 'vue';
+import { isVNode, computed, resolveComponent, createVNode, defineComponent } from 'vue';
 import { useNamespace, onRouteChange } from '@ibiz-template/vue3-util';
 import './index-blank-placeholder.css';
 
@@ -9,10 +9,16 @@ function _isSlot(s) {
 const IndexBlankPlaceholder = /* @__PURE__ */ defineComponent({
   name: "IBizIndexBlankPlaceholder",
   props: {
+    /**
+     * @description 空白占位模型数据
+     */
     modelData: {
       type: Object,
       required: true
     },
+    /**
+     * @description 空白占位控制器
+     */
     controller: {
       type: Object,
       required: true

package/es/panel-component/index.mjs

@@ -29,6 +29,7 @@ import { IBizPanelButtonList } from './panel-button-list/index.mjs';
 import { IBizAuthSso } from './auth-sso/index.mjs';
 import { IBizIndexBlankPlaceholder } from './index-blank-placeholder/index.mjs';
 import { IBizGlobalSearch } from './global-search/index.mjs';
+import { IBizAppSwitch } from './app-switch/index.mjs';
 export { NavPosIndexState } from './nav-pos-index/nav-pos-index.state.mjs';
 export { NavPosIndexController } from './nav-pos-index/nav-pos-index.controller.mjs';
 export { PanelButtonController } from './panel-button/panel-button.controller.mjs';
@@ -86,6 +87,7 @@ const IBizPanelComponents = {
     v.use(IBizAuthCaptcha);
     v.use(IBizPanelButtonList);
     v.use(IBizAuthWxmpQrcode);
+    v.use(IBizAppSwitch);
   }
 };
 

package/es/panel-component/nav-breadcrumb/nav-breadcrumb.controller.d.ts

@@ -15,18 +15,21 @@ export declare class NavBreadcrumbController extends PanelItemController<IPanelR
     protected createState(): NavBreadcrumbState;
     /**
      * @description 面包屑分割符
+     * @exposedoc
      * @type {string}
      * @memberof NavBreadcrumbController
      */
     separator: string;
     /**
-     * @description 导航模式（路由、菜单、缓存）
+     * @description 导航模式，路由模式：根据路由计算导航数据，菜单模式：根据菜单模型计算导航数据，缓存模式：根据缓存计算导航数据
+     * @exposedoc
      * @type {('router' | 'menu' | 'store')}
      * @memberof NavBreadcrumbController
      */
     navMode: 'router' | 'menu' | 'store';
     /**
      * @description 是否显示应用标题
+     * @exposedoc
      * @type {boolean}
      * @memberof NavBreadcrumbController
      */
@@ -39,20 +42,23 @@ export declare class NavBreadcrumbController extends PanelItemController<IPanelR
     service: NavBreadcrumbService;
     /**
      * @description 自定义补充参数
+     * @exposedoc
      * @type {IData}
      * @memberof NavBreadcrumbController
      */
     rawItemParams: IData;
     /**
      * @description 应用菜单控制器
+     * @exposedoc
      * @readonly
      * @type {(IAppMenuController | undefined)}
      * @memberof NavBreadcrumbController
      */
     get appmenu(): IAppMenuController | undefined;
     /**
-     * @description 首页导航栏
+     * @description 首页导航占位控制器
      * @readonly
+     * @exposedoc
      * @type {(NavPosIndexController | undefined)}
      * @memberof NavBreadcrumbController
      */
@@ -76,11 +82,11 @@ export declare class NavBreadcrumbController extends PanelItemController<IPanelR
      */
     resetBreadcrumbs(): void;
     /**
-     * 更新视图信息
-     * @author lxm
-     * @date 2023-05-09 01:40:34
-     * @param {string} key
-     * @param {{ caption?: string; dataInfo?: string }} info
+     * @description 更新视图信息
+     * @param {string} fullPath
+     * @param {{ viewName: string; caption?: string; dataInfo?: string }} info
+     * @return {*}  {void}
+     * @memberof NavBreadcrumbController
      */
     updateViewInfo(fullPath: string, info: {
         viewName: string;

package/es/panel-component/nav-breadcrumb/nav-breadcrumb.controller.mjs

@@ -1,5 +1,5 @@
 import { PanelItemController } from '@ibiz-template/runtime';
-import { reject, isNil } from 'ramda';
+import { isNil, reject } from 'ramda';
 import { route2routePath, routePath2string } from '@ibiz-template/vue3-util';
 import { notNilEmpty } from 'qx-util';
 import { NavBreadcrumbState } from './nav-breadcrumb.state.mjs';
@@ -18,18 +18,21 @@ class NavBreadcrumbController extends PanelItemController {
     super(...arguments);
     /**
      * @description 面包屑分割符
+     * @exposedoc
      * @type {string}
      * @memberof NavBreadcrumbController
      */
     __publicField(this, "separator", "/");
     /**
-     * @description 导航模式（路由、菜单、缓存）
+     * @description 导航模式，路由模式：根据路由计算导航数据，菜单模式：根据菜单模型计算导航数据，缓存模式：根据缓存计算导航数据
+     * @exposedoc
      * @type {('router' | 'menu' | 'store')}
      * @memberof NavBreadcrumbController
      */
     __publicField(this, "navMode", "router");
     /**
      * @description 是否显示应用标题
+     * @exposedoc
      * @type {boolean}
      * @memberof NavBreadcrumbController
      */
@@ -42,6 +45,7 @@ class NavBreadcrumbController extends PanelItemController {
     __publicField(this, "service");
     /**
      * @description 自定义补充参数
+     * @exposedoc
      * @type {IData}
      * @memberof NavBreadcrumbController
      */
@@ -53,6 +57,7 @@ class NavBreadcrumbController extends PanelItemController {
   }
   /**
    * @description 应用菜单控制器
+   * @exposedoc
    * @readonly
    * @type {(IAppMenuController | undefined)}
    * @memberof NavBreadcrumbController
@@ -61,8 +66,9 @@ class NavBreadcrumbController extends PanelItemController {
     return this.panel.view.getController("appmenu");
   }
   /**
-   * @description 首页导航栏
+   * @description 首页导航占位控制器
    * @readonly
+   * @exposedoc
    * @type {(NavPosIndexController | undefined)}
    * @memberof NavBreadcrumbController
    */
@@ -130,11 +136,11 @@ class NavBreadcrumbController extends PanelItemController {
     this.state.breadcrumbItems = this.service.getChache();
   }
   /**
-   * 更新视图信息
-   * @author lxm
-   * @date 2023-05-09 01:40:34
-   * @param {string} key
-   * @param {{ caption?: string; dataInfo?: string }} info
+   * @description 更新视图信息
+   * @param {string} fullPath
+   * @param {{ viewName: string; caption?: string; dataInfo?: string }} info
+   * @return {*}  {void}
+   * @memberof NavBreadcrumbController
    */
   updateViewInfo(fullPath, info) {
     if (this.navMode === "menu") {

package/es/panel-component/nav-breadcrumb/nav-breadcrumb.d.ts

@@ -6,11 +6,25 @@ export interface dropdownAction {
     text: string;
     value?: string;
 }
+/**
+ * 面包屑导航
+ * @primary
+ * @description 首页下的面包屑组件，使用el-breadcrumb绘制，根据打开视图层级绘制面包屑。
+ * @panelitemparams {name:navmode,parameterType:router|menu|store,defaultvalue:router,description:导航模式}
+ * @panelitemparams {name:separator,parameterType:string,defaultvalue:/,description:面包屑分隔符}
+ * @panelitemparams {name:showhome,parameterType:boolean,defaultvalue:true,description:是否显示应用标题}
+ */
 export declare const NavBreadcrumb: import("vue").DefineComponent<{
+    /**
+     * @description 面包屑导航数据
+     */
     modelData: {
         type: PropType<IPanelRawItem>;
         required: true;
     };
+    /**
+     * @description 面包屑导航控制器
+     */
     controller: {
         type: typeof NavBreadcrumbController;
         required: true;
@@ -20,10 +34,16 @@ export declare const NavBreadcrumb: import("vue").DefineComponent<{
     c: NavBreadcrumbController;
     items: import("vue").ComputedRef<import("./nav-breadcrumb.state").BreadcrumbMsg[]>;
 }, 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 NavBreadcrumbController;
         required: true;

package/es/panel-component/nav-breadcrumb/nav-breadcrumb.mjs

@@ -1,4 +1,4 @@
-import { isVNode, defineComponent, watch, computed, createVNode, resolveComponent } from 'vue';
+import { isVNode, watch, computed, resolveComponent, createVNode, defineComponent } from 'vue';
 import { useNamespace } from '@ibiz-template/vue3-util';
 import { useRoute, useRouter } from 'vue-router';
 import { NavBreadcrumbController } from './nav-breadcrumb.controller.mjs';
@@ -11,10 +11,16 @@ function _isSlot(s) {
 const NavBreadcrumb = /* @__PURE__ */ defineComponent({
   name: "IBizNavBreadcrumb",
   props: {
+    /**
+     * @description 面包屑导航数据
+     */
     modelData: {
       type: Object,
       required: true
     },
+    /**
+     * @description 面包屑导航控制器
+     */
     controller: {
       type: NavBreadcrumbController,
       required: true

package/es/panel-component/nav-breadcrumb/nav-breadcrumb.service.mjs

@@ -1,4 +1,4 @@
-import { clone, reject, isNil } from 'ramda';
+import { clone, isNil, reject } from 'ramda';
 import { getIndexBreadcrumb } from './nav-breadcrumb.util.mjs';
 
 "use strict";

package/es/panel-component/nav-breadcrumb/nav-breadcrumb.state.d.ts

@@ -18,7 +18,8 @@ export interface BreadcrumbMsg {
  */
 export declare class NavBreadcrumbState extends PanelItemState {
     /**
-     * @description 面包屑导航项
+     * @description 面包屑数据
+     * @exposedoc
      * @type {BreadcrumbMsg[]}
      * @memberof NavBreadcrumbState
      */

package/es/panel-component/nav-breadcrumb/nav-breadcrumb.state.mjs

@@ -11,7 +11,8 @@ class NavBreadcrumbState extends PanelItemState {
   constructor() {
     super(...arguments);
     /**
-     * @description 面包屑导航项
+     * @description 面包屑数据
+     * @exposedoc
      * @type {BreadcrumbMsg[]}
      * @memberof NavBreadcrumbState
      */

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;
 }