@byteluck-fe/model-driven-controls 7.0.0-props.8 → 7.0.0-props.81

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

@@ -7,10 +7,35 @@ declare class DataViewControlPropertyRuntimeRules extends PropertyRuntimeRules {
  * @public
  */
 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[];
     /**
      * 加载中
@@ -20,6 +45,7 @@ interface DataViewPropertyInterface extends LayoutControlPropertyInterface {
     isLoading: boolean;
     /**
      * 绑定业务模型
+     * @defaultValue new DataSourceBind()
      * @public
      */
     datasourceBind: DataSourceBind;

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

@@ -1,3 +1,7 @@
+/**
+ * name: rok_grid
+ * description: 网格布局容器组件。用于承载网格化排版内容和规则化布局区域。当前继承基础布局属性，适合配合网格行列子组件构建页面结构。
+ */
 import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
 interface GridPropertyInterface extends LayoutControlPropertyInterface {
 }

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

@@ -1,3 +1,7 @@
+/**
+ * name: rok_grid_layout_container
+ * description: 自适应网格容器组件。用于多控件均匀排布和响应式宫格布局场景。支持设置子控件最小宽度与列间距，便于自动换列展示。
+ */
 import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
 interface GridLayoutContainerPropertyInterface extends LayoutControlPropertyInterface {
     /**

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

@@ -1,3 +1,7 @@
+/**
+ * name: rok_grid_row
+ * description: 网格行容器组件。用于在网格布局中组织一行内容。继承行布局能力，适合与列组件配合完成分栏排版。
+ */
 import { RowControlProperty, RowPropertyInterface } from '../Row';
 interface GridRowPropertyInterface extends RowPropertyInterface {
 }

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

@@ -1,17 +1,81 @@
+/**
+ * name: rok_grid_table_column
+ * description: 表格列配置组件。用于定义数据表格中单列的展示与格式化规则。支持列宽、标题、字段绑定、固定列、文本清洗、数值精度和时间/部门展示设置。
+ */
 import { DateType, FieldTypes } from '@byteluck-fe/model-driven-shared';
 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 {

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

@@ -1,10 +1,20 @@
+/**
+ * name: rok_list_view
+ * description: 列表视图组件。用于展示业务数据列表并驱动联动、子表和树形列表场景。支持数据源绑定、分页排序、行样式、关联关系、子列表触发和主从明细展示能力。
+ */
 import { RuleItem } from 'async-validator';
 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
 }
 /**
@@ -29,6 +39,7 @@ declare class ListViewControlPropertyRules extends PropertyRules {
 interface ListViewPropertyInterface extends LayoutControlPropertyInterface {
     /**
      * 数据高级设置
+     * @defaultValue new DataSourceBind()
      * @public
      */
     datasourceBind: DataSourceBind;
@@ -45,31 +56,38 @@ interface ListViewPropertyInterface extends LayoutControlPropertyInterface {
      */
     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';
@@ -86,8 +104,8 @@ interface ListViewPropertyInterface extends LayoutControlPropertyInterface {
      */
     isFixedHeader: boolean;
     /**
-     * 显示选择框类型
-     * @defaultValue  undefined | 'multiple' | 'radio'
+     * 显示选择框类型；取值：multiple：多选；single：单选；
+     * @defaultValue 'multiple'
      * @public
      */
     selectionType: undefined | 'multiple' | 'single';
@@ -104,8 +122,8 @@ interface ListViewPropertyInterface extends LayoutControlPropertyInterface {
      */
     isAllLoaded: boolean;
     /**
-     * 计数模式
-     * @defaultValue 'async'
+     * 计数模式；取值：sync：同步；async：异步；none：无；
+     * @defaultValue undefined
      * @public
      */
     countType?: 'sync' | 'async' | 'none';
@@ -117,19 +135,33 @@ interface ListViewPropertyInterface extends LayoutControlPropertyInterface {
     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;
 }
 declare class ListViewControlProperty extends LayoutControlProperty implements ListViewPropertyInterface {

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

@@ -1,3 +1,7 @@
+/**
+ * name: rok_page
+ * description: 页面容器组件。用于定义整页内容区域的基础展示结构。支持隐藏页头、背景色、最小/最大宽度和高度填充策略设置。
+ */
 import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
 interface PagePropertyInterface extends LayoutControlPropertyInterface {
     /**
@@ -6,14 +10,29 @@ interface PagePropertyInterface extends LayoutControlPropertyInterface {
      * @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';
 }
 declare class PageProperty extends LayoutControlProperty implements PagePropertyInterface {

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

@@ -1,8 +1,32 @@
+/**
+ * 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 {

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

@@ -1,3 +1,7 @@
+/**
+ * name: rok_positioning_container
+ * description: 定位容器组件。用于承载自由摆放的定位布局内容。当前继承基础布局属性，适合与定位项配合搭建画布式页面。
+ */
 import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
 interface PositioningContainerPropertyInterface extends LayoutControlPropertyInterface {
 }

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

@@ -1,11 +1,32 @@
+/**
+ * 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';
-    gutter: number;
-    align: string;
-    justify: string;
+    /**
+     * 内边距配置
+     * @defaultValue new Padding()
+     * @public
+     */
     padding: Padding;
+    /**
+     * 外边距配置
+     * @defaultValue new Margin()
+     * @public
+     */
     margin: Margin;
+    /**
+     * 是否占满整行
+     * @defaultValue false
+     * @public
+     */
     isFull: boolean;
 }
 declare class RowControlProperty extends LayoutControlProperty implements RowPropertyInterface {

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

@@ -1,63 +1,79 @@
+/**
+ * name: rok_step
+ * description: 步骤条容器组件。用于分步骤表单、流程导航和向导式填写场景。支持方向、标签位置、尺寸、导航样式、粘性展示、步骤状态以及前后切换按钮配置。
+ */
 import { LayoutControlProperty, LayoutControlPropertyInterface, StepButtons } from '@byteluck-fe/model-driven-core';
 interface StepPropertyInterface extends LayoutControlPropertyInterface {
     /**
      * 步骤条方向；horizontal：水平方向；vertical：垂直方向
-     * @defaultValue horizontal
+     * @defaultValue 'horizontal'
+     * @public
      */
     direction: 'horizontal' | 'vertical';
     /**
      * 标签放置位置；horizontal：水平方向；vertical：竖直方向
-     * @defaultValue horizontal
+     * @defaultValue 'horizontal'
+     * @public
      */
     labelPlacement: 'horizontal' | 'vertical';
     /**
-     * 大小；small：迷你； default：普通；
-     * @defaultValue default
+     * 大小；取值：small：小尺寸；default：默认尺寸；large：大尺寸；
+     * @defaultValue 'default'
+     * @public
      */
     size: 'small' | 'default' | 'large';
     /**
      * 步骤条类型；default：默认； navigation：导航
-     * @defaultValue default
+     * @defaultValue 'default'
+     * @public
      */
     type: 'default' | 'navigation';
     /**
      * 是否粘性
      * @defaultValue false
+     * @public
      */
     isSticky: boolean;
     /**
      * 步骤条间距，可输入%或px
-     * @defaultValue
+     * @defaultValue ''
+     * @public
      */
     step: string;
     /**
      * 是否居中对齐
      * @defaultValue false
+     * @public
      */
     isCenter: boolean;
     /**
      * 是否允许结束步骤点击
      * @defaultValue false
+     * @public
      */
     isStopStepClick: boolean;
     /**
      * 当前步骤的状态，wait：等待； process：进行中； finish：完成； error：错误；
-     * @defaultValue process
+     * @defaultValue 'process'
+     * @public
      */
     status: 'wait' | 'process' | 'finish' | 'error';
     /**
      * 结束步骤的状态，wait：等待； process：进行中； finish：完成； error：错误；
-     * @defaultValue finish
+     * @defaultValue 'finish'
+     * @public
      */
     stopStatus: 'wait' | 'process' | 'finish' | 'error';
     /**
      * 是否显示步骤条按钮
      * @defaultValue false
+     * @public
      */
     isShowStepButton: boolean;
     /**
      * 步骤条按钮配置
-     * @defaultValue {prev: {icon: 'iconleft', label: '上一步'}, next: {icon: 'iconxiangyou', label: '下一步'}, }
+     * @defaultValue new StepButtons()
+     * @public
      */
     stepButtons: StepButtons;
 }

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

@@ -1,35 +1,56 @@
+/**
+ * name: rok_step_pane
+ * description: 步骤项组件。用于定义步骤条中的单个步骤内容与状态。支持标题、副标题、图标、颜色、状态、描述、禁用和默认选中设置。
+ */
 import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
 interface StepPanePropertyInterface extends LayoutControlPropertyInterface {
     /**
      * 主标题
+     * @defaultValue ''
+     * @public
      */
     title: string;
     /**
      * 副标题
+     * @defaultValue ''
+     * @public
      */
     subTitle?: string;
     /**
      * 是否禁用点击
      * @defaultValue false
+     * @public
      */
     disabled: boolean;
     /**
      * 步骤图标
+     * @defaultValue ''
+     * @public
      */
     icon: string;
     /**
-     * 步骤激活颜色
+     * 步骤激活颜色；取值：primary：主色；danger：危险；warning：警告；success：成功；info：信息；blue：蓝色；
+     * @defaultValue ''
+     * @public
      */
     color: string;
     /**
-     * 步骤状态；wait：等待； process：进行中； finish：完成； error：错误；
-     * @defaultValue wait
+     * 步骤状态；取值：wait：等待；process：进行中；finish：完成；error：错误；
+     * @defaultValue 'wait'
+     * @public
      */
     status: 'wait' | 'process' | 'finish' | 'error';
     /**
      * 步骤描述
+     * @defaultValue ''
+     * @public
      */
     description?: string;
+    /**
+     * 是否默认选中
+     * @defaultValue false
+     * @public
+     */
     isDefault?: boolean;
 }
 declare class StepPaneControlProperty extends LayoutControlProperty implements StepPanePropertyInterface {

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

@@ -1,3 +1,7 @@
+/**
+ * name: rok_sub_table_column
+ * description: 子表列配置组件。用于定义明细子表中每列的标题与展示行为。支持列宽配置、固定列、标题提示和标题显隐控制。
+ */
 import { RuleItem } from 'async-validator';
 import { LayoutControlProperty, LayoutControlPropertyInterface, PropertyRules, MetaAutoWidth } from '@byteluck-fe/model-driven-core';
 declare class SubTableColumnControlPropertyRules extends PropertyRules {
@@ -9,28 +13,39 @@ declare class SubTableColumnControlPropertyRules extends PropertyRules {
 interface SubTableColumnPropertyInterface extends LayoutControlPropertyInterface {
     /**
      * 设置宽度在移动和pc - 宽度
-     * pc 电脑端   mobile -手机端
-     * */
+     * @defaultValue new MetaAutoWidth()
+     * @public
+     */
     metaAutoWidth: MetaAutoWidth;
     /**
      * 列标题
-     * */
+     * @defaultValue ''
+     * @public
+     */
     caption: string;
     /**
      * 是否固定列
-     * */
+     * @defaultValue false
+     * @public
+     */
     fixed: boolean;
     /**
      * 是否开启气泡提示
-     * */
+     * @defaultValue false
+     * @public
+     */
     isShowCaptionTip: boolean;
     /**
      * 气泡提示语
-     * */
+     * @defaultValue ''
+     * @public
+     */
     captionTip: string;
     /**
      * 隐藏标题一直为false
-     * */
+     * @defaultValue false
+     * @public
+     */
     isHideCaption: boolean;
 }
 declare class SubTableColumnControlProperty extends LayoutControlProperty implements SubTableColumnPropertyInterface {

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

@@ -1,3 +1,7 @@
+/**
+ * name: rok_sub_table_row
+ * description: 子表行容器组件。用于组织明细子表中的单行布局内容。当前继承基础布局属性，适合与子表列共同构建明细结构。
+ */
 import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
 interface SubtableRowPropertyInterface extends LayoutControlPropertyInterface {
 }

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

@@ -1,28 +1,37 @@
+/**
+ * name: rok_tab
+ * description: 选项卡容器组件。用于将内容分为多个页签按需切换展示。支持移动端展示方式、线条/卡片风格、页签位置、标签撑开和内容延迟渲染。
+ */
 import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
 interface TabPropertyInterface extends LayoutControlPropertyInterface {
     /**
-     * 移动端展示样式
-     * @defaultValue vertical
+     * 移动端展示样式；取值：horizontal：横向；vertical：纵向；
+     * @defaultValue 'vertical'
+     * @public
      */
     mobileShowType: 'horizontal' | 'vertical';
     /**
      * 风格类型，line：默认样式；card：选项卡样式；
-     * @defaultValue line
+     * @defaultValue 'line'
+     * @public
      */
     type: 'line' | 'card';
     /**
      * 页签位置，top：页签在上；bottom：页签在下；left：页签在左侧；right：页签在右侧；
-     * @defaultValue top
+     * @defaultValue 'top'
+     * @public
      */
     tabPosition: 'top' | 'bottom' | 'left' | 'right';
     /**
      * 页签宽度是否自动撑开
      * @defaultValue false
+     * @public
      */
     isLabelFlat: boolean;
     /**
      * 内容是否延迟渲染
      * @defaultValue false
+     * @public
      */
     isDelay: boolean;
 }

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

@@ -1,3 +1,7 @@
+/**
+ * name: rok_tab_pane
+ * description: 选项卡子页签组件。用于承载单个页签对应的内容区域。支持配置页签标题，适合与选项卡容器组合实现分组切换展示。
+ */
 import { LayoutControlProperty, LayoutControlPropertyInterface, PropertyRules } from '@byteluck-fe/model-driven-core';
 import { RuleItem } from 'async-validator';
 declare class TabPaneControlPropertyRules extends PropertyRules {
@@ -5,6 +9,11 @@ declare class TabPaneControlPropertyRules extends PropertyRules {
     constructor(props: TabPaneControlProperty);
 }
 interface TabPanePropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 标题
+     * @defaultValue 控件名称
+     * @public
+     */
     caption: string;
 }
 declare class TabPaneControlProperty extends LayoutControlProperty implements TabPanePropertyInterface {