@byteluck-fe/model-driven-controls 7.0.0-beta.6 → 7.0.0-beta.8

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

@@ -24,8 +24,23 @@ interface ActionBarPropertyInterface extends LayoutControlPropertyInterface {
     align: 'left' | 'middle' | 'right';
 }
 declare class ActionBarControlProperty extends LayoutControlProperty implements ActionBarPropertyInterface {
+    /**
+     * 位置；取值：top：顶部；bottom：底部；top-fixed：固定在顶部；bottom-fixed：固定在底部；
+     * @defaultValue 'bottom'
+     * @public
+     */
     position: 'top' | 'bottom' | 'top-fixed' | 'bottom-fixed';
+    /**
+     * 背景透明
+     * @defaultValue true
+     * @public
+     */
     opacity: boolean;
+    /**
+     * 对齐方式；取值：left：左侧；middle：中间；right：右侧；
+     * @defaultValue 'right'
+     * @public
+     */
     align: 'left' | 'middle' | 'right';
     constructor(props: Partial<ActionBarControlProperty>);
 }

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

@@ -19,7 +19,17 @@ interface AdvancedContainerPropertyInterface extends LayoutControlPropertyInterf
     flexConfig: FlexStyleConfig;
 }
 declare class AdvancedContainerProperty extends LayoutControlProperty implements AdvancedContainerPropertyInterface {
+    /**
+     * 显示类型；取值：block：块级；inline-block：行内块；inline：行内；flex：弹性；inline-flex：行内弹性；grid：网格；inline-grid：行内网格；
+     * @defaultValue 'flex'
+     * @public
+     */
     display: 'block' | 'inline-block' | 'inline' | 'flex' | 'inline-flex' | 'grid' | 'inline-grid';
+    /**
+     * Flex 布局配置
+     * @defaultValue new FlexStyleConfig()
+     * @public
+     */
     flexConfig: FlexStyleConfig;
     constructor(props?: Partial<AdvancedContainerProperty>);
 }

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

@@ -1,7 +1,3 @@
-/**
- * name: rok_blank_container
- * description: 空白容器布局组件。用于作为自由编排内容的占位容器。支持标题字体样式、标题居中方式、背景色和阴影开关设置，适合页面分区与内容承载场景。
- */
 import { RuleItem } from 'async-validator';
 import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
 import { FONT_WEIGHT } from '../../framework';
@@ -66,14 +62,59 @@ interface BlankContainerPropertyInterface extends LayoutControlPropertyInterface
 }
 declare class BlankContainerProperty extends LayoutControlProperty implements BlankContainerPropertyInterface {
     static readonly Rules: typeof BlankContainerPropertyRules;
+    /**
+     * 标题
+     * @defaultValue getLocaleText('CMD.fbd81777541728197')
+     * @public
+     */
     caption: string;
+    /**
+     * 是否隐藏标题
+     * @defaultValue false
+     * @public
+     */
     isHideCaption: boolean;
+    /**
+     * 标题大小
+     * @defaultValue ''
+     * @public
+     */
     captionSize: string;
+    /**
+     * 标题颜色
+     * @defaultValue ''
+     * @public
+     */
     captionColor: string;
+    /**
+     * 标题斜体
+     * @defaultValue false
+     * @public
+     */
     isCaptionItalic: boolean;
+    /**
+     * 标题字重；取值：normal：常规；bold：粗体；lighter：更细；
+     * @defaultValue 'normal'
+     * @public
+     */
     captionFontWeight: FONT_WEIGHT;
+    /**
+     * 标题对齐方式；取值：left：左对齐；center：居中；right：右对齐；
+     * @defaultValue 'left'
+     * @public
+     */
     position: 'left' | 'center' | 'right';
+    /**
+     * 背景色
+     * @defaultValue ''
+     * @public
+     */
     backgroundColor: string;
+    /**
+     * 是否开启阴影
+     * @defaultValue false
+     * @public
+     */
     showShadow: boolean;
     constructor(props?: Partial<BlankContainerProperty>);
 }

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

