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

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

@@ -167,26 +167,131 @@ interface ListViewPropertyInterface extends LayoutControlPropertyInterface {
 declare class ListViewControlProperty extends LayoutControlProperty implements ListViewPropertyInterface {
     static readonly Rules: typeof ListViewControlPropertyRules;
     static readonly RuntimeRules: typeof ListViewControlPropertyRuntimeRules;
+    /**
+     * 数据高级设置
+     * @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;
     constructor(props?: Partial<ListViewControlProperty>);
 }

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

@@ -36,10 +36,35 @@ interface PagePropertyInterface extends LayoutControlPropertyInterface {
     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：填充；
+     * @defaultValue 'auto'
+     * @public
+     */
     heightConfig: 'auto' | 'fill';
     constructor(props?: Partial<PageProperty>);
 }

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

@@ -30,9 +30,29 @@ interface PositionPropertyInterface extends LayoutControlPropertyInterface {
     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>);
 }

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

@@ -10,6 +10,24 @@ interface RowPropertyInterface extends LayoutControlPropertyInterface {
      * @public
      */
     layoutMode: 'select' | 'custom';
+    /**
+     * 栅格间隔
+     * @defaultValue 0
+     * @public
+     */
+    gutter: number;
+    /**
+     * 交叉轴对齐
+     * @defaultValue ''
+     * @public
+     */
+    align: string;
+    /**
+     * 主轴对齐
+     * @defaultValue ''
+     * @public
+     */
+    justify: string;
     /**
      * 内边距配置
      * @defaultValue new Padding()
@@ -30,12 +48,47 @@ interface RowPropertyInterface extends LayoutControlPropertyInterface {
     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>);
 }

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

@@ -78,17 +78,77 @@ interface StepPropertyInterface extends LayoutControlPropertyInterface {
     stepButtons: StepButtons;
 }
 declare class StepControlProperty extends LayoutControlProperty implements StepPropertyInterface {
+    /**
+     * 步骤条方向；horizontal：水平方向；vertical：垂直方向
+     * @defaultValue 'horizontal'
+     * @public
+     */
     direction: 'horizontal' | 'vertical';
+    /**
+     * 标签放置位置；horizontal：水平方向；vertical：竖直方向
+     * @defaultValue 'horizontal'
+     * @public
+     */
     labelPlacement: 'horizontal' | 'vertical';
+    /**
+     * 大小；取值：small：小尺寸；default：默认尺寸；large：大尺寸；
+     * @defaultValue 'default'
+     * @public
+     */
     size: 'small' | 'default' | 'large';
+    /**
+     * 步骤条类型；default：默认； navigation：导航
+     * @defaultValue 'default'
+     * @public
+     */
     type: 'default' | 'navigation';
+    /**
+     * 是否粘性
+     * @defaultValue false
+     * @public
+     */
     isSticky: boolean;
+    /**
+     * 步骤条间距，可输入%或px
+     * @defaultValue ''
+     * @public
+     */
     step: string;
+    /**
+     * 是否居中对齐
+     * @defaultValue false
+     * @public
+     */
     isCenter: boolean;
+    /**
+     * 是否允许结束步骤点击
+     * @defaultValue false
+     * @public
+     */
     isStopStepClick: boolean;
+    /**
+     * 当前步骤的状态，wait：等待； process：进行中； finish：完成； error：错误；
+     * @defaultValue 'process'
+     * @public
+     */
     status: 'wait' | 'process' | 'finish' | 'error';
+    /**
+     * 结束步骤的状态，wait：等待； process：进行中； finish：完成； error：错误；
+     * @defaultValue 'finish'
+     * @public
+     */
     stopStatus: 'wait' | 'process' | 'finish' | 'error';
+    /**
+     * 是否显示步骤条按钮
+     * @defaultValue false
+     * @public
+     */
     isShowStepButton: boolean;
+    /**
+     * 步骤条按钮配置
+     * @defaultValue new StepButtons()
+     * @public
+     */
     stepButtons: StepButtons;
     constructor(props?: Partial<StepControlProperty>);
 }

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

@@ -54,13 +54,53 @@ interface StepPanePropertyInterface extends LayoutControlPropertyInterface {
     isDefault?: boolean;
 }
 declare class StepPaneControlProperty extends LayoutControlProperty implements StepPanePropertyInterface {
+    /**
+     * 主标题
+     * @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'
+     * @public
+     */
     status: 'wait' | 'process' | 'finish' | 'error';
+    /**
+     * 步骤描述
+     * @defaultValue ''
+     * @public
+     */
     description?: string;
+    /**
+     * 是否默认选中
+     * @defaultValue false
+     * @public
+     */
     isDefault?: boolean;
     constructor(props?: Partial<StepPaneControlProperty>);
 }

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

