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

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

@@ -1,4 +1,8 @@
-import { LayoutControlProperty } from '@byteluck-fe/model-driven-core';
+/**
+ * name: rok_table_layout
+ * description: 表格布局容器组件。用于构建按行列对齐的表单编排场景。支持行列数、标题位置、列宽分配、标题宽度、边框背景、圆角和内外边距等表格式布局能力。
+ */
+import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
 interface PaddingProperty {
     paddingTop: number | string;
     paddingRight: number | string;
@@ -32,13 +36,106 @@ interface BorderRadiusProperty {
     borderBottomRightRadius: number | string;
     borderBottomLeftRadius: number | string;
 }
-declare class TableLayoutControlProperty extends LayoutControlProperty {
+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 {
+    rowCount: number;
+    colCount: number;
+    labelPosition: 'top' | 'left';
+    colWidthType: 'custom' | 'average';
+    colWidth: string;
+    labelWidth: string;
+    isLabelBold: boolean;
     padding: PaddingProperty;
     margin: MarginProperty;
     border: BorderProperty;
@@ -50,4 +147,4 @@ declare class TableLayoutControlProperty extends LayoutControlProperty {
     constructor(props?: Partial<TableLayoutControlProperty>);
 }
 export default TableLayoutControlProperty;
-export { TableLayoutControlProperty };
+export { TableLayoutControlProperty, TableLayoutPropertyInterface };

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

@@ -1,22 +1,88 @@
-import { LayoutControlProperty } from '@byteluck-fe/model-driven-core';
+/**
+ * name: rok_table_layout_col
+ * description: 表格布局列组件。用于定义表格布局中单元列的占位与样式。支持列跨度、单元格合并、Flex/块级布局、主侧轴对齐、背景和与标题同宽等能力。
+ */
+import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
 interface BackgroundProperty {
     type: 'backgroundColor' | 'backgroundImage';
     backgroundColor: string;
     backgroundImage: string;
     placementMode: string;
 }
-declare class TableLayoutColControlProperty extends LayoutControlProperty {
+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';
-    flexDirection: 'row' | 'column' | 'row-reverse' | 'column-reverse';
+    /**
+     * 主轴方向；取值：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 {
+    span: number;
+    offset: number;
+    tableLayoutColSpan: number;
+    tableLayoutColSpanType: '' | 'full' | 'custom';
+    layout: 'flex' | 'block';
+    flexDirection: 'row' | 'column' | 'row-reverse' | 'column-reverse' | '';
     alignItems: 'flex-start' | 'flex-end' | 'center' | 'baseline' | 'stretch';
-    justifyContent: 'flex-start' | 'flex-end' | 'center' | 'space-between' | 'space-around';
+    justifyContent: 'flex-start' | 'flex-end' | 'center' | 'space-between' | 'space-around' | '';
     background: BackgroundProperty;
     isLabelCol: Boolean;
     constructor(props?: Partial<TableLayoutColControlProperty>);
 }
 export default TableLayoutColControlProperty;
-export { TableLayoutColControlProperty };
+export { TableLayoutColControlProperty, TableLayoutColPropertyInterface };

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

@@ -1,8 +1,26 @@
-import { LayoutControlProperty } from '@byteluck-fe/model-driven-core';
-declare class TableLayoutRowControlProperty extends LayoutControlProperty {
+/**
+ * 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 {
     layoutMode: 'select' | 'custom';
     gutter: number;
     constructor(props?: Partial<TableLayoutRowControlProperty>);
 }
 export default TableLayoutRowControlProperty;
-export { TableLayoutRowControlProperty };
+export { TableLayoutRowControlProperty, TableLayoutRowPropertyInterface };

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

@@ -1,9 +1,33 @@
-import { LayoutControlProperty } from '@byteluck-fe/model-driven-core';
-declare class TableLayoutWrapperControlProperty extends LayoutControlProperty {
+/**
+ * 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 {
     width: string;
     widthCompany: 'px' | '%' | 'fill';
     showFormBorder: boolean;
     constructor(props?: Partial<TableLayoutWrapperControlProperty>);
 }
 export default TableLayoutWrapperControlProperty;
-export { TableLayoutWrapperControlProperty };
+export { TableLayoutWrapperControlProperty, TableLayoutWrapperPropertyInterface };

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

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

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,12 +1,49 @@
-import { DesignerColumnControl, ListControlProperty, RuntimeColumnControl } from '@byteluck-fe/model-driven-core';
+/**
+ * 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';
 import { RuntimeGridTableControl } from './runtime';
+type ControlType<Mode extends MODE | 'Schema'> = Mode extends 'Runtime' ? RuntimeColumnControl : Mode extends 'Designer' ? DesignerColumnControl : Schema<ColumnControlsKeys>;
 /**
  * GridTable 表格组件
  * @public
  */
-declare class GridTableControlProperty<Mode extends MODE | 'Schema', Control extends object = Mode extends 'Runtime' ? RuntimeColumnControl : Mode extends 'Designer' ? DesignerColumnControl : Schema<ColumnControlsKeys>> extends ListControlProperty<Mode, Control> {
+interface GridTablePropertyInterface<Mode extends MODE | 'Schema', Control extends object = ControlType<Mode>> extends ListControlPropertyInterface<Mode, Control> {
+    /**
+     * 冻结表头
+     * @defaultValue false
+     * @public
+     */
+    isFixedHeader: boolean;
+    /**
+     * 选择类型；取值：multiple：多选；single：单选；
+     * @defaultValue undefined
+     * @public
+     */
+    selectionType: undefined | 'multiple' | 'single';
+    /**
+     * 显示工具栏
+     * @defaultValue true
+     * @public
+     */
+    isShowToolbar: boolean;
+    /**
+     * 显示选择框
+     * @defaultValue false
+     * @public
+     */
+    isShowSelection: boolean;
+    /**
+     * 显示自定义表头
+     * @defaultValue true
+     * @public
+     */
+    isShowCustomColumns: boolean;
+}
+declare class GridTableControlProperty<Mode extends MODE | 'Schema', Control extends object = ControlType<Mode>> extends ListControlProperty<Mode, Control> implements GridTablePropertyInterface<Mode, Control> {
     /**
      * 冻结表头
      * @defaultValue false
@@ -42,4 +79,4 @@ declare class GridTableControlProperty<Mode extends MODE | 'Schema', Control ext
     }>);
 }
 export default GridTableControlProperty;
-export { GridTableControlProperty };
+export { GridTableControlProperty, GridTablePropertyInterface };