@byteluck-fe/model-driven-controls 7.0.0-props.1 → 7.0.0-props.100

package/dist/types/layoutControls/ActionBar/property.d.ts

@@ -1,9 +1,33 @@
-import { LayoutControlProperty } from '@byteluck-fe/model-driven-core';
-declare class ActionBarControlProperty extends LayoutControlProperty {
+/**
+ * name: rok_action_bar
+ * description: 页面操作栏容器组件。用于在表单或页面顶部、底部承载保存、提交等操作按钮。支持顶部/底部及固定定位、左右中对齐和背景透明展示。
+ */
+import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
+interface ActionBarPropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 位置；取值：top：顶部；bottom：底部；top-fixed：固定在顶部；bottom-fixed：固定在底部；
+     * @defaultValue 'bottom'
+     * @public
+     */
+    position: 'top' | 'bottom' | 'top-fixed' | 'bottom-fixed';
+    /**
+     * 背景透明
+     * @defaultValue true
+     * @public
+     */
+    opacity: boolean;
+    /**
+     * 对齐方式；取值：left：左侧；middle：中间；right：右侧；
+     * @defaultValue 'right'
+     * @public
+     */
+    align: 'left' | 'middle' | 'right';
+}
+declare class ActionBarControlProperty extends LayoutControlProperty implements ActionBarPropertyInterface {
     position: 'top' | 'bottom' | 'top-fixed' | 'bottom-fixed';
     opacity: boolean;
     align: 'left' | 'middle' | 'right';
     constructor(props: Partial<ActionBarControlProperty>);
 }
 export default ActionBarControlProperty;
-export { ActionBarControlProperty };
+export { ActionBarControlProperty, ActionBarPropertyInterface };

package/dist/types/layoutControls/AdvancedContainer/property.d.ts

@@ -1,8 +1,27 @@
-import { LayoutControlProperty } from '@byteluck-fe/model-driven-core';
+/**
+ * name: rok_advanced_container
+ * description: 高级容器布局组件。用于搭建自定义区块、复杂内容编排和弹性布局场景。支持多种 display 模式切换，并可配置 Flex 布局能力。
+ */
+import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
 import { FlexStyleConfig } from '../../framework';
-declare class AdvancedContainerProperty extends LayoutControlProperty {
+interface AdvancedContainerPropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 显示类型；取值：block：块级；inline-block：行内块；inline：行内；flex：弹性；inline-flex：行内弹性；grid：网格；inline-grid：行内网格；
+     * @defaultValue 'flex'
+     * @public
+     */
+    display: 'block' | 'inline-block' | 'inline' | 'flex' | 'inline-flex' | 'grid' | 'inline-grid';
+    /**
+     * Flex 布局配置
+     * @defaultValue new FlexStyleConfig()
+     * @public
+     */
+    flexConfig: FlexStyleConfig;
+}
+declare class AdvancedContainerProperty extends LayoutControlProperty implements AdvancedContainerPropertyInterface {
     display: 'block' | 'inline-block' | 'inline' | 'flex' | 'inline-flex' | 'grid' | 'inline-grid';
     flexConfig: FlexStyleConfig;
     constructor(props?: Partial<AdvancedContainerProperty>);
 }
 export default AdvancedContainerProperty;
+export { AdvancedContainerProperty, AdvancedContainerPropertyInterface };

package/dist/types/layoutControls/BlankContainer/designer.d.ts

@@ -0,0 +1,13 @@
+import { DesignerLayoutControl, DesignerControl, SettingOption, LayoutControlSchema } from '@byteluck-fe/model-driven-core';
+import BlankContainerProperty from './property';
+declare class BlankContainerControl extends DesignerLayoutControl {
+    static get controlName(): string;
+    static get controlIcon(): string;
+    static get controlType(): string;
+    static excludes: never[];
+    static readonly setting: SettingOption[];
+    readonly props: BlankContainerProperty;
+    constructor(props?: LayoutControlSchema<'blank-container', BlankContainerProperty, DesignerControl>);
+}
+export default BlankContainerControl;
+export { BlankContainerControl as DesignerBlankContainerControl };

