diff --git a/CHANGELOG.md b/CHANGELOG.md index 696f9050601c8c5b26ca65a2bc24e65967a3bb03..5a46c6aabf9255333215de9e8d6faa9070ecbdc9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ ### Change +- 更新面板项组件注释 - 更新编辑器组件输入参数注释 - 更新部件组件输入参数注释 - 更新md-ctrl组件输入参数注释 diff --git a/src/panel-component/async-action/mob-async-action.tsx b/src/panel-component/async-action/mob-async-action.tsx index 4be0cc034545ea2b73a63e3d5457adcdde0a330e..30097b39110cda0939064eaeeb3ff5c676d10cbf 100644 --- a/src/panel-component/async-action/mob-async-action.tsx +++ b/src/panel-component/async-action/mob-async-action.tsx @@ -5,6 +5,11 @@ import { MobAsyncActionController } from './mob-async-action.controller'; import { AsyncActionTab } from './async-action-tab/async-action-tab'; import './mob-async-action.scss'; +/** + * 移动端后台作业组件 + * @primary + * @description 用于在一些需要后台异步操作(如上传导入文件)的场景下,对异步操作过程和结果进行通知。 + */ export const MobAsyncAction = defineComponent({ name: 'MobAsyncAction', props: getRawProps(), diff --git a/src/panel-component/auth-sso/auth-sso.tsx b/src/panel-component/auth-sso/auth-sso.tsx index 8d59b83405d48eecd7591c85c7b3dc6d23a3bdbd..0a9f42765bbb5c5fe1c3433acc82bcdffce98524 100644 --- a/src/panel-component/auth-sso/auth-sso.tsx +++ b/src/panel-component/auth-sso/auth-sso.tsx @@ -4,13 +4,25 @@ import { IPanelRawItem } from '@ibiz/model-core'; import { useNamespace } from '@ibiz-template/vue3-util'; import './auth-sso.scss'; +/** + * 第三方登录 + * @primary + * @description 提供了钉钉和企业微信的第三方授权登录功能入口。 + * + */ export const AuthSso = defineComponent({ name: 'IBizAuthSsO', props: { + /** + * @description 第三方登录组件模型数据 + */ modelData: { type: Object as PropType, required: true, }, + /** + * @description 第三方登录组件控制器 + */ controller: { type: PanelItemController, required: true, diff --git a/src/panel-component/auth-userinfo/auth-userinfo.tsx b/src/panel-component/auth-userinfo/auth-userinfo.tsx index 11cd501baeb8662bcec4ffb72d2abbbc806b4f35..22f744317886cac7e9cd8776434ba22612c08835 100644 --- a/src/panel-component/auth-userinfo/auth-userinfo.tsx +++ b/src/panel-component/auth-userinfo/auth-userinfo.tsx @@ -4,13 +4,25 @@ import './auth-userinfo.scss'; import { IPanelRawItem } from '@ibiz/model-core'; import { PanelItemController } from '@ibiz-template/runtime'; +/** + * 用户信息组件 + * @description 用于显示当前登录用户的基本信息,如姓名,组织名等。 + * @primary + * + */ export const AuthUserinfo = defineComponent({ name: 'IBizAuthUserinfo', props: { + /** + * @description 用户信息组件模型数据 + */ modelData: { type: Object as PropType, required: true, }, + /** + * @description 用户信息组件控制器 + */ controller: { type: PanelItemController, required: true, diff --git a/src/panel-component/nav-pos-index/nav-pos-index.controller.ts b/src/panel-component/nav-pos-index/nav-pos-index.controller.ts index 14bb426abf99986ee2b5c7aa28f3d3baa9c42ce1..7aaa714bd332f2199e57dc95bdca54dd03f7952f 100644 --- a/src/panel-component/nav-pos-index/nav-pos-index.controller.ts +++ b/src/panel-component/nav-pos-index/nav-pos-index.controller.ts @@ -23,43 +23,35 @@ export class NavPosIndexController extends PanelItemController { declare 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 = true; /** - * 自定义补充参数 - * - * @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 = false; @@ -79,9 +71,8 @@ export class NavPosIndexController extends PanelItemController { } /** - * 当前视图的路由层级,非路由模式不存在。 - * @author lxm - * @date 2023-05-09 12:46:26 + * @description 当前视图的路由层级,非路由模式不存在。 + * @exposedoc * @readonly */ get routeDepth(): number | undefined { @@ -89,9 +80,8 @@ export class NavPosIndexController extends PanelItemController { } /** - * 应用菜单控制器 - * @author lxm - * @date 2023-05-10 08:41:42 + * @description 应用菜单控制器 + * @exposedoc * @readonly * @type {(IAppMenuController | undefined)} */ @@ -100,9 +90,8 @@ export class NavPosIndexController extends PanelItemController { } /** - * 改变显示视图 - * @author lxm - * @date 2023-05-25 01:28:49 + * @description 改变显示视图 + * @exposedoc * @param {string} key */ changeView(key: string): void { @@ -183,9 +172,8 @@ export class NavPosIndexController extends PanelItemController { } /** - * 删除单个缓存 - * @author lxm - * @date 2023-05-09 02:19:09 + * @description 删除单个缓存 + * @exposedoc * @param {string} key */ removeCache(key: string): void { @@ -208,9 +196,8 @@ export class NavPosIndexController extends PanelItemController { } /** - * 清空缓存 - * @author lxm - * @date 2023-05-09 02:19:55 + * @description 清空缓存 + * @exposedoc */ clearCache(): void { this.state.cacheKeys = []; @@ -218,10 +205,8 @@ export class NavPosIndexController extends PanelItemController { } /** - * 关闭视图 - * 走modal的dismiss,会走一遍视图内部的校验,不通过则不会关闭 - * @author lxm - * @date 2023-05-25 03:10:23 + * @description 关闭视图 + * @exposedoc * @param {string} keys */ async closeViewByKeys(keys: string[]): Promise { @@ -258,7 +243,8 @@ export class NavPosIndexController extends PanelItemController { } /** - * 返回上一个页面或上一层空白路由 + * @description 返回上一个页面或上一层空白路由 + * @exposedoc * @author lxm * @date 2023-05-25 06:46:27 * @protected diff --git a/src/panel-component/nav-pos-index/nav-pos-index.state.ts b/src/panel-component/nav-pos-index/nav-pos-index.state.ts index 9fca6994f098d2d06773d539a630934704c2d3eb..faea3744bb613098a7f7ac983a8719c5ba83eb69 100644 --- a/src/panel-component/nav-pos-index/nav-pos-index.state.ts +++ b/src/panel-component/nav-pos-index/nav-pos-index.state.ts @@ -11,33 +11,29 @@ import { INavViewMsg, PanelItemState } from '@ibiz-template/runtime'; */ export 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[] = ['RouterShell']; /** - * 导航视图详细信息 - * @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[] = []; diff --git a/src/panel-component/nav-pos-index/nav-pos-index.tsx b/src/panel-component/nav-pos-index/nav-pos-index.tsx index 3c44a4bd1d443aa4497e81b5ac5a7b89a86a690d..5125aa26a1fd74e3a6fd3b614758d742a1e181c8 100644 --- a/src/panel-component/nav-pos-index/nav-pos-index.tsx +++ b/src/panel-component/nav-pos-index/nav-pos-index.tsx @@ -12,13 +12,25 @@ import { useRoute, useRouter } from 'vue-router'; 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 const NavPosIndex = defineComponent({ name: 'IBizNavPosIndex', props: { + /** + * @description 首页导航占位模型数据 + */ modelData: { type: Object as PropType, required: true, }, + /** + * @description 首页导航占位控制器 + */ controller: { type: NavPosIndexController, required: true, diff --git a/src/panel-component/panel-app-title/panel-app-title.controller.ts b/src/panel-component/panel-app-title/panel-app-title.controller.ts index fd8e69d7de5e38f8fe759c4587d1fd7fae4f8eb9..89808441f7769c7e955523b5eca72ee00df718f3 100644 --- a/src/panel-component/panel-app-title/panel-app-title.controller.ts +++ b/src/panel-component/panel-app-title/panel-app-title.controller.ts @@ -20,8 +20,8 @@ export class PanelAppTitleController extends PanelItemController } /** - * 面板控制器 - * + * @description 面板控制器 + * @exposedoc * @type {ViewLayoutPanelController} * @memberof PanelAppTitleController */ @@ -29,6 +29,7 @@ export class PanelAppTitleController extends PanelItemController /** * @description 自定义补充参数 + * @exposedoc * @type {IData} * @memberof PanelAppTitleController */ diff --git a/src/panel-component/panel-app-title/panel-app-title.state.ts b/src/panel-component/panel-app-title/panel-app-title.state.ts index 6f8284e3a247f6a2ff07974865954ac2642112bc..a369fa878068761fb941c7c2dbd10247457a11ef 100644 --- a/src/panel-component/panel-app-title/panel-app-title.state.ts +++ b/src/panel-component/panel-app-title/panel-app-title.state.ts @@ -11,64 +11,50 @@ import { PanelItemState } from '@ibiz-template/runtime'; */ export 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 = false; diff --git a/src/panel-component/panel-app-title/panel-app-title.tsx b/src/panel-component/panel-app-title/panel-app-title.tsx index cb909f38634ba1bbf284cf8ae14dec59548969b8..1610cec9afcbfa5baa81bc3769ce67e8412f11f2 100644 --- a/src/panel-component/panel-app-title/panel-app-title.tsx +++ b/src/panel-component/panel-app-title/panel-app-title.tsx @@ -10,13 +10,24 @@ import { useRoute, useRouter } from 'vue-router'; import { PanelAppTitleController } from './panel-app-title.controller'; import './panel-app-title.scss'; +/** + * 面板应用标题 + * @primary + * @description 用于绘制应用logo和应用标题,提供点击标题跳转首页的能力。 + */ export const PanelAppTitle = defineComponent({ name: 'IBizPanelAppTitle', props: { + /** + * @description 面板应用标题模型数据 + */ modelData: { type: Object as PropType, required: true, }, + /** + * @description 面板应用标题控制器 + */ controller: { type: PanelAppTitleController, required: true, diff --git a/src/panel-component/panel-button-list/panel-button-list.controller.ts b/src/panel-component/panel-button-list/panel-button-list.controller.ts index a4ff8bbba58d85aa9c1b352c7871248af7bd935f..5b150550ac8c4cac0b33823de1d02af218b740a5 100644 --- a/src/panel-component/panel-button-list/panel-button-list.controller.ts +++ b/src/panel-component/panel-button-list/panel-button-list.controller.ts @@ -29,9 +29,8 @@ export class PanelButtonListController extends PanelItemController} diff --git a/src/panel-component/panel-button-list/panel-button-list.state.ts b/src/panel-component/panel-button-list/panel-button-list.state.ts index aad73271e5887e7353d40d34820b6178e0fd6b50..485e5992f40e3d016326c970533690dfb385eeba 100644 --- a/src/panel-component/panel-button-list/panel-button-list.state.ts +++ b/src/panel-component/panel-button-list/panel-button-list.state.ts @@ -9,8 +9,8 @@ import { IButtonContainerState, PanelItemState } from '@ibiz-template/runtime'; */ export class PanelButtonListState extends PanelItemState { /** - * 按钮组状态 - * + * @description 按钮组状态 + * @exposedoc * @type {IButtonContainerState} * @memberof PanelButtonListState */ diff --git a/src/panel-component/panel-button-list/panel-button-list.tsx b/src/panel-component/panel-button-list/panel-button-list.tsx index 7e0b926c0ee4d3953c17ecf9c10cf6ddeeaa9c98..0b61daf3285d7c477496327db80c50593212127b 100644 --- a/src/panel-component/panel-button-list/panel-button-list.tsx +++ b/src/panel-component/panel-button-list/panel-button-list.tsx @@ -5,13 +5,24 @@ import { defineComponent, PropType } from 'vue'; import { PanelButtonListController } from './panel-button-list.controller'; import './panel-button-list.scss'; +/** + * 按钮列表 + * @primary + * @description 绘制按钮组组件,并在接收到抛出的点击事件后调用控制器的方法执行按钮对应的行为。 + */ export const PanelButtonList = defineComponent({ name: 'IBizPanelButtonList', props: { + /** + * @description 按钮组模型数据 + */ modelData: { type: Object as PropType, required: true, }, + /** + * @description 按钮组控制器 + */ controller: { type: PanelButtonListController, required: true, diff --git a/src/panel-component/panel-button/panel-button.controller.ts b/src/panel-component/panel-button/panel-button.controller.ts index 43f55b668f3e4f986e52aed3869437229ff1ebbe..0f660f812548736678508748f28bcab84ae1ab7f 100644 --- a/src/panel-component/panel-button/panel-button.controller.ts +++ b/src/panel-component/panel-button/panel-button.controller.ts @@ -24,17 +24,16 @@ export class PanelButtonController extends PanelItemController { } /** - * 面板控制器 - * + * @description面板控制器 + * @exposedoc * @type {ViewLayoutPanelController} * @memberof PanelButtonController */ declare panel: ViewLayoutPanelController; /** - * 父容器数据对象数据 - * @author lxm - * @date 2023-07-15 01:33:58 + * @description 父容器数据对象数据 + * @exposedoc * @readonly * @type {IData} */ diff --git a/src/panel-component/panel-button/panel-button.state.ts b/src/panel-component/panel-button/panel-button.state.ts index 64c83f07dba2181e73e099de1f5bad11a3061d1d..d7098a067a9267c165ae451c1453a6cf4cbb6efe 100644 --- a/src/panel-component/panel-button/panel-button.state.ts +++ b/src/panel-component/panel-button/panel-button.state.ts @@ -11,17 +11,15 @@ import { PanelItemState, UIActionButtonState } from '@ibiz-template/runtime'; */ export class PanelButtonState extends PanelItemState { /** - * 加载中 - * @author lxm - * @date 2023-07-21 10:11:21 + * @description 加载中 + * @exposedoc * @type {boolean} */ loading: boolean = false; /** - * 界面行为状态 - * @author lxm - * @date 2023-07-21 03:34:27 + * @description 界面行为状态 + * @exposedoc * @type {UIActionButtonState} */ uiActionState!: UIActionButtonState; diff --git a/src/panel-component/panel-button/panel-button.tsx b/src/panel-component/panel-button/panel-button.tsx index 0339c42c0453a3cab0880cbd3e3700d0bcf6d30b..0c155a98b948a9359bbc7219e88902b5ddbefef7 100644 --- a/src/panel-component/panel-button/panel-button.tsx +++ b/src/panel-component/panel-button/panel-button.tsx @@ -5,13 +5,24 @@ import { PanelButtonController } from './panel-button.controller'; import { convertBtnType } from '../../util'; import './panel-button.scss'; +/** + * 按钮组件 + * @primary + * @description 面板中最常见的按钮组件,支持配置界面行为、界面逻辑等,同时支持权限配置是否显示、是否禁用。 + */ export const PanelButton = defineComponent({ name: 'IBizPanelButton', props: { + /** + * @description 按钮模型 + */ modelData: { type: Object as PropType, required: true, }, + /** + * @description 按钮控制器 + */ controller: { type: PanelButtonController, required: true, diff --git a/src/panel-component/panel-carousel/panel-carousel.controller.ts b/src/panel-component/panel-carousel/panel-carousel.controller.ts index 6bb10c9f26a304a03c6f90b9712fc00b0cc46f1e..5552ba489c9acebf38bc6c1f903722d3878d7a33 100644 --- a/src/panel-component/panel-carousel/panel-carousel.controller.ts +++ b/src/panel-component/panel-carousel/panel-carousel.controller.ts @@ -12,10 +12,8 @@ import { IPanelRawItem, IRawItemParam, ISysImage } from '@ibiz/model-core'; */ export class PanelCarouselController extends PanelItemController { /** - * 图片集 - * - * @author zk - * @date 2023-12-08 01:12:38 + * @description 图片集 + * @exposedoc * @memberof PanelCarouselController */ public images: ISysImage[] = []; diff --git a/src/panel-component/panel-carousel/panel-carousel.tsx b/src/panel-component/panel-carousel/panel-carousel.tsx index f0e87a8ee72665e72ba38d964bf899954145826a..cb26f1c15098f7a7ddfb136bb79147f291de44f5 100644 --- a/src/panel-component/panel-carousel/panel-carousel.tsx +++ b/src/panel-component/panel-carousel/panel-carousel.tsx @@ -3,13 +3,24 @@ import { defineComponent, PropType } from 'vue'; import { PanelCarouselController } from './panel-carousel.controller'; import './panel-carousel.scss'; +/** + * 轮播图 + * @primary + * @description 可配置一组静态图片,用于轮播。 + */ export const PanelCarousel = defineComponent({ name: 'IBizPanelCarousel', props: { + /** + * @description 轮播图模型数据 + */ controller: { type: PanelCarouselController, required: true, }, + /** + * @description 轮播图控制器 + */ attrs: { type: Object as PropType, required: false, diff --git a/src/panel-component/panel-tab-panel/panel-tab-panel.controller.ts b/src/panel-component/panel-tab-panel/panel-tab-panel.controller.ts index f0b489d1594ee6bf9efd634f2d7a99bdd5788018..90db27c40a808b68e9cc007f045e921095f2301d 100644 --- a/src/panel-component/panel-tab-panel/panel-tab-panel.controller.ts +++ b/src/panel-component/panel-tab-panel/panel-tab-panel.controller.ts @@ -30,10 +30,8 @@ export class PanelTabPanelController extends PanelItemController } /** - * 分页点击切换处理 - * - * @author tony001 - * @date 2024-05-12 14:05:11 + * @description 分页点击切换处理 + * @exposedoc * @param {string} tabId */ onTabChange(tabId: string): void { diff --git a/src/panel-component/panel-tab-panel/panel-tab-panel.state.ts b/src/panel-component/panel-tab-panel/panel-tab-panel.state.ts index f96a6d732882fbe4e0d50eea2693b41e53e50e8a..c20b20491cedae5ea1101ec47de190a497aa9d24 100644 --- a/src/panel-component/panel-tab-panel/panel-tab-panel.state.ts +++ b/src/panel-component/panel-tab-panel/panel-tab-panel.state.ts @@ -11,10 +11,8 @@ import { PanelItemState } from '@ibiz-template/runtime'; */ export class PanelTabPanelState extends PanelItemState { /** - * 当前激活分页 - * - * @author tony001 - * @date 2024-05-12 14:05:36 + * @description 当前激活分页 + * @exposedoc * @type {string} */ activeTab: string = ''; diff --git a/src/panel-component/panel-tab-panel/panel-tab-panel.tsx b/src/panel-component/panel-tab-panel/panel-tab-panel.tsx index 46d389e46f61f573ff6789d90e2aa0cd8469ccd7..81fce52e5f943bcaccb1ccf8a4ac09f1683aa2bf 100644 --- a/src/panel-component/panel-tab-panel/panel-tab-panel.tsx +++ b/src/panel-component/panel-tab-panel/panel-tab-panel.tsx @@ -4,13 +4,24 @@ import { computed, defineComponent, PropType, VNode } from 'vue'; import { PanelTabPanelController } from './panel-tab-panel.controller'; import './panel-tab-panel.scss'; +/** + * 面板分页部件 + * @primary + * @description 可显示多个分页,每个分页有自己的内容。 + */ export const PanelTabPanel = defineComponent({ name: 'IBizPanelTabPanel', props: { + /** + * @description 面板分页部件模型数据 + */ modelData: { type: Object as PropType, required: true, }, + /** + * @description 面板分页部件控制器 + */ controller: { type: PanelTabPanelController, required: true, diff --git a/src/panel-component/panel-video-player/panel-video-player.controller.ts b/src/panel-component/panel-video-player/panel-video-player.controller.ts index db02dbf221eaa6e12a0ee9793559739e1cfd44c2..64e67fbebee22bb636d38d42189e0df8a95ea832 100644 --- a/src/panel-component/panel-video-player/panel-video-player.controller.ts +++ b/src/panel-component/panel-video-player/panel-video-player.controller.ts @@ -12,10 +12,8 @@ import { IPanelRawItem, IRawItemParam } from '@ibiz/model-core'; */ export class PanelVideoPlayerController extends PanelItemController { /** - * 视频播放器额外参数 - * - * @author zk - * @date 2023-12-08 03:12:09 + * @description 视频播放器额外参数 + * @exposedoc * @memberof PanelVideoPlayerController */ public rawItemParams = {}; diff --git a/src/panel-component/panel-video-player/panel-video-player.tsx b/src/panel-component/panel-video-player/panel-video-player.tsx index d1dea0b7f3fea8fba2375319ba5ad4aa2bb3edc4..19c835c435e8dd15e9375ba42c5976e4b4d04233 100644 --- a/src/panel-component/panel-video-player/panel-video-player.tsx +++ b/src/panel-component/panel-video-player/panel-video-player.tsx @@ -4,9 +4,17 @@ import { createUUID } from 'qx-util'; import { PanelVideoPlayerController } from './panel-video-player.controller'; import './panel-video-player.scss'; +/** + * 视频播放器 + * @primary + * @description 可配置视频地址播放视频。 + */ export const PanelVideoPlayer = defineComponent({ name: 'IBizPanelVideoPlayer', props: { + /** + * @description 视频控制器 + */ controller: { type: PanelVideoPlayerController, required: true, diff --git a/src/panel-component/user-message/user-message.tsx b/src/panel-component/user-message/user-message.tsx index 2397e2fa4427f0c40e09b55b7208a95b58456b1f..da8fe09ea16b74d7ad8169f7d4f12d9dd6f7c969 100644 --- a/src/panel-component/user-message/user-message.tsx +++ b/src/panel-component/user-message/user-message.tsx @@ -24,6 +24,11 @@ import { MobUserMessageController } from './user-message.controller'; import './user-message.scss'; import { InternalMessageDefaultProvider } from './common'; +/** + * 用户消息 + * @primary + * @description 用户消息组件,用于显示网站内关于用户的通知消息。 + */ export const MobUserMessage = defineComponent({ name: 'MobUserMessage', props: getRawProps(), diff --git a/src/panel-component/view-content-panel-container/view-content-panel-container.tsx b/src/panel-component/view-content-panel-container/view-content-panel-container.tsx index 049abb8b96b6cf1e2675fa08b0e3fe1b1a111a60..6e9a0c46184e8059f54dbeeb3cc6fee95d7d8992 100644 --- a/src/panel-component/view-content-panel-container/view-content-panel-container.tsx +++ b/src/panel-component/view-content-panel-container/view-content-panel-container.tsx @@ -9,13 +9,24 @@ import { SysUIActionTag } from '@ibiz-template/runtime'; import { useRoute } from 'vue-router'; import './view-content-panel-container.scss'; +/** + * 视图内容容器 + * @primary + * @description 用于包裹视图布局主体内容。 + */ export const ViewContentPanelContainer: Component = defineComponent({ name: 'IBizViewContentPanelContainer', props: { + /** + * @description 视图内容容器模型数据 + */ modelData: { type: Object as PropType, required: true, }, + /** + * @description 视图内容容器控制器 + */ controller: { type: PanelContainerController, required: true, diff --git a/src/panel-component/view-footer-panel-container/view-footer-panel-container.tsx b/src/panel-component/view-footer-panel-container/view-footer-panel-container.tsx index 71b51a7a8cc9a3a8ee8a296f876aeb5cd2875c96..8143e01113adb370c711050dbf0e6839f2be7a62 100644 --- a/src/panel-component/view-footer-panel-container/view-footer-panel-container.tsx +++ b/src/panel-component/view-footer-panel-container/view-footer-panel-container.tsx @@ -6,13 +6,24 @@ import { IPanelContainer } from '@ibiz/model-core'; import { PropType, defineComponent, computed } from 'vue'; import './view-footer-panel-container.scss'; +/** + * 视图底部容器 + * @primary + * @description 用于包裹视图布局底部内容。 + */ export const ViewFooterPanelContainer = defineComponent({ name: 'IBizViewFooterPanelContainer', props: { + /** + * @description 视图底部容器模型数据 + */ modelData: { type: Object as PropType, required: true, }, + /** + * @description 视图底部容器控制器 + */ controller: { type: PanelContainerController, required: true, diff --git a/src/panel-component/view-header-panel-container/view-header-panel-container.tsx b/src/panel-component/view-header-panel-container/view-header-panel-container.tsx index 622a4f3daec4fcd5a45d9c921777f0fd0c942c35..6b8a67eebe62725b3ea2ae15f597e08b8a0535ea 100644 --- a/src/panel-component/view-header-panel-container/view-header-panel-container.tsx +++ b/src/panel-component/view-header-panel-container/view-header-panel-container.tsx @@ -8,13 +8,24 @@ import './view-header-panel-container.scss'; import { useRoute } from 'vue-router'; import { useViewStack } from '../../util'; +/** + * 视图头部容器 + * @primary + * @description 用于包裹视图布局头部内容。 + */ export const ViewHeaderPanelContainer = defineComponent({ name: 'IBizViewHeaderPanelContainer', props: { + /** + * @description 视图头部容器模型数据 + */ modelData: { type: Object as PropType, required: true, }, + /** + * @description 视图头部容器控制器 + */ controller: { type: PanelContainerController, required: true, diff --git a/src/panel-component/wf-action-button/wf-action-button.controller.ts b/src/panel-component/wf-action-button/wf-action-button.controller.ts index 162ff0c91450b59b29bf5387c63b84433e6dbc39..47a8cddcb31a07a0e516640255e139cd8f65702b 100644 --- a/src/panel-component/wf-action-button/wf-action-button.controller.ts +++ b/src/panel-component/wf-action-button/wf-action-button.controller.ts @@ -20,18 +20,16 @@ export class WFActionButtonController extends PanelItemController } /** - * 面板控制器 - * + * @description 面板控制器 + * @exposedoc * @type {ViewLayoutPanelController} * @memberof WFActionButtonController */ declare panel: ViewLayoutPanelController; /** - * 工作流动态按钮 - * - * @author zk - * @date 2023-11-12 06:11:28 + * @description 工作流动态按钮 + * @exposedoc * @readonly * @type {IData[]} * @memberof WFActionButtonController diff --git a/src/panel-component/wf-action-button/wf-action-button.state.ts b/src/panel-component/wf-action-button/wf-action-button.state.ts index 2bdfeefa200baf3a61a8e942c0a5ba54e2f17b15..edf8e8292851462ed2553c6ca2200719cee95e0a 100644 --- a/src/panel-component/wf-action-button/wf-action-button.state.ts +++ b/src/panel-component/wf-action-button/wf-action-button.state.ts @@ -11,10 +11,8 @@ import { PanelItemState } from '@ibiz-template/runtime'; */ export class WFActionButtonState extends PanelItemState { /** - * 工作流按钮数组 - * - * @author zk - * @date 2023-11-09 11:11:49 + * @description 工作流按钮数组 + * @exposedoc * @type {IData[]} * @memberof WFActionButtonState */ diff --git a/src/panel-component/wf-action-button/wf-action-button.tsx b/src/panel-component/wf-action-button/wf-action-button.tsx index edf54cbf40a6316e7727348363857e5935709d89..6424800b4c03263415d3ed489048251b06bd69f0 100644 --- a/src/panel-component/wf-action-button/wf-action-button.tsx +++ b/src/panel-component/wf-action-button/wf-action-button.tsx @@ -4,13 +4,24 @@ import { defineComponent, PropType, computed, ref } from 'vue'; import { WFActionButtonController } from './wf-action-button.controller'; import './wf-action-button.scss'; +/** + * 工作流动态按钮 + * @primary + * @description 用于绘制工作流工具栏里面的按钮。 + */ export const WFActionButton = defineComponent({ name: 'IBizWFActionButton', props: { + /** + * @description 工作流动态按钮模型数据 + */ modelData: { type: Object as PropType, required: true, }, + /** + * @description 工作流动态按钮控制器 + */ controller: { type: WFActionButtonController, required: true, diff --git a/src/panel-component/wf-step-trace/wf-step-trace.controller.ts b/src/panel-component/wf-step-trace/wf-step-trace.controller.ts index f92c03510d90bb9bc18b5210ef4735b4cf4648ef..6d379b714b14b1d42a87bdb2c8a59b7664566248 100644 --- a/src/panel-component/wf-step-trace/wf-step-trace.controller.ts +++ b/src/panel-component/wf-step-trace/wf-step-trace.controller.ts @@ -89,10 +89,8 @@ export class WFStepTraceController extends PanelItemController { } /** - * 获取数据 - * - * @author zk - * @date 2023-07-04 05:07:57 + * @description 获取数据 + * @exposedoc * @return {*} * @memberof WFStepTraceController */ diff --git a/src/panel-component/wf-step-trace/wf-step-trace.state.ts b/src/panel-component/wf-step-trace/wf-step-trace.state.ts index ad87eda53c950369f11f283d97eadd83cccf0704..5d8869602d056ba3e39c35608b48213a3295e831 100644 --- a/src/panel-component/wf-step-trace/wf-step-trace.state.ts +++ b/src/panel-component/wf-step-trace/wf-step-trace.state.ts @@ -9,10 +9,8 @@ import { PanelItemState } from '@ibiz-template/runtime'; */ export class WFStepTraceState extends PanelItemState { /** - * 流程跟踪数据 - * - * @author zk - * @date 2023-07-04 01:07:30 + * @description 流程跟踪数据 + * @exposedoc * @type {IData} * @memberof WFStepTraceState */ diff --git a/src/panel-component/wf-step-trace/wf-step-trace.tsx b/src/panel-component/wf-step-trace/wf-step-trace.tsx index acec0e25c06af8722ea0bd7f05dbb5c1b8753bf7..4168c563df41e946b35ab8344177e3ff397efe44 100644 --- a/src/panel-component/wf-step-trace/wf-step-trace.tsx +++ b/src/panel-component/wf-step-trace/wf-step-trace.tsx @@ -3,6 +3,11 @@ import { computed, defineComponent } from 'vue'; import { WFStepTraceController } from './wf-step-trace.controller'; import './wf-step-trace.scss'; +/** + * 流程跟踪组件 + * @primary + * @description 根据流程跟踪数据循环绘制步骤条,每一条提供了4个步骤信息展示,包括处理完成时间(time),处理环节(type),处理人(authorNames),提交路径(taskName)。 + */ export const WFStepTrace = defineComponent({ name: 'IBizWFStepTrace', props: {