From bba025442f225688773f5a791bc321ac43211954 Mon Sep 17 00:00:00 2001 From: zhf <1204297681@qq.com> Date: Wed, 30 Apr 2025 15:27:13 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E4=BC=98=E5=8C=96=E7=BC=96=E8=BE=91?= =?UTF-8?q?=E5=99=A8=E5=92=8C=E9=9D=A2=E6=9D=BF=E9=A1=B9=E7=9A=84=E6=B3=A8?= =?UTF-8?q?=E9=87=8A?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../cascader/ibiz-cascader/ibiz-cascader.tsx | 3 +-- .../ibiz-checkbox-list/ibiz-checkbox-list.tsx | 3 +-- .../check-box/ibiz-checkbox/ibiz-checkbox.tsx | 7 +++---- .../ibiz-color-picker/ibiz-color-picker.tsx | 3 +-- .../data-picker/ibiz-mpicker/ibiz-mpicker.tsx | 3 +-- .../ibiz-picker-select-view.tsx | 3 +-- .../data-picker/ibiz-picker/ibiz-picker.tsx | 3 +-- .../ibiz-date-picker/ibiz-date-picker.tsx | 3 +-- .../ibiz-date-range-picker.tsx | 13 ++++++------- .../ibiz-dropdown-list/ibiz-dropdown-list.tsx | 3 +-- .../dropdown-list/ibiz-dropdown/ibiz-dropdown.tsx | 3 +-- .../ibiz-emoji-picker/ibiz-emoji-picker.tsx | 3 +-- src/editor/html/quill-editor/quill-editor.tsx | 3 +-- .../ibiz-markdown-editor/ibiz-markdown-editor.tsx | 3 +-- .../ibiz-number-range-picker.tsx | 11 +++++------ src/editor/qrcode/ibiz-qrcode/ibiz-qrcode.tsx | 2 +- .../radio-button-list/ibiz-radio/ibiz-radio.tsx | 3 +-- src/editor/rate/ibiz-rate/ibiz-rate.tsx | 5 ++--- src/editor/raw/ibiz-raw/ibiz-raw.tsx | 6 ++---- src/editor/slider/ibiz-slider/ibiz-slider.tsx | 15 +++++++-------- src/editor/span/span/span.tsx | 4 ++-- src/editor/stepper/ibiz-stepper/ibiz-stepper.tsx | 10 +++++----- src/editor/switch/ibiz-switch/ibiz-switch.tsx | 6 +++--- .../ibiz-input-number/ibiz-input-number.tsx | 6 +++--- src/editor/text-box/input/input.tsx | 2 +- src/editor/upload/ibiz-carousel/ibiz-carousel.tsx | 12 ++++++------ .../upload/ibiz-file-upload/ibiz-file-upload.tsx | 6 +++--- .../ibiz-image-cropping/ibiz-image-cropping.tsx | 2 +- .../ibiz-image-select/ibiz-image-select.tsx | 2 +- .../ibiz-image-upload/ibiz-image-upload.tsx | 6 +++--- .../panel-button-list/panel-button-list.tsx | 2 +- .../panel-button/panel-button.controller.ts | 2 +- .../panel-carousel/panel-carousel.tsx | 4 ++-- 33 files changed, 71 insertions(+), 91 deletions(-) diff --git a/src/editor/cascader/ibiz-cascader/ibiz-cascader.tsx b/src/editor/cascader/ibiz-cascader/ibiz-cascader.tsx index 294776f63d..cb1c2870f4 100644 --- a/src/editor/cascader/ibiz-cascader/ibiz-cascader.tsx +++ b/src/editor/cascader/ibiz-cascader/ibiz-cascader.tsx @@ -14,10 +14,9 @@ import { usePopstateListener } from '../../../util'; /** * 移动端级联选择器 * @primary - * @description 支持多级联动加载与异步数据动态渲染，用于选择具有级联关系的数据。支持编辑器类型包含：`移动端级联选择器`。 + * @description 使用van-cascader组件，用于选择具有级联关系的数据。支持编辑器类型包含：`移动端级联选择器` * @editorparams {name:editorStyle,title:编辑器样式,parameterType:string,defaultvalue:default,description:值为default时，加载下级数据时，从节点的value属性获取值，否则从节点的data属性里的value上获取值} * @editorparams {name:separator,title:分割符,parameterType:string,defaultvalue:'/',description:用于拼接选择的值} - * @editorparams {name:triggerMode,title:change触发模式,parameterType:string,description:指定触发 'change' 事件的模式，例如 'blur' 或 'input' 等} * @ignoreprops autoFocus | overflowMode * @ignoreemits infoTextChange | enter */ diff --git a/src/editor/check-box-list/ibiz-checkbox-list/ibiz-checkbox-list.tsx b/src/editor/check-box-list/ibiz-checkbox-list/ibiz-checkbox-list.tsx index 7f9a3920d7..87ae280e4b 100644 --- a/src/editor/check-box-list/ibiz-checkbox-list/ibiz-checkbox-list.tsx +++ b/src/editor/check-box-list/ibiz-checkbox-list/ibiz-checkbox-list.tsx @@ -12,8 +12,7 @@ import { CheckBoxListEditorController } from '../checkbox-list-editor.controller /** * 选项框列表 * @primary - * @description 实现轻量化多选列表框组件，支持选项勾选、数据绑定与状态反馈，满足高效的多项数据选取需求。支持编辑器类型包含：`选项框列表`。 - * @editorparams {name:triggerMode,parameterType:string,description:指定触发 'change' 事件的模式，例如 'blur' 或 'input' 等} + * @description 使用van-checkbox-group组件和van-checkbox组件，用于在一组备选项中进行多选的场景。支持编辑器类型包含：`选项框列表` * @ignoreprops autoFocus | overflowMode * @ignoreemits infoTextChange | enter */ diff --git a/src/editor/check-box/ibiz-checkbox/ibiz-checkbox.tsx b/src/editor/check-box/ibiz-checkbox/ibiz-checkbox.tsx index b9abfba6a2..54ed940846 100644 --- a/src/editor/check-box/ibiz-checkbox/ibiz-checkbox.tsx +++ b/src/editor/check-box/ibiz-checkbox/ibiz-checkbox.tsx @@ -11,10 +11,9 @@ import './ibiz-checkbox.scss'; /** * 选项框 * @primary - * @description 采用轻量化状态切换组件，通过布尔值勾选控制属性状态，支持即时反馈与无障碍操作，适用于配置项开关或编辑器场景。支持编辑器类型包含：`选项框`。 - * @editorparams {name:selectValue,title:选中时抛出的值,parameterType:number,defaultValue:1,description:选中时抛出的值} - * @editorparams {name:nullValue,title:未选中时抛出的值,parameterType:number,defaultValue:0,description:未选中时抛出的值} - * @editorparams {name:triggerMode,parameterType:string,description:指定触发 'change' 事件的模式，例如 'blur' 或 'input' 等} + * @description 使用van-checkbox组件，用于选中或取消选项场景。支持编辑器类型包含：`选项框` + * @editorparams {name:selectValue,title:选中时抛出的值,parameterType:number,defaultvalue:1,description:选中时抛出的值} + * @editorparams {name:nullValue,title:取消选中时抛出的值,parameterType:number,defaultvalue:0,description:取消选中时抛出的值} * @ignoreprops autoFocus | overflowMode * @ignoreemits infoTextChange | enter */ diff --git a/src/editor/color-picker/ibiz-color-picker/ibiz-color-picker.tsx b/src/editor/color-picker/ibiz-color-picker/ibiz-color-picker.tsx index 05f9685888..fcd38013bb 100644 --- a/src/editor/color-picker/ibiz-color-picker/ibiz-color-picker.tsx +++ b/src/editor/color-picker/ibiz-color-picker/ibiz-color-picker.tsx @@ -10,8 +10,7 @@ import { ColorPickerEditorController } from '../color-picker-editor.controller'; /** * 移动端颜色选择器 * @primary - * @description 轻量化的颜色选择器，支持色板选取、RGB 格式输入及实时预览，满足高效精准的色彩配置需求。支持编辑器类型包含：`移动端颜色选择器`。 - * @editorparams {name:triggerMode,parameterType:string,description:指定触发 'change' 事件的模式，例如 'blur' 或 'input' 等} + * @description 使用van-field组件，轻量化的颜色选择器，支持色板选取、RGB 格式输入及实时预览，满足高效精准的色彩配置需求。支持编辑器类型包含：`移动端颜色选择器` * @ignoreprops autoFocus | overflowMode * @ignoreemits infoTextChange | enter */ diff --git a/src/editor/data-picker/ibiz-mpicker/ibiz-mpicker.tsx b/src/editor/data-picker/ibiz-mpicker/ibiz-mpicker.tsx index 0e7881e1fd..0f7d22909b 100644 --- a/src/editor/data-picker/ibiz-mpicker/ibiz-mpicker.tsx +++ b/src/editor/data-picker/ibiz-mpicker/ibiz-mpicker.tsx @@ -12,8 +12,7 @@ import { IBizCommonRightIcon } from '../../common/right-icon/right-icon'; /** * 移动端多数据选择 * @primary - * @description 实现可扩展的数据选择器组件，支持模态化选择视图调用、支持多选操作、多维度数据筛选与选中结果回调处理，提供完整的数据选取交互闭环。支持编辑器类型包含：`移动端多数据选择`。 - * @editorparams {name:triggerMode,parameterType:string,description:指定触发 'change' 事件的模式，例如 'blur' 或 'input' 等} + * @description 使用van-field组件和van-popup组件，用于在弹出列表中选择多项数据的场景。支持编辑器类型包含：`移动端多数据选择` * @ignoreprops autoFocus | overflowMode * @ignoreemits infoTextChange | enter */ diff --git a/src/editor/data-picker/ibiz-picker-select-view/ibiz-picker-select-view.tsx b/src/editor/data-picker/ibiz-picker-select-view/ibiz-picker-select-view.tsx index ce39113072..239512dc70 100644 --- a/src/editor/data-picker/ibiz-picker-select-view/ibiz-picker-select-view.tsx +++ b/src/editor/data-picker/ibiz-picker-select-view/ibiz-picker-select-view.tsx @@ -12,9 +12,8 @@ import { PickerEditorController } from '../picker-editor.controller'; /** * 移动端数据选择（下拉视图） * @primary - * @description 通过弹出一个模态来承载选择视图，可通过编辑参数multiple来决定是单选还是多选。支持编辑器类型包含：`移动端数据选择（下拉视图）`。 + * @description 使用van-field组件和van-button组件，点击按钮后弹出一个模态来呈现配置的选择视图。支持编辑器类型包含：`移动端数据选择（下拉视图）` * @editorparams {name:multiple,title:多选,description:是否多选,parameterType:boolean,default:true} - * @editorparams {name:triggerMode,parameterType:string,description:指定触发 'change' 事件的模式，例如 'blur' 或 'input' 等} * @ignoreprops autoFocus | overflowMode * @ignoreemits infoTextChange | enter */ diff --git a/src/editor/data-picker/ibiz-picker/ibiz-picker.tsx b/src/editor/data-picker/ibiz-picker/ibiz-picker.tsx index c70829a538..aa823e1cb2 100644 --- a/src/editor/data-picker/ibiz-picker/ibiz-picker.tsx +++ b/src/editor/data-picker/ibiz-picker/ibiz-picker.tsx @@ -12,8 +12,7 @@ import { usePopstateListener } from '../../../util'; /** * 移动端数据选择 * @primary - * @description 实现轻量级单选数据选择器组件，支持视图层动态唤起、精准数据匹配及选中结果回调处理，提供高效的单数据点选取解决方案。支持编辑器类型包含：`移动端数据选择`。 - * @editorparams {name:triggerMode,parameterType:string,description:指定触发 'change' 事件的模式，例如 'blur' 或 'input' 等} + * @description 使用van-field组件和van-popup组件，用于在弹出列表中选择单项数据的场景。支持编辑器类型包含：`移动端数据选择` * @ignoreprops autoFocus | overflowMode * @ignoreemits infoTextChange | enter */ diff --git a/src/editor/date-picker/ibiz-date-picker/ibiz-date-picker.tsx b/src/editor/date-picker/ibiz-date-picker/ibiz-date-picker.tsx index 880a061583..6d7cea7e5a 100644 --- a/src/editor/date-picker/ibiz-date-picker/ibiz-date-picker.tsx +++ b/src/editor/date-picker/ibiz-date-picker/ibiz-date-picker.tsx @@ -15,8 +15,7 @@ import { usePopstateListener } from '../../../util'; /** * 移动端时间选择器 * @primary - * @description 轻量的时间选择器，默认时间格式为年月日-时分秒，可通过配置值格式化串来格式化日期。支持编辑器类型包含: `移动端时间选择器`、`移动端时间选择器（YYYY-MM-DD HH）`、`移动端时间选择器（YYYY-MM-DD HH:mm）`、`移动端时间选择器（HH:mm:ss）`、`移动端时间选择器（HH:mm）`、`移动端时间选择器（YYYY-MM-DD）`、`移动端时间选择器（YYYY-MM-DD HH:mm:ss）` - * @editorparams {name:triggerMode,parameterType:string,description:指定触发 'change' 事件的模式，例如 'blur' 或 'input' 等} + * @description 基于rolldate的轻量时间选择器，默认时间格式为年月日-时分秒，可通过配置值格式化串来格式化日期。支持编辑器类型包含: `移动端时间选择器`、`移动端时间选择器（YYYY-MM-DD HH）`、`移动端时间选择器（YYYY-MM-DD HH:mm）`、`移动端时间选择器（HH:mm:ss）`、`移动端时间选择器（HH:mm）`、`移动端时间选择器（YYYY-MM-DD）`、`移动端时间选择器（YYYY-MM-DD HH:mm:ss）` * @ignoreprops autoFocus | overflowMode * @ignoreemits infoTextChange | enter */ diff --git a/src/editor/date-range/ibiz-date-range-picker/ibiz-date-range-picker.tsx b/src/editor/date-range/ibiz-date-range-picker/ibiz-date-range-picker.tsx index af9984ae25..33ce589495 100644 --- a/src/editor/date-range/ibiz-date-range-picker/ibiz-date-range-picker.tsx +++ b/src/editor/date-range/ibiz-date-range-picker/ibiz-date-range-picker.tsx @@ -15,13 +15,12 @@ import { IBizDateRangeCalendar } from '../../../common/date-range-picker/date-ra /** * 移动端时间范围选择器 * @primary - * @description 提供轻量的时间范围的选择组件，默认支持年月日的时间范围选择。支持编辑器类型包含: `移动端时间范围选择器`、`移动端时间范围选择器（YYYY-MM-DD）`。 - * @editorparams {name:SHOWMODE,parameterType:'DEFAULT' | 'CALENDAR',defaultValue:'DEFALUIT',description:显示模式，值为CALENDAR时，使用日历组件来选择日期范围，值为DEFAULT时，绘制两个时间选择器来绘制日期范围} - * @editorparams {name:rangeSeparator,parameterType:string,defaultValue:'~',description:选择范围时的分隔符} - * @editorparams {name:valueSeparator,parameterType:string,defaultValue:'',description:值分割符} - * @editorparams {name:startPlaceHolder,parameterType:string,defaultValue:'',description:开始占位提示} - * @editorparams {name:endPlaceHolder,parameterType:string,defaultValue:'',description:结束占位提示} - * @editorparams {name:triggerMode,parameterType:string,description:指定触发 'change' 事件的模式，例如 'blur' 或 'input' 等} + * @description 基于rolldate的轻量时间范围选择器，类型为CALENDAR时，使用van-calendar组件，默认支持年月日的时间范围选择。支持编辑器类型包含: `移动端时间范围选择器`、`移动端时间范围选择器（YYYY-MM-DD）` + * @editorparams {name:SHOWMODE,parameterType:'DEFAULT' | 'CALENDAR',defaultvalue:'DEFALUIT',description:显示模式，值为CALENDAR时，使用日历组件来选择日期范围，值为DEFAULT时，绘制两个时间选择器来绘制日期范围} + * @editorparams {name:rangeSeparator,parameterType:string,defaultvalue:'~',description:选择范围时的分隔符} + * @editorparams {name:valueSeparator,parameterType:string,defaultvalue:'',description:值分割符} + * @editorparams {name:startPlaceHolder,parameterType:string,defaultvalue:'',description:选择范围开始占位提示} + * @editorparams {name:endPlaceHolder,parameterType:string,defaultvalue:'',description:选择范围结束占位提示} * @ignoreprops autoFocus | overflowMode * @ignoreemits infoTextChange | enter */ diff --git a/src/editor/dropdown-list/ibiz-dropdown-list/ibiz-dropdown-list.tsx b/src/editor/dropdown-list/ibiz-dropdown-list/ibiz-dropdown-list.tsx index 9a0ed6581b..d5b9144e80 100644 --- a/src/editor/dropdown-list/ibiz-dropdown-list/ibiz-dropdown-list.tsx +++ b/src/editor/dropdown-list/ibiz-dropdown-list/ibiz-dropdown-list.tsx @@ -13,8 +13,7 @@ import { usePopstateListener } from '../../../util'; /** * 移动端下拉列表（多选） * @primary - * @description 用于在一维数组中进行多项数据选择。支持编辑器类型包含：`移动端下拉列表（多选）`。 - * @editorparams {name:triggerMode,parameterType:string,description:指定触发 'change' 事件的模式，例如 'blur' 或 'input' 等} + * @description 使用van-field组件和van-popup组件，用于在弹出的选择列表中选择多条数据的场景。支持编辑器类型包含：`移动端下拉列表（多选）` * @ignoreprops autoFocus | overflowMode * @ignoreemits infoTextChange | enter */ diff --git a/src/editor/dropdown-list/ibiz-dropdown/ibiz-dropdown.tsx b/src/editor/dropdown-list/ibiz-dropdown/ibiz-dropdown.tsx index c40c1576b6..636d17e616 100644 --- a/src/editor/dropdown-list/ibiz-dropdown/ibiz-dropdown.tsx +++ b/src/editor/dropdown-list/ibiz-dropdown/ibiz-dropdown.tsx @@ -12,8 +12,7 @@ import { usePopstateListener } from '../../../util'; /** * 移动端下拉列表（单选） * @primary - * @description 用于在一维数组中进行单项数据选择。支持编辑器类型包含：`移动端下拉列表（单选）`。 - * @editorparams {name:triggerMode,parameterType:string,description:指定触发 'change' 事件的模式，例如 'blur' 或 'input' 等} + * @description 使用van-field组件和van-popup组件，用于在弹出的选择列表中选择单条数据的场景。支持编辑器类型包含：`移动端下拉列表（单选）` * @ignoreprops autoFocus | overflowMode * @ignoreemits infoTextChange | enter */ diff --git a/src/editor/dropdown-list/ibiz-emoji-picker/ibiz-emoji-picker.tsx b/src/editor/dropdown-list/ibiz-emoji-picker/ibiz-emoji-picker.tsx index 110fd60c95..7deae1cb43 100644 --- a/src/editor/dropdown-list/ibiz-emoji-picker/ibiz-emoji-picker.tsx +++ b/src/editor/dropdown-list/ibiz-emoji-picker/ibiz-emoji-picker.tsx @@ -12,8 +12,7 @@ import { usePopstateListener } from '../../../util'; /** * 表情选择器（扩展） * @primary - * @description 通过弹出底部抽屉来绘制表情列表，进而支持对表情数据的搜索与选择。 - * @editorparams {name:triggerMode,parameterType:string,description:指定触发 'change' 事件的模式，例如 'blur' 或 'input' 等} + * @description 使用van-popup组件，通过弹出底部抽屉来绘制表情列表，进而支持对表情数据的搜索与选择。基于`移动端下拉列表（单选）`编辑器扩展，编辑器样式代码名称为：EMOJI_PICKER * @ignoreprops autoFocus | overflowMode * @ignoreemits infoTextChange | enter */ diff --git a/src/editor/html/quill-editor/quill-editor.tsx b/src/editor/html/quill-editor/quill-editor.tsx index 72582ac1bb..4d637c4ace 100644 --- a/src/editor/html/quill-editor/quill-editor.tsx +++ b/src/editor/html/quill-editor/quill-editor.tsx @@ -17,7 +17,7 @@ import './quill-editor.scss'; /** * 移动端HTML编辑框 * @primary - * @description 基于Quill深度定制可扩展的富文本编辑器，集成文件/图片上传、实时预览及样式配置功能，提供完整的富媒体编辑解决方案。支持编辑器类型包含：`移动端HTML编辑框`。 + * @description 基于Quill深度定制可扩展的富文本编辑器，集成文件/图片上传、实时预览及样式配置功能，提供完整的富媒体编辑解决方案。支持编辑器类型包含：`移动端HTML编辑框` * @editorparams {name:uploadParams,parameterType:IData,defaultvalue:{},description:上传参数} * @editorparams {name:exportParams,parameterType:IData,defaultvalue:{},description:下载参数} * @editorparams {name:SHOWTOOLBAR,parameterType:boolean,defaultvalue:true,description:显示工具栏} @@ -26,7 +26,6 @@ import './quill-editor.scss'; * @editorparams {name:MODULES,parameterType:IData,description:quill配置} * @editorparams {name:DEFAULTHEIGHT,parameterType:number,defaultvalue:200,description:收缩时的高度} * @editorparams {name:SHOWCOLLAPSE,parameterType:boolean,defaultvalue:true,description:是否显示伸缩按钮} - * @editorparams {name:triggerMode,parameterType:string,description:指定触发 'change' 事件的模式，例如 'blur' 或 'input' 等} * @ignoreprops autoFocus | overflowMode * @ignoreemits infoTextChange | enter */ diff --git a/src/editor/markdown/ibiz-markdown-editor/ibiz-markdown-editor.tsx b/src/editor/markdown/ibiz-markdown-editor/ibiz-markdown-editor.tsx index 0dd6efb2c8..02559a0b98 100644 --- a/src/editor/markdown/ibiz-markdown-editor/ibiz-markdown-editor.tsx +++ b/src/editor/markdown/ibiz-markdown-editor/ibiz-markdown-editor.tsx @@ -22,10 +22,9 @@ import './ibiz-markdown-editor.scss'; /** * 移动端Markdown编辑框 * @primary - * @description 用于Markdown文档编辑。支持编辑器类型包含：`移动端Markdown编辑框`。 + * @description 基于cherry-markdown深度定制可扩展的Markdown编辑器，用于Markdown文档编辑。支持编辑器类型包含：`移动端Markdown编辑框` * @editorparams {name:uploadparams,parameterType:IData,defaultvalue:{},description:上传参数} * @editorparams {name:exportparams,parameterType:IData,defaultvalue:{},description:下载参数} - * @editorparams {name:triggerMode,parameterType:string,description:指定触发 'change' 事件的模式，例如 'blur' 或 'input' 等} * @ignoreprops autoFocus | overflowMode * @ignoreemits infoTextChange | enter */ diff --git a/src/editor/number-range/ibiz-number-range-picker/ibiz-number-range-picker.tsx b/src/editor/number-range/ibiz-number-range-picker/ibiz-number-range-picker.tsx index 60d1e4f047..c00bbc026e 100644 --- a/src/editor/number-range/ibiz-number-range-picker/ibiz-number-range-picker.tsx +++ b/src/editor/number-range/ibiz-number-range-picker/ibiz-number-range-picker.tsx @@ -12,15 +12,14 @@ import { NumberRangeEditorController } from '../number-range-editor.controller'; /** * 移动端数值范围编辑框 * @primary - * @description 实现移动端优化的数值范围选择器组件，支持双滑块精准控制、边界限制与手势交互，提供流畅的区间值选取体验。支持编辑器类型包含：`移动端数值范围编辑框`。 + * @description 使用van-field组件，用于指定数值范围的场景。支持编辑器类型包含：`移动端数值范围编辑框` * @editorparams {name:maxValue,parameterType:string,defaultvalue:Infinity,description:最大值} * @editorparams {name:minValue,parameterType:string,defaultvalue:-Infinity,description:最小值} - * @editorparams {name:valueSeparator,parameterType:string,defaultvalue:'-',description:数值范围分隔符} - * @editorparams {name:rangeSeparator,parameterType:string,defaultvalue:'~',description:选择范围时的分隔符} - * @editorparams {name:startPlaceHolder,parameterType:string,defaultvalue:'',description:开始占位提示} - * @editorparams {name:endPlaceHolder,parameterType:string,defaultvalue:'',description:结束占位提示} + * @editorparams {name:valueSeparator,parameterType:string,defaultvalue:'-',description:值分割符} + * @editorparams {name:rangeSeparator,parameterType:string,defaultvalue:'~',description:选择范围的分隔符} + * @editorparams {name:startPlaceHolder,parameterType:string,defaultvalue:'',description:选择范围开始占位提示，van-field组件的placeholder属性} + * @editorparams {name:endPlaceHolder,parameterType:string,defaultvalue:'',description:选择范围结束占位提示，van-field组件的placeholder属性} * @editorparams {name:precision,parameterType:number,defaultvalue:0,description:数值精度} - * @editorparams {name:triggerMode,parameterType:string,description:指定触发 'change' 事件的模式，例如 'blur' 或 'input' 等} * @ignoreprops autoFocus | overflowMode * @ignoreemits infoTextChange | enter */ diff --git a/src/editor/qrcode/ibiz-qrcode/ibiz-qrcode.tsx b/src/editor/qrcode/ibiz-qrcode/ibiz-qrcode.tsx index f7a1f0d7d7..377a3078d7 100644 --- a/src/editor/qrcode/ibiz-qrcode/ibiz-qrcode.tsx +++ b/src/editor/qrcode/ibiz-qrcode/ibiz-qrcode.tsx @@ -11,7 +11,7 @@ import './ibiz-qrcode.scss'; /** * 移动端二维码阅读器 * @primary - * @description 支持将指定的值转换为二维码图片。支持编辑器类型包含：`移动端二维码阅读器`。 + * @description 支持将指定的值转换为二维码图片。支持编辑器类型包含：`移动端二维码阅读器` * @ignoreprops autoFocus | overflowMode * @ignoreemits infoTextChange | enter | change | focus | blur */ diff --git a/src/editor/radio-button-list/ibiz-radio/ibiz-radio.tsx b/src/editor/radio-button-list/ibiz-radio/ibiz-radio.tsx index 612d4c6d75..56c543e00d 100644 --- a/src/editor/radio-button-list/ibiz-radio/ibiz-radio.tsx +++ b/src/editor/radio-button-list/ibiz-radio/ibiz-radio.tsx @@ -11,8 +11,7 @@ import { RadioButtonListEditorController } from '../radio-button-list.controller /** * 移动端单选项列表 * @primary - * @description 实现轻量化单选框列表组件，支持数据驱动渲染、选项互斥选择与状态回调，适用于标准化单项数据选取场景。支持编辑器类型包含：`移动端单选项列表`。 - * @editorparams {name:triggerMode,parameterType:string,description:指定触发 'change' 事件的模式，例如 'blur' 或 'input' 等} + * @description 使用van-radio-group组件和van-radio组件，用于在一组备选项中进行单选的场景。支持编辑器类型包含：`移动端单选项列表` * @ignoreprops autoFocus | overflowMode * @ignoreemits infoTextChange | enter */ diff --git a/src/editor/rate/ibiz-rate/ibiz-rate.tsx b/src/editor/rate/ibiz-rate/ibiz-rate.tsx index fb56354cb9..746f84be57 100644 --- a/src/editor/rate/ibiz-rate/ibiz-rate.tsx +++ b/src/editor/rate/ibiz-rate/ibiz-rate.tsx @@ -12,9 +12,8 @@ import './ibiz-rate.scss'; /** * 移动端评分器 * @primary - * @description 用于给某些东西进行评分，通过图标的多少来表示评分。支持编辑器类型包含：`移动端评分器`。 - * @editorprops {name:maxValue,parameterType:number,defaultvalue:5,description:设置允许的最大值} - * @editorparams {name:triggerMode,parameterType:string,description:指定触发 'change' 事件的模式，例如 'blur' 或 'input' 等} + * @description 使用van-rate组件，用于给某些东西进行评分。支持编辑器类型包含：`移动端评分器` + * @editorparams {name:maxValue,parameterType:number,defaultvalue:5,description:设置最大评分值，van-rate组件的count属性} * @ignoreprops autoFocus | overflowMode * @ignoreemits infoTextChange | enter */ diff --git a/src/editor/raw/ibiz-raw/ibiz-raw.tsx b/src/editor/raw/ibiz-raw/ibiz-raw.tsx index 0bd188b96d..4d147488f5 100644 --- a/src/editor/raw/ibiz-raw/ibiz-raw.tsx +++ b/src/editor/raw/ibiz-raw/ibiz-raw.tsx @@ -10,11 +10,9 @@ import './ibiz-raw.scss'; /** * 直接内容 * @primary - * @description 用于直接显示某个值或图片的编辑器，支持通过freemarker表达式动态获取值。支持编辑器类型包含：`直接内容`。 + * @description 用于绘制配置的直接内容，如HTML内容、视频内容、图片内容等。支持编辑器类型包含：`直接内容` * @editorparams {name:contenttype,parameterType:string,defaultvalue:TEXT,description:内容类型} - * @editorparams {name:template,parameterType:string,description:freeMarker模版字符串} - * @editorparams {name:TEMPLATE,parameterType:string,description:freeMarker模版字符串} - * @editorparams {name:triggerMode,parameterType:string,description:指定触发 'change' 事件的模式，例如 'blur' 或 'input' 等} + * @editorparams {name:template,parameterType:string,description:配置的handlerBars模版，用于将组件输入参数中的value值解析并转换为HTML内容，实现动态内容的渲染} * @ignoreprops autoFocus | overflowMode * @ignoreemits infoTextChange | enter */ diff --git a/src/editor/slider/ibiz-slider/ibiz-slider.tsx b/src/editor/slider/ibiz-slider/ibiz-slider.tsx index 9ab0ac68c2..254467250f 100644 --- a/src/editor/slider/ibiz-slider/ibiz-slider.tsx +++ b/src/editor/slider/ibiz-slider/ibiz-slider.tsx @@ -12,16 +12,15 @@ import './ibiz-slider.scss'; /** * 移动端滑动输入条 * @primary - * @description 通过拖动滑块来改变值。支持编辑器类型包含：`移动端滑动输入条`。 - * @editorparams {name:stepValue,parameterType:number,defaultvalue:1,description:步长} - * @editorparams {name:maxValue,parameterType:number,defaultvalue:100,description:最大值} - * @editorparams {name:minValue,parameterType:number,defaultvalue:0,description:最小值} - * @editorparams {name:range,parameterType:boolean,defaultvalue:false,description:是否开启选择范围} + * @description 使用van-slider组件，用于在给定的范围内选择一个值的场景。支持编辑器类型包含：`移动端滑动输入条` + * @editorparams {name:stepValue,parameterType:number,defaultvalue:1,description:步长，van-slider组件的step属性} + * @editorparams {name:maxValue,parameterType:number,defaultvalue:100,description:最大值，van-slider组件的max属性} + * @editorparams {name:minValue,parameterType:number,defaultvalue:0,description:最小值，van-slider组件的min属性} + * @editorparams {name:range,parameterType:boolean,defaultvalue:false,description:是否开启双滑块模式，van-slider组件的range属性} * @editorparams {name:type,parameterType:string,defaultvalue:line,description:进度条类型，可选值为line（线形）或circle（环形）} - * @editorparams {name:triggerMode,parameterType:string,description:指定触发 'change' 事件的模式，例如 'blur' 或 'input' 等} * @editorparams {name:textItem,parameterType:string,description:环形时显示的文本属性} - * @editorparams {name:showText,parameterType:boolean,defaultvalue:false,description:是否显示百分比} - * @editorparams {name:format,parameterType:string,defaultvalue:0%,description:格式化显示值} + * @editorparams {name:showText,parameterType:boolean,defaultvalue:false,description:环形时是否显示文本} + * @editorparams {name:format,parameterType:string,defaultvalue:0%,description:环形时显示文本的格式化规则} * @ignoreprops autoFocus | overflowMode * @ignoreemits infoTextChange | enter */ diff --git a/src/editor/span/span/span.tsx b/src/editor/span/span/span.tsx index a33995a7dc..22c8645fe2 100644 --- a/src/editor/span/span/span.tsx +++ b/src/editor/span/span/span.tsx @@ -21,11 +21,11 @@ function isValidDateFormat(dateStr: string, format: string): boolean { return dayjs(dateStr, format, true).isValid(); // 严格模式判断是否是复合值格式化要求的日期文本 } -// {name:TEXTSEPARATOR,parameterType:string,defaultvalue:',',description:文本分隔符。如果是数组数据，在呈现时用逗号分隔并且转换为字符串显示} /** * 标签 * @primary - * @description 直接呈现文本内容。支持编辑器类型包含：`标签` + * @description 直接呈现文本内容，可配置单位。支持编辑器类型包含：`标签` + * @editorparams {name:TEXTSEPARATOR,parameterType:string,defaultvalue:'',description:文本分隔符。如果是数组数据，在呈现时用逗号分隔并且转换为字符串显示} * @editorparams {name:REVERSECOLOR,parameterType:boolean,description:是否反转颜色，即代码表项的color是否用于代码表项的背景色} * @editorparams {name:SHOWMODE,parameterType:'DEFAULT' | 'ICON' | 'TEXT',defaultvalue:'DEFAULT',description:显示模式，即代码表项的显示情况，值为DEFAULT：显示图标和文本，值为ICON：只显示图标，值为TEXT：只显示文本} * @ignoreprops autoFocus | overflowMode diff --git a/src/editor/stepper/ibiz-stepper/ibiz-stepper.tsx b/src/editor/stepper/ibiz-stepper/ibiz-stepper.tsx index 186b8e0727..3e884a72ab 100644 --- a/src/editor/stepper/ibiz-stepper/ibiz-stepper.tsx +++ b/src/editor/stepper/ibiz-stepper/ibiz-stepper.tsx @@ -11,12 +11,12 @@ import './ibiz-stepper.scss'; /** * 移动端步进器 * - * @description 用于仅允许输入标准的数字值的场景。支持编辑器类型包含：`移动端步进器` + * @description 使用van-stepper组件，用于在一定范围内调整数字的场景。支持编辑器类型包含：`移动端步进器` * @primary - * @editorparams {name:stepValue,parameterType:number,defaultvalue:1,description:设置递增递减的步进控制} - * @editorparams {name:precision,parameterType:number,defaultvalue:0,description:设置数值精度} - * @editorparams {name:maxValue,parameterType:number,defaultvalue:Infinity,description:设置步进器允许的最大值} - * @editorparams {name:minValue,parameterType:number,defaultvalue:-Infinity,description:设置步进器允许的最小值} + * @editorparams {name:stepValue,parameterType:number,defaultvalue:1,description:设置递增或递减的步长，van-stepper组件的step属性} + * @editorparams {name:precision,parameterType:number,defaultvalue:0,description:设置数值精度，van-stepper组件的decimal-length属性} + * @editorparams {name:maxValue,parameterType:number,defaultvalue:Infinity,description:设置步进器允许的最大值，van-stepper组件的max属性} + * @editorparams {name:minValue,parameterType:number,defaultvalue:-Infinity,description:设置步进器允许的最小值，van-stepper组件的min属性} * @ignoreprops autoFocus | overflowMode * @ignoreemits enter | infoTextChange */ diff --git a/src/editor/switch/ibiz-switch/ibiz-switch.tsx b/src/editor/switch/ibiz-switch/ibiz-switch.tsx index 1609169d41..a73e9e837a 100644 --- a/src/editor/switch/ibiz-switch/ibiz-switch.tsx +++ b/src/editor/switch/ibiz-switch/ibiz-switch.tsx @@ -11,10 +11,10 @@ import { SwitchEditorController } from '../switch-editor.controller'; /** * 移动端开关部件 * - * @description 表示两种相互对立的状态间的切换，多用于触发「开/关」。支持编辑器类型包含：`移动端开关部件` + * @description 使用van-switch组件，表示两种相互对立的状态间的切换，多用于触发「开/关」。支持编辑器类型包含：`移动端开关部件` * @primary - * @ignoreprops overflowMode - * @ignoreemits blur | focus | enter | infoTextChange + * @ignoreprops overflowMode | autoFocus + * @ignoreemits enter | infoTextChange */ export const IBizSwitch = defineComponent({ name: 'IBizSwitch', diff --git a/src/editor/text-box/ibiz-input-number/ibiz-input-number.tsx b/src/editor/text-box/ibiz-input-number/ibiz-input-number.tsx index 555d4bd314..67ad762396 100644 --- a/src/editor/text-box/ibiz-input-number/ibiz-input-number.tsx +++ b/src/editor/text-box/ibiz-input-number/ibiz-input-number.tsx @@ -11,11 +11,11 @@ import { TextBoxEditorController } from '../text-box-editor.controller'; /** * 移动端数值框 * - * @description 用于仅允许输入标准的数字值的场景。支持编辑器类型包含：`移动端数值框` + * @description 使用van-field组件，用于仅允许输入标准的数字值的场景。支持编辑器类型包含：`移动端数值框` * @primary - * @editorparams {name:precision,parameterType:number,description:设置数值精度} + * @editorparams {name:precision,parameterType:number,description:设置数值精度，van-field组件的precision属性} * @ignoreprops overflowMode - * @ignoreemits infoTextChange + * @ignoreemits infoTextChange | enter */ export const IBizInputNumber = defineComponent({ name: 'IBizInputNumber', diff --git a/src/editor/text-box/input/input.tsx b/src/editor/text-box/input/input.tsx index 1e960c52ed..d39ef4fc75 100644 --- a/src/editor/text-box/input/input.tsx +++ b/src/editor/text-box/input/input.tsx @@ -12,7 +12,7 @@ import { TextBoxEditorController } from '../text-box-editor.controller'; /** * 移动端文本框 * - * @description 用于数据录入，通过键盘输入字符。支持编辑器类型包含：`移动端文本框`、`移动端多行文本`、`移动端密码框` + * @description 使用van-field组件，用于数据录入，通过键盘输入字符。支持编辑器类型包含：`移动端文本框`、`移动端多行文本`、`移动端密码框` * @primary * @ignoreprops overflowMode * @ignoreemits infoTextChange diff --git a/src/editor/upload/ibiz-carousel/ibiz-carousel.tsx b/src/editor/upload/ibiz-carousel/ibiz-carousel.tsx index 0e6f0b1318..5b14186c7a 100644 --- a/src/editor/upload/ibiz-carousel/ibiz-carousel.tsx +++ b/src/editor/upload/ibiz-carousel/ibiz-carousel.tsx @@ -10,13 +10,13 @@ import { useVanUpload } from '../use/use-van-upload'; import { UploadEditorController } from '../upload-editor.controller'; /** - * 轮播图 + * 轮播图（扩展） * @primary - * @description 用于对图片数组进行轮播，提供了自动轮播，设置轮播动画时长，显示项指示器以及支持手势滑动的功能。支持编辑器类型包含：轮播图。 - * @editorparams {name:autoplay,parameterType:number,defaultValue:3000,description:轮播间隔} - * @editorparams {name:duration,parameterType:number,defaultValue:500,description:动画时长} - * @editorparams {name:showIndicators,parameterType:boolean,defaultValue:true,description:是否显示指示器} - * @editorparams {name:touchable,parameterType:boolean,defaultValue:true,description:是否可以通过手势滑动} + * @description 使用van-swipe组件，用于对图片数组进行轮播，提供了自动轮播，设置轮播动画时长，显示项指示器以及支持手势滑动的功能。是预制类型，类型为：FIELD_CAROUSEL_PICTURE + * @editorparams {name:autoplay,parameterType:number,defaultvalue:3000,description:轮播间隔，van-swipe组件的autoplay属性} + * @editorparams {name:duration,parameterType:number,defaultvalue:500,description:动画时长，van-swipe组件的duration属性} + * @editorparams {name:showIndicators,parameterType:boolean,defaultvalue:true,description:是否显示指示器，van-swipe组件的show-indicators属性} + * @editorparams {name:touchable,parameterType:boolean,defaultvalue:true,description:是否可以通过手势滑动，van-swipe组件的touchable属性} * @ignoreprops autoFocus | overflowMode * @ignoreemits blur | focus | enter | change | infoTextChange */ diff --git a/src/editor/upload/ibiz-file-upload/ibiz-file-upload.tsx b/src/editor/upload/ibiz-file-upload/ibiz-file-upload.tsx index d2f1e40255..c8d2e0ccd6 100644 --- a/src/editor/upload/ibiz-file-upload/ibiz-file-upload.tsx +++ b/src/editor/upload/ibiz-file-upload/ibiz-file-upload.tsx @@ -11,9 +11,9 @@ import { UploadEditorController } from '../upload-editor.controller'; /** * 移动端文件控件 * @primary - * @description 用于对文件进行上传，可限制上传文件类型与数量，并对已上传的文件进行回显。支持编辑器类型包含：`移动端文件控件（单项）`、`移动端文件控件（多项）` - * @editorparams {name:multiple,parameterType:boolean,description:是否支持多选文件} - * @editorparams {name:accept,parameterType:string,description:允许上传的文件类型} + * @description 使用van-uploader组件，用于对文件进行上传，可限制上传文件类型与数量，并对已上传的文件进行回显。支持编辑器类型包含：`移动端文件控件（单项）`、`移动端文件控件（多项）` + * @editorparams {name:multiple,parameterType:boolean,description:是否支持多选文件，van-uploader组件的multiple属性} + * @editorparams {name:accept,parameterType:string,description:允许上传的文件类型，van-uploader组件的accept属性} * @editorparams {name:uploadParams,parameterType:IData,description:上传参数} * @editorparams {name:exportParams,parameterType:IData,description:下载参数} * @ignoreprops autoFocus | overflowMode diff --git a/src/editor/upload/ibiz-image-cropping/ibiz-image-cropping.tsx b/src/editor/upload/ibiz-image-cropping/ibiz-image-cropping.tsx index e403e4252a..46a4dfc4f3 100644 --- a/src/editor/upload/ibiz-image-cropping/ibiz-image-cropping.tsx +++ b/src/editor/upload/ibiz-image-cropping/ibiz-image-cropping.tsx @@ -13,7 +13,7 @@ import { UploadEditorController } from '../upload-editor.controller'; /** * 图片裁剪上传（扩展） * @primary - * @description 用于对指定的图片进行裁剪，并根据裁剪内容生成新的图片后将其进行上传。 + * @description 使用van-uploader组件和van-popup组件，用于对指定的图片进行裁剪，并根据裁剪内容生成新的图片后将其进行上传。基于`移动端图片控件（单项）`编辑器扩展，编辑器样式代码名称为：CROPPING * @editorparams {name:multiple,parameterType:boolean,description:是否支持多选文件} * @editorparams {name:accept,parameterType:string,description:允许上传的文件类型} * @editorparams {name:STOPPROPAGATION,parameterType:boolean,description:是否阻止默认点击} diff --git a/src/editor/upload/ibiz-image-select/ibiz-image-select.tsx b/src/editor/upload/ibiz-image-select/ibiz-image-select.tsx index 80e01d067f..6370361993 100644 --- a/src/editor/upload/ibiz-image-select/ibiz-image-select.tsx +++ b/src/editor/upload/ibiz-image-select/ibiz-image-select.tsx @@ -13,7 +13,7 @@ import { useVanUpload } from '../use/use-van-upload'; /** * 移动端图片控件（单项、直接内容） * @primary - * @description 用于选择图片并可以进行预览。支持编辑器类型包含：`移动端图片控件（单项、直接内容）`。 + * @description 使用van-uploader组件，用于选择图片并可以进行预览。支持编辑器类型包含：`移动端图片控件（单项、直接内容）` * @editorparams {name:STOPPROPAGATION,parameterType:boolean,description:是否阻止默认点击} * @editorparams {name:uploadParams,parameterType:IData,description:上传参数} * @editorparams {name:exportParams,parameterType:IData,description:下载参数} diff --git a/src/editor/upload/ibiz-image-upload/ibiz-image-upload.tsx b/src/editor/upload/ibiz-image-upload/ibiz-image-upload.tsx index 6df3916dba..69937481f8 100644 --- a/src/editor/upload/ibiz-image-upload/ibiz-image-upload.tsx +++ b/src/editor/upload/ibiz-image-upload/ibiz-image-upload.tsx @@ -13,9 +13,9 @@ import { UploadEditorController } from '../upload-editor.controller'; /** * 移动端图片控件 * @primary - * @description 用于对指定的图片文件类型进行上传。支持编辑器类型包含：`移动端图片控件（单项）`、`移动端图片控件（多项）`。 - * @editorparams {name:multiple,parameterType:boolean,description:是否支持多选文件} - * @editorparams {name:accept,parameterType:string,description:允许上传的文件类型} + * @description 使用van-uploader组件，用于对指定的图片文件类型进行上传。支持编辑器类型包含：`移动端图片控件（单项）`、`移动端图片控件（多项）` + * @editorparams {name:multiple,parameterType:boolean,description:是否支持多选文件，van-uploader组件的multiple属性} + * @editorparams {name:accept,parameterType:string,description:允许上传的文件类型，van-uploader组件的multiple属性} * @editorparams {name:STOPPROPAGATION,parameterType:boolean,description:是否阻止默认点击} * @editorparams {name:uploadParams,parameterType:IData,description:上传参数} * @editorparams {name:exportParams,parameterType:IData,description:下载参数} 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 0b61daf328..a25f041767 100644 --- a/src/panel-component/panel-button-list/panel-button-list.tsx +++ b/src/panel-component/panel-button-list/panel-button-list.tsx @@ -6,7 +6,7 @@ import { PanelButtonListController } from './panel-button-list.controller'; import './panel-button-list.scss'; /** - * 按钮列表 + * 按钮组 * @primary * @description 绘制按钮组组件，并在接收到抛出的点击事件后调用控制器的方法执行按钮对应的行为。 */ diff --git a/src/panel-component/panel-button/panel-button.controller.ts b/src/panel-component/panel-button/panel-button.controller.ts index 0f660f8125..019f355e1b 100644 --- a/src/panel-component/panel-button/panel-button.controller.ts +++ b/src/panel-component/panel-button/panel-button.controller.ts @@ -24,7 +24,7 @@ export class PanelButtonController extends PanelItemController { } /** - * @description面板控制器 + * @description 面板控制器 * @exposedoc * @type {ViewLayoutPanelController} * @memberof PanelButtonController diff --git a/src/panel-component/panel-carousel/panel-carousel.tsx b/src/panel-component/panel-carousel/panel-carousel.tsx index cb26f1c150..cea917722d 100644 --- a/src/panel-component/panel-carousel/panel-carousel.tsx +++ b/src/panel-component/panel-carousel/panel-carousel.tsx @@ -12,14 +12,14 @@ export const PanelCarousel = defineComponent({ name: 'IBizPanelCarousel', props: { /** - * @description 轮播图模型数据 + * @description 轮播图控制器 */ controller: { type: PanelCarouselController, required: true, }, /** - * @description 轮播图控制器 + * @description 轮播图属性 */ attrs: { type: Object as PropType, -- Gitee