diff --git a/src/panel-component/app-extend-menu/bottom-side-menu/bottom-side-menu.tsx b/src/panel-component/app-extend-menu/bottom-side-menu/bottom-side-menu.tsx index 07a1ed83c9c70a79f7edbdfaca84145898a51d4e..5a98040403db19d599067464b72926a180d5301a 100644 --- a/src/panel-component/app-extend-menu/bottom-side-menu/bottom-side-menu.tsx +++ b/src/panel-component/app-extend-menu/bottom-side-menu/bottom-side-menu.tsx @@ -9,7 +9,7 @@ import './bottom-side-menu.scss'; * 底部菜单 * @primary * @description 首页视图扩展菜单底部菜单 - * @panelitemparams {name:rendermode,parameterType:'BUTTON' | 'MENU',defaultvalue:BUTTON,description:菜单项绘制模式,其中BUTTON表示按照按钮形态绘制、MENU表示按照菜单形态绘制} + * @panelitemparams {name:rendermode,parameterType:'BUTTON' | 'MENU',defaultvalue:'BUTTON',description:菜单项绘制模式,其中BUTTON表示按照按钮形态绘制、MENU表示按照菜单形态绘制} * @primary */ export const BottomSideMenu = defineComponent({ diff --git a/src/panel-component/app-extend-menu/left-side-menu/left-side-menu.tsx b/src/panel-component/app-extend-menu/left-side-menu/left-side-menu.tsx index d2ca4e9ff43b3b372f460b6534df6ad132143539..91698076093b6dd5a3d78557c072aed18ef53868 100644 --- a/src/panel-component/app-extend-menu/left-side-menu/left-side-menu.tsx +++ b/src/panel-component/app-extend-menu/left-side-menu/left-side-menu.tsx @@ -9,7 +9,7 @@ import './left-side-menu.scss'; * 左侧菜单 * @primary * @description 首页视图扩展菜单左侧菜单 - * @panelitemparams {name:rendermode,parameterType:'BUTTON' | 'MENU',defaultvalue:BUTTON,description:菜单项绘制模式,其中BUTTON表示按照按钮形态绘制、MENU表示按照菜单形态绘制} + * @panelitemparams {name:rendermode,parameterType:'BUTTON' | 'MENU',defaultvalue:'BUTTON',description:菜单项绘制模式,其中BUTTON表示按照按钮形态绘制、MENU表示按照菜单形态绘制} * @primary */ export const LeftSideMenu = defineComponent({ diff --git a/src/panel-component/app-extend-menu/right-side-menu/right-side-menu.tsx b/src/panel-component/app-extend-menu/right-side-menu/right-side-menu.tsx index 2e3f612662e95e8afcfcee90e943e21e2295d9c9..5f1e0c1660b3a9f7dc7806f6d2836e314ac7b836 100644 --- a/src/panel-component/app-extend-menu/right-side-menu/right-side-menu.tsx +++ b/src/panel-component/app-extend-menu/right-side-menu/right-side-menu.tsx @@ -9,7 +9,7 @@ import './right-side-menu.scss'; * 右侧菜单 * @primary * @description 首页视图扩展菜单右侧菜单 - * @panelitemparams {name:rendermode,parameterType:'BUTTON' | 'MENU',defaultvalue:BUTTON,description:菜单项绘制模式,其中BUTTON表示按照按钮形态绘制、MENU表示按照菜单形态绘制} + * @panelitemparams {name:rendermode,parameterType:'BUTTON' | 'MENU',defaultvalue:'BUTTON',description:菜单项绘制模式,其中BUTTON表示按照按钮形态绘制、MENU表示按照菜单形态绘制} * @primary */ export const RightSideMenu = defineComponent({ diff --git a/src/panel-component/app-extend-menu/top-side-menu/top-side-menu.tsx b/src/panel-component/app-extend-menu/top-side-menu/top-side-menu.tsx index 92f058075f639daa728b15bef99dbf9d42f672f2..95e4baeb7314379f6f9ecd111f2ee0cef91b3148 100644 --- a/src/panel-component/app-extend-menu/top-side-menu/top-side-menu.tsx +++ b/src/panel-component/app-extend-menu/top-side-menu/top-side-menu.tsx @@ -9,7 +9,7 @@ import './top-side-menu.scss'; * 头部菜单 * @primary * @description 首页视图扩展菜单头部菜单 - * @panelitemparams {name:rendermode,parameterType:'BUTTON' | 'MENU',defaultvalue:BUTTON,description:菜单项绘制模式,其中BUTTON表示按照按钮形态绘制、MENU表示按照菜单形态绘制} + * @panelitemparams {name:rendermode,parameterType:'BUTTON' | 'MENU',defaultvalue:'BUTTON',description:菜单项绘制模式,其中BUTTON表示按照按钮形态绘制、MENU表示按照菜单形态绘制} * @primary */ export const TopSideMenu = defineComponent({ diff --git a/src/panel-component/app-switch/app-switch.tsx b/src/panel-component/app-switch/app-switch.tsx index 62bd600bf66d83ce15133f055b02359d2f073ae4..8030753a75824d5a9d5136e29931479a0d266453 100644 --- a/src/panel-component/app-switch/app-switch.tsx +++ b/src/panel-component/app-switch/app-switch.tsx @@ -11,7 +11,7 @@ import './app-switch.scss'; * 应用切换器 * @primary * @description 应用切换器是前端导航核心组件,通过可视化列表实现多应用快速跳转,当应用存在子应用时,使用该能力需在首页视图配置应用选择模式为`默认`。 - * @panelitemparams {name:sourcetype,parameterType:'UTIL' | 'REFAPP',defaultvalue:REFAPP,description:应用源类型,其中UTIL表示微应用数据来源于功能组件服务、REFAPP表示微应用数据来源于引用子应用集(主应用和引用子应用的所有首页)} + * @panelitemparams {name:sourcetype,parameterType:'UTIL' | 'REFAPP',defaultvalue:'REFAPP',description:应用源类型,其中UTIL表示微应用数据来源于功能组件服务、REFAPP表示微应用数据来源于引用子应用集(主应用和引用子应用的所有首页)} * @primary */ export const AppSwitch = defineComponent({ diff --git a/src/panel-component/coop-pos/coop-pos.tsx b/src/panel-component/coop-pos/coop-pos.tsx index 920fc633c775b307642856726094ac9cb551ce72..ceeba58fd59d86e9a8db9463c7ac829eee32c93c 100644 --- a/src/panel-component/coop-pos/coop-pos.tsx +++ b/src/panel-component/coop-pos/coop-pos.tsx @@ -14,7 +14,7 @@ import './coop-pos.scss'; * - 勾选【登记打开数据】 -> 显示浏览用户 * - 勾选【登记更新数据】 -> 显示编辑用户 * - 勾选【提示刷新数据】 -> 显示更新用户 - * @panelitemparams {name:showmode,parameterType:avatar|default,defaultvalue:default,description:当值为avatar时会绘制头像} + * @panelitemparams {name:showmode,parameterType:'avatar' | 'default',defaultvalue:'default',description:当值为avatar时会绘制头像} * */ diff --git a/src/panel-component/global-search/global-search.tsx b/src/panel-component/global-search/global-search.tsx index 25e40f4e28d447d76f769f61b25ba72092a86e1a..b979993b4d3ce4d8c74aeb40fd0dff17e845eb3b 100644 --- a/src/panel-component/global-search/global-search.tsx +++ b/src/panel-component/global-search/global-search.tsx @@ -21,7 +21,7 @@ import './global-search.scss'; * 全局搜索 * @primary * @description 全局搜索组件,监听快捷键Ctrl+K弹出搜索框,需在菜单上绑定应用功能预定义类型为GLOBAL_SEARCH的隐藏菜单项,应用功能类型为全局搜索,同时绑定应用实体与自填模式。输入值时会查询实体自填模式数据,同时点击下拉数据后会打开自填模式中的链接视图。每次查询后还会缓存为搜索历史记录。 - * @panelitemparams {name:historyCacheKey,parameterType:string,defaultvalue:global-search-history,description:搜索历史缓存标识} + * @panelitemparams {name:historyCacheKey,parameterType:string,defaultvalue:'global-search-history',description:搜索历史缓存标识} * @panelitemparams {name:maxhistory,parameterType:number,defaultvalue:7,description:最大历史记录,默认7条} * @panelitemparams {name:size,parameterType:number,defaultvalue:100,description:单次查询最大数量,默认100条} * @panelitemparams {name:placeholder,parameterType:string,description:搜索框提示信息} diff --git a/src/panel-component/nav-breadcrumb/nav-breadcrumb.tsx b/src/panel-component/nav-breadcrumb/nav-breadcrumb.tsx index a76a851d9673dad792bd6299557d1eb3fa2efcd2..8e66747f289fe365986011b154dd914f3945f64b 100644 --- a/src/panel-component/nav-breadcrumb/nav-breadcrumb.tsx +++ b/src/panel-component/nav-breadcrumb/nav-breadcrumb.tsx @@ -16,8 +16,8 @@ export interface dropdownAction { * 面包屑导航 * @primary * @description 首页下的面包屑组件,使用el-breadcrumb绘制,根据打开视图层级绘制面包屑。 - * @panelitemparams {name:navmode,parameterType:router|menu|store,defaultvalue:router,description:导航模式} - * @panelitemparams {name:separator,parameterType:string,defaultvalue:/,description:面包屑分隔符} + * @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 const NavBreadcrumb = defineComponent({ 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 01e49c9f02f99545cf86bd1a89b86f06dec38207..7fbba1be3b29ca7af790772ae4dc20a7edd1f84f 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 @@ -66,7 +66,7 @@ export class NavPosIndexController extends PanelItemController { /** * @exposedoc - * @description 当前视图的路由层级,非路由模式不存在。 + * @description 当前视图的路由层级,非路由模式不存在 * @readonly * @type {(number | undefined)} * @memberof NavPosIndexController 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 388ff9c13ad2f62a99409b69d2cedd2b06825751..2e2b9fb359eb14f8a7ddabce4c5af5a4a9d78cb5 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 @@ -28,7 +28,7 @@ export class PanelAppTitleController extends PanelItemController declare panel: ViewLayoutPanelController; /** - * @description 分隔符,将标题以`|`符分割,分隔符前面为caption,后面为caption2 + * @description 分隔符,将标题以`\|`符分割,分隔符前面为caption,后面为caption2 * @exposedoc * @return {*} * @memberof PanelAppTitleController diff --git a/src/panel-component/user-action/user-action.tsx b/src/panel-component/user-action/user-action.tsx index f11215bffc08808592614b0313d1c7966e545e43..e346aa9e2a962cbdd7359562815e3448cbcff562 100644 --- a/src/panel-component/user-action/user-action.tsx +++ b/src/panel-component/user-action/user-action.tsx @@ -13,7 +13,7 @@ import './user-action.scss'; * 用户操作 * @primary * @description 首页中用户操作行为按钮,需在菜单上配置标识为设置(setting)、帮助(helper)、自定义(custom)的三种隐藏菜单项,点击按钮将会执行对应的菜单项应用功能。 - * @panelitemparams {name:noprivmode,parameterType:PARENT|SELF,defaultvalue:PARENT,description:无权限模式,为PARENT时会通过父容器进行显示隐藏} + * @panelitemparams {name:noprivmode,parameterType:'PARENT' | 'SELF',defaultvalue:'PARENT',description:无权限模式,为PARENT时会通过父容器进行显示隐藏} * @export * @class UserAction */ diff --git a/src/panel-component/view-msg-pos/view-msg-pos.tsx b/src/panel-component/view-msg-pos/view-msg-pos.tsx index 71d67c99fd231c07413182bca8264fc88cdaab52..009a37cbacaff4ea76ff94a558d4756c5dbce734 100644 --- a/src/panel-component/view-msg-pos/view-msg-pos.tsx +++ b/src/panel-component/view-msg-pos/view-msg-pos.tsx @@ -8,7 +8,7 @@ import { ViewMsgPosController } from './view-msg-pos.controller'; * @primary * @description 使用el-alert组件,读取视图状态的viewMessages数据,用于在界面布局中给视图消息提供一个显示位置。 * @panelitemparams {name:scroll,parameterType:boolean,defaultvalue:false,description:是否滚动展示} - * @panelitemparams {name:position,parameterType:TOP | BOTTOM | BODY,defaultvalue:BODY,description:指定展示哪个位置的视图消息,TOP代表视图上方,BOTTOM代表视图下方,BODY代表视图内容区} + * @panelitemparams {name:position,parameterType:'TOP' | 'BOTTOM' | 'BODY',defaultvalue:'BODY',description:指定展示哪个位置的视图消息,TOP代表视图上方,BOTTOM代表视图下方,BODY代表视图内容区} */ export const ViewMsgPos = defineComponent({ name: 'IBizViewMsgPos',