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

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

@@ -1,19 +1,157 @@
+/**
+ * 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 {
+    /**
+     * 宽度类型；取值：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;
     constructor(props?: Partial<GridTableColumnControlProperty>);
 }
 export default GridTableColumnControlProperty;
-export { GridTableColumnControlProperty };
+export { GridTableColumnControlProperty, GridTableColumnPropertyInterface };

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

@@ -1,10 +1,20 @@
+/**
+ * name: rok_list_view
+ * description: 列表视图组件。用于展示业务数据列表并驱动联动、子表和树形列表场景。支持数据源绑定、分页排序、行样式、关联关系、子列表触发和主从明细展示能力。
+ */
 import { RuleItem } from 'async-validator';
-import { LayoutControlProperty, PropertyRules, PropertyRuntimeRules, DataSourceBind, SubListPageConfig, JoinRelation, RowStyle, ListTreeData, MasterDetail } from '@byteluck-fe/model-driven-core';
+import { LayoutControlProperty, LayoutControlPropertyInterface, PropertyRules, PropertyRuntimeRules, DataSourceBind, SubListPageConfig, JoinRelation, RowStyle, ListTreeData, MasterDetail } from '@byteluck-fe/model-driven-core';
 /**
  * @internal
  */
 export declare enum TriggerType {
+    /**
+     * 点击整行
+     */
     CLICK_ROW = 1,
+    /**
+     * 点击单元格
+     */
     CLICK_CELL = 2
 }
 /**
@@ -26,11 +36,140 @@ declare class ListViewControlPropertyRules extends PropertyRules {
  * ListView 列表
  * @public
  */
