@byteluck-fe/model-driven-controls 7.0.0-1-beta9 → 7.0.0-beta.10

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

@@ -1,55 +1,90 @@
-import { Property, OptObject } from '@byteluck-fe/model-driven-core';
-declare class ButtonProperty extends Property {
+import { Property, PropertyInterface, OptObject, ActionObject } from '@byteluck-fe/model-driven-core';
+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
+     * 颜色；取值：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
+     */
+    optObj?: OptObject;
+    /**
+     * 操作行动项
+     * @defaultValue new ActionObject({})
+     * @public
+     */
+    actionObj: ActionObject;
+    /**
+     * 操作项按钮类型；取值：button：按钮操作项；businessAction：业务行动操作；
+     * @defaultValue 'button'
+     * @public
+     */
+    optButtonType: 'button' | 'businessAction';
+}
+declare class ButtonProperty extends Property implements ButtonPropertyInterface {
+    content: string;
+    buttonType: 'primary' | 'secondary' | 'text';
+    showType: 'text' | 'icon' | 'iconText';
+    color: 'primary' | 'danger' | 'warning' | 'success' | 'info' | 'blue';
+    icon: string;
+    /**
+     * 默认状态；取值：default：默认；readonly：只读；
+     * @defaultValue 'default'
      * @public
-     * @defaultValue ''
      */
+    defaultState: 'default' | 'readonly';
+    command: string;
+    isLoading: boolean;
     optObj?: OptObject;
+    actionObj: ActionObject;
+    optButtonType: 'button' | 'businessAction';
     constructor(props?: Partial<ButtonProperty>);
 }
 export default ButtonProperty;
-export { ButtonProperty };
+export { ButtonProperty, ButtonPropertyInterface };

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

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

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

@@ -1,15 +1,43 @@
-import { ButtonProperty } from '../Button';
+/**
+ * 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';
 declare class CreateFormListButtonPropertyRules extends PropertyRules {
     formKey: RuleItem;
     constructor(props: CreateFormListButtonProperty);
 }
-declare class CreateFormListButtonProperty extends ButtonProperty {
+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 {
     static readonly Rules: typeof CreateFormListButtonPropertyRules;
+    /**
+     * 绑定表单
+     * @defaultValue ''
+     * @public
+     */
     formKey: string;
+    /**
+     * 打开方式；取值：modal：弹窗；window：新窗口；dialog：对话框；tab：页签；
+     * @defaultValue 'modal'
+     * @public
+     */
     openType: 'modal' | 'window' | 'dialog' | 'tab';
     constructor(props?: Partial<CreateFormListButtonProperty>);
 }
 export default CreateFormListButtonProperty;
-export { CreateFormListButtonProperty, CreateFormListButtonPropertyRules };
+export { CreateFormListButtonProperty, CreateFormListButtonPropertyInterface, CreateFormListButtonPropertyRules };

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