package/dist/types/layoutControls/BlankContainer/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/layoutControls/BlankContainer/property.d.ts

@@ -0,0 +1,81 @@
+/**
+ * name: rok_blank_container
+ * description: 空白容器布局组件。用于作为自由编排内容的占位容器。支持标题字体样式、标题居中方式、背景色和阴影开关设置，适合页面分区与内容承载场景。
+ */
+import { RuleItem } from 'async-validator';
+import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
+import { FONT_WEIGHT } from '../../framework';
+declare class BlankContainerPropertyRules extends LayoutControlProperty.Rules {
+    caption: RuleItem;
+}
+interface BlankContainerPropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 标题
+     * @defaultValue '空白容器'
+     * @public
+     */
+    caption: string;
+    /**
+     * 是否隐藏标题
+     * @defaultValue false
+     * @public
+     */
+    isHideCaption: boolean;
+    /**
+     * 标题大小
+     * @defaultValue ''
+     * @public
+     */
+    captionSize: string;
+    /**
+     * 标题颜色
+     * @defaultValue ''
+     * @public
+     */
+    captionColor: string;
+    /**
+     * 标题斜体
+     * @defaultValue false
+     * @public
+     */
+    isCaptionItalic: boolean;
+    /**
+     * 标题字重；取值：normal：常规；bold：粗体；lighter：更细；
+     * @defaultValue 'normal'
+     * @public
+     */
+    captionFontWeight: FONT_WEIGHT;
+    /**
+     * 标题对齐方式；取值：left：左对齐；center：居中；right：右对齐；
+     * @defaultValue 'left'
+     * @public
+     */
+    position: 'left' | 'center' | 'right';
+    /**
+     * 背景色
+     * @defaultValue ''
+     * @public
+     */
+    backgroundColor: string;
+    /**
+     * 是否开启阴影
+     * @defaultValue false
+     * @public
+     */
+    showShadow: boolean;
+}
+declare class BlankContainerProperty extends LayoutControlProperty implements BlankContainerPropertyInterface {
+    static readonly Rules: typeof BlankContainerPropertyRules;
+    caption: string;
+    isHideCaption: boolean;
+    captionSize: string;
+    captionColor: string;
+    isCaptionItalic: boolean;
+    captionFontWeight: FONT_WEIGHT;
+    position: 'left' | 'center' | 'right';
+    backgroundColor: string;
+    showShadow: boolean;
+    constructor(props?: Partial<BlankContainerProperty>);
+}
+export default BlankContainerProperty;
+export { BlankContainerProperty, BlankContainerPropertyInterface, BlankContainerPropertyRules, };

package/dist/types/layoutControls/BlankContainer/runtime.d.ts

@@ -0,0 +1,9 @@
+import { RuntimeControl, RuntimeLayoutControl, LayoutControlSchema } from '@byteluck-fe/model-driven-core';
+import BlankContainerProperty from './property';
+declare class BlankContainerControl extends RuntimeLayoutControl {
+    static get controlType(): string;
+    readonly props: BlankContainerProperty;
+    constructor(props?: LayoutControlSchema<'blank-container', BlankContainerProperty, RuntimeControl>);
+}
+export default BlankContainerControl;
+export { BlankContainerControl as RuntimeBlankContainerControl };

package/dist/types/layoutControls/CardGroup/property.d.ts

@@ -1,53 +1,87 @@
+/**
+ * name: rok_card_group
+ * description: 卡片分组容器组件。用于将表单内容按业务主题分区展示。支持标题与描述、展开收起、标签样式、边框分割线和阴影等卡片化展示能力。
+ */
 import { RuleItem } from 'async-validator';