@@ -50,11 +50,41 @@ interface SubTableColumnPropertyInterface extends LayoutControlPropertyInterface
 }
 declare class SubTableColumnControlProperty extends LayoutControlProperty implements SubTableColumnPropertyInterface {
     static readonly Rules: typeof SubTableColumnControlPropertyRules;
+    /**
+     * 设置宽度在移动和pc - 宽度
+     * @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;
     constructor(props?: Partial<SubTableColumnControlProperty>);
 }

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

@@ -36,10 +36,35 @@ interface TabPropertyInterface extends LayoutControlPropertyInterface {
     isDelay: boolean;
 }
 declare class TabControlProperty extends LayoutControlProperty implements TabPropertyInterface {
+    /**
+     * 移动端展示样式；取值：horizontal：横向；vertical：纵向；
+     * @defaultValue 'vertical'
+     * @public
+     */
     mobileShowType: 'horizontal' | 'vertical';
+    /**
+     * 风格类型，line：默认样式；card：选项卡样式；
+     * @defaultValue 'line'
+     * @public
+     */
     type: 'line' | 'card';
+    /**
+     * 页签位置，top：页签在上；bottom：页签在下；left：页签在左侧；right：页签在右侧；
+     * @defaultValue 'top'
+     * @public
+     */
     tabPosition: 'top' | 'bottom' | 'left' | 'right';
+    /**
+     * 页签宽度是否自动撑开
+     * @defaultValue false
+     * @public
+     */
     isLabelFlat: boolean;
+    /**
+     * 内容是否延迟渲染
+     * @defaultValue false
+     * @public
+     */
     isDelay: boolean;
     constructor(props?: Partial<TabControlProperty>);
 }

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

@@ -18,6 +18,11 @@ interface TabPanePropertyInterface extends LayoutControlPropertyInterface {
 }
 declare class TabPaneControlProperty extends LayoutControlProperty implements TabPanePropertyInterface {
     static readonly Rules: typeof TabPaneControlPropertyRules;
+    /**
+     * 标题
+     * @defaultValue 控件名称
+     * @public
+     */
     caption: string;
     constructor(props?: Partial<TabPaneControlProperty>);
 }

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

@@ -36,6 +36,11 @@ interface BorderRadiusProperty {
     borderBottomRightRadius: number | string;
     borderBottomLeftRadius: number | string;
 }
+interface InnerBorderProperty {
+    borderWidth: number;
+    borderColor: string;
+    borderType: 'solid' | 'dashed' | 'dotted' | '';
+}
 interface TableLayoutPropertyInterface extends LayoutControlPropertyInterface {
     /**
      * 行数
@@ -126,24 +131,99 @@ interface TableLayoutPropertyInterface extends LayoutControlPropertyInterface {
      * @defaultValue { borderWidth: 1, borderColor: '', borderType: 'solid' }
      * @public
      */
-    innerBorder: Object;
+    innerBorder: InnerBorderProperty;
 }
 declare class TableLayoutControlProperty extends LayoutControlProperty implements TableLayoutPropertyInterface {
+    /**
+     * 行数
+     * @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';
-    innerBorder: Object;
+    /**
+     * 表格内边框
+     * @defaultValue { borderWidth: 1, borderColor: '', borderType: 'solid' }
+     * @public
+     */
+    innerBorder: InnerBorderProperty;
     constructor(props?: Partial<TableLayoutControlProperty>);
 }
 export default TableLayoutControlProperty;

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

@@ -72,15 +72,65 @@ interface TableLayoutColPropertyInterface extends LayoutControlPropertyInterface
     isLabelCol: Boolean;
 }
 declare class TableLayoutColControlProperty extends LayoutControlProperty implements TableLayoutColPropertyInterface {
+    /**
+     * 占用列数
+     * @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;
     constructor(props?: Partial<TableLayoutColControlProperty>);
 }

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

@@ -18,7 +18,17 @@ interface TableLayoutRowPropertyInterface extends LayoutControlPropertyInterface
     gutter: number;
 }
 declare class TableLayoutRowControlProperty extends LayoutControlProperty implements TableLayoutRowPropertyInterface {
+    /**
+     * 布局模式；取值：select：选择预设布局；custom：自定义布局；
+     * @defaultValue 'select'
+     * @public
+     */
     layoutMode: 'select' | 'custom';
+    /**
+     * 间距
+     * @defaultValue 0
+     * @public
+     */
     gutter: number;
     constructor(props?: Partial<TableLayoutRowControlProperty>);
 }