-declare class ListViewControlProperty extends LayoutControlProperty {
+interface ListViewPropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 数据高级设置
+     * @defaultValue new DataSourceBind()
+     * @public
+     */
+    datasourceBind: DataSourceBind;
+    /**
+     * 加载中
+     * @defaultValue false
+     * @public
+     */
+    isLoading: boolean;
+    /**
+     * 显示明细表
+     * @defaultValue false
+     * @public
+     */
+    isShowSubList: boolean;
+    /**
+     * 触发时机 1=整行，2=字段；取值：1：点击整行；2：点击单元格；
+     * @defaultValue 1
+     * @public
+     */
+    triggerType: TriggerType;
+    /**
+     * 触发字段
+     * @defaultValue ''
+     * @public
+     */
+    triggerFieldCode: string;
+    /**
+     * 抽屉内容配置
+     * @defaultValue new SubListPageConfig()
+     * @public
+     */
+    sublistPage: SubListPageConfig;
+    /**
+     * 显示连接表
+     * @defaultValue false
+     * @public
+     */
+    isShowJoinRelation: boolean;
+    /**
+     * 连接表配置
+     * @defaultValue new JoinRelation()
+     * @public
+     */
+    joinRelation: JoinRelation;
+    /**
+     * 提供给关联单选中复用list-view的能力；取值：stretch：拉伸；shrink：收缩；
+     * @defaultValue 'stretch'
+     * @internal
+     */
+    showType: 'stretch' | 'shrink';
+    /**
+     * 全屏显示
+     * @defaultValue false
+     * @public
+     */
+    showFullScreen: boolean;
+    /**
+     * 固定表头
+     * @defaultValue false
+     * @public
+     */
+    isFixedHeader: boolean;
+    /**
+     * 显示选择框类型；取值：multiple：多选；single：单选；
+     * @defaultValue 'multiple'
+     * @public
+     */
+    selectionType: undefined | 'multiple' | 'single';
+    /**
+     * 显示选择框
+     * @defaultValue false
+     * @public
+     */
+    isShowSelection: boolean;
+    /**
+     * 加载全部数据
+     * @defaultValue true
+     * @public
+     */
+    isAllLoaded: boolean;
+    /**
+     * 计数模式；取值：sync：同步；async：异步；none：无；
+     * @defaultValue undefined
+     * @public
+     */
+    countType?: 'sync' | 'async' | 'none';
+    /**
+     * 列表展示最多条数
+     * @defaultValue 100000
+     * @public
+     */
+    countLimit?: number;
+    /**
+     * 行背景规则
+     * @defaultValue new RowStyle()
+     * @public
+     */
+    rowStyle: RowStyle;
+    /**
+     * 是否树状列表
+     * @defaultValue false
+     * @public
+     */
+    isTreeData?: boolean;
+    /**
+     * 树状列表配置详情
+     * @defaultValue new ListTreeData()
+     * @public
+     */
+    treeData?: ListTreeData;
+    /**
+     * 是否开启嵌套列表
+     * @defaultValue false
+     * @public
+     */
+    isMasterDetail?: boolean;
+    /**
+     * 嵌套列表的关联表配置
+     * @defaultValue new MasterDetail()
+     * @public
+     */
+    masterDetail?: MasterDetail;
+}
+declare class ListViewControlProperty extends LayoutControlProperty implements ListViewPropertyInterface {
     static readonly Rules: typeof ListViewControlPropertyRules;
     static readonly RuntimeRules: typeof ListViewControlPropertyRuntimeRules;
     /**
      * 数据高级设置
+     * @defaultValue new DataSourceBind()
      * @public
      */
     datasourceBind: DataSourceBind;
@@ -47,31 +186,38 @@ declare class ListViewControlProperty extends LayoutControlProperty {
      */
     isShowSubList: boolean;
     /**
-     * 触发时机 1=整行，2=字段
+     * 触发时机 1=整行，2=字段；取值：1：点击整行；2：点击单元格；
      * @defaultValue 1
      * @public
      */
     triggerType: TriggerType;
     /**
      * 触发字段
+     * @defaultValue ''
      * @public
      */
     triggerFieldCode: string;
     /**
      * 抽屉内容配置
+     * @defaultValue new SubListPageConfig()
      * @public
      */
     sublistPage: SubListPageConfig;
     /**
      * 显示连接表
+     * @defaultValue false
+     * @public
      */
     isShowJoinRelation: boolean;
     /**
      * 连接表配置
+     * @defaultValue new JoinRelation()
      * @public
      */
     joinRelation: JoinRelation;
     /**
+     * 提供给关联单选中复用list-view的能力；取值：stretch：拉伸；shrink：收缩；
+     * @defaultValue 'stretch'
      * @internal
      */
     showType: 'stretch' | 'shrink';
@@ -88,8 +234,8 @@ declare class ListViewControlProperty extends LayoutControlProperty {
      */
     isFixedHeader: boolean;
     /**
-     * 显示选择框类型
-     * @defaultValue  undefined | 'multiple' | 'radio'
+     * 显示选择框类型；取值：multiple：多选；single：单选；
+     * @defaultValue 'multiple'
      * @public
      */
     selectionType: undefined | 'multiple' | 'single';
@@ -106,8 +252,8 @@ declare class ListViewControlProperty extends LayoutControlProperty {
      */
     isAllLoaded: boolean;
     /**
-     * 计数模式
-     * @defaultValue 'async'
+     * 计数模式；取值：sync：同步；async：异步；none：无；
+     * @defaultValue undefined
      * @public
      */
     countType?: 'sync' | 'async' | 'none';
@@ -119,21 +265,35 @@ declare class ListViewControlProperty extends LayoutControlProperty {
     countLimit?: number;
     /**
      * 行背景规则
-     * @defaultValue 'none'
+     * @defaultValue new RowStyle()
+     * @public
      */
     rowStyle: RowStyle;
     /**
      * 是否树状列表
      * @defaultValue false
+     * @public
      */
     isTreeData?: boolean;
     /**
      * 树状列表配置详情
+     * @defaultValue new ListTreeData()
+     * @public
      */
     treeData?: ListTreeData;
+    /**
+     * 是否开启嵌套列表
+     * @defaultValue false
+     * @public
+     */
     isMasterDetail?: boolean;
+    /**
+     * 嵌套列表的关联表配置
+     * @defaultValue new MasterDetail()
+     * @public
+     */
     masterDetail?: MasterDetail;
     constructor(props?: Partial<ListViewControlProperty>);
 }
 export default ListViewControlProperty;
-export { ListViewControlProperty, ListViewControlPropertyRules };
+export { ListViewControlProperty, ListViewPropertyInterface, ListViewControlPropertyRules };

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

@@ -1,15 +1,72 @@
-import { LayoutControlProperty } from '@byteluck-fe/model-driven-core';
-declare class PageProperty extends LayoutControlProperty {
+/**
+ * name: rok_page
+ * description: 页面容器组件。用于定义整页内容区域的基础展示结构。支持隐藏页头、背景色、最小/最大宽度和高度填充策略设置。
+ */
+import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
+interface PagePropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 隐藏头
+     * @defaultValue false
+     * @public
+     */
     hideHeader: boolean;
+    /**
+     * 背景
+     * @defaultValue '#fff'
+     * @public
+     */
     background: string;
+    /**
+     * 最小宽度
+     * @defaultValue ''
+     * @public
+     */
     minWidth: number | '';
+    /**
+     * 最大宽度
+     * @defaultValue ''
+     * @public
+     */
+    maxWidth: number | '';
+    /**
+     * 最小高度；取值：auto：自动；fill：填充；
+     * @defaultValue 'auto'
+     * @public
+     */
+    heightConfig: 'auto' | 'fill';
+}
+declare class PageProperty extends LayoutControlProperty implements PagePropertyInterface {
+    /**
+     * 隐藏头
+     * @defaultValue false
+     * @public
+     */
+    hideHeader: boolean;
+    /**
+     * 背景
+     * @defaultValue '#fff'
+     * @public
+     */
+    background: string;
+    /**
+     * 最小宽度
+     * @defaultValue ''
+     * @public
+     */
+    minWidth: number | '';
+    /**
+     * 最大宽度
+     * @defaultValue ''
+     * @public
+     */
     maxWidth: number | '';
     /**
-     * 最小高度
-     * auto指内容多高它多高
-     * fill指最小占一屏幕高
-     * */
+     * 最小高度；取值：auto：自动；fill：填充；
+     * @defaultValue 'auto'
+     * @public
+     */
     heightConfig: 'auto' | 'fill';
     constructor(props?: Partial<PageProperty>);
 }
 export default PageProperty;
+export { PageProperty, PagePropertyInterface };

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

@@ -1,9 +1,60 @@
-import { LayoutControlProperty } from '@byteluck-fe/model-driven-core';
-declare class PositionProperty extends LayoutControlProperty {
+/**
+ * name: rok_position
+ * description: 定位布局项组件。用于在定位容器中按坐标和占比放置内容。支持宽高占比以及顶部、左侧偏移，适合自由布局场景。
+ */
+import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
+interface PositionPropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 宽度占比
+     * @defaultValue 12
+     * @public
+     */
     widthSpan: number;
+    /**
+     * 高度占比
+     * @defaultValue 12
+     * @public
+     */
     heightSpan: number;
+    /**
+     * 左侧偏移
+     * @defaultValue 0
+     * @public
+     */
     left: number;
+    /**
+     * 顶部偏移
+     * @defaultValue 0
+     * @public
+     */
+    top: number;
+}
+declare class PositionProperty extends LayoutControlProperty implements PositionPropertyInterface {
+    /**
+     * 宽度占比
+     * @defaultValue 12
+     * @public
+     */
+    widthSpan: number;
+    /**
+     * 高度占比
+     * @defaultValue 12
+     * @public
+     */
+    heightSpan: number;
+    /**
+     * 左侧偏移
+     * @defaultValue 0
+     * @public
+     */
+    left: number;
+    /**
+     * 顶部偏移
+     * @defaultValue 0
+     * @public
+     */
     top: number;
     constructor(props?: Partial<PositionProperty>);
 }
 export default PositionProperty;
+export { PositionProperty, PositionPropertyInterface };

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

@@ -1,5 +1,12 @@
-import { LayoutControlProperty } from '@byteluck-fe/model-driven-core';
-declare class PositioningContainerProperty extends LayoutControlProperty {
+/**
+ * name: rok_positioning_container
+ * description: 定位容器组件。用于承载自由摆放的定位布局内容。当前继承基础布局属性，适合与定位项配合搭建画布式页面。
+ */
+import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
+interface PositioningContainerPropertyInterface extends LayoutControlPropertyInterface {
+}
+declare class PositioningContainerProperty extends LayoutControlProperty implements PositioningContainerPropertyInterface {
     constructor(props?: Partial<PositioningContainerProperty>);
 }
 export default PositioningContainerProperty;
+export { PositioningContainerProperty, PositioningContainerPropertyInterface };

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

@@ -1,13 +1,78 @@
-import { LayoutControlProperty, Margin, Padding } from '@byteluck-fe/model-driven-core';
-declare class RowControlProperty extends LayoutControlProperty {
+/**
+ * name: rok_row
+ * description: 行布局容器组件。用于按行组织多个控件并进行横向编排。支持预设/自定义布局模式、间距、主侧轴对齐、内外边距和整行占满设置。
+ */
+import { LayoutControlProperty, LayoutControlPropertyInterface, Margin, Padding } from '@byteluck-fe/model-driven-core';
+interface RowPropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 布局模式；取值：select：选择预设布局；custom：自定义布局；
+     * @defaultValue 'select'
+     * @public
+     */
     layoutMode: 'select' | 'custom';
+    /**
+     * 内边距配置
+     * @defaultValue new Padding()
+     * @public
+     */
+    padding: Padding;
+    /**
+     * 外边距配置
+     * @defaultValue new Margin()
+     * @public
+     */
+    margin: Margin;
+    /**
+     * 是否占满整行
+     * @defaultValue false
+     * @public
+     */
+    isFull: boolean;
+}
+declare class RowControlProperty extends LayoutControlProperty implements RowPropertyInterface {
+    /**
+     * 布局模式；取值：select：选择预设布局；custom：自定义布局；
+     * @defaultValue 'select'
+     * @public
+     */
+    layoutMode: 'select' | 'custom';
+    /**
+     * 间距
+     * @defaultValue 0
+     * @public
+     */
     gutter: number;
+    /**
+     * 对齐方式
+     * @defaultValue ''
+     * @public
+     */
     align: string;
+    /**
+     * 主轴对齐方式
+     * @defaultValue ''
+     * @public
+     */
     justify: string;
+    /**
+     * 内边距配置
+     * @defaultValue new Padding()
+     * @public
+     */
     padding: Padding;
+    /**
+     * 外边距配置
+     * @defaultValue new Margin()
+     * @public
+     */
     margin: Margin;
+    /**
+     * 是否占满整行
+     * @defaultValue false
+     * @public
+     */
     isFull: boolean;
     constructor(props?: Partial<RowControlProperty>);
 }
 export default RowControlProperty;
-export { RowControlProperty };
+export { RowControlProperty, RowPropertyInterface };