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

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

@@ -1,3 +1,7 @@
+/**
+ * name: rok_table_layout
+ * description: 表格布局容器组件。用于构建按行列对齐的表单编排场景。支持行列数、标题位置、列宽分配、标题宽度、边框背景、圆角和内外边距等表格式布局能力。
+ */
 import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
 interface PaddingProperty {
     paddingTop: number | string;
@@ -33,20 +37,95 @@ interface BorderRadiusProperty {
     borderBottomLeftRadius: number | string;
 }
 interface TableLayoutPropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 行数
+     * @defaultValue 2
+     * @public
+     */
     rowCount: number;
+    /**
+     * 列数
+     * @defaultValue 2
+     * @public
+     */
     colCount: number;
+    /**
+     * 标题布局；取值：top：上方；left：左侧；
+     * @defaultValue 'left'
+     * @public
+     */
     labelPosition: 'top' | 'left';
+    /**
+     * 列宽分配方式；取值：custom：自定义；average：平均分配；
+     * @defaultValue 'average'
+     * @public
+     */
     colWidthType: 'custom' | 'average';
+    /**
+     * 列宽分配值，使用冒号分隔，例如 '12:12'
+     * @defaultValue '12:12'
+     * @public
+     */
     colWidth: string;
+    /**
+     * 标题宽度
+     * @defaultValue ''
+     * @public
+     */
     labelWidth: string;
+    /**
+     * 标题是否加粗
+     * @defaultValue false
+     * @public
+     */
     isLabelBold: boolean;
+    /**
+     * 内边距配置
+     * @defaultValue { paddingTop: '', paddingRight: '', paddingBottom: '', ... }
+     * @public
+     */
     padding: PaddingProperty;
+    /**
+     * 外边距配置
+     * @defaultValue { marginTop: '', marginRight: '', marginBottom: '', ... }
+     * @public
+     */
     margin: MarginProperty;
+    /**
+     * 边框配置
+     * @defaultValue { borderTop: true, borderBottom: true, borderLeft: true, ... }
+     * @public
+     */
     border: BorderProperty;
+    /**
+     * 背景
+     * @defaultValue { type: 'backgroundColor', backgroundColor: '', backgroundImage: '', ... }
+     * @public
+     */
     background: BackgroundProperty;
+    /**
+     * 圆角配置
+     * @defaultValue { borderTopLeftRadius: '', borderTopRightRadius: '', borderBottomRightRadius: '', ... }
+     * @public
+     */
     borderRadius: BorderRadiusProperty;
+    /**
+     * 标题水平对齐方式；取值：left：左侧；center：居中；right：右侧；justify：两端对齐；
+     * @defaultValue ''
+     * @public
+     */
     align: 'left' | 'center' | 'right' | 'justify' | '';
+    /**
+     * 标题垂直对齐方式；取值：flex-start：起点对齐；center：居中；flex-end：终点对齐；
+     * @defaultValue 'center'
+     * @public
+     */
     verticalAlign: 'flex-start' | 'center' | 'flex-end';
+    /**
+     * 表格内边框
+     * @defaultValue { borderWidth: 1, borderColor: '', borderType: 'solid' }
+     * @public
+     */
     innerBorder: Object;
 }
 declare class TableLayoutControlProperty extends LayoutControlProperty implements TableLayoutPropertyInterface {

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

@@ -1,3 +1,7 @@
+/**
+ * name: rok_table_layout_col
+ * description: 表格布局列组件。用于定义表格布局中单元列的占位与样式。支持列跨度、单元格合并、Flex/块级布局、主侧轴对齐、背景和与标题同宽等能力。
+ */
 import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
 interface BackgroundProperty {
     type: 'backgroundColor' | 'backgroundImage';
@@ -6,15 +10,65 @@ interface BackgroundProperty {
     placementMode: string;
 }
 interface TableLayoutColPropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 占用列数
+     * @defaultValue 24
+     * @public
+     */
     span: number;
+    /**
+     * 偏移量
+     * @defaultValue 0
+     * @public
+     */
     offset: number;
+    /**
+     * 在表格布局中的合并单元格数量
+     * @defaultValue 0
+     * @public
+     */
     tableLayoutColSpan: number;
+    /**
+     * full 占满整行，'' 没有合并单元格，custom 自定义合并格数
+     * @defaultValue ''
+     * @public
+     */
     tableLayoutColSpanType: '' | 'full' | 'custom';
+    /**
+     * 布局方式；取值：flex：弹性；block：块级；
+     * @defaultValue 'flex'
+     * @public
+     */
     layout: 'flex' | 'block';
+    /**
+     * 主轴方向；取值：row：横向；column：纵向；row-reverse：横向反向；column-reverse：纵向反向；
+     * @defaultValue 'column'
+     * @public
+     */
     flexDirection: 'row' | 'column' | 'row-reverse' | 'column-reverse' | '';
+    /**
+     * 侧轴对齐方式；取值：flex-start：起点对齐；flex-end：终点对齐；center：居中；baseline：基线对齐；stretch：拉伸；
+     * @defaultValue 'flex-start'
+     * @public
+     */
     alignItems: 'flex-start' | 'flex-end' | 'center' | 'baseline' | 'stretch' | '';
+    /**
+     * 主轴对齐方式；取值：flex-start：起点对齐；flex-end：终点对齐；center：居中；space-between：两端对齐；space-around：环绕对齐；
+     * @defaultValue 'flex-start'
+     * @public
+     */
     justifyContent: 'flex-start' | 'flex-end' | 'center' | 'space-between' | 'space-around' | '';
+    /**
+     * 背景
+     * @defaultValue { type: 'backgroundColor', backgroundColor: '', backgroundImage: '', ... }
+     * @public
+     */
     background: BackgroundProperty;
+    /**
+     * 设置该列与标题同宽
+     * @defaultValue false
+     * @public
+     */
     isLabelCol: Boolean;
 }
 declare class TableLayoutColControlProperty extends LayoutControlProperty implements TableLayoutColPropertyInterface {

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

@@ -1,6 +1,20 @@
+/**
+ * name: rok_table_layout_row
+ * description: 表格布局行组件。用于在表格布局中组织一行单元内容。支持预设/自定义布局模式和列间距设置。
+ */
 import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
 interface TableLayoutRowPropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 布局模式；取值：select：选择预设布局；custom：自定义布局；
+     * @defaultValue 'select'
+     * @public
+     */
     layoutMode: 'select' | 'custom';
+    /**
+     * 间距
+     * @defaultValue 0
+     * @public
+     */
     gutter: number;
 }
 declare class TableLayoutRowControlProperty extends LayoutControlProperty implements TableLayoutRowPropertyInterface {

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

@@ -1,7 +1,26 @@
+/**
+ * name: rok_table_layout_wrapper
+ * description: 表格布局外层容器组件。用于控制表格布局整体包裹区域的尺寸与边框表现。支持宽度、宽度单位和表单边框线显示设置。
+ */
 import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
 interface TableLayoutWrapperPropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 宽度
+     * @defaultValue ''
+     * @public
+     */
     width: string;
+    /**
+     * wrapper 单位；取值：px：像素；%：%；fill：填充；
+     * @defaultValue 'px'
+     * @public
+     */
     widthCompany: 'px' | '%' | 'fill';
+    /**
+     * 表单控件是否显示边框线
+     * @defaultValue false
+     * @public
+     */
     showFormBorder: boolean;
 }
 declare class TableLayoutWrapperControlProperty extends LayoutControlProperty implements TableLayoutWrapperPropertyInterface {

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

@@ -1,3 +1,7 @@
+/**
+ * name: rok_toolbox
+ * description: 工具箱容器组件。用于承载页面中的辅助工具区、快捷操作区或扩展按钮区域。当前继承基础布局属性，适合作为工具集合承载容器。
+ */
 import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
 interface ToolboxPropertyInterface extends LayoutControlPropertyInterface {
 }

package/dist/types/layoutControls/index.d.ts

@@ -1,27 +1,56 @@
 export { default as Grid } from './Grid';
+export type { GridPropertyInterface } from './Grid';
 export { default as Col } from './Col';
+export type { ColPropertyInterface } from './Col';
 export { default as Row } from './Row';
+export type { RowPropertyInterface } from './Row';
 export { default as GridRow } from './GridRow';
+export type { GridRowPropertyInterface } from './GridRow';
 export { default as CardGroup } from './CardGroup';
+export type { CardGroupPropertyInterface } from './CardGroup';
+export { default as BlankContainer } from './BlankContainer';
+export type { BlankContainerPropertyInterface } from './BlankContainer';
 export { default as SubTableColumn } from './SubTableColumn';
+export type { SubTableColumnPropertyInterface } from './SubTableColumn';
 export { default as SubTableRow } from './SubTableRow';
+export type { SubtableRowPropertyInterface } from './SubTableRow';
 export { default as GridTableColumn } from './GridTableColumn';
+export type { GridTableColumnPropertyInterface } from './GridTableColumn';
 export { default as GridLayoutContainer } from './GridLayoutContainer';
+export type { GridLayoutContainerPropertyInterface } from './GridLayoutContainer';
 export { default as Tab } from './Tab';
+export type { TabPropertyInterface } from './Tab';
 export { default as TabPane } from './TabPane';
+export type { TabPanePropertyInterface } from './TabPane';
 export { default as Toolbox } from './Toolbox';
+export type { ToolboxPropertyInterface } from './Toolbox';
 export { default as ListView } from './ListView';
+export type { ListViewPropertyInterface } from './ListView';
 export { default as DataView } from './DataView';
+export type { DataViewPropertyInterface } from './DataView';
 export { default as Page } from './Page';
+export type { PagePropertyInterface } from './Page';
 export { default as AdvancedContainer } from './AdvancedContainer';
+export type { AdvancedContainerPropertyInterface } from './AdvancedContainer';
 export { default as PositioningContainer } from './PositioningContainer';
+export type { PositioningContainerPropertyInterface } from './PositioningContainer';
 export { default as Position } from './Position';
+export type { PositionPropertyInterface } from './Position';
 export { default as ActionBar } from './ActionBar';
+export type { ActionBarPropertyInterface } from './ActionBar';
 export { default as Step } from './Step';
+export type { StepPropertyInterface } from './Step';
 export { default as StepPane } from './StepPane';
+export type { StepPanePropertyInterface } from './StepPane';
 export { default as TableLayout } from './TableLayout';
+export type { TableLayoutPropertyInterface } from './TableLayout';
 export { default as TableLayoutRow } from './TableLayoutRow';
+export type { TableLayoutRowPropertyInterface } from './TableLayoutRow';
 export { default as TableLayoutCol } from './TableLayoutCol';
+export type { TableLayoutColPropertyInterface } from './TableLayoutCol';
 export { default as TableLayoutWrapper } from './TableLayoutWrapper';
+export type { TableLayoutWrapperPropertyInterface } from './TableLayoutWrapper';
 export { default as Collapse } from './Collapse';
+export type { CollapsePropertyInterface } from './Collapse';
 export { default as CollapsePane } from './CollapsePane';
+export type { CollapsePanePropertyInterface } from './CollapsePane';

package/dist/types/listControls/GridTable/property.d.ts

@@ -1,3 +1,7 @@
+/**
+ * name: rok_grid_table
+ * description: 表格列表组件。用于展示结构化业务数据和批量操作场景。支持冻结表头、单选/多选、工具栏、勾选框以及自定义表头配置。
+ */
 import { DesignerColumnControl, ListControlProperty, ListControlPropertyInterface, RuntimeColumnControl } from '@byteluck-fe/model-driven-core';
 import { ColumnControlsKeys, MODE, Schema } from '@byteluck-fe/model-driven-core';
 import { DesignerGridTableControl } from './designer';
@@ -15,7 +19,8 @@ interface GridTablePropertyInterface<Mode extends MODE | 'Schema', Control exten
      */
     isFixedHeader: boolean;
     /**
-     * 选择类型
+     * 选择类型；取值：multiple：多选；single：单选；
+     * @defaultValue undefined
      * @public
      */
     selectionType: undefined | 'multiple' | 'single';

package/dist/types/listControls/SubTable/property.d.ts

@@ -1,3 +1,7 @@
+/**
+ * name: rok_sub_table
+ * description: 明细子表组件。用于录入和展示一对多明细数据。支持行数限制、弹窗/行内编辑、表单绑定、导入导出、移动端展示、标题提示和最大高度等能力。
+ */
 import { RuleItem } from 'async-validator';
 import { DesignerSubTableControl } from './designer';
 import { ListControlProperty, ListControlPropertyInterface, PropertyRules, PropertyRuntimeRules, DataSourceBind, DataStorageDoc } from '@byteluck-fe/model-driven-core';
@@ -25,186 +29,218 @@ type ControlType<Mode extends MODE | 'Schema'> = Mode extends 'Runtime' ? Runtim
 interface SubTablePropertyInterface<Mode extends MODE | 'Schema', Control extends object = ControlType<Mode>> extends ListControlPropertyInterface<Mode, Control> {
     /**
      * 标题
-     * */
+     * @defaultValue 控件名称
+     * @public
+     */
     caption: string;
     /**
-     * 标题布局
+     * 标题布局；取值：top：上方；left：左侧；
      * @defaultValue 'top'
      * @public
-     * */
+     */
     labelPosition: 'top' | 'left';
     /**
      * 隐藏标题
      * @defaultValue false
      * @public
-     * */
+     */
     isHideCaption: boolean;
     /**
      * 开启气泡提示
      * @defaultValue false
      * @public
-     * */
+     */
     isShowCaptionTip: boolean;
     /**
      * 气泡提示语
      * @defaultValue ''
      * @public
-     * */
+     */
     captionTip: string;
     /**
      * 默认状态 default=普通 readonly=只读
      * @defaultValue 'default'
      * @public
-     * */
+     */
     defaultState: 'default' | 'readonly';
     /**
      * 最小填写行数，并且是默认行数
      * @defaultValue 1
      * @public
-     * */
+     */
     limitRows: number;
     /**
      * 最多填写行数
-     * @defaultValue
+     * @defaultValue null
      * @public
-     * */
+     */
     maxRows: number | null;
     /**
      * 默认填写行数
      * @defaultValue 1
      * @public
-     * */
+     */
     defaultRows: number;
     /**
      * 绑定数据源
+     * @defaultValue new DataSourceBind()
      * @public
-     * */
+     */
     datasourceBind: DataSourceBind;
     /**
      * 打印配置 col=纵向打印|row=横向打印
      * @defaultValue 'row'
      * @public
-     * */
+     */
     printMode: 'col' | 'row';
     /**
-     * 打开方式（查看，编辑，创建）
-     * default列表模式|modal表单模式
+     * 打开方式（查看，编辑，创建）；取值：default：默认；modal：弹窗；dialog：对话框；
      * @defaultValue 'default'
      * @public
-     * */
+     */
     openType: 'default' | 'modal' | 'dialog';
     /**
      * openType=modal表单模式，formKey为绑定的表单
      * @defaultValue ''
      * @public
-     * */
+     */
     formKey: string;
     /**
      * 使用自定义高度
      * @defaultValue false
      * @public
-     * */
+     */
     useCustomHeight: boolean;
     /**
      * 用户自定义最大高度，默认480
      * @defaultValue 480
      * @public
-     * */
+     */
     maxHeight: number;
     /**
      * 可以新增
-     * */
+     * @defaultValue true
+     * @public
+     */
     canAdd: boolean;
     /**
      * 可以删除
-     * */
+     * @defaultValue true
+     * @public
+     */
     canDelete: boolean;
     /**
      * 可以查看
-     * */
+     * @defaultValue false
+     * @public
+     */
     canCheck: boolean;
     /**
      * 可以编辑
-     * */
+     * @defaultValue false
+     * @public
+     */
     canEdit: boolean;
     /**
      * 可以导入
-     * */
+     * @defaultValue false
+     * @public
+     */
     canImport: boolean;
     /**
      * 导入配置
-     * */
+     * @defaultValue new ImportConfig()
+     * @public
+     */
     importConfig: ImportConfig;
     /**
      * 可以导出
-     * */
+     * @defaultValue false
+     * @public
+     */
     canExport: boolean;
     /**
      * 导出配置
-     * */
+     * @defaultValue new ExportConfig()
+     * @public
+     */
     exportConfig: ExportConfig;
     /**
      * 可以清除
-     * */
+     * @defaultValue true
+     * @public
+     */
     canClear: boolean;
     /**
      * 是否展示粘贴按钮
-     * */
+     * @defaultValue false
+     * @public
+     */
     isPaste: boolean;
     /**
      * 移动端展现形式 tile=平铺|list=列表
      * @defaultValue 'list'
      * @public
-     * */
+     */
     mobileShowType: 'tile' | 'list';
     /**
      * 移动端默认展示条数
-     * @defaultValue tile 5 | list 10
+     * @defaultValue 10
      * @public
-     * */
+     */
     mobileDefaultNum: number;
     /**
      * 数据收起简述
-     * @defaultValue
+     * @defaultValue new DataStorageDoc()
      * @public
-     * */
+     */
     dataStorageDoc: DataStorageDoc;
     /**
      * 开启后端分页
-     * */
+     * @defaultValue false
+     * @public
+     */
     serverPagination: boolean;
     /**
      * 固定列 字段
      * @defaultValue []
      * @public
-     * */
+     */
     fixedColumn: string[];
     /**
      * 移动端平铺行展示标题
      * @defaultValue '明细'
      * @public
-     * */
+     */
     mobileRowCaption: string;
     /**
      * 移动端平铺数据流开关
      * @defaultValue false
      * @public
-     * */
+     */
     mobileIsTile: Boolean;
     /**
      * 是否开启数据排序
      * @defaultValue false
      * @public
-     * */
+     */
     sortable: Boolean;
     /**
-     * 排序or筛选字段
-     * */
+     * 排序字段配置；键为字段编码，值为排序方向；取值：asc：升序；desc：降序；
+     * @defaultValue {}
+     * @public
+     */
     sortKey: Record<string, 'asc' | 'desc'>;
+    /**
+     * 是否展示序号
+     * @defaultValue true
+     * @public
+     */
     showTableIndex: Boolean;
     /**
      * 触发编辑方式；single：单击；double：双击；
-     * @defaultValue single
+     * @defaultValue 'single'
+     * @public
      */
     triggerEdit: 'single' | 'double';
 }

package/dist/types/listControls/index.d.ts

@@ -1,2 +1,4 @@
 export { default as SubTable } from './SubTable';
+export type { SubTablePropertyInterface } from './SubTable';
 export { default as GridTable } from './GridTable';
+export type { GridTablePropertyInterface } from './GridTable';

package/dist/types/searchControls/SimpleSearch/property.d.ts

@@ -14,28 +14,30 @@ declare class SimpleSearchControlPropertyRuntimeRules extends PropertyRuntimeRul
 interface SimpleSearchPropertyInterface extends SearchControlPropertyInterface {
     /**
      * 查询按钮
+     * @defaultValue new OperationItem({ content: '查询', isShow: true })
      * @public
      */
     search: OperationItem;
     /**
      * 取消按钮
+     * @defaultValue new OperationItem({ content: '重置', isShow: true })
      * @public
      */
     cancel: OperationItem;
     /**
-     * 查询类型
+     * 查询类型；取值：model：模型查询；inputParams：入参查询；
      * @defaultValue 'model'
      * @public
      */
     searchType: 'model' | 'inputParams';
     /**
-     * 标题布局
+     * 标题布局；取值：top：上方；left：左侧；
      * @defaultValue 'top'
      * @public
      */
     labelPosition: 'top' | 'left';
     /**
-     * 默认状态
+     * 默认展示模式；取值：mini：紧凑模式；full：展开模式；
      * @defaultValue 'mini'
      * @public
      */
@@ -46,6 +48,11 @@ interface SimpleSearchPropertyInterface extends SearchControlPropertyInterface {
      * @public
      */
     isLoading: boolean;
+    /**
+     * 自定义操作项
+     * @defaultValue []
+     * @public
+     */
     custom: OperationItem[];
     /**
      * 筛选条件-查询设置

package/dist/types/searchControls/index.d.ts

@@ -1 +1,2 @@
 export { default as SimpleSearch } from './SimpleSearch';
+export type { SimpleSearchPropertyInterface } from './SimpleSearch';