@@ -71,15 +71,65 @@ interface CardGroupPropertyInterface extends LayoutControlPropertyInterface {
 }
 declare class CardGroupControlProperty extends LayoutControlProperty implements CardGroupPropertyInterface {
     static readonly Rules: typeof CardGroupControlPropertyRules;
+    /**
+     * 标题信息
+     * @defaultValue '分组'
+     * @public
+     */
     caption: string;
+    /**
+     * 隐藏标题
+     * @defaultValue false
+     * @public
+     */
     isHideCaption: boolean;
+    /**
+     * 卡片分组是否支持展开收起；可选项： none 不支持 | open 默认展开 | close 默认关闭
+     * @defaultValue 'none'
+     * @public
+     */
     collapse: 'none' | 'open' | 'close';
+    /**
+     * 展示风格；default：默认；card：卡片；
+     * @defaultValue 'default'
+     * @public
+     */
     type: 'default' | 'card';
+    /**
+     * 描述信息
+     * @defaultValue ''
+     * @public
+     */
     describe: string;
+    /**
+     * 标签位置；left：左对齐；center：居中；right：右对齐；
+     * @defaultValue 'left'
+     * @public
+     */
     position: 'left' | 'center' | 'right';
+    /**
+     * 标签类型；default：默认；warning：警告；success：成功；
+     * @defaultValue 'default'
+     * @public
+     */
     captionType: 'default' | 'warning' | 'success';
+    /**
+     * 边框类型；none：无边框；dotted：虚线；solid：实线
+     * @defaultValue 'none'
+     * @public
+     */
     borderType: 'none' | 'dotted' | 'solid';
+    /**
+     * 分割线；none：无分割线；dotted：虚线；solid：实线
+     * @defaultValue 'solid'
+     * @public
+     */
     divider: 'none' | 'dotted' | 'solid';
+    /**
+     * 显示阴影时机；never：从不显示；always：总是显示；hover：鼠标悬浮时显示;
+     * @defaultValue 'never'
+     * @public
+     */
     triggerShadow: 'never' | 'hover' | 'always';
     constructor(props?: Partial<CardGroupControlProperty>);
 }

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

@@ -24,8 +24,23 @@ interface ColPropertyInterface extends LayoutControlPropertyInterface {
     isNoFull: boolean;
 }
 declare class ColControlProperty extends LayoutControlProperty implements ColPropertyInterface {
+    /**
+     * 占用列数
+     * @defaultValue 24
+     * @public
+     */
     span: number;
+    /**
+     * 偏移量
+     * @defaultValue 0
+     * @public
+     */
     offset: number;
+    /**
+     * 是否不占满容器
+     * @defaultValue false
+     * @public
+     */
     isNoFull: boolean;
     constructor(props?: Partial<ColControlProperty>);
 }

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

@@ -24,8 +24,23 @@ interface CollapsePropertyInterface extends LayoutControlPropertyInterface {
     isShowHighlightBar: boolean;
 }
 declare class CollapseControlProperty extends LayoutControlProperty implements CollapsePropertyInterface {
+    /**
+     * 手风琴模式，始终只有一个面板处在激活状态
+     * @defaultValue false
+     * @public
+     */
     accordion: boolean;
+    /**
+     * 带边框风格的折叠面板
+     * @defaultValue true
+     * @public
+     */
     bordered: boolean;
+    /**
+     * 是否在标题左侧显示高亮条
+     * @defaultValue false
+     * @public
+     */
     isShowHighlightBar: boolean;
     constructor(props?: Partial<CollapseControlProperty>);
 }

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

@@ -12,6 +12,11 @@ interface CollapsePanePropertyInterface extends LayoutControlPropertyInterface {
     header: string;
 }
 declare class CollapsePaneControlProperty extends LayoutControlProperty implements CollapsePanePropertyInterface {
+    /**
+     * 面板头内容
+     * @defaultValue getLocaleText('CMD.08411774579056771')
+     * @public
+     */
     header: string;
     constructor(props?: Partial<CollapsePaneControlProperty>);
 }

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

@@ -55,10 +55,35 @@ declare class DataViewControlProperty extends LayoutControlProperty implements D
      * @internal
      */
     static readonly RuntimeRules: typeof DataViewControlPropertyRuntimeRules;
+    /**
+     * 保存按钮
+     * @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[];
     /**
      * 加载中

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

@@ -18,7 +18,17 @@ interface GridLayoutContainerPropertyInterface extends LayoutControlPropertyInte
     colGap: number;
 }
 declare class GridLayoutContainerControlProperty extends LayoutControlProperty implements GridLayoutContainerPropertyInterface {
+    /**
+     * 子控件宽度最小值
+     * @defaultValue 230
+     * @public
+     */
     childMinWidth: number;
+    /**
+     * 子控件间距
+     * @defaultValue 24
+     * @public
+     */
     colGap: number;
     constructor(props?: Partial<GridLayoutContainerControlProperty>);
 }

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

@@ -79,17 +79,77 @@ interface GridTableColumnPropertyInterface extends LayoutControlPropertyInterfac
     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>);
 }

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

@@ -30,12 +30,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>);
 }