-import { LayoutControlProperty } from '@byteluck-fe/model-driven-core';
+import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
 declare class CardGroupControlPropertyRules extends LayoutControlProperty.Rules {
     caption: RuleItem;
 }
-declare class CardGroupControlProperty extends LayoutControlProperty {
-    static readonly Rules: typeof CardGroupControlPropertyRules;
+interface CardGroupPropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 标题信息
+     * @defaultValue '分组'
+     * @public
+     */
     caption: string;
+    /**
+     * 隐藏标题
+     * @defaultValue false
+     * @public
+     */
     isHideCaption: boolean;
     /**
      * 卡片分组是否支持展开收起；可选项： none 不支持 | open 默认展开 | close 默认关闭
-     * @defaultValue none
+     * @defaultValue 'none'
+     * @public
      */
     collapse: 'none' | 'open' | 'close';
     /**
      * 展示风格；default：默认；card：卡片；
-     * @defaultValue default
+     * @defaultValue 'default'
+     * @public
      */
     type: 'default' | 'card';
     /**
      * 描述信息
-     * @defaultValue
+     * @defaultValue ''
+     * @public
      */
     describe: string;
     /**
      * 标签位置；left：左对齐；center：居中；right：右对齐；
-     * @defaultValue left
+     * @defaultValue 'left'
+     * @public
      */
     position: 'left' | 'center' | 'right';
     /**
      * 标签类型；default：默认；warning：警告；success：成功；
-     * @defaultValue default
+     * @defaultValue 'default'
+     * @public
      */
     captionType: 'default' | 'warning' | 'success';
     /**
      * 边框类型；none：无边框；dotted：虚线；solid：实线
-     * @defaultValue none
+     * @defaultValue 'none'
+     * @public
      */
     borderType: 'none' | 'dotted' | 'solid';
     /**
      * 分割线；none：无分割线；dotted：虚线；solid：实线
-     * @defaultValue solid
+     * @defaultValue 'solid'
+     * @public
      */
     divider: 'none' | 'dotted' | 'solid';
     /**
      * 显示阴影时机；never：从不显示；always：总是显示；hover：鼠标悬浮时显示;
-     * @defaultValue never
+     * @defaultValue 'never'
+     * @public
      */
     triggerShadow: 'never' | 'hover' | 'always';
+}
+declare class CardGroupControlProperty extends LayoutControlProperty implements CardGroupPropertyInterface {
+    static readonly Rules: typeof CardGroupControlPropertyRules;
+    caption: string;
+    isHideCaption: boolean;
+    collapse: 'none' | 'open' | 'close';
+    type: 'default' | 'card';
+    describe: string;
+    position: 'left' | 'center' | 'right';
+    captionType: 'default' | 'warning' | 'success';
+    borderType: 'none' | 'dotted' | 'solid';
+    divider: 'none' | 'dotted' | 'solid';
+    triggerShadow: 'never' | 'hover' | 'always';
     constructor(props?: Partial<CardGroupControlProperty>);
 }
 export default CardGroupControlProperty;
-export { CardGroupControlProperty, CardGroupControlPropertyRules };
+export { CardGroupControlProperty, CardGroupPropertyInterface, CardGroupControlPropertyRules };

package/dist/types/layoutControls/Col/property.d.ts

@@ -1,9 +1,33 @@
-import { LayoutControlProperty } from '@byteluck-fe/model-driven-core';
-declare class ColControlProperty extends LayoutControlProperty {
+/**
+ * name: rok_col
+ * description: 栅格列布局组件。用于在行容器中按列宽分配摆放控件。支持列跨度、偏移量以及是否不占满容器的布局控制。
+ */
+import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
+interface ColPropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 占用列数
+     * @defaultValue 24
+     * @public
+     */
+    span: number;
+    /**
+     * 偏移量
+     * @defaultValue 0
+     * @public
+     */
+    offset: number;
+    /**
+     * 是否不占满容器
+     * @defaultValue false
+     * @public
+     */
+    isNoFull: boolean;
+}
+declare class ColControlProperty extends LayoutControlProperty implements ColPropertyInterface {
     span: number;
     offset: number;
     isNoFull: boolean;
     constructor(props?: Partial<ColControlProperty>);
 }
 export default ColControlProperty;
