@byteluck-fe/model-driven-controls 2.3.0 → 2.3.1-beta.13

package/dist/types/api-doc-index.d.ts

@@ -0,0 +1,88 @@
+export { default as Text } from './baseControls/Text/property';
+export { default as Link } from './baseControls/Link/property';
+export { default as Button } from './baseControls/Button/property';
+export { default as Divider } from './baseControls/Divider/property';
+export { default as Title } from './baseControls/Title/property';
+export { default as CreateFormListButton } from './baseControls/CreateFormListButton/property';
+export { default as BatchSubmissionListButton } from './baseControls/BatchSubmissionListButton/property';
+export { default as SubmissionRecordListButton } from './baseControls/SubmissionRecordListButton/property';
+export { default as ExportListButton } from './baseControls/ExportListButton/property';
+export { default as ExportRecordListButton } from './baseControls/ExportRecordListButton/property';
+export { default as ImportRecordListButton } from './baseControls/ImportRecordListButton/property';
+export { default as FormSelectButton } from './baseControls/FormSelectButton/property';
+export { default as ListSelectButton } from './baseControls/ListSelectButton/property';
+export { default as Pagination } from './baseControls/Pagination/property';
+export { default as Dashboard } from './baseControls/Dashboard/property';
+export { default as ListViewSelect } from './baseControls/ListViewSelect/property';
+export { default as TextOcrButton } from './baseControls/TextOcrButton/property';
+export { default as InvoiceCheckButton } from './baseControls/InvoiceCheckButton/property';
+export { default as BatchPrintListButton } from './baseControls/BatchPrintListButton/property';
+export { default as BatchPrintRecordListButton } from './baseControls/BatchPrintRecordListButton/property';
+export { default as OperationButton } from './baseControls/OperationButton/property';
+export { default as BatchDeleteButton } from './baseControls/BatchDeleteButton/property';
+export { default as VarcharColumn } from './columnControls/VarcharColumn/property';
+export { default as TextColumn } from './columnControls/TextColumn/property';
+export { default as DecimalColumn } from './columnControls/DecimalColumn/property';
+export { default as TimescopeColumn } from './columnControls/TimescopeColumn/property';
+export { default as TimestampColumn } from './columnControls/TimestampColumn/property';
+export { default as ArrayColumn } from './columnControls/ArrayColumn/property';
+export { default as DepartmentColumn } from './columnControls/DepartmentColumn/property';
+export { default as AutoNumberColumn } from './columnControls/AutoNumberColumn/property';
+export { default as FileColumn } from './columnControls/FileColumn/property';
+export { default as ImageColumn } from './columnControls/ImageColumn/property';
+export { default as PeopleColumn } from './columnControls/PeopleColumn/property';
+export { default as LocationColumn } from './columnControls/LocationColumn/property';
+export { default as CustomColumn } from './columnControls/CustomColumn/property';
+export { default as OrderColumn } from './columnControls/OrderColumn/property';
+export { default as OperationColumn } from './columnControls/OperationColumn/property';
+export { default as EmployeeColumn } from './columnControls/EmployeeColumn/property';
+export { default as Input } from './formControls/Input/property';
+export { default as Checkbox } from './formControls/Checkbox/property';
+export { default as Radio } from './formControls/Radio/property';
+export { default as Number } from './formControls/Number/property';
+export { default as DatePicker } from './formControls/DatePicker/property';
+export { default as DateRange } from './formControls/DateRange/property';
+export { default as Textarea } from './formControls/Textarea/property';
+export { default as RichText } from './formControls/RichText/property';
+export { default as Select } from './formControls/Select/property';
+export { default as SelectMultiple } from './formControls/SelectMultiple/property';
+export { default as Employee } from './formControls/Employee/property';
+export { default as Image } from './formControls/Image/property';
+export { default as Attachment } from './formControls/Attachment/property';
+export { default as Amount } from './formControls/Amount/property';
+export { default as Score } from './formControls/Score/property';
+export { default as Address } from './formControls/Address/property';
+export { default as Department } from './formControls/Department/property';
+export { default as AutoNumber } from './formControls/AutoNumber/property';
+export { default as Calc } from './formControls/Calc/property';
+export { default as SearchNumberRange } from './formControls/SearchNumberRange/property';
+export { default as SearchDateRange } from './formControls/SearchDateRange/property';
+export { default as VueFormItem } from './formControls/VueFormItem/property';
+export { default as SelectRelation } from './formControls/SelectRelation/property';
+export { default as SearchInput } from './formControls/SearchInput/property';
+export { default as Tree } from './formControls/Tree/property';
+export { default as Employee2 } from './formControls/Employee2/property';
+export { default as ElectronicSignature } from './formControls/ElectronicSignature/property';
+export { default as WPS } from './formControls/WPS/property';
+export { default as Department2 } from './formControls/Department2/property';
+export { default as Grid } from './layoutControls/Grid/property';
+export { default as Col } from './layoutControls/Col/property';
+export { default as Row } from './layoutControls/Row/property';
+export { default as GridRow } from './layoutControls/GridRow/property';
+export { default as CardGroup } from './layoutControls/CardGroup/property';
+export { default as SubTableColumn } from './layoutControls/SubTableColumn/property';
+export { default as SubTableRow } from './layoutControls/SubTableRow/property';
+export { default as GridTableColumn } from './layoutControls/GridTableColumn/property';
+export { default as Tab } from './layoutControls/Tab/property';
+export { default as TabPane } from './layoutControls/TabPane/property';
+export { default as Toolbox } from './layoutControls/Toolbox/property';
+export { default as ListView } from './layoutControls/ListView/property';
+export { default as DataView } from './layoutControls/DataView/property';
+export { default as Page } from './layoutControls/Page/property';
+export { default as AdvancedContainer } from './layoutControls/AdvancedContainer/property';
+export { default as PositioningContainer } from './layoutControls/PositioningContainer/property';
+export { default as Position } from './layoutControls/Position/property';
+export { default as SubTable } from './listControls/SubTable/property';
+export { default as GridTable } from './listControls/GridTable/property';
+export { default as SimpleSearch } from './searchControls/SimpleSearch/property';
+export * from './framework';

