From 455247de22994d7bcb44062b28c8cf11263c14ef Mon Sep 17 00:00:00 2001 From: hisoka0728 <1399952343@qq.com> Date: Mon, 2 Sep 2024 13:46:33 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=96=87=E6=A1=A3=E6=9B=B4=E6=96=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vitepress/config.ts | 6 +++++- docs/guide/custom-image-search-box.md | 12 ++++++------ docs/guide/screen-portlet-real-time.md | 6 +++--- docs/guide/screen-radio-list.md | 14 +++++++------- docs/guide/screen-real-time.md | 8 ++++---- docs/guide/tagged-wall.md | 19 +++++++++++-------- 6 files changed, 36 insertions(+), 29 deletions(-) diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 16ae2f8..3f368a6 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -80,9 +80,13 @@ export default defineConfig({ link: '/guide/screen-radio-list', }, { - text: '实时时间', + text: '实时时间（编辑器绘制插件）', link: '/guide/screen-real-time', }, + { + text: '门户实时时间(部件绘制插件)', + link: '/guide/screen-portlet-real-time', + }, { text: '面板按钮', link: '/guide/custom-btn', diff --git a/docs/guide/custom-image-search-box.md b/docs/guide/custom-image-search-box.md index 56b5f0f..2d20204 100644 --- a/docs/guide/custom-image-search-box.md +++ b/docs/guide/custom-image-search-box.md @@ -1,6 +1,6 @@ # 图片搜索框 -图片搜索框为搜索框呈现模式，主要应用与需要自定义背景的搜索框。 +图片搜索框为输入框编辑器的扩展模式，主要应用于需要自定义背景的搜索框。 ## 效果呈现 @@ -8,7 +8,7 @@ ## 配置 -该插件隶属于自定义编辑器插件（基于自定义编辑器进行扩展），下方数据导入应用即可使用 +该插件隶属编辑器绘制插件（基于输入框编辑器进行扩展），下方数据导入应用即可使用 ::: details 点我查看代码 @@ -46,7 +46,7 @@ ![配置](../public/img/custom-image-search-box_config.png) -编辑器样式 +编辑器样式配置截图 ![配置](../public/img/custom-image-search-box_configStyle.png) @@ -57,6 +57,6 @@ ## 参数说明 （成员参数配置） -| 名称 | 类型 | 说明 | 默认值 | -| ----------- | ------ | -------------- | ------ | -| PLACEHOLDER | string | 输入框占位提示 | ' ' | +| 名称 | 类型 | 默认值 | 说明 | +| ----------- | ------ | ------ | -------------- | +| PLACEHOLDER | string | ' ' | 输入框占位提示 | diff --git a/docs/guide/screen-portlet-real-time.md b/docs/guide/screen-portlet-real-time.md index 18625fe..cbac0c8 100644 --- a/docs/guide/screen-portlet-real-time.md +++ b/docs/guide/screen-portlet-real-time.md @@ -38,6 +38,6 @@ ## 参数说明 (成员参数配置) -| 属性名 | 描述 | 类型 | 默认值 | -| ----------- | -------------- | ------ | ------------------------ | -| VALUEFORMAT | 时间格式化参数 | string | YYYY-MM-DD,week,HH:mm:ss | +| 属性名 | 类型 | 默认值 | 说明 | +| ----------- | ------ | ------------------------ | -------------- | +| VALUEFORMAT | string | YYYY-MM-DD,week,HH:mm:ss | 时间格式化参数 | diff --git a/docs/guide/screen-radio-list.md b/docs/guide/screen-radio-list.md index a7b909d..c93542a 100644 --- a/docs/guide/screen-radio-list.md +++ b/docs/guide/screen-radio-list.md @@ -1,6 +1,6 @@ # 大屏循环单选列表 -循环单选列表为大屏单选项列表呈现模式，主要应用在页面中需要循环切换的场景。 +循环单选列表为大屏单选项列表呈现模式，主要应用在页面中需要循环切换选项的场景。 ## 效果呈现 @@ -8,7 +8,7 @@ ## 配置 -该插件隶属于编辑器样式（基于单选项列表进行扩展），下方数据导入应用即可使用 +该插件隶属于编辑器绘制插件（基于单选项列表进行扩展），下方数据导入应用即可使用 ::: details 点我查看代码 @@ -28,7 +28,7 @@ ::: -编辑器样式 +编辑器样式配置截图 ![配置](../public/img/screen-radio-list_config.png) @@ -38,7 +38,7 @@ ## 参数说明（编辑器参数配置） -| 属性名 | 描述 | 类型 | 默认值 | -| --------------- | ------------ | ------- | ------ | -| ENABLECIRCULATE | 是否开启循环 | boolean | true | -| INTERVALTIME | 循环间隔 | number | 3000 | +| 属性名 | 类型 | 默认值 | 说明 | +| --------------- | ------- | ------ | ------------ | +| ENABLECIRCULATE | boolean | true | 是否开启循环 | +| INTERVALTIME | number | 3000 | 循环间隔 | diff --git a/docs/guide/screen-real-time.md b/docs/guide/screen-real-time.md index 6f6c965..2d102d6 100644 --- a/docs/guide/screen-real-time.md +++ b/docs/guide/screen-real-time.md @@ -8,7 +8,7 @@ ## 配置 -该插件隶属于编辑器样式（基于标签进行扩展），下方数据导入应用即可使用 +该插件隶属于编辑器绘制插件（基于标签进行扩展），下方数据导入应用即可使用 ::: details 点我查看代码 @@ -39,8 +39,8 @@ ## 参数说明 （编辑器参数配置） -| 属性名 | 描述 | 类型 | 默认值 | -| -------- | -------------- | ------ | ------------------------ | -| 值格式化 | 时间格式化参数 | string | YYYY-MM-DD,week,HH:mm:ss | +| 属性名 | 类型 | 默认值 | 说明 | +| -------- | ------ | ------------------------ | -------------- | +| 值格式化 | string | YYYY-MM-DD,week,HH:mm:ss | 时间格式化参数 | ![配置](../public/img/screen-real-time_params.png) diff --git a/docs/guide/tagged-wall.md b/docs/guide/tagged-wall.md index 8143928..78d32f4 100644 --- a/docs/guide/tagged-wall.md +++ b/docs/guide/tagged-wall.md @@ -1,6 +1,6 @@ # 标签墙 -标签墙为大屏列表呈现模式，是列表的一种增强，要达到该目标，需要在列表上绑定标签墙。 +标签墙为大屏列表呈现模式，是列表的一种增强，通常由多个标签组成，以可视化的方式呈现特定的信息或分类。 ## 效果呈现 @@ -31,15 +31,18 @@ ![配置](../public/img/tagged-wall_config.png) -## 说明 +## 功能说明 标签墙由多个标签组件(customTag)组成。首先通过函数$RandomSplit获取一组和为列表长度的数组，后通过函数将$RandomSplit将列表数组随机排列为菱形(中间多两头少的列表)。最后通过customTag绘制。标签的字体大小和颜色由函数$Normal和函数$RandomColor随机生成。 +- 支持配置字体大小是否随机，字体大小随机范围 +- 支持配置字体随机颜色 + ## 参数说明 (部件参数配置) -| 名称 | 类型 | 说明 | 默认值 | -| -------------------- | -------- | ------------------------ | ------------------- | -| ENABLEFONTSIZERANDOM | boolean | 字体大小是否为随机 | true | -| RANDOMFONTSIZERANGE | object | 随机字体大小时的范围参数 | 最大值：16，最小值2 | -| DEFAULTFONTSIZE | number | 不随机时默认字号 | 16 | -| CUSTOMCOLORGROUP | string[] | 自定义字体颜色组 | [] | +| 名称 | 类型 | 默认值 | 说明 | +| -------------------- | -------- | ------------------- | ------------------------ | +| ENABLEFONTSIZERANDOM | boolean | true | 字体大小是否为随机 | +| RANDOMFONTSIZERANGE | object | 最大值：16，最小值2 | 随机字体大小时的范围参数 | +| DEFAULTFONTSIZE | number | 16 | 不随机时默认字号 | +| CUSTOMCOLORGROUP | string[] | [] | 自定义字体颜色组 | -- Gitee