-export { ColControlProperty };
+export { ColControlProperty, ColPropertyInterface };

package/dist/types/layoutControls/Collapse/property.d.ts

@@ -1,26 +1,33 @@
-import { LayoutControlProperty } from '@byteluck-fe/model-driven-core';
-declare class CollapseControlProperty extends LayoutControlProperty {
+/**
+ * name: rok_collapse
+ * description: 折叠面板容器组件。用于将内容分组折叠展示，适合信息分段收纳和按需展开查看。支持手风琴模式、边框、标题高亮条和幽灵样式。
+ */
+import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
+interface CollapsePropertyInterface extends LayoutControlPropertyInterface {
     /**
      * 手风琴模式，始终只有一个面板处在激活状态
      * @defaultValue false
+     * @public
      */
     accordion: boolean;
     /**
      * 带边框风格的折叠面板
      * @defaultValue true
+     * @public
      */
     bordered: boolean;
     /**
      * 是否在标题左侧显示高亮条
      * @defaultValue false
+     * @public
      */
     isShowHighlightBar: boolean;
-    /**
-     * 幽灵折叠面板，使折叠面板透明且无边框
-     * @defaultValue false
-     */
-    ghost: boolean;
+}
+declare class CollapseControlProperty extends LayoutControlProperty implements CollapsePropertyInterface {
+    accordion: boolean;
+    bordered: boolean;
+    isShowHighlightBar: boolean;
     constructor(props?: Partial<CollapseControlProperty>);
 }
 export default CollapseControlProperty;
-export { CollapseControlProperty };
+export { CollapseControlProperty, CollapsePropertyInterface };

package/dist/types/layoutControls/CollapsePane/property.d.ts

@@ -1,11 +1,19 @@
-import { LayoutControlProperty } from '@byteluck-fe/model-driven-core';
-declare class CollapsePaneControlProperty extends LayoutControlProperty {
+/**
+ * name: rok_collapse_pane
+ * description: 折叠面板子项组件。用于在折叠容器中承载单个可展开区块内容。支持配置面板头标题，适合分组信息按需展开查看。
+ */
+import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
+interface CollapsePanePropertyInterface extends LayoutControlPropertyInterface {
     /**
      * 面板头内容
-     * @defaultValue
+     * @defaultValue getLocaleText('CMD.08411774579056771')
+     * @public
      */
     header: string;
+}
+declare class CollapsePaneControlProperty extends LayoutControlProperty implements CollapsePanePropertyInterface {
+    header: string;
     constructor(props?: Partial<CollapsePaneControlProperty>);
 }
 export default CollapsePaneControlProperty;
-export { CollapsePaneControlProperty, };
+export { CollapsePaneControlProperty, CollapsePanePropertyInterface, };

package/dist/types/layoutControls/DataView/property.d.ts

@@ -1,4 +1,4 @@
-import { LayoutControlProperty, PropertyRuntimeRules, DataSourceBind, OperationItem } from '@byteluck-fe/model-driven-core';
+import { LayoutControlProperty, LayoutControlPropertyInterface, PropertyRuntimeRules, DataSourceBind, OperationItem } from '@byteluck-fe/model-driven-core';
 declare class DataViewControlPropertyRuntimeRules extends PropertyRuntimeRules {
     constructor(props: DataViewControlProperty);
 }
@@ -6,7 +6,51 @@ declare class DataViewControlPropertyRuntimeRules extends PropertyRuntimeRules {
  * DataView 表单页
  * @public
  */
-declare class DataViewControlProperty extends LayoutControlProperty {
+interface DataViewPropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 保存按钮
+     * @defaultValue new OperationItem({ content: '保存', type: 'save', isShow: false })
+     * @public
+     */
+    save: OperationItem;
+    /**
+     * 取消按钮
+     * @defaultValue new OperationItem({ content: '取消', type: 'cancel', isShow: false })
+     * @public
+     */
+    cancel: OperationItem;
+    /**
+     * 另存为按钮
+     * @defaultValue new OperationItem({ content: '保存草稿', type: 'saveAs', isShow: false })
+     * @public
+     */
+    saveAs: OperationItem;
+    /**
+     * 打印按钮
+     * @defaultValue new OperationItem({ content: '打印', type: 'print', isShow: false })
+     * @public
+     */
+    print: OperationItem;
+    /**
+     * 自定义操作项
+     * @defaultValue []
+     * @public
+     */
+    custom: OperationItem[];
+    /**
+     * 加载中
+     * @defaultValue false
+     * @public
+     */
+    isLoading: boolean;
+    /**
+     * 绑定业务模型
+     * @defaultValue new DataSourceBind()
+     * @public
+     */
+    datasourceBind: DataSourceBind;
+}
+declare class DataViewControlProperty extends LayoutControlProperty implements DataViewPropertyInterface {
     /**
      * @internal
      */
@@ -27,7 +71,12 @@ declare class DataViewControlProperty extends LayoutControlProperty {
      * @public
      */
     datasourceBind: DataSourceBind;
+    /**
+     * 流程表单只读控件展现形式；disabled：禁用模式；text：文本模式；
+     * @defaultValue disabled
+     */
+    processFormReadonlyControlMode: 'disabled' | 'text';
     constructor(props?: Partial<DataViewControlProperty>);
 }
 export default DataViewControlProperty;
-export { DataViewControlProperty, DataViewControlPropertyRuntimeRules };
+export { DataViewControlProperty, DataViewPropertyInterface, DataViewControlPropertyRuntimeRules };

package/dist/types/layoutControls/Grid/property.d.ts

@@ -1,2 +1,12 @@
-import { LayoutControlProperty } from '@byteluck-fe/model-driven-core';
-export default LayoutControlProperty;
+/**
+ * name: rok_grid
+ * description: 网格布局容器组件。用于承载网格化排版内容和规则化布局区域。当前继承基础布局属性，适合配合网格行列子组件构建页面结构。
+ */
+import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
+interface GridPropertyInterface extends LayoutControlPropertyInterface {
+}
+declare class GridControlProperty extends LayoutControlProperty implements GridPropertyInterface {
+    constructor(props?: Partial<GridControlProperty>);
+}
+export default GridControlProperty;
+export { GridControlProperty, GridPropertyInterface };

package/dist/types/layoutControls/GridLayoutContainer/property.d.ts

@@ -1,8 +1,26 @@
-import { LayoutControlProperty } from '@byteluck-fe/model-driven-core';
-declare class GridLayoutContainerControlProperty extends LayoutControlProperty {
+/**
+ * name: rok_grid_layout_container
+ * description: 自适应网格容器组件。用于多控件均匀排布和响应式宫格布局场景。支持设置子控件最小宽度与列间距，便于自动换列展示。
+ */
+import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
+interface GridLayoutContainerPropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 子控件宽度最小值
+     * @defaultValue 230
+     * @public
+     */
+    childMinWidth: number;
+    /**
+     * 子控件间距
+     * @defaultValue 24
+     * @public
+     */
+    colGap: number;
+}
+declare class GridLayoutContainerControlProperty extends LayoutControlProperty implements GridLayoutContainerPropertyInterface {
     childMinWidth: number;
     colGap: number;
     constructor(props?: Partial<GridLayoutContainerControlProperty>);
 }
 export default GridLayoutContainerControlProperty;
-export { GridLayoutContainerControlProperty };
+export { GridLayoutContainerControlProperty, GridLayoutContainerPropertyInterface };

package/dist/types/layoutControls/GridRow/property.d.ts

@@ -1,6 +1,12 @@
-import { RowControlProperty } from '../Row';
-declare class GridRowControlProperty extends RowControlProperty {
+/**
+ * name: rok_grid_row
+ * description: 网格行容器组件。用于在网格布局中组织一行内容。继承行布局能力，适合与列组件配合完成分栏排版。
+ */
+import { RowControlProperty, RowPropertyInterface } from '../Row';
+interface GridRowPropertyInterface extends RowPropertyInterface {
+}
+declare class GridRowControlProperty extends RowControlProperty implements GridRowPropertyInterface {
     constructor(props: Partial<GridRowControlProperty>);
 }
 export default GridRowControlProperty;
-export { GridRowControlProperty };
+export { GridRowControlProperty, GridRowPropertyInterface };

package/dist/types/layoutControls/GridTableColumn/property.d.ts

@@ -1,6 +1,84 @@
+/**
+ * name: rok_grid_table_column
+ * description: 表格列配置组件。用于定义数据表格中单列的展示与格式化规则。支持列宽、标题、字段绑定、固定列、文本清洗、数值精度和时间/部门展示设置。
+ */
 import { DateType, FieldTypes } from '@byteluck-fe/model-driven-shared';
-import { LayoutControlProperty, DataSourceBind } from '@byteluck-fe/model-driven-core';
-declare class GridTableColumnControlProperty extends LayoutControlProperty {
+import { LayoutControlProperty, LayoutControlPropertyInterface, DataSourceBind } from '@byteluck-fe/model-driven-core';
+interface GridTableColumnPropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 宽度类型；取值：px：像素；auto：自动；percent：百分比；
+     * @defaultValue 'auto'
+     * @public
+     */
+    widthType: 'px' | 'auto' | 'percent';
+    /**
+     * 宽度
+     * @defaultValue 200
+     * @public
+     */
+    width: number;
+    /**
+     * 标题
+     * @defaultValue ''
+     * @public
+     */
+    caption: string;
+    /**
+     * 字段编码
+     * @defaultValue ''
+     * @public
+     */
+    fieldCode: string;
+    /**
+     * 字段类型
+     * @defaultValue 'varchar'
+     * @public
+     */
+    fieldType: FieldTypes;
+    /**
+     * 字段名称
+     * @defaultValue ''
+     * @public
+     */
+    fieldName: string;
+    /**
+     * 数据源绑定
+     * @defaultValue new DataSourceBind()
+     * @public
+     */
+    datasourceBind: DataSourceBind;
+    /**
+     * 是否固定
+     * @defaultValue false
+     * @public
+     */
+    fixed: boolean;
+    /**
+     * 是否去除标签格式
+     * @defaultValue false
+     * @public
+     */
+    textCleanFormart: boolean;
+    /**
+     * 小数保留位数
+     * @defaultValue 0
+     * @public
+     */
+    decimalKeepPrecision: number;
+    /**
+     * 时间戳展示类型；取值：year：年；month：年月；date：年月日；datehour：年月日时；datemin：年月日时分；datetime：年月日时分秒；custom：自定义；
+     * @defaultValue 'date'
+     * @public
+     */
+    timestampDateType: DateType;
+    /**
+     * 部门显示层级
+     * @defaultValue 1
+     * @public
+     */
+    departmentDisplayLevel: number;
+}
+declare class GridTableColumnControlProperty extends LayoutControlProperty implements GridTableColumnPropertyInterface {
     widthType: 'px' | 'auto' | 'percent';
     width: number;
     caption: string;
@@ -16,4 +94,4 @@ declare class GridTableColumnControlProperty extends LayoutControlProperty {
     constructor(props?: Partial<GridTableColumnControlProperty>);
 }
 export default GridTableColumnControlProperty;
-export { GridTableColumnControlProperty };
+export { GridTableColumnControlProperty, GridTableColumnPropertyInterface };