package/dist/types/baseControls/ListSelectButton/property.d.ts

@@ -7,10 +7,26 @@ declare class ListSelectButtonPropertyRules extends PropertyRules {
     fillBack: RuleItem;
     constructor(props: ListSelectButtonProperty);
 }
+/**
+ * ListSelectButton 列表选择
+ * @public
+ */
 declare class ListSelectButtonProperty extends ButtonProperty {
     static readonly Rules: typeof ListSelectButtonPropertyRules;
+    /**
+     * 数据过滤
+     * @public
+     */
     fillPayload: FillPayloadBind;
+    /**
+     * 绑定列表页
+     * @public
+     */
     listPageBind: ListBind;
+    /**
+     * 回填配置
+     * @public
+     */
     fillBack: FillBackBind;
     constructor(props?: Partial<ListSelectButtonProperty>);
 }

package/dist/types/columnControls/ArrayColumn/property.d.ts

@@ -1,15 +1,36 @@
 import { ColumnControlProperty, ColumnOptionAndDataSourcePropertyRules, DataSourceBind, OptionSetting } from '@byteluck-fe/model-driven-core';
+/**
+ * ArrayColumn 数组列
+ * @public
+ */
 declare class ArrayColumnControlPropertyRules extends ColumnOptionAndDataSourcePropertyRules {
     constructor(props: ArrayColumnControlProperty);
 }
+/**
+ * ArrayColumn 数组类型列
+ * @public
+ */
 declare class ArrayColumnControlProperty extends ColumnControlProperty {
+    /**
+     * @internal
+     */
     static readonly Rules: typeof ArrayColumnControlPropertyRules;
     /**
      * 选项配置
-     * none无 custom自定义 datasource数据源
+     * @defaultValue 'none'
+     * @public
      * */
     optionConfig: 'none' | 'custom' | 'datasource';
+    /**
+     * 关联数据源
+     * @public
+     */
     datasourceBind: DataSourceBind;
+    /**
+     * 自定义选项
+     * @defaultValue []
+     * @public
+     */
     options: OptionSetting[];
     constructor(props?: Partial<ArrayColumnControlProperty>);
 }

