@byteluck-fe/model-driven-controls 7.0.0-props.3 → 7.0.0-props.31

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

@@ -1,4 +1,4 @@
-import { ButtonProperty } from '../Button';
+import { ButtonProperty, ButtonPropertyInterface } from '../Button';
 import { PropertyRules, MultistageFillingItem } from '@byteluck-fe/model-driven-core';
 import { RuleItem } from 'async-validator';
 declare class InvoiceCheckButtonPropertyRules extends PropertyRules {
@@ -10,7 +10,51 @@ declare class InvoiceCheckButtonPropertyRules extends PropertyRules {
     captionTip: RuleItem;
     constructor(props: InvoiceCheckButtonProperty);
 }
-declare class InvoiceCheckButtonProperty extends ButtonProperty {
+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 {
     static readonly Rules: typeof InvoiceCheckButtonPropertyRules;
     caption: string;
     isHideCaption: boolean;
@@ -22,4 +66,4 @@ declare class InvoiceCheckButtonProperty extends ButtonProperty {
     constructor(props?: Partial<InvoiceCheckButtonProperty>);
 }
 export default InvoiceCheckButtonProperty;
-export { InvoiceCheckButtonProperty, InvoiceCheckButtonPropertyRules };
+export { InvoiceCheckButtonProperty, InvoiceCheckButtonPropertyInterface, InvoiceCheckButtonPropertyRules };

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

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

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

@@ -1,4 +1,8 @@
-import { ButtonProperty } from '../Button';
+/**
+ * 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';
 declare class ListSelectButtonPropertyRules extends PropertyRules {
@@ -7,31 +11,59 @@ declare class ListSelectButtonPropertyRules extends PropertyRules {
     fillBack: RuleItem;
     constructor(props: ListSelectButtonProperty);
 }
-/**
- * ListSelectButton 列表选择
- * @public
- */
-declare class ListSelectButtonProperty extends ButtonProperty {
-    static readonly Rules: typeof ListSelectButtonPropertyRules;
+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;
+}
+/**
+ * ListSelectButton 列表选择
+ * @public
+ */
+declare class ListSelectButtonProperty extends ButtonProperty implements ListSelectButtonPropertyInterface {
+    static readonly Rules: typeof ListSelectButtonPropertyRules;
+    fillPayload: FillPayloadBind;
+    listPageBind: ListBind;
+    disableFilling: boolean;
     fillBack: FillBackBind;
     showSelectedDetail: boolean;
     isSelectedRowFill: boolean;
@@ -39,4 +71,4 @@ declare class ListSelectButtonProperty extends ButtonProperty {
     constructor(props?: Partial<ListSelectButtonProperty>);
 }
 export default ListSelectButtonProperty;
-export { ListSelectButtonProperty, ListSelectButtonPropertyRules };
+export { ListSelectButtonProperty, ListSelectButtonPropertyInterface, ListSelectButtonPropertyRules };

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

@@ -1,15 +1,33 @@
-import { Property, PropertyRules, ViewOperationItem } from '@byteluck-fe/model-driven-core';
+import { Property, PropertyInterface, PropertyRules, ViewOperationItem } from '@byteluck-fe/model-driven-core';
 import { RuleItem } from 'async-validator';
 declare class ListViewSelectPropertyRules extends PropertyRules {
     showType: RuleItem;
     viewList: RuleItem;
     constructor(props: ListViewSelectProperty);
 }
-declare class ListViewSelectProperty extends Property {
+/**
+ * ListViewSelect 列表选择
+ * @public
+ */
+interface ListViewSelectPropertyInterface extends PropertyInterface {
+    /**
+     * 展示类型；取值：select：下拉选择；tabs：页签切换；
+     * @defaultValue 'select'
+     * @public
+     */
+    showType: 'select' | 'tabs';
+    /**
+     * 查看操作列表
+     * @defaultValue []
+     * @public
+     */
+    viewList: ViewOperationItem[];
+}
+declare class ListViewSelectProperty extends Property implements ListViewSelectPropertyInterface {
     static readonly Rules: typeof ListViewSelectPropertyRules;
     showType: 'select' | 'tabs';
     viewList: ViewOperationItem[];
     constructor(props?: Partial<ListViewSelectProperty>);
 }
 export default ListViewSelectProperty;
-export { ListViewSelectProperty, ListViewSelectPropertyRules };
+export { ListViewSelectProperty, ListViewSelectPropertyInterface, ListViewSelectPropertyRules };

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

@@ -1,10 +1,104 @@
-import { Property, PropertyRules } from '@byteluck-fe/model-driven-core';
+/**
+ * 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 {
     formKey: RuleItem;
     constructor(props: OperationButtonProperty);
 }
-declare class OperationButtonProperty extends Property {
+/**
+ * OperationButton 操作按钮
+ * @public
+ */
+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;
+}
+declare class OperationButtonProperty extends Property implements OperationButtonPropertyInterface {
     static readonly Rules: typeof OperationButtonPropertyRules;
     content: string;
     code?: string;
@@ -23,4 +117,4 @@ declare class OperationButtonProperty extends Property {
     constructor(props?: Partial<OperationButtonProperty>);
 }
 export default OperationButtonProperty;
-export { OperationButtonProperty, OperationButtonPropertyRules };
+export { OperationButtonProperty, OperationButtonPropertyInterface, OperationButtonPropertyRules };

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

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

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

@@ -1,15 +1,51 @@
-import { PropertyRules, Property } from '@byteluck-fe/model-driven-core';
+/**
+ * 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';
 declare class ReferenceListPropertyRules extends PropertyRules {
     actionSetting: RuleItem;
     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;
+}
 /**
  * ReferenceList 引用列表
  * @public
  */
-declare class ReferenceListProperty extends Property {
+declare class ReferenceListProperty extends Property implements ReferenceListPropertyInterface {
     static readonly Rules: typeof ReferenceListPropertyRules;
     isShowSimpleSearch: boolean;
     isShowToolbar: boolean;
@@ -19,4 +55,4 @@ declare class ReferenceListProperty extends Property {
     constructor(props?: Partial<ReferenceListProperty>);
 }
 export default ReferenceListProperty;
-export { ReferenceListProperty, ReferenceListPropertyRules };
+export { ReferenceListProperty, ReferenceListPropertyInterface, ReferenceListPropertyRules };

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

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

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

@@ -1,14 +1,44 @@
-import { Property } from '@byteluck-fe/model-driven-core';
-declare class TextProperty extends Property {
+import { Property, PropertyInterface } from '@byteluck-fe/model-driven-core';
+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';
     /**
-   * 标题大小
-   * @defaultValue ''
-   * @public
-   */
+     * 标题大小
+     * @defaultValue ''
+     * @public
+     */
     captionSize: string;
     /**
      * 标题颜色
@@ -23,13 +53,43 @@ declare class TextProperty extends Property {
      */
     isCaptionItalic: boolean;
     /**
-     * ai 显示内容搜索 false | true
+     * 是否开启 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;
+    icon: string;
+    align: string;
+    showState: 'text' | 'imageText' | 'image';
+    captionSize: string;
+    captionColor: string;
+    isCaptionItalic: boolean;
     aiContentSearch: boolean;
     isLabel: boolean;
+    close: closeProperty;
+    background: BackgroundProperty;
     constructor(props?: Partial<TextProperty>);
 }
 export default TextProperty;
-export { TextProperty };
+export { TextProperty, TextPropertyInterface };

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

@@ -1,4 +1,8 @@
-import { ButtonProperty } from '../Button';
+/**
+ * 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';
 declare class TextOcrButtonPropertyRules extends PropertyRules {
@@ -10,7 +14,51 @@ declare class TextOcrButtonPropertyRules extends PropertyRules {
     captionTip: RuleItem;
     constructor(props: TextOcrButtonProperty);
 }
-declare class TextOcrButtonProperty extends ButtonProperty {
+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 {
     static readonly Rules: typeof TextOcrButtonPropertyRules;
     caption: string;
     isHideCaption: boolean;
@@ -22,4 +70,4 @@ declare class TextOcrButtonProperty extends ButtonProperty {
     constructor(props?: Partial<TextOcrButtonProperty>);
 }
 export default TextOcrButtonProperty;
-export { TextOcrButtonProperty, TextOcrButtonPropertyRules };
+export { TextOcrButtonProperty, TextOcrButtonPropertyRules, TextOcrButtonPropertyInterface };