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

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

@@ -12,6 +12,11 @@ interface FileColumnPropertyInterface extends ColumnControlPropertyInterface {
     operation: string[];
 }
 declare class FileColumnControlProperty extends ColumnControlProperty implements FileColumnPropertyInterface {
+    /**
+     * 附件按钮操作数组
+     * @defaultValue ['info', 'preview', 'download']
+     * @public
+     */
     operation: string[];
     constructor(props?: Partial<FileColumnControlProperty>);
 }

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

@@ -26,7 +26,17 @@ interface LocationColumnPropertyInterface extends ColumnControlPropertyInterface
 }
 declare class LocationColumnControlProperty extends ColumnControlProperty implements LocationColumnPropertyInterface {
     static readonly Rules: typeof LocationColumnControlPropertyRules;
+    /**
+     * 是否显示链接操作
+     * @defaultValue false
+     * @public
+     */
     showLinkOperation: boolean;
+    /**
+     * 链接操作配置
+     * @defaultValue new LinkOperationOption()
+     * @public
+     */
     linkOperationOption: LinkOperationOption;
     constructor(props?: Partial<LocationColumnControlProperty>);
 }

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

@@ -22,7 +22,17 @@ interface OperationColumnPropertyInterface extends ColumnControlPropertyInterfac
     limit: number;
 }
 declare class OperationColumnControlProperty extends ColumnControlProperty implements OperationColumnPropertyInterface {
+    /**
+     * 显示效果；取值：text：文本；icon：图标；iconText：图标文字；
+     * @defaultValue 'icon'
+     * @public
+     */
     showType?: 'text' | 'icon' | 'iconText';
+    /**
+     * 最多展示操作数
+     * @defaultValue 3
+     * @public
+     */
     limit: number;
     constructor(props?: Partial<OperationColumnControlProperty>);
 }

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

@@ -38,9 +38,29 @@ interface TextColumnPropertyInterface extends ColumnControlPropertyInterface {
 }
 declare class TextColumnControlProperty extends ColumnControlProperty implements TextColumnPropertyInterface {
     static readonly Rules: typeof TextColumnControlPropertyRules;
+    /**
+     * 保留富文本格式
+     * @defaultValue false
+     * @public
+     */
     escapeHTML: boolean;
+    /**
+     * 是否显示链接操作
+     * @defaultValue false
+     * @public
+     */
     showLinkOperation: boolean;
+    /**
+     * 链接操作配置
+     * @defaultValue new LinkOperationOption()
+     * @public
+     */
     linkOperationOption: LinkOperationOption;
+    /**
+     * 行数设置
+     * @defaultValue 1
+     * @public
+     */
     lineEllipsis: number;
     constructor(props?: Partial<TextColumnControlProperty>);
 }

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

@@ -39,9 +39,29 @@ interface TimescopeColumnPropertyInterface extends ColumnControlPropertyInterfac
 }
 declare class TimescopeColumnControlProperty extends ColumnControlProperty implements TimescopeColumnPropertyInterface {
     static readonly Rules: typeof TimescopeColumnControlPropertyRules;
+    /**
+     * 日期展示格式；取值：year：年；month：年月；date：年月日；datehour：年月日时；datemin：年月日时分；datetime：年月日时分秒；custom：自定义；
+     * @defaultValue 'date'
+     * @public
+     */
     dateType: DateType;
+    /**
+     * 是否显示链接操作
+     * @defaultValue false
+     * @public
+     */
     showLinkOperation: boolean;
+    /**
+     * 链接操作配置
+     * @defaultValue new LinkOperationOption()
+     * @public
+     */
     linkOperationOption: LinkOperationOption;
+    /**
+     * 是否国际化
+     * @defaultValue false
+     * @public
+     */
     isInternational: boolean;
     constructor(props?: Partial<TimescopeColumnControlProperty>);
 }

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