@@ -1,4 +1,4 @@
-import { Property, PropertyRules } from '@byteluck-fe/model-driven-core';
+import { Property, PropertyInterface, PropertyRules } from '@byteluck-fe/model-driven-core';
 import { RuleItem, FieldFilterCondition, FieldFilterConditions } from '@byteluck-fe/model-driven-core';
 declare class DashboardPropertyRules extends PropertyRules {
     dashboardKey: RuleItem;
@@ -10,17 +10,107 @@ declare class DashboardPropertyRules extends PropertyRules {
     reportParams: RuleItem;
     constructor(props: DashboardProperty);
 }
-declare class DashboardProperty extends Property {
+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 {
     static readonly Rules: typeof DashboardPropertyRules;
+    /**
+     * 仪表盘标识
+     * @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>[];
     constructor(props?: Partial<DashboardProperty>);
 }
 export default DashboardProperty;
-export { DashboardProperty, DashboardPropertyRules };
+export { DashboardProperty, DashboardPropertyInterface, DashboardPropertyRules };

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

@@ -1,9 +1,121 @@
-import { Property } from '@byteluck-fe/model-driven-core';
-import { LINE_STYLE } from '../../framework';
-declare class DividerProperty extends Property {
+/**
+ * name: rok_divider
+ * description: 分割线组件。用于分隔页面内容、突出区块层级。支持线条颜色、线型、标题内容、对齐位置、标题字号颜色字重和垂直位置配置，适合表单分组与版面分区场景。
+ */
+import { Property, PropertyInterface } from '@byteluck-fe/model-driven-core';
+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：更细；
+     * @defaultValue 'normal'
+     * @public
+     */
+    captionFontWeight: FONT_WEIGHT;
+    /**
+     * 标题斜体；取值：top：上方；middle：中间；bottom：下方；
+     * @defaultValue 'middle'
+     * @public
+     */
+    verticalPosition: 'top' | 'middle' | 'bottom';
+}
+declare class DividerProperty extends Property implements DividerPropertyInterface {
+    /**
+     * 颜色；取值：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：更细；
+     * @defaultValue 'normal'
+     * @public
+     */
+    captionFontWeight: FONT_WEIGHT;
+    /**
+     * 标题斜体；取值：top：上方；middle：中间；bottom：下方；
+     * @defaultValue 'middle'
+     * @public
+     */
+    verticalPosition: 'top' | 'middle' | 'bottom';
     constructor(props?: Partial<DividerProperty>);
 }
 export default DividerProperty;
-export { DividerProperty };
+export { DividerProperty, DividerPropertyInterface };

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

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

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

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

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

@@ -1,4 +1,8 @@
-import { ButtonProperty } from '../Button';
+/**
+ * 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';
 declare class FormSelectButtonPropertyRules extends PropertyRules {
@@ -7,13 +11,59 @@ declare class FormSelectButtonPropertyRules extends PropertyRules {
     fillBack: RuleItem;
     constructor(props: FormSelectButtonProperty);
 }
-declare class FormSelectButtonProperty extends ButtonProperty {
+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 {
     static readonly Rules: typeof FormSelectButtonPropertyRules;
+    /**
+     * 数据过滤
+     * @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';
     constructor(props?: Partial<FormSelectButtonProperty>);
 }
 export default FormSelectButtonProperty;
-export { FormSelectButtonProperty, FormSelectButtonPropertyRules };
+export { FormSelectButtonProperty, FormSelectButtonPropertyInterface, FormSelectButtonPropertyRules };

package/dist/types/baseControls/Iframe/designer.d.ts

@@ -0,0 +1,12 @@
+import { DesignerControl, Schema, SettingOption } from '@byteluck-fe/model-driven-core';
+import IframeProperty from './property';
+declare class IframeControl extends DesignerControl {
+    static get controlName(): string;
+    static get controlIcon(): string;
+    static get controlType(): string;
+    static readonly setting: SettingOption[];
+    readonly props: IframeProperty;
+    constructor(props?: Partial<Schema<'iframe'>>);
+}
+export default IframeControl;
+export { IframeControl as DesignerIframeControl };

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

@@ -0,0 +1,12 @@
+import Designer from './designer';
+import Runtime from './runtime';
+import Property from './property';
+declare const _default: {
+    Designer: typeof Designer;
+    Runtime: typeof Runtime;
+    Property: typeof Property;
+};
+export default _default;
+export * from './designer';
+export * from './runtime';
+export * from './property';

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

@@ -0,0 +1,55 @@
+/**
+ * name: rok_iframe
+ * description: 网页嵌入组件。用于在页面中嵌入外部 URL 页面。支持配置链接地址、宽度和高度，适合展示第三方报表、系统页面或外部内容。
+ */
+import { RuleItem } from 'async-validator';
+import { Property, PropertyInterface, PropertyRules } from '@byteluck-fe/model-driven-core';
+declare class IframePropertyRules extends PropertyRules {
+    content: RuleItem;
+    width: RuleItem;
+    height: RuleItem;
+}
+interface IframePropertyInterface extends PropertyInterface {
+    /**
+     * URL
+     * @defaultValue ''
+     * @public
+     */
+    content: string;
+    /**
+     * 宽
+     * @defaultValue 600
+     * @public
+     */
+    width: number;
+    /**
+     * 高
+     * @defaultValue 400
+     * @public
+     */
+    height: number;
+}
+declare class IframeProperty extends Property implements IframePropertyInterface {
+    static readonly Rules: typeof IframePropertyRules;
+    /**
+     * URL
+     * @defaultValue ''
+     * @public
+     */
+    content: string;
+    /**
+     * 宽
+     * @defaultValue 600
+     * @public
+     */
+    width: number;
+    /**
+     * 高
+     * @defaultValue 400
+     * @public
+     */
+    height: number;
+    constructor(props?: Partial<IframeProperty>);
+}
+export default IframeProperty;
+export { IframeProperty, IframePropertyInterface, IframePropertyRules };

package/dist/types/baseControls/Iframe/runtime.d.ts

@@ -0,0 +1,10 @@
+import { RuntimeControl } from '@byteluck-fe/model-driven-core';
+import IframeProperty from './property';
+import { Schema } from '@byteluck-fe/model-driven-core';
+declare class IframeControl extends RuntimeControl {
+    static get controlType(): string;
+    readonly props: IframeProperty;
+    constructor(props?: Partial<Schema<'iframe'>>);
+}
+export default IframeControl;
+export { IframeControl as RuntimeIframeControl };