@byteluck-fe/model-driven-controls 7.0.0-props.7 → 7.0.0-props.71

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 {

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

@@ -1,3 +1,7 @@
+/**
+ * name: rok_operation_button
+ * description: 操作按钮组件。用于列表或页面中定义单条数据的编辑、查看、删除或自定义操作。支持命令类型、表单绑定、打开方式、确认提示、自定义参数、加载态和同步删除流程数据等能力。
+ */
 import { Property, PropertyInterface, PropertyRules } from '@byteluck-fe/model-driven-core';
 import { RuleItem } from 'async-validator';
 declare class OperationButtonPropertyRules extends PropertyRules {
@@ -11,71 +15,85 @@ declare class OperationButtonPropertyRules extends PropertyRules {
 interface OperationButtonPropertyInterface extends PropertyInterface {
     /**
      * 按钮内容
+     * @defaultValue '按钮'
      * @public
      */
     content: string;
     /**
      * 按钮代码
+     * @defaultValue undefined
      * @public
      */
     code?: string;
     /**
-     * 操作类型
+     * 操作类型；取值：edit：编辑；view：查看；delete：删除；custom：自定义；
+     * @defaultValue 'custom'
      * @public
      */
     command: 'edit' | 'view' | 'delete' | 'custom';
     /**
-     * 按钮颜色
+     * 按钮颜色；取值：primary：主色；danger：危险；warning：警告；success：成功；info：信息；blue：蓝色；
+     * @defaultValue 'primary'
      * @public
      */
     color: 'primary' | 'danger' | 'warning' | 'success' | 'info' | 'blue';
     /**
      * 按钮图标
+     * @defaultValue undefined
      * @public
      */
     icon?: string;
     /**
      * 绑定表单
+     * @defaultValue undefined
      * @public
      */
     formKey?: string;
     /**
-     * 打开方式
+     * 打开方式；取值：modal：弹窗；window：新窗口；dialog：对话框；tab：页签；
+     * @defaultValue undefined
      * @public
      */
     openType?: 'modal' | 'window' | 'dialog' | 'tab';
     /**
      * 是否需要确认
+     * @defaultValue undefined
      * @public
      */
     needConfirm?: boolean;
     /**
      * 确认消息
+     * @defaultValue undefined
      * @public
      */
     confirmMessage?: string;
     /**
      * 自定义参数
+     * @defaultValue undefined
      * @public
      */
     options?: object;
     /**
-     * 默认状态
+     * 默认状态；取值：default：默认；readonly：只读；
+     * @defaultValue 'default'
      * @public
      */
     defaultState: 'default' | 'readonly';
     /**
      * 优先访问流程列表
+     * @defaultValue undefined
      * @public
      */
     priorityProcess?: boolean;
     /**
      * 是否加载中
+     * @defaultValue false
      * @public
      */
     isLoading: boolean;
     /**
      * 是否同步删除流程数据
+     * @defaultValue false
      * @public
      */
     isSyncDelete: boolean;

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

@@ -1,3 +1,7 @@
+/**
+ * name: rok_pagination
+ * description: 分页组件。用于列表或数据展示场景进行分页导航与页码切换。适合作为标准分页容器配置项，为大数据量列表提供分段浏览能力。
+ */
 import { Property, PropertyInterface, PropertyRules, PropertyRuntimeRules } from '@byteluck-fe/model-driven-core';
 declare class PaginationPropertyRules extends PropertyRules {
     constructor(props: PaginationProperty);

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

@@ -1,3 +1,7 @@
+/**
+ * name: rok_reference_list
+ * description: 引用列表组件。用于在当前页面嵌入并展示关联业务列表。支持业务模型与列表绑定、查询栏与工具栏开关、列表高度配置和标题隐藏设置，适合关联数据查看与引用明细场景。
+ */
 import { PropertyRules, Property, PropertyInterface } from '@byteluck-fe/model-driven-core';
 import { ActionSetting, ListHeightSetting } from '../../framework';
 import { RuleItem } from 'async-validator';
@@ -6,10 +10,35 @@ declare class ReferenceListPropertyRules extends PropertyRules {
     constructor(props: ReferenceListProperty);
 }
 interface ReferenceListPropertyInterface extends PropertyInterface {
+    /**
+     * 是否显示查询栏
+     * @defaultValue true
+     * @public
+     */
     isShowSimpleSearch: boolean;
+    /**
+     * 是否显示工具栏
+     * @defaultValue true
+     * @public
+     */
     isShowToolbar: boolean;
+    /**
+     * 动作设置
+     * @defaultValue new ActionSetting()
+     * @public
+     */
     actionSetting: ActionSetting;
+    /**
+     * 列表高度配置
+     * @defaultValue new ListHeightSetting()
+     * @public
+     */
     listHeightSetting: ListHeightSetting;
+    /**
+     * 列表高度配置
+     * @defaultValue false
+     * @public
+     */
     isHideCaption: boolean;
 }
 /**

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

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

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

@@ -1,8 +1,39 @@
 import { Property, PropertyInterface } from '@byteluck-fe/model-driven-core';
+import { FONT_WEIGHT } from '../../framework';
+interface BackgroundProperty {
+    type: 'backgroundColor' | 'backgroundImage';
+    backgroundColor: string;
+    backgroundImage: string;
+    placementMode: string;
+}
+interface closeProperty {
+    show: boolean;
+    text: string;
+}
 interface TextPropertyInterface extends PropertyInterface {
+    /**
+     * 内容
+     * @defaultValue '说明文字'
+     * @public
+     */
     content: string;
+    /**
+     * 图标
+     * @defaultValue 'page-hint'
+     * @public
+     */
     icon: string;
+    /**
+     * 位置对齐
+     * @defaultValue ''
+     * @public
+     */
     align: string;
+    /**
+     * 显示状态；取值：text：纯文本；imageText：图文；image：纯图片；
+     * @defaultValue 'text'
+     * @public
+     */
     showState: 'text' | 'imageText' | 'image';
     /**
      * 标题大小
@@ -23,12 +54,35 @@ interface TextPropertyInterface extends PropertyInterface {
      */
     isCaptionItalic: boolean;
     /**
-     * ai 显示内容搜索 false | true
+     * 标题字重；取值：normal：常规；bold：粗体；lighter：更细；
+     * @defaultValue 'normal'
+     * @public
+     */
+    captionFontWeight: FONT_WEIGHT;
+    /**
+     * 是否开启 AI 内容搜索
      * @defaultValue false
      * @public
      */
     aiContentSearch: boolean;
+    /**
+     * 是否作为标签展示
+     * @defaultValue false
+     * @public
+     */
     isLabel: boolean;
+    /**
+     * 关闭配置
+     * @defaultValue { show: false, text: '关闭' }
+     * @public
+     */
+    close: closeProperty;
+    /**
+     * 背景
+     * @defaultValue { type: 'backgroundColor', backgroundColor: '', backgroundImage: '', ... }
+     * @public
+     */
+    background: BackgroundProperty;
 }
 declare class TextProperty extends Property implements TextPropertyInterface {
     content: string;
@@ -38,8 +92,11 @@ declare class TextProperty extends Property implements TextPropertyInterface {
     captionSize: string;
     captionColor: string;
     isCaptionItalic: boolean;
+    captionFontWeight: FONT_WEIGHT;
     aiContentSearch: boolean;
     isLabel: boolean;
+    close: closeProperty;
+    background: BackgroundProperty;
     constructor(props?: Partial<TextProperty>);
 }
 export default TextProperty;

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

@@ -1,3 +1,7 @@
+/**
+ * name: rok_text_ocr_button
+ * description: 文字识别按钮组件。用于上传或识别文本图片内容并将结果回填到表单字段。支持识别类型、标题展示、气泡提示和多字段填充配置，适合证照采集、票据录入和 OCR 辅助录入场景。
+ */
 import { ButtonProperty, ButtonPropertyInterface } from '../Button';
 import { PropertyRules, MultistageFillingItem } from '@byteluck-fe/model-driven-core';
 import { RuleItem } from 'async-validator';
@@ -11,12 +15,47 @@ declare class TextOcrButtonPropertyRules extends PropertyRules {
     constructor(props: TextOcrButtonProperty);
 }
 interface TextOcrButtonPropertyInterface 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 ''
+     * @public
+     */
     ocrType: string;
+    /**
+     * 填充配置
+     * @defaultValue []
+     * @public
+     */
     fillList: MultistageFillingItem[];
 }
 declare class TextOcrButtonProperty extends ButtonProperty implements TextOcrButtonPropertyInterface {

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

@@ -1,3 +1,7 @@
+/**
+ * name: rok_title
+ * description: 标题组件。用于在页面顶部展示业务标题和单据信息。支持绑定数据项、配置显示业务标题、提交人、提交时间、提交部门、当前审批人等内容及位置，适合单据页头与流程信息展示场景。
+ */
 import { RuleItem } from 'async-validator';
 import { Property, PropertyInterface, PropertyRules, DataBind } from '@byteluck-fe/model-driven-core';
 import { TitleConfigEnum } from '../../framework';
@@ -8,9 +12,29 @@ declare class TitleControlPropertyRules extends PropertyRules {
     constructor(props: TitleProperty);
 }
 interface TitlePropertyInterface extends PropertyInterface {
+    /**
+     * 数据绑定项
+     * @defaultValue new DataBind()
+     * @public
+     */
     dataBind: DataBind;
+    /**
+     * 标题
+     * @defaultValue ''
+     * @public
+     */
     caption: string;
+    /**
+     * 标题配置项；取值：is_show_biz_key：显示业务标题；is_show_submit_user：显示提交人；is_show_submit_time：显示提交时间；is_show_submit_dept：显示提交部门；is_show_current_approvar：显示当前审批人；is_show_title：显示标题；
+     * @defaultValue ['is_show_submit_user', ...]
+     * @public
+     */
     config: TitleConfigEnum[];
+    /**
+     * 位置
+     * @defaultValue 'top'
+     * @public
+     */
     position: string;
 }
 declare class TitleProperty extends Property implements TitlePropertyInterface {

package/dist/types/baseControls/index.d.ts

@@ -1,24 +1,50 @@
 export { default as Text } from './Text';
+export type { TextPropertyInterface } from './Text';
 export { default as Link } from './Link';
+export type { LinkPropertyInterface } from './Link';
+export { default as Iframe } from './Iframe';
+export type { IframePropertyInterface } from './Iframe';
 export { default as Button } from './Button';
+export type { ButtonPropertyInterface } from './Button';
 export { default as Divider } from './Divider';
+export type { DividerPropertyInterface } from './Divider';
 export { default as Title } from './Title';
+export type { TitlePropertyInterface } from './Title';
 export { default as CreateFormListButton } from './CreateFormListButton';
+export type { CreateFormListButtonPropertyInterface } from './CreateFormListButton';
 export { default as BatchSubmissionListButton } from './BatchSubmissionListButton';
+export type { BatchSubmissionListButtonPropertyInterface } from './BatchSubmissionListButton';
 export { default as SubmissionRecordListButton } from './SubmissionRecordListButton';
+export type { SubmissionRecordListButtonPropertyInterface } from './SubmissionRecordListButton';
 export { default as ExportListButton } from './ExportListButton';
+export type { ExportListButtonPropertyInterface } from './ExportListButton';
 export { default as ExportRecordListButton } from './ExportRecordListButton';
+export type { ExportRecordListButtonPropertyInterface } from './ExportRecordListButton';
 export { default as ImportRecordListButton } from './ImportRecordListButton';
+export type { ImportRecordListButtonPropertyInterface } from './ImportRecordListButton';
 export { default as FormSelectButton } from './FormSelectButton';
+export type { FormSelectButtonPropertyInterface } from './FormSelectButton';
 export { default as ListSelectButton } from './ListSelectButton';
+export type { ListSelectButtonPropertyInterface } from './ListSelectButton';
 export { default as Pagination } from './Pagination';
+export type { PaginationPropertyInterface } from './Pagination';
 export { default as Dashboard } from './Dashboard';
+export type { DashboardPropertyInterface } from './Dashboard';
 export { default as ListViewSelect } from './ListViewSelect';
+export type { ListViewSelectPropertyInterface } from './ListViewSelect';
 export { default as TextOcrButton } from './TextOcrButton';
+export type { TextOcrButtonPropertyInterface } from './TextOcrButton';
 export { default as InvoiceCheckButton } from './InvoiceCheckButton';
+export type { InvoiceCheckButtonPropertyInterface } from './InvoiceCheckButton';
 export { default as BatchPrintListButton } from './BatchPrintListButton';
+export type { BatchPrintListButtonPropertyInterface } from './BatchPrintListButton';
 export { default as BatchPrintRecordListButton } from './BatchPrintRecordListButton';
+export type { BatchPrintRecordListButtonPropertyInterface } from './BatchPrintRecordListButton';
 export { default as OperationButton } from './OperationButton';
+export type { OperationButtonPropertyInterface } from './OperationButton';
 export { default as BatchDeleteButton } from './BatchDeleteButton';
+export type { BatchDeleteButtonPropertyInterface } from './BatchDeleteButton';
 export { default as ReferenceList } from './ReferenceList';
+export type { ReferenceListPropertyInterface } from './ReferenceList';
 export { default as CommentControl } from './Comment';
+export type { CommentPropertyInterface } from './Comment';

package/dist/types/columnControls/ApprovalStatusColumn/property.d.ts

@@ -1,20 +1,24 @@
-import { ColumnControlProperty, ColumnControlPropertyInterface, LinkOperationOption } from '@byteluck-fe/model-driven-core';
 /**
- * ApprovalStatusColumn 审批状态列
- * @public
+ * name: rok_approval_status_column
+ * description: 审批状态展示列。用于在表格中展示流程审批结果与状态信息，适合审批单据、流程列表等场景，支持多行省略展示和配置链接操作以便快速查看详情。
  */
+import { ColumnControlProperty, ColumnControlPropertyInterface, LinkOperationOption } from '@byteluck-fe/model-driven-core';
 interface ApprovalStatusColumnPropertyInterface extends ColumnControlPropertyInterface {
     /**
      * 行数设置
-    */
+     * @defaultValue 1
+     * @public
+     */
     lineEllipsis: number;
     /**
      * 是否显示链接操作
+     * @defaultValue false
      * @public
      */
     showLinkOperation: boolean;
     /**
      * 链接操作配置
+     * @defaultValue new LinkOperationOption()
      * @public
      */
     linkOperationOption: LinkOperationOption;

package/dist/types/columnControls/ArrayColumn/property.d.ts

@@ -1,3 +1,7 @@
+/**
+ * name: rok_array_column
+ * description: 数组内容展示列。用于在表格中展示多值数组或多选结果，适合标签集合、枚举列表等场景，支持自定义选项、绑定数据源以及配置链接操作。
+ */
 import { ColumnControlProperty, ColumnControlPropertyInterface, ColumnOptionAndDataSourcePropertyRules, DataSourceBind, OptionSetting, LinkOperationOption } from '@byteluck-fe/model-driven-core';
 /**
  * ArrayColumn 数组列
@@ -12,29 +16,32 @@ declare class ArrayColumnControlPropertyRules extends ColumnOptionAndDataSourceP
  */
 interface ArrayColumnPropertyInterface extends ColumnControlPropertyInterface {
     /**
-     * 选项配置
+     * 选项配置；取值：none：无；custom：自定义；datasource：数据源；
      * @defaultValue 'none'
      * @public
-     * */
+     */
     optionConfig: 'none' | 'custom' | 'datasource';
     /**
      * 关联数据源
+     * @defaultValue new DataSourceBind()
      * @public
      */
     datasourceBind: DataSourceBind;
     /**
      * 是否显示链接操作
+     * @defaultValue false
      * @public
      */
     showLinkOperation: boolean;
     /**
      * 链接操作配置
+     * @defaultValue new LinkOperationOption()
      * @public
      */
     linkOperationOption: LinkOperationOption;
     /**
      * 自定义选项
-     * @defaultValue []
+     * @defaultValue [{}]
      * @public
      */
     options: OptionSetting[];

package/dist/types/columnControls/AutoNumberColumn/property.d.ts

@@ -1,3 +1,7 @@
+/**
+ * name: rok_auto_number_column
+ * description: 自动编号展示列。用于在表格中展示系统生成的流水号、单号或编码，适合单据列表、记录追踪等场景，支持配置链接操作便于跳转查看详情。
+ */
 import { ColumnControlProperty, ColumnControlPropertyInterface, LinkOperationOption, ColumnControlPropertyRules } from '@byteluck-fe/model-driven-core';
 declare class AutoNumberColumnControlPropertyRules extends ColumnControlPropertyRules {
     constructor(props: AutoNumberColumnControlProperty);
@@ -5,10 +9,14 @@ declare class AutoNumberColumnControlPropertyRules extends ColumnControlProperty
 interface AutoNumberColumnPropertyInterface extends ColumnControlPropertyInterface {
     /**
      * 是否显示链接操作
+     * @defaultValue false
+     * @public
      */
     showLinkOperation: boolean;
     /**
      * 链接操作配置
+     * @defaultValue new LinkOperationOption()
+     * @public
      */
     linkOperationOption: LinkOperationOption;
 }

package/dist/types/columnControls/CustomColumn/property.d.ts

@@ -1,3 +1,7 @@
+/**
+ * name: rok_custom_column
+ * description: 自定义组合列。用于将多个字段组合成一个展示单元，适合列表信息聚合、复合内容展示等场景，支持配置字段编码列表并指定排序字段。
+ */
 import { ColumnControlProperty, ColumnControlPropertyInterface, ColumnControlPropertyRules } from '@byteluck-fe/model-driven-core';
 import { RuleItem } from 'async-validator';
 declare class CustomColumnControlPropertyRules extends ColumnControlPropertyRules {
@@ -11,10 +15,14 @@ declare class CustomColumnControlPropertyRules extends ColumnControlPropertyRule
 interface CustomColumnPropertyInterface extends ColumnControlPropertyInterface {
     /**
      * 字段编码列表
+     * @defaultValue []
+     * @public
      */
     fieldCodeList: string[];
     /**
      * 排序字段编码
+     * @defaultValue ''
+     * @public
      */
     sortFieldCode: string;
 }