@byteluck-fe/model-driven-controls 7.0.0-props.6 → 7.0.0-props.60

package/dist/types/api-doc-index.d.ts

@@ -20,6 +20,10 @@ export { default as BatchPrintListButton } from './baseControls/BatchPrintListBu
 export { default as BatchPrintRecordListButton } from './baseControls/BatchPrintRecordListButton/property';
 export { default as OperationButton } from './baseControls/OperationButton/property';
 export { default as BatchDeleteButton } from './baseControls/BatchDeleteButton/property';
+export { default as Switch } from './formControls/Switch/property';
+export { default as Tag } from './formControls/Tag/property';
+export { default as Barcode } from './formControls/Barcode/property';
+export { default as QrCode } from './formControls/QrCode/property';
 export { default as VarcharColumn } from './columnControls/VarcharColumn/property';
 export { default as TextColumn } from './columnControls/TextColumn/property';
 export { default as DecimalColumn } from './columnControls/DecimalColumn/property';

package/dist/types/baseControls/BatchDeleteButton/property.d.ts

@@ -1,12 +1,56 @@
+/**
+ * name: rok_batch_delete_button
+ * description: 批量删除按钮组件。用于列表场景对多条选中数据执行批量删除操作。支持按钮内容、展示形式、颜色状态、图标、命令类型和加载态配置，适合高频批处理操作入口。
+ */
 import { Property, PropertyInterface } from '@byteluck-fe/model-driven-core';
 interface BatchDeleteButtonPropertyInterface extends PropertyInterface {
+    /**
+     * 内容
+     * @defaultValue 控件名称
+     * @public
+     */
     content: string;
+    /**
+     * 按钮类型；取值：primary：主按钮；secondary：次按钮；text：文本；
+     * @defaultValue 'primary'
+     * @public
+     */
     buttonType: 'primary' | 'secondary' | 'text';
+    /**
+     * 展示类型；取值：text：文本；icon：图标；iconText：图标文字；
+     * @defaultValue 'iconText'
+     * @public
+     */
     showType: 'text' | 'icon' | 'iconText';
+    /**
+     * 颜色；取值：primary：主按钮；danger：危险；warning：警告；success：成功；info：信息；blue：蓝色；
+     * @defaultValue 'danger'
+     * @public
+     */
     color: 'primary' | 'danger' | 'warning' | 'success' | 'info' | 'blue';
+    /**
+     * 图标
+     * @defaultValue 控件默认图标
+     * @public
+     */
     icon: string;
+    /**
+     * 默认状态；取值：default：默认；readonly：只读；
+     * @defaultValue 'default'
+     * @public
+     */
     defaultState: 'default' | 'readonly';
+    /**
+     * 执行命令；取值：create：新建；edit：编辑；view：查看；delete：删除；custom：自定义；
+     * @defaultValue 'custom'
+     * @public
+     */
     command: string;
+    /**
+     * 加载中
+     * @defaultValue false
+     * @public
+     */
     isLoading: boolean;
 }
 declare class BatchDeleteButtonProperty extends Property implements BatchDeleteButtonPropertyInterface {

package/dist/types/baseControls/BatchPrintListButton/property.d.ts

@@ -1,3 +1,7 @@
+/**
+ * name: rok_batch_print_list_button
+ * description: 批量打印列表按钮组件。用于列表场景对选中数据批量发起打印。支持绑定多个打印模板、自动选择模板，并继承按钮样式、图标和命令配置，适合批量单据输出场景。
+ */
 import { PropertyRules } from '@byteluck-fe/model-driven-core';
 import { ButtonProperty, ButtonPropertyInterface } from '../Button';
 import { PrintTemplate } from '../../framework';
@@ -6,7 +10,17 @@ declare class BatchPrintListButtonRules extends PropertyRules {
     printTemplates: RuleItem;
 }
 interface BatchPrintListButtonPropertyInterface extends ButtonPropertyInterface {
+    /**
+     * 打印模板列表
+     * @defaultValue []
+     * @public
+     */
     printTemplates: PrintTemplate[];
+    /**
+     * 是否自动选择模板
+     * @defaultValue false
+     * @public
+     */
     autoSelectTemplate: boolean;
 }
 declare class BatchPrintListButtonProperty extends ButtonProperty implements BatchPrintListButtonPropertyInterface {

package/dist/types/baseControls/BatchPrintRecordListButton/property.d.ts

@@ -1,3 +1,7 @@
+/**
+ * name: rok_batch_print_record_list_button
+ * description: 批量打印记录列表按钮组件。用于记录列表场景快速发起批量打印操作。支持沿用通用按钮的文案、样式、图标、颜色和命令配置，适合标准化批量打印入口。
+ */
 import { ButtonProperty, ButtonPropertyInterface } from '../Button';
 interface BatchPrintRecordListButtonPropertyInterface extends ButtonPropertyInterface {
 }

package/dist/types/baseControls/BatchSubmissionListButton/property.d.ts

@@ -1,3 +1,7 @@
+/**
+ * name: rok_batch_submission_list_button
+ * description: 批量提交流程按钮组件。用于列表场景将多条选中数据批量提交到指定流程。支持绑定流程、设置发起人模式、指定操作人等能力，适合批量送审、批量发起审批场景。
+ */
 import { RuleItem } from 'async-validator';
 import { ButtonProperty, ButtonPropertyInterface } from '../Button';
 import { PropertyRules } from '@byteluck-fe/model-driven-core';
@@ -8,17 +12,27 @@ declare class BatchSubmissionListButtonPropertyRules extends PropertyRules {
 interface BatchSubmissionListButtonPropertyInterface extends ButtonPropertyInterface {
     /**
      * 绑定的流程key
-    */
+     * @defaultValue ''
+     * @public
+     */
     processKey: string;
     /**
-     * 'assigned' 指定操作人
-     * 'currentInitiator' 当前登录人
-    */
+     * 发起人模式；取值：currentInitiator：当前发起人；assigned：指定操作人；
+     * @defaultValue 'currentInitiator'
+     * @public
+     */
     initiatorMode: 'currentInitiator' | 'assigned';
+    /**
+     * TODO 不知道干嘛的属性
+     * @defaultValue ''
+     * @public
+     */
     fieldCode: string;
     /**
      * 指定人员的id
-    */
+     * @defaultValue ''
+     * @public
+     */
     employeeId: string;
 }
 declare class BatchSubmissionListButtonProperty extends ButtonProperty implements BatchSubmissionListButtonPropertyInterface {

package/dist/types/baseControls/Button/property.d.ts

@@ -2,51 +2,56 @@ import { Property, PropertyInterface, OptObject } from '@byteluck-fe/model-drive
 interface ButtonPropertyInterface extends PropertyInterface {
     /**
      * 按钮标题
+     * @defaultValue '按钮'
      * @public
-     * @defaultValue ''
      */
     content: string;
     /**
      * 按钮类型
-     * @public
      * @defaultValue 'primary'
+     * @public
      */
     buttonType: 'primary' | 'secondary' | 'text';
     /**
-     * 显示形式
-     * @public
+     * 显示形式；取值：text：文本；icon：图标；iconText：图标文字；
      * @defaultValue 'text'
+     * @public
      */
     showType: 'text' | 'icon' | 'iconText';
     /**
-    * 颜色
-    * @public
-    * @defaultValue 'primary'
-    */
+     * 颜色；取值：primary：主色；danger：危险；warning：警告；success：成功；info：信息；blue：蓝色；
+     * @defaultValue 'primary'
+     * @public
+     */
     color: 'primary' | 'danger' | 'warning' | 'success' | 'info' | 'blue';
     /**
      * 图标
+     * @defaultValue 'iconfenlei2'
      * @public
-     * @defaultValue ''
      */
     icon: string;
+    /**
+     * 默认状态；取值：default：默认；readonly：只读；
+     * @defaultValue 'default'
+     * @public
+     */
     defaultState: 'default' | 'readonly';
     /**
-     * 按钮命令
+     * 按钮命令；取值：create：新建；edit：编辑；view：查看；delete：删除；custom：自定义；
+     * @defaultValue 'custom'
      * @public
-     * @defaultValue ''
      */
     command: string;
     /**
      * 加载中
+     * @defaultValue false
      * @public
-     * @defaultValue ''
      */
     isLoading: boolean;
     /**
      * 操作项
+     * @defaultValue new OptObject({})
      * @public
-     * @defaultValue ''
      */
     optObj?: OptObject;
 }

package/dist/types/baseControls/Comment/property.d.ts

@@ -1,3 +1,7 @@
+/**
+ * name: rok_comment
+ * description: 评论组件。用于展示说明内容或结构化评论信息。支持配置评论内容以及多组评论字段、对齐方式、标题字号颜色和斜体样式，适合审批意见、备注说明等场景。
+ */
 import { Property, PropertyInterface } from '@byteluck-fe/model-driven-core';
 interface CommentOption {
     align: 'flex-start' | 'center' | 'flex-end' | 'space-between';
@@ -8,7 +12,17 @@ interface CommentOption {
     id: string;
 }
 interface CommentPropertyInterface extends PropertyInterface {
+    /**
+     * 内容
+     * @defaultValue ''
+     * @public
+     */
     content: string;
+    /**
+     * 评论选项
+     * @defaultValue []
+     * @public
+     */
     commentOptions?: Array<CommentOption>;
 }
 declare class CommentProperty extends Property implements CommentPropertyInterface {

package/dist/types/baseControls/CreateFormListButton/property.d.ts

@@ -1,3 +1,7 @@
+/**
+ * name: rok_create_form_list_button
+ * description: 新建表单按钮组件。用于从列表或页面中打开指定表单发起新建。支持绑定目标表单和弹窗、新窗口、对话框、页签等打开方式，并继承按钮样式与图标能力。
+ */
 import { ButtonProperty, ButtonPropertyInterface } from '../Button';
 import { PropertyRules } from '@byteluck-fe/model-driven-core';
 import { RuleItem } from 'async-validator';
@@ -6,7 +10,17 @@ declare class CreateFormListButtonPropertyRules extends PropertyRules {
     constructor(props: CreateFormListButtonProperty);
 }
 interface CreateFormListButtonPropertyInterface extends ButtonPropertyInterface {
+    /**
+     * 绑定表单
+     * @defaultValue ''
+     * @public
+     */
     formKey: string;
+    /**
+     * 打开方式；取值：modal：弹窗；window：新窗口；dialog：对话框；tab：页签；
+     * @defaultValue 'modal'
+     * @public
+     */
     openType: 'modal' | 'window' | 'dialog' | 'tab';
 }
 declare class CreateFormListButtonProperty extends ButtonProperty implements CreateFormListButtonPropertyInterface {

package/dist/types/baseControls/Dashboard/property.d.ts

@@ -11,13 +11,53 @@ declare class DashboardPropertyRules extends PropertyRules {
     constructor(props: DashboardProperty);
 }
 interface DashboardPropertyInterface extends PropertyInterface {
+    /**
+     * 仪表盘标识
+     * @defaultValue ''
+     * @public
+     */
     dashboardKey: string;
+    /**
+     * 标题
+     * @defaultValue ''
+     * @public
+     */
     caption: string;
+    /**
+     * 隐藏标题
+     * @defaultValue false
+     * @public
+     */
     isHideCaption: boolean;
+    /**
+     * 是否开启气泡提示
+     * @defaultValue false
+     * @public
+     */
     isShowCaptionTip: boolean;
+    /**
+     * 气泡提示语
+     * @defaultValue ''
+     * @public
+     */
     captionTip: string;
+    /**
+     * 标题布局；取值：top：上方；left：左侧；
+     * @defaultValue 'top'
+     * @public
+     */
     labelPosition: 'top' | 'left';
+    /**
+     * 是否显示报表参数
+     * @defaultValue false
+     * @public
+     */
     isShowReportParams: boolean;
+    /**
+     * 报表参数
+     * @defaultValue []
+     * @public
+     */
     reportParams: Array<FieldFilterCondition | FieldFilterConditions>[];
 }
 declare class DashboardProperty extends Property implements DashboardPropertyInterface {

package/dist/types/baseControls/Divider/property.d.ts

@@ -1,12 +1,75 @@
+/**
+ * name: rok_divider
+ * description: 分割线组件。用于分隔页面内容、突出区块层级。支持线条颜色、线型、标题内容、对齐位置、标题字号颜色字重和垂直位置配置，适合表单分组与版面分区场景。
+ */
 import { Property, PropertyInterface } from '@byteluck-fe/model-driven-core';
-import { LINE_STYLE } from '../../framework';
+import { LINE_STYLE, FONT_WEIGHT } from '../../framework';
 interface DividerPropertyInterface extends PropertyInterface {
+    /**
+     * 颜色；取值：primary：主色；danger：危险；warning：警告；success：成功；info：信息；blue：蓝色；
+     * @defaultValue '#000'
+     * @public
+     */
     color: string;
+    /**
+     * 线条样式；取值：solid-line：实线；dashed-line：虚线；bold-solid-line：粗实线；bold-dashed-line：粗虚线；double-solid-line：双实线；double-dashed-line：双虚线；
+     * @defaultValue 'solid-line'
+     * @public
+     */
     lineStyle: LINE_STYLE;
+    /**
+     * 内容
+     * @defaultValue ''
+     * @public
+     */
+    content: string;
+    /**
+     * 位置；取值：left：左侧；center：居中；right：右侧；
+     * @defaultValue 'left'
+     * @public
+     */
+    position: 'left' | 'center' | 'right';
+    /**
+     * 标题大小
+     * @defaultValue ''
+     * @public
+     */
+    captionSize: string;
+    /**
+     * 标题颜色
+     * @defaultValue ''
+     * @public
+     */
+    captionColor: string;
+    /**
+     * 标题斜体
+     * @defaultValue false
+     * @public
+     */
+    isCaptionItalic: boolean;
+    /**
+     * 标题字重；取值：normal：常规；bold：粗体；lighter：更细；bolder：更粗；
+     * @defaultValue 'normal'
+     * @public
+     */
+    captionFontWeight: FONT_WEIGHT;
+    /**
+     * 标题斜体；取值：top：上方；middle：中间；bottom：下方；
+     * @defaultValue 'middle'
+     * @public
+     */
+    verticalPosition: 'top' | 'middle' | 'bottom';
 }
 declare class DividerProperty extends Property implements DividerPropertyInterface {
     color: string;
     lineStyle: LINE_STYLE;
+    content: string;
+    position: 'left' | 'center' | 'right';
+    captionSize: string;
+    captionColor: string;
+    isCaptionItalic: boolean;
+    captionFontWeight: FONT_WEIGHT;
+    verticalPosition: 'top' | 'middle' | 'bottom';
     constructor(props?: Partial<DividerProperty>);
 }
 export default DividerProperty;

package/dist/types/baseControls/ExportListButton/property.d.ts

@@ -1,7 +1,21 @@
+/**
+ * name: rok_export_list_button
+ * description: 导出列表按钮组件。用于列表场景按模板导出数据。支持系统模板或外部模板配置、多模板切换，并继承按钮样式、图标和颜色能力，适合报表导出和数据下载场景。
+ */
 import { ButtonProperty, ButtonPropertyInterface } from '../Button';
 import { ExportTemplate } from '../../framework';
 interface ExportListButtonPropertyInterface extends ButtonPropertyInterface {
+    /**
+     * 模板列表
+     * @defaultValue [new ExportTemplate({ id: 'default', name: '默认模版', appId: 'default', ... })]
+     * @public
+     */
     templateList: ExportTemplate[];
+    /**
+     * 模板类型；取值：system：系统；external：外部；
+     * @defaultValue 'system'
+     * @public
+     */
     templateType: 'system' | 'external';
 }
 declare class ExportListButtonProperty extends ButtonProperty implements ExportListButtonPropertyInterface {

package/dist/types/baseControls/ExportRecordListButton/property.d.ts

@@ -1,3 +1,7 @@
+/**
+ * name: rok_export_record_list_button
+ * description: 导出记录列表按钮组件。用于记录列表场景快速发起导出操作。支持沿用通用按钮的文案、样式、图标、颜色和命令配置，适合标准化记录导出入口。
+ */
 import { ButtonProperty, ButtonPropertyInterface } from '../Button';
 interface ExportRecordListButtonPropertyInterface extends ButtonPropertyInterface {
 }

package/dist/types/baseControls/FormSelectButton/property.d.ts

@@ -1,3 +1,7 @@
+/**
+ * name: rok_form_select_button
+ * description: 表单选择按钮组件。用于打开目标表单选择数据并回填当前页面。支持数据过滤、目标表单绑定、回填配置以及新建、编辑、查看命令模式，适合主子表关联和单据引用场景。
+ */
 import { ButtonProperty, ButtonPropertyInterface } from '../Button';
 import { PropertyRules, FillBackBind, FillPayloadBind, FormSelectBind } from '@byteluck-fe/model-driven-core';
 import { RuleItem } from 'async-validator';
@@ -8,9 +12,29 @@ declare class FormSelectButtonPropertyRules extends PropertyRules {
     constructor(props: FormSelectButtonProperty);
 }
 interface FormSelectButtonPropertyInterface extends ButtonPropertyInterface {
+    /**
+     * 数据过滤
+     * @defaultValue new FillPayloadBind()
+     * @public
+     */
     fillPayload: FillPayloadBind;
+    /**
+     * 选择表单
+     * @defaultValue new FormSelectBind()
+     * @public
+     */
     formBind: FormSelectBind;
+    /**
+     * 回填配置
+     * @defaultValue new FillBackBind()
+     * @public
+     */
     fillBack: FillBackBind;
+    /**
+     * 按钮命令；取值：create：新建；edit：编辑；view：查看；
+     * @defaultValue 'create'
+     * @public
+     */
     command: 'create' | 'edit' | 'view';
 }
 declare class FormSelectButtonProperty extends ButtonProperty implements FormSelectButtonPropertyInterface {

package/dist/types/baseControls/ImportRecordListButton/property.d.ts

@@ -1,10 +1,24 @@
+/**
+ * name: rok_import_record_list_button
+ * description: 导入记录列表按钮组件。用于列表场景导入外部数据到指定业务模型。支持配置可导入的数据对象与模板类型，并继承按钮样式、图标和颜色能力，适合批量数据录入场景。
+ */
 import { ButtonProperty, ButtonPropertyInterface } from '../Button';
 declare class ImportListBind {
     dataCode: string;
     constructor(props: ImportListBind);
 }
 interface ImportRecordListButtonPropertyInterface extends ButtonPropertyInterface {
+    /**
+     * 可以导入的数据
+     * @defaultValue []
+     * @public
+     */
     canImportList: Array<ImportListBind>;
+    /**
+     * 模板类型；取值：system：系统；external：外部；
+     * @defaultValue 'system'
+     * @public
+     */
     templateType: 'system' | 'external';
 }
 declare class ImportRecordListButtonProperty extends ButtonProperty implements ImportRecordListButtonPropertyInterface {

package/dist/types/baseControls/InvoiceCheckButton/property.d.ts

@@ -11,12 +11,47 @@ declare class InvoiceCheckButtonPropertyRules extends PropertyRules {
     constructor(props: InvoiceCheckButtonProperty);
 }
 interface InvoiceCheckButtonPropertyInterface extends ButtonPropertyInterface {
+    /**
+     * 标题
+     * @defaultValue 控件名称
+     * @public
+     */
     caption: string;
+    /**
+     * 隐藏标题
+     * @defaultValue false
+     * @public
+     */
     isHideCaption: boolean;
+    /**
+     * 是否开启气泡提示
+     * @defaultValue false
+     * @public
+     */
     isShowCaptionTip: boolean;
+    /**
+     * 气泡提示语
+     * @defaultValue ''
+     * @public
+     */
     captionTip: string;
+    /**
+     * 标题布局；取值：top：上方；left：左侧；
+     * @defaultValue 'top'
+     * @public
+     */
     labelPosition: 'top' | 'left';
+    /**
+     * 发票验真
+     * @defaultValue true
+     * @public
+     */
     invoiceCheck: boolean;
+    /**
+     * 填充配置
+     * @defaultValue []
+     * @public
+     */
     fillList: MultistageFillingItem[];
 }
 declare class InvoiceCheckButtonProperty extends ButtonProperty implements InvoiceCheckButtonPropertyInterface {

package/dist/types/baseControls/Link/property.d.ts

@@ -1,13 +1,53 @@
+/**
+ * name: rok_link
+ * description: 链接组件。用于展示可点击的文本链接并跳转页面或执行脚本。支持链接地址、描述、对齐方式、颜色、图标、打开方式以及动态脚本或 JavaScript 配置，适合导航与快捷操作场景。
+ */
 import { Property, PropertyInterface } from '@byteluck-fe/model-driven-core';
 interface LinkPropertyInterface extends PropertyInterface {
+    /**
+     * 内容
+     * @defaultValue '我是一个链接'
+     * @public
+     */
     content: string;
+    /**
+     * 链接地址
+     * @defaultValue ''
+     * @public
+     */
     url: string;
+    /**
+     * 位置；取值：left：左侧；center：居中；right：右侧；
+     * @defaultValue 'left'
+     * @public
+     */
+    position: 'left' | 'center' | 'right';
+    /**
+     * 颜色；取值：primary：主色；danger：危险；warning：警告；success：成功；info：信息；blue：蓝色；
+     * @defaultValue 'primary'
+     * @public
+     */
+    color: 'primary' | 'danger' | 'warning' | 'success' | 'info' | 'blue';
+    /**
+     * 打开方式；取值：new：新页面；current：当前；
+     * @defaultValue 'new'
+     * @public
+     */
     openMode: 'new' | 'current';
+    /**
+     * 图标
+     * @defaultValue ''
+     * @public
+     */
+    icon: string;
 }
 declare class LinkProperty extends Property implements LinkPropertyInterface {
     content: string;
     url: string;
+    position: 'left' | 'center' | 'right';
+    color: 'primary' | 'danger' | 'warning' | 'success' | 'info' | 'blue';
     openMode: 'new' | 'current';
+    icon: string;
     constructor(props?: Partial<LinkProperty>);
 }
 export default LinkProperty;

package/dist/types/baseControls/ListSelectButton/property.d.ts

@@ -1,3 +1,7 @@
+/**
+ * name: rok_list_select_button
+ * description: 列表选择按钮组件。用于打开列表页选择数据并回填到当前页面。支持查询过滤、目标列表绑定、回填设置、选中行填充和已选内容展示配置，适合数据引用、关联选择和批量带回场景。
+ */
 import { ButtonProperty, ButtonPropertyInterface } from '../Button';
 import { PropertyRules, FillBackBind, FillPayloadBind, SelectedContentConfig, ListBind } from '@byteluck-fe/model-driven-core';
 import { RuleItem } from 'async-validator';
@@ -10,26 +14,45 @@ declare class ListSelectButtonPropertyRules extends PropertyRules {
 interface ListSelectButtonPropertyInterface extends ButtonPropertyInterface {
     /**
      * 数据过滤
+     * @defaultValue new FillPayloadBind()
      * @public
      */
     fillPayload: FillPayloadBind;
     /**
      * 绑定列表页
+     * @defaultValue new ListBind()
      * @public
      */
     listPageBind: ListBind;
     /**
      * 禁用填充
+     * @defaultValue true
      * @public
      */
     disableFilling: boolean;
     /**
      * 回填配置
+     * @defaultValue new FillBackBind()
      * @public
      */
     fillBack: FillBackBind;
+    /**
+     * 展示已选明细
+     * @defaultValue false
+     * @public
+     */
     showSelectedDetail: boolean;
+    /**
+     * 是否使用选中行填充
+     * @defaultValue false
+     * @public
+     */
     isSelectedRowFill: boolean;
+    /**
+     * 展示已选内容配置字段
+     * @defaultValue new SelectedContentConfig()
+     * @public
+     */
     selectedContentConfig: SelectedContentConfig;
 }
 /**

package/dist/types/baseControls/ListViewSelect/property.d.ts

@@ -11,9 +11,16 @@ declare class ListViewSelectPropertyRules extends PropertyRules {
  */
 interface ListViewSelectPropertyInterface extends PropertyInterface {
     /**
-     * 展示类型
+     * 展示类型；取值：select：下拉选择；tabs：页签切换；
+     * @defaultValue 'select'
+     * @public
      */
     showType: 'select' | 'tabs';
+    /**
+     * 查看操作列表
+     * @defaultValue []
+     * @public
+     */
     viewList: ViewOperationItem[];
 }
 declare class ListViewSelectProperty extends Property implements ListViewSelectPropertyInterface {