From 769cceee8d70c973e73c7f46f1ad5d98099b971d Mon Sep 17 00:00:00 2001 From: "jlj05024111@163.com" Date: Mon, 28 Apr 2025 18:01:24 +0800 Subject: [PATCH 1/2] =?UTF-8?q?feat:=20=E6=9B=B4=E6=96=B0=E9=9D=A2?= =?UTF-8?q?=E6=9D=BF=E9=A1=B9=E7=BB=84=E4=BB=B6=E6=B3=A8=E9=87=8A?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGELOG.md | 1 + .../async-action/mob-async-action.tsx | 5 ++ src/panel-component/auth-sso/auth-sso.tsx | 12 ++++ .../auth-userinfo/auth-userinfo.tsx | 12 ++++ .../nav-pos-index/nav-pos-index.controller.ts | 60 +++++++------------ .../nav-pos-index/nav-pos-index.state.ts | 20 +++---- .../nav-pos-index/nav-pos-index.tsx | 12 ++++ .../panel-app-title.controller.ts | 5 +- .../panel-app-title/panel-app-title.state.ts | 42 +++++-------- .../panel-app-title/panel-app-title.tsx | 11 ++++ .../panel-button-list.controller.ts | 9 ++- .../panel-button-list.state.ts | 4 +- .../panel-button-list/panel-button-list.tsx | 11 ++++ .../panel-button/panel-button.controller.ts | 9 ++- .../panel-button/panel-button.state.ts | 10 ++-- .../panel-button/panel-button.tsx | 11 ++++ .../panel-carousel.controller.ts | 6 +- .../panel-carousel/panel-carousel.tsx | 11 ++++ .../panel-tab-panel.controller.ts | 6 +- .../panel-tab-panel/panel-tab-panel.state.ts | 6 +- .../panel-tab-panel/panel-tab-panel.tsx | 11 ++++ .../panel-video-player.controller.ts | 6 +- .../panel-video-player/panel-video-player.tsx | 8 +++ .../user-message/user-message.tsx | 5 ++ .../view-content-panel-container.tsx | 11 ++++ .../view-footer-panel-container.tsx | 11 ++++ .../view-header-panel-container.tsx | 11 ++++ .../wf-action-button.controller.ts | 10 ++-- .../wf-action-button.state.ts | 6 +- .../wf-action-button/wf-action-button.tsx | 11 ++++ .../wf-step-trace/wf-step-trace.controller.ts | 6 +- .../wf-step-trace/wf-step-trace.state.ts | 6 +- .../wf-step-trace/wf-step-trace.tsx | 5 ++ 33 files changed, 239 insertions(+), 131 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 696f905060..5a46c6aabf 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 4be0cc0345..30097b3911 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 8d59b83405..5951e507d2 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 11cd501bae..22f7443178 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 14bb426abf..7aaa714bd3 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 9fca6994f0..faea3744bb 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 3c44a4bd1d..5125aa26a1 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 fd8e69d7de..89808441f7 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 6f8284e3a2..a369fa8780 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 cb909f3863..1610cec9af 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 a4ff8bbba5..5b150550ac 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 aad73271e5..485e5992f4 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 7e0b926c0e..0b61daf328 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 43f55b668f..0f660f8125 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 64c83f07db..d7098a067a 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 0339c42c04..0c155a98b9 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 6bb10c9f26..5552ba489c 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 f0e87a8ee7..cb26f1c150 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 f0b489d159..90db27c40a 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 f96a6d7328..c20b20491c 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 46d389e46f..81fce52e5f 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 db02dbf221..64e67fbebe 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 d1dea0b7f3..19c835c435 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 2397e2fa44..da8fe09ea1 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 049abb8b96..6e9a0c4618 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 71b51a7a8c..8143e01113 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 622a4f3dae..6b8a67eebe 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 162ff0c914..47a8cddcb3 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 2bdfeefa20..edf8e82928 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 edf54cbf40..ef1cdb7fd0 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 f92c03510d..6d379b714b 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 ad87eda53c..5d8869602d 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 acec0e25c0..4168c563df 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: { -- Gitee From cf663ee340ea5542b00e86c23b483623c4859821 Mon Sep 17 00:00:00 2001 From: "jlj05024111@163.com" Date: Mon, 28 Apr 2025 18:07:02 +0800 Subject: [PATCH 2/2] =?UTF-8?q?feat:=20=E6=9B=B4=E6=96=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/panel-component/auth-sso/auth-sso.tsx | 2 +- src/panel-component/wf-action-button/wf-action-button.tsx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/panel-component/auth-sso/auth-sso.tsx b/src/panel-component/auth-sso/auth-sso.tsx index 5951e507d2..0a9f42765b 100644 --- a/src/panel-component/auth-sso/auth-sso.tsx +++ b/src/panel-component/auth-sso/auth-sso.tsx @@ -7,7 +7,7 @@ import './auth-sso.scss'; /** * 第三方登录 * @primary - * @description 提供了第三方授权登录功能入口。 + * @description 提供了钉钉和企业微信的第三方授权登录功能入口。 * */ export const AuthSso = defineComponent({ 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 ef1cdb7fd0..6424800b4c 100644 --- a/src/panel-component/wf-action-button/wf-action-button.tsx +++ b/src/panel-component/wf-action-button/wf-action-button.tsx @@ -7,7 +7,7 @@ import './wf-action-button.scss'; /** * 工作流动态按钮 * @primary - * @description 工作流动态按钮 + * @description 用于绘制工作流工具栏里面的按钮。 */ export const WFActionButton = defineComponent({ name: 'IBizWFActionButton', -- Gitee