@@ -39,9 +39,29 @@ interface TimestampColumnPropertyInterface extends ColumnControlPropertyInterfac
 }
 declare class TimestampColumnControlProperty extends ColumnControlProperty implements TimestampColumnPropertyInterface {
     static readonly Rules: typeof TimestampColumnControlPropertyRules;
+    /**
+     * 日期展示格式；取值：year：年；month：年月；date：年月日；datehour：年月日时；datemin：年月日时分；datetime：年月日时分秒；custom：自定义；
+     * @defaultValue 'date'
+     * @public
+     */
     dateType: DateType;
+    /**
+     * 是否显示链接操作
+     * @defaultValue false
+     * @public
+     */
     showLinkOperation: boolean;
+    /**
+     * 链接操作配置
+     * @defaultValue new LinkOperationOption()
+     * @public
+     */
     linkOperationOption: LinkOperationOption;
+    /**
+     * 是否国际化
+     * @defaultValue false
+     * @public
+     */
     isInternational: boolean;
     constructor(props?: Partial<TimestampColumnControlProperty>);
 }

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

@@ -59,12 +59,47 @@ interface VarcharColumnPropertyInterface extends ColumnControlPropertyInterface
 }
 declare class VarcharColumnControlProperty extends ColumnControlProperty implements VarcharColumnPropertyInterface {
     static readonly Rules: typeof VarcharColumnControlPropertyRules;
+    /**
+     * 选项配置；取值：none：无；custom：自定义；datasource：数据源；
+     * @defaultValue 'none'
+     * @public
+     */
     optionConfig: 'none' | 'custom' | 'datasource';
+    /**
+     * 关联数据源
+     * @defaultValue new DataSourceBind()
+     * @public
+     */
     datasourceBind: DataSourceBind;
+    /**
+     * 是否显示链接操作
+     * @defaultValue false
+     * @public
+     */
     showLinkOperation: boolean;
+    /**
+     * 链接操作配置
+     * @defaultValue new LinkOperationOption()
+     * @public
+     */
     linkOperationOption: LinkOperationOption;
+    /**
+     * 自定义选项
+     * @defaultValue [{}]
+     * @public
+     */
     options: OptionSetting[];
+    /**
+     * 最大行数
+     * @defaultValue 1
+     * @public
+     */
     lineEllipsis: number;
+    /**
+     * tag配置
+     * @defaultValue { isTag: false }
+     * @public
+     */
     dictionaryTagConfig: {
         isTag: boolean;
         color?: number;

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

@@ -38,9 +38,29 @@ interface AddressPropertyInterface extends BaseControlPropertyInterface {
 }
 declare class AddressProperty extends BaseControlProperty implements AddressPropertyInterface {
     static readonly RuntimeRules: typeof AddressControlPropertyRuntimeRules;
+    /**
+     * 默认值类型 default固定地址 current当前定位
+     * @defaultValue 'default'
+     * @public
+     */
     defaultValueType: 'default' | 'current';
+    /**
+     * 默认值
+     * @defaultValue new AddressValue({})
+     * @public
+     */
     defaultValue: AddressValue;
+    /**
+     * 地址类型；country：国家；province：省；city：城市；district：区县；
+     * @defaultValue ['province', 'city', 'district']
+     * @public
+     */
     addressType: string[];
+    /**
+     * 国家范围
+     * @defaultValue false
+     * @public
+     */
     countryScope: Array<string>;
     constructor(props?: Partial<AddressProperty>);
 }

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

@@ -92,17 +92,77 @@ interface AmountPropertyInterface extends BaseControlPropertyInterface {
 declare class AmountProperty extends BaseControlProperty implements AmountPropertyInterface {
     static readonly Rules: typeof AmountPropertyRules;
     static readonly RuntimeRules: typeof AmountPropertyRuntimeRules;
+    /**
+     * 最小值
+     * @defaultValue ''
+     * @public
+     */
     rangeMin: number | '';
+    /**
+     * 最大值
+     * @defaultValue ''
+     * @public
+     */
     rangeMax: number | '';
+    /**
+     * 是否显示大写数字
+     * @defaultValue false
+     * @public
+     */
     showUpperCase: boolean;
+    /**
+     * 提交时选择币种
+     * @defaultValue false
+     * @public
+     */
     submitSelectCurrency: boolean;
+    /**
+     * 千分位展示
+     * @defaultValue false
+     * @public
+     */
     micrometer: boolean;
+    /**
+     * 小数位数
+     * @defaultValue 2
+     * @public
+     */
     precision: number | '';
+    /**
+     * 单位位置 left right align-right
+     * @defaultValue 'right'
+     * @public
+     */
     unitPosition: 'left' | 'right' | 'align-right';
+    /**
+     * 选项配置 custom datasource
+     * @defaultValue 'datasource'
+     * @public
+     */
     optionConfig: 'custom' | 'datasource';
+    /**
+     * 金额和币种的数据绑定
+     * @defaultValue new AmountDataBind()
+     * @public
+     */
     dataBind: AmountDataBind;
+    /**
+     * 币种的数据源绑定
+     * @defaultValue new DataSourceBind({ displayBoList: [new DisplayBoListItem({ value: 'name' })] })
+     * @public
+     */
     datasourceBind: DataSourceBind;
+    /**
+     * 默认值
+     * @defaultValue new AmountValue({ amount: '', currency: 'CNY' })
+     * @public
+     */
     defaultValue: AmountValue;
+    /**
+     * 币种的默认选项
+     * @defaultValue []
+     * @public
+     */
     options: OptionSetting[];
     constructor(props?: Partial<AmountProperty>);
 }

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

@@ -111,20 +111,95 @@ interface AttachmentPropertyInterface extends BaseControlPropertyInterface {
 declare class AttachmentProperty extends BaseControlProperty implements AttachmentPropertyInterface {
     static readonly Rules: typeof AttachmentControlPropertyRules;
     static readonly RuntimeRules: typeof AttachmentControlPropertyRuntimeRules;
+    /**
+     * 存储类型；取值：local：本地；cloud：云端；
+     * @defaultValue 'local'
+     * @public
+     */
     storageType: 'local' | 'cloud';
+    /**
+     * 默认值
+     * @defaultValue []
+     * @public
+     */
     defaultValue: string[];
+    /**
+     * 展示样式；取值：default：默认列表；table：表格列表；image：图片列表；
+     * @defaultValue 'default'
+     * @public
+     */
     showType: 'default' | 'table' | 'image';
+    /**
+     * 结果展示类型；取值：simple：简洁；table：表格；
+     * @defaultValue 'simple'
+     * @public
+     */
     resultShowType: 'simple' | 'table';
+    /**
+     * 允许上传的附件类型
+     * @defaultValue []
+     * @public
+     */
     attachmentAccept: string[];
+    /**
+     * 最大上传数量
+     * @defaultValue 10
+     * @public
+     */
     maxLimit: number;
+    /**
+     * 最小上传数量
+     * @defaultValue 0
+     * @public
+     */
     minLimit: number;
+    /**
+     * 是否开启水印
+     * @defaultValue false
+     * @public
+     */
     isShowWatermark: boolean;
+    /**
+     * 水印配置
+     * @defaultValue {}
+     * @public
+     */
     watermarkFx: object;
+    /**
+     * 最大文件大小，单位为字节
+     * @defaultValue 104857600
+     * @public
+     */
     maxSize: number;
+    /**
+     * 附件按钮操作数组
+     * @defaultValue ['info', 'preview', 'download']
+     * @public
+     */
     operation: string[];
+    /**
+     * 附件ai解释
+     * @defaultValue false
+     * @public
+     */
     aiExplanation: boolean;
+    /**
+     * 附件ai解释长度
+     * @defaultValue 500
+     * @public
+     */
     aiExplanationLength: number;
+    /**
+     * 自定义附件操作
+     * @defaultValue []
+     * @public
+     */
     customOperation: Array<FileOperationBtn>;
+    /**
+     * 描述信息
+     * @defaultValue ''
+     * @public
+     */
     describe: string;
     constructor(props?: Partial<AttachmentProperty>);
 }

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

@@ -8,6 +8,11 @@ interface AutoNumberPropertyInterface extends BaseControlPropertyInterface {
     defaultValue: string;
 }
 declare class AutoNumberProperty extends BaseControlProperty implements AutoNumberPropertyInterface {
+    /**
+     * 默认值
+     * @defaultValue ''
+     * @public
+     */
     defaultValue: string;
     constructor(props?: Partial<AutoNumberProperty>);
 }

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

@@ -1,4 +1,5 @@
 import { BaseControlProperty, BaseControlPropertyInterface, BaseControlPropertyRules, BaseControlPropertyRuntimeRules } from '@byteluck-fe/model-driven-core';
+type BarcodeColor = '#000000' | '#001F3F' | '#004225' | '#4A0404' | '#2F2F2F' | '#1A237E';
 declare class BarcodePropertyRules extends BaseControlPropertyRules {
     constructor(props: BarcodeProperty);
 }
@@ -31,17 +32,11 @@ interface BarcodePropertyInterface extends BaseControlPropertyInterface {
      */
     codeMargin: number;
     /**
-     * 背景色
-     * @defaultValue '#ffffff'
-     * @public
-     */
-    backgroundColor: string;
-    /**
-     * 条码颜色
+     * 条码颜色；取值：#000000：纯黑；#001F3F：深海军蓝；#004225：深森林绿；#4A0404：深酒红；#2F2F2F：深炭灰；#1A237E：深靛青；
      * @defaultValue '#000000'
      * @public
      */
-    barcodeColor: string;
+    barcodeColor: BarcodeColor;
     /**
      * 对齐；取值：left：左对齐；center：居中；right：右对齐；
      * @defaultValue 'left'
@@ -58,15 +53,50 @@ interface BarcodePropertyInterface extends BaseControlPropertyInterface {
 declare class BarcodeProperty extends BaseControlProperty implements BarcodePropertyInterface {
     static readonly Rules: typeof BarcodePropertyRules;
     static readonly RuntimeRules: typeof BarcodePropertyRuntimeRules;
+    /**
+     * 默认值
+     * @defaultValue ''
+     * @public
+     */
     defaultValue: string;
+    /**
+     * 条码高度；单位 px
+     * @defaultValue 40
+     * @public
+     */
     codeHeight: number;
+    /**
+     * 条码宽度；单位 px
+     * @defaultValue 200
+     * @public
+     */
     codeWidth: number;
+    /**
+     * 边距；单位 px
+     * @defaultValue 0
+     * @public
+     */
     codeMargin: number;
-    backgroundColor: string;
-    barcodeColor: string;
+    /**
+     * 条码颜色；取值：#000000：纯黑；#001F3F：深海军蓝；#004225：深森林绿；#4A0404：深酒红；#2F2F2F：深炭灰；#1A237E：深靛青；
+     * @defaultValue '#000000'
+     * @public
+     */
+    barcodeColor: BarcodeColor;
+    /**
+     * 对齐；取值：left：左对齐；center：居中；right：右对齐；
+     * @defaultValue 'left'
+     * @public
+     */
     align: 'left' | 'center' | 'right';
+    /**
+     * 是否显示条码值文本
+     * @defaultValue true
+     * @public
+     */
     displayValue: boolean;
     constructor(props?: Partial<BarcodeProperty>);
 }
 export default BarcodeProperty;
+export type { BarcodeColor };
 export { BarcodeProperty, BarcodePropertyInterface, BarcodePropertyRules, BarcodePropertyRuntimeRules, };

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

@@ -65,14 +65,59 @@ interface CalcPropertyInterface extends BaseControlPropertyInterface {
 declare class CalcProperty extends BaseControlProperty implements CalcPropertyInterface {
     static readonly Rules: typeof CalcControlPropertyRules;
     static readonly RuntimeRules: typeof CalcControlPropertyRuntimeRules;
+    /**
+     * 保留小数点后几位
+     * @defaultValue 0
+     * @public
+     */
     precision: number | '';
+    /**
+     * 千分位展示
+     * @defaultValue false
+     * @public
+     */
     micrometer: boolean;
+    /**
+     * 是否显示大写数字
+     * @defaultValue false
+     * @public
+     */
     showUpperCase: boolean;
+    /**
+     * 解释执行的表达式源码
+     * @defaultValue ''
+     * @public
+     */
     scriptSrc: string;
+    /**
+     * 辅助回显的表达式
+     * @defaultValue []
+     * @public
+     */
     scriptEcho: CalcScriptEchoItem[];
+    /**
+     * 计算公式的数据绑定
+     * @defaultValue new CalcDataBind()
+     * @public
+     */
     dataBind: CalcDataBind;
+    /**
+     * 默认值
+     * @defaultValue new CalcValue()
+     * @public
+     */
     defaultValue: CalcValue;
+    /**
+     * 单位位置 left right align-right
+     * @defaultValue 'right'
+     * @public
+     */
     unitPosition: 'left' | 'right' | 'align-right';
+    /**
+     * 页面加载时计算
+     * @defaultValue false
+     * @public
+     */
     calcOnMounted: boolean;
     constructor(props?: Partial<CalcProperty>);
 }

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

@@ -84,18 +84,83 @@ interface CascaderPropertyInterface extends BaseControlPropertyInterface {
     openMultistageFilling: boolean;
 }
 declare class CascaderProperty extends BaseControlProperty implements CascaderPropertyInterface {
+    /**
+     * 支持搜索
+     * @defaultValue true
+     * @public
+     */
     showSearch: boolean;
+    /**
+     * 支持多选节点
+     * @defaultValue false
+     * @public
+     */
     multiple: boolean;
+    /**
+     * 次级菜单的展开方式，click 点击方式打开，hover hover方式打开
+     * @defaultValue 'click'
+     * @public
+     */
     expandTrigger: 'click' | 'hover';
+    /**
+     * 默认值
+     * @defaultValue []
+     * @public
+     */
     defaultValue: string[];
+    /**
+     * 是否支持清除
+     * @defaultValue true
+     * @public
+     */
     allowClear: boolean;
+    /**
+     * 显示模式，'': 默认模式；Cascader.SHOW_CHILD: 只显示选中的子节点；Cascader.SHOW_PARENT: 只显示父节点（当父节点下所有子节点都选中时）
+     * @defaultValue ''
+     * @public
+     */
     showCheckedStrategy: '' | 'Cascader.SHOW_PARENT' | 'Cascader.SHOW_CHILD';
+    /**
+     * 选值模式，CHILD：只存储选中的子节点；ANY：任意节点
+     * @defaultValue 'CHILD'
+     * @public
+     */
     saveCheckedStrategy: 'CHILD' | 'ANY';
+    /**
+     * 分割符
+     * @defaultValue '/'
+     * @public
+     */
     separator: string;
+    /**
+     * 数据源类型，custom：自定义；datasource：绑定数据源
+     * @defaultValue 'custom'
+     * @public
+     */
     optionConfig: 'custom' | 'datasource';
+    /**
+     * 绑定数据源
+     * @defaultValue new TreeDataSourceBind({ attributes: CascaderControl.controlCustomAttributes })
+     * @public
+     */
     datasourceBind: TreeDataSourceBind;
+    /**
+     * 数据过滤
+     * @defaultValue new TreeDataSourceBind({ attributes: CascaderControl.controlCustomAttributes })
+     * @public
+     */
     filterItemDatasourceBind: TreeDataSourceBind;
+    /**
+     * 数据填充
+     * @defaultValue []
+     * @public
+     */
     multistageFilling: MultistageFillingItem[];
+    /**
+     * 是否开启填充
+     * @defaultValue false
+     * @public
+     */
     openMultistageFilling: boolean;
     constructor(props?: Partial<CascaderProperty>);
 }