package/dist/types/columnControls/AutoNumberColumn/property.d.ts

@@ -1,4 +1,8 @@
 import { ColumnControlProperty } from '@byteluck-fe/model-driven-core';
+/**
+ * AutoNumberColumn 自动编号类型列
+ * @public
+ */
 declare class AutoNumberColumnControlProperty extends ColumnControlProperty {
     constructor(props?: Partial<AutoNumberColumnControlProperty>);
 }

package/dist/types/columnControls/CustomColumn/property.d.ts

@@ -1,4 +1,8 @@
 import { ColumnControlProperty } from '@byteluck-fe/model-driven-core';
+/**
+ * CustomColumn 自定义列
+ * @public
+ */
 declare class CustomColumnControlProperty extends ColumnControlProperty {
     fieldCodeList: string[];
     constructor(props?: Partial<CustomColumnControlProperty>);

package/dist/types/columnControls/DecimalColumn/property.d.ts

@@ -1,22 +1,42 @@
 import { ColumnControlProperty, DataSourceBind, OptionSetting } from '@byteluck-fe/model-driven-core';
+/**
+ * DecimalColumn 数字列
+ * @public
+ */
 declare class DecimalColumnControlProperty extends ColumnControlProperty {
     /**
      * 选项配置
-     * none无 custom自定义 datasource数据源
+     * @defaultValue 'none'
+     * @public
      * */
     optionConfig: 'none' | 'custom' | 'datasource';
+    /**
+     * 关联数据源
+     * @public
+     */
     datasourceBind: DataSourceBind;
+    /**
+     * 自定义选项
+     * @defaultValue []
+     * @public
+     */
     options: OptionSetting[];
     /**
-     * 保留几位小数，默认为0
+     * 保留几位小数
+     * @defaultValue 0
+     * @public
      * */
     precision: number | '';
     /**
      * 千分位展示
+     * @defaultValue false
+     * @public
      * */
-    micrometer: boolean;
+    micrometer: false;
     /**
      * 百分比格式化
+     * @defaultValue false
+     * @public
      * */
     percentageFormat: boolean;
     constructor(props?: Partial<DecimalColumnControlProperty>);

package/dist/types/columnControls/DepartmentColumn/property.d.ts

@@ -1,7 +1,13 @@
 import { ColumnControlProperty } from '@byteluck-fe/model-driven-core';
+/**
+ * DepartmentColumn 部门列
+ * @public
+ */
 declare class DepartmentColumnControlProperty extends ColumnControlProperty {
     /**
      * 部门显示层级
+     * @defaultValue 1
+     * @public
      * */
     displayLevel: number;
     constructor(props?: Partial<DepartmentColumnControlProperty>);

package/dist/types/columnControls/EmployeeColumn/property.d.ts

@@ -1,5 +1,13 @@
 import { ColumnControlProperty, SuperDataSourceBind } from '@byteluck-fe/model-driven-core';
+/**
+ * EmployeeColumn 人员列
+ * @public
+ */
 declare class EmployeeColumnControlProperty extends ColumnControlProperty {
+    /**
+     * 关联数据源
+     * @public
+     */
     datasourceBind: SuperDataSourceBind;
     constructor(props?: Partial<EmployeeColumnControlProperty>);
 }

package/dist/types/columnControls/FileColumn/property.d.ts

@@ -1,4 +1,7 @@
 import { ColumnControlProperty } from '@byteluck-fe/model-driven-core';
+/**
+ * FileColumn 文件列
+ */
 declare class FileColumnControlProperty extends ColumnControlProperty {
     constructor(props?: Partial<FileColumnControlProperty>);
 }

package/dist/types/columnControls/ImageColumn/property.d.ts

@@ -1,4 +1,7 @@
 import { ColumnControlProperty } from '@byteluck-fe/model-driven-core';
+/**
+ * ImageColumn 图片列
+ */
 declare class ImageColumnControlProperty extends ColumnControlProperty {
     constructor(props?: Partial<ImageColumnControlProperty>);
 }

package/dist/types/columnControls/LocationColumn/property.d.ts

@@ -1,4 +1,8 @@
 import { ColumnControlProperty } from '@byteluck-fe/model-driven-core';
+/**
+ * LocationColumn 地址列
+ * @public
+ */
 declare class LocationColumnControlProperty extends ColumnControlProperty {
     constructor(props?: Partial<LocationColumnControlProperty>);
 }

package/dist/types/columnControls/OperationColumn/property.d.ts

@@ -1,6 +1,20 @@
 import { ColumnControlProperty } from '@byteluck-fe/model-driven-core';
+/**
+ * OperationColumn 操作列
+ * @public
+ */
 declare class OperationColumnControlProperty extends ColumnControlProperty {
+    /**
+     * 显示效果
+     * @defaultValue 'icon'
+     * @public
+     */
     showType?: 'text' | 'icon' | 'iconText';
+    /**
+     * 最多展示操作数
+     * @defaultValue 3
+     * @public
+     */
     limit: number;
     constructor(props?: Partial<OperationColumnControlProperty>);
 }

package/dist/types/columnControls/OrderColumn/property.d.ts

@@ -2,6 +2,10 @@ import { ColumnControlProperty, ColumnControlPropertyRules } from '@byteluck-fe/
 declare class OrderColumnControlPropertyRules extends ColumnControlPropertyRules {
     constructor(props: OrderColumnControlProperty);
 }
+/**
+ * OrderColumn 序号列
+ * @public
+ */
 declare class OrderColumnControlProperty extends ColumnControlProperty {
     static readonly Rules: typeof OrderColumnControlPropertyRules;
     constructor(props?: Partial<OrderColumnControlProperty>);

package/dist/types/columnControls/PeopleColumn/property.d.ts

@@ -1,4 +1,7 @@
 import { ColumnControlProperty } from '@byteluck-fe/model-driven-core';
+/**
+ * PeopleColumn 已废弃
+ */
 declare class PeopleColumnControlProperty extends ColumnControlProperty {
     constructor(props?: Partial<PeopleColumnControlProperty>);
 }

package/dist/types/columnControls/TextColumn/property.d.ts

@@ -1,9 +1,20 @@
 import { ColumnControlProperty } from '@byteluck-fe/model-driven-core';
+/**
+ * TextColumn 长文本列
+ * @public
+ */
 declare class TextColumnControlProperty extends ColumnControlProperty {
     /**
-     * 是否转换HTML标签，默认为true
+     * 保留富文本格式
+     * @defaultValue true
+     * @public
      * */
     escapeHTML: boolean;
+    /**
+     * 行数设置
+     * @defaultValue 1
+     * @public
+     */
     lineEllipsis: number;
     constructor(props?: Partial<TextColumnControlProperty>);
 }

package/dist/types/columnControls/TimescopeColumn/property.d.ts

@@ -1,8 +1,14 @@
 import { ColumnControlProperty } from '@byteluck-fe/model-driven-core';
 import { DateType } from '@byteluck-fe/model-driven-shared';
+/**
+ * TimescopeColumn 日期区间列
+ * @public
+ */
 declare class TimescopeColumnControlProperty extends ColumnControlProperty {
     /**
      * 日期展示格式
+     * @defaultValue 'date'
+     * @public
      * */
     dateType: DateType;
     constructor(props?: Partial<TimescopeColumnControlProperty>);

package/dist/types/columnControls/TimestampColumn/property.d.ts

@@ -1,8 +1,14 @@
 import { ColumnControlProperty } from '@byteluck-fe/model-driven-core';
 import { DateType } from '@byteluck-fe/model-driven-shared';
+/**
+ * TimestampColumn 日期列
+ * @public
+ */
 declare class TimestampColumnControlProperty extends ColumnControlProperty {
     /**
      * 日期展示格式
+     * @defaultValue 'date'
+     * @public
      * */
     dateType: DateType;
     constructor(props?: Partial<TimestampColumnControlProperty>);

package/dist/types/columnControls/VarcharColumn/property.d.ts

@@ -2,14 +2,28 @@ import { ColumnControlProperty, ColumnOptionAndDataSourcePropertyRules, DataSour
 declare class VarcharColumnControlPropertyRules extends ColumnOptionAndDataSourcePropertyRules {
     constructor(props: VarcharColumnControlProperty);
 }
+/**
+ * VarcharColumn 短文本列
+ * @public
+ */
 declare class VarcharColumnControlProperty extends ColumnControlProperty {
     static readonly Rules: typeof VarcharColumnControlPropertyRules;
     /**
      * 选项配置
-     * none无 custom自定义 datasource数据源
+     * @defaultValue 'none'
+     * @public
      * */
     optionConfig: 'none' | 'custom' | 'datasource';
+    /**
+     * 关联数据源
+     * @public
+     */
     datasourceBind: DataSourceBind;
+    /**
+     * 自定义选项
+     * @defaultValue []
+     * @public
+     */
     options: OptionSetting[];
     /**
      * 最大行数

package/dist/types/formControls/Input/property.d.ts

@@ -9,14 +9,47 @@ declare class InputControlPropertyRules extends BaseControlPropertyRules {
 declare class InputControlPropertyRuntimeRules extends BaseControlPropertyRuntimeRules {
     constructor(props: InputProperty);
 }
+/**
+ * Input 单行文本
+ * @public
+ */
 declare class InputProperty extends BaseControlProperty {
     static readonly Rules: typeof InputControlPropertyRules;
     static readonly RuntimeRules: typeof InputControlPropertyRuntimeRules;
+    /**
+     * 最大长度
+     * @defaultValue 200
+     * @public
+     */
     maxLength: number;
+    /**
+     * 最小长度
+     * @defaultValue 0
+     * @public
+     */
     minLength: number;
+    /**
+     * 正则校验
+     * @public
+     */
     regularRules: RegularRules;
+    /**
+     * 默认值
+     * @defaultValue ''
+     * @public
+     */
     defaultValue: string;
+    /**
+     * 开启密码模式
+     * @defaultValue false
+     * @public
+     */
     encrypted: boolean;
+    /**
+     * 密码模式 '' | 'ALL_MASK' | 'LAST_FOUR_MASK'
+     * @defaultValue ''
+     * @public
+     */
     encryptedMode: string;
     constructor(props?: Partial<InputProperty>);
 }

package/dist/types/formControls/Number/property.d.ts

@@ -8,53 +8,83 @@ declare class NumberControlPropertyRules extends BaseControlPropertyRules {
 declare class NumberControlPropertyRuntimeRules extends BaseControlPropertyRuntimeRules {
     constructor(props: NumberProperty);
 }
+/**
+ * Number 数字
+ * @public
+ */
 declare class NumberProperty extends BaseControlProperty {
     static readonly Rules: typeof NumberControlPropertyRules;
     static readonly RuntimeRules: typeof NumberControlPropertyRuntimeRules;
     /**
      * 最小值
+     * @defaultValue ''
+     * @public
      * */
     rangeMin: number | '';
     /**
      * 最大值
+     * @defaultValue ''
+     * @public
      * */
     rangeMax: number | '';
     /**
      * 类型 （数值number/百分比percentage）
+     * @defaultValue 'number'
+     * @public
      * */
     numberType: 'number' | 'percentage';
     /**
      * 百分比格式化
+     * @defaultValue false
+     * @public
      * */
     percentageFormat: boolean;
     /**
      * 千分位展示
+     * @defaultValue false
+     * @public
      * */
     micrometer: boolean;
     /**
      * 小数位数
+     * @defaultValue ''
+     * @public
      */
     precision: number | '';
     /**
-     * 是否显示大写数字
+     * 显示大写数字
+     * @defaultValue false
+     * @public
      * */
     showUpperCase: boolean;
     /**
      * 是否勾选单位
+     * @defaultValue false
+     * @public
      * */
     isShowUnit: boolean;
     /**
      * 单位位置 left right
+     * @defaultValue 'right'
+     * @public
      * */
     unitPosition: 'left' | 'right';
     /**
      * 自定义单位
+     * @defaultValue ''
+     * @public
      * */
     unit: string;
     /**
      * 默认值
+     * @defaultValue ''
+     * @public
      * */
     defaultValue: number | '';
+    /**
+     * 正则校验
+     * @public
+     * */
     regularRules: RegularRules;
     constructor(props?: Partial<NumberProperty>);
 }

package/dist/types/formControls/SelectRelation/designer.d.ts

@@ -7,6 +7,7 @@ declare class SelectRelationControl extends DesignerFormControl {
     static get controlType(): string;
     static controlFieldType: FieldTypes;
     static readonly setting: SettingOption[];
+    static readonly controlEventKeys: string[];
     readonly props: SelectRelationProperty;
     constructor(props?: Partial<Schema<'select-relation'>>);
 }

package/dist/types/formControls/SelectRelation/property.d.ts

@@ -4,18 +4,57 @@ declare class SelectRelationControlPropertyRules extends OptionAndDataSourceProp
     listPageBind: RuleItem[];
     constructor(props: SelectRelationProperty);
 }
+/**
+ * SelectRelation 关联单选
+ * @public
+ */
 declare class SelectRelationProperty extends BaseControlProperty {
     static readonly Rules: typeof SelectRelationControlPropertyRules;
+    /**
+     * 自定义选项
+     * @defaultValue []
+     * @public
+     */
     options: Array<OptionSetting>;
+    /**
+     * 选项配置
+     * @defaultValue 'datasource'
+     * @public
+     * */
     optionConfig: 'custom' | 'datasource';
+    /**
+     * 默认值
+     * @defaultValue ''
+     * @public
+     */
     defaultValue: string;
+    /**
+     * 绑定列表页
+     * @public
+     */
     listPageBind: ListBind;
+    /**
+     * 关联数据源
+     * @public
+     */
     datasourceBind: DataSourceBind;
+    /**
+     * 数据填充
+     * @defaultValue []
+     * @public
+     */
     multistageFilling?: MultistageFillingItem[];
     /**
-     * @description 查看详情 https://www.tapd.cn/49877295/prong/stories/view/1149877295001003559
+     * 查看详情
+     * @defaultValue false
+     * @public
      */
     canViewForm: boolean;
+    /**
+     * 数据填充-查看/编辑页面生效
+     * @defaultValue false
+     * @public
+     */
     openMultistageFilling: boolean;
     constructor(props?: Partial<SelectRelationProperty>);
 }

package/dist/types/formControls/Textarea/property.d.ts

@@ -9,12 +9,36 @@ declare class TextareaControlPropertyRules extends BaseControlPropertyRules {
 declare class TextareaControlPropertyRuntimeRules extends BaseControlPropertyRuntimeRules {
     constructor(props: TextareaProperty);
 }
+/**
+ * Textarea 多行文本
+ * @public
+ */
 declare class TextareaProperty extends BaseControlProperty {
     static readonly Rules: typeof TextareaControlPropertyRules;
     static readonly RuntimeRules: typeof TextareaControlPropertyRuntimeRules;
+    /**
+     * 最大长度
+     * @defaultValue 50000
+     * @public
+     */
     maxLength: number;
+    /**
+     * 最小长度
+     * @defaultValue 0
+     * @public
+     */
     minLength: number;
+    /**
+     * 默认值
+     * @defaultValue ''
+     * @public
+     */
     defaultValue: string;
+    /**
+     * 行数设置
+     * @defaultValue 4
+     * @public
+     */
     lineEllipsis: number;
     constructor(props?: Partial<TextareaProperty>);
 }