@byteluck-fe/model-driven-core 7.0.0-1-beta9 → 7.0.0-beta.10

package/dist/types/common/BaseControl/designer.d.ts

@@ -47,12 +47,15 @@ declare class Control {
     toSchema(): BaseControlSchema<ControlsKeys, Property>;
     updateSetting: typeof updateSetting;
     removeSetting: typeof removeSetting;
+    removeSettingByKeyAndName: typeof removeSettingByKeyAndName;
     static updateBasicControl(key: 'setting', setting: {
         add?: SettingOption[];
         remove?: string[];
         update?: string[];
     }): void;
     static removeSettingItem: typeof removeSetting;
+    static removeSettingByKeyAndName: typeof removeSettingByKeyAndName;
+    static removeSettingItemByKeyAndName: typeof removeSettingByKeyAndName;
     static updateSettingItem: typeof updateSetting;
 }
 export default Control;
@@ -63,6 +66,17 @@ export { Control as DesignerControl };
  * @param keys 需要删除的key或key组成的数组
  * */
 declare function removeSetting(keys: Array<string | HideOptions> | string | HideOptions): void;
+/**
+ * @function 根据key和name删除控件或者实例上的setting
+ * @description 用于删除使用公共key但通过name区分的setting项
+ * @param options 需要删除的setting key和name
+ * */
+interface RemoveSettingByKeyAndNameOption {
+    key: string;
+    name: string;
+}
+declare function removeSettingByKeyAndName(options: RemoveSettingByKeyAndNameOption[]): void;
+declare function removeSettingByKeyAndName(key: string, name: string): void;
 interface UpdateSettingOption {
     showItems: COMMON_SETTING_TYPE[];
     type?: 'push' | 'replace';

package/dist/types/common/BaseControl/property.d.ts

@@ -1,3 +1,7 @@
+/**
+ * name: base_property
+ * description: 基础属性定义。提供控件通用的隐藏状态、类名、样式、标题和默认状态配置，是表单、布局、列表等属性模型的公共基类。
+ */
 import { RuleItem } from '../Validator';
 import { BaseStyle } from '../../framework';
 import { MODE } from 'type';
@@ -11,10 +15,44 @@ declare class PropertyRuntimeRules extends Array<RuleItem> {
     constructor(props: Property);
 }
 /**
- * 全局属性
+ * 属性定义
+ */
+interface PropertyInterface {
+    /**
+     * 是否隐藏
+     * @public
+     * @defaultValue false
+     */
+    isHide: boolean;
+    /**
+     * 类名
+     * @public
+     * @noSchema
+     */
+    className?: string[];
+    /**
+     * 样式
+     * @public
+     * @noSchema
+     */
+    style: BaseStyle;
+    /**
+     * 标题
+     * @public
+     * @defaultValue ''
+     */
+    caption: string;
+    /**
+     * 默认状态
+     * @public
+     */
+    defaultState: 'readonly' | 'default';
+}
+/**
+ * 属性实现
  * @public
  */
-declare class Property {
+declare class Property implements PropertyInterface {
     static mode: MODE;
     static readonly Rules: typeof PropertyRules;
     static readonly RuntimeRules: typeof PropertyRuntimeRules;
@@ -24,7 +62,17 @@ declare class Property {
      * @defaultValue false
      */
     isHide: boolean;
+    /**
+     * 类名
+     * @public
+     * @noSchema
+     */
     className?: string[];
+    /**
+     * 样式
+     * @public
+     * @noSchema
+     */
     style: BaseStyle;
     /**
      * 标题
@@ -33,12 +81,11 @@ declare class Property {
      */
     caption: string;
     /**
-     * 标题
+     * 默认状态
      * @public
-     * @defaultValue ''
      */
     defaultState: 'readonly' | 'default';
     constructor(props?: Partial<Property>, caption?: string);
 }
 export default Property;
-export { Property, PropertyRules, PropertyRuntimeRules };
+export { Property, PropertyInterface, PropertyRules, PropertyRuntimeRules };

package/dist/types/common/BaseControl/types.d.ts

@@ -12,6 +12,10 @@ export declare interface SettingOption {
     label?: string;
     name?: string;
     tip?: string;
+    children?: SettingOption[];
+    layout?: 'horizontal' | 'vertical';
+    min?: number;
+    max?: number;
 }
 export declare interface HideOptions {
     key: string;

package/dist/types/common/ColumnControl/designer.d.ts

@@ -7,13 +7,13 @@ declare class ColumnControl extends DesignerControl {
     children: DesignerControl[];
     constructor(props?: Partial<ColumnControlSchema<ColumnControlsKeys>>);
     toSchema(): {
-        children: import("../../type").BaseControlSchema<never, import("../BaseControl").Property>[];
+        children: import("../../type").BaseControlSchema<never, import("../BaseControl/property").default>[];
         id: string;
         type: never;
-        props: import("../BaseControl").Property;
+        props: import("../BaseControl/property").default;
         controlType: import("../../type").BaseControlTypes;
-        fieldType?: import("@byteluck-fe/model-driven-shared").FieldTypes;
-        pageStatus?: import("../..").PAGE_STATUS;
+        fieldType?: import("@byteluck-fe/model-driven-shared/dist/types").FieldTypes | undefined;
+        pageStatus?: import("../..").PAGE_STATUS | undefined;
     };
 }
 export default ColumnControl;

package/dist/types/common/ColumnControl/property.d.ts

@@ -1,4 +1,8 @@
-import { Property, PropertyRules, RuntimeControl } from '../BaseControl';
+/**
+ * name: base_column_control_property
+ * description: 列控件基础属性定义。提供列宽、标题、数据绑定、自适应宽度、冻结、排序、对齐、跨列、自动高度和子控件配置。
+ */
+import { Property, PropertyInterface, PropertyRules, RuntimeControl } from '../BaseControl';
 import { RuleItem } from 'async-validator';
 import { DataBind, DataSourceBind, OptionSetting, AutoWidth } from '../../framework';
 declare class ColumnControlPropertyRules extends PropertyRules {
@@ -6,11 +10,62 @@ declare class ColumnControlPropertyRules extends PropertyRules {
     width: RuleItem;
     constructor(props: ColumnControlProperty);
 }
+interface ColumnControlPropertyInterface extends PropertyInterface {
+    /**
+     * 宽度类型
+     * @defaultValue 'auto'
+     */
+    widthType: 'px' | 'auto' | 'percent';
+    /**
+     * 宽度
+     * @defaultValue 150
+     */
+    width: number;
+    /**
+     * 标题
+     */
+    caption: string;
+    /**
+     * 绑定数据项
+     */
+    dataBind: DataBind;
+    /**
+     * 自适应页面宽度
+     */
+    autoWidth: AutoWidth;
+    /**
+     * 冻结
+     * @defaultValue 'none'
+     */
+    fixed: 'left' | 'right' | 'none';
+    /**
+     * 表头排序
+     * @defaultValue true
+     */
+    sort: boolean;
+    /**
+     * 对齐
+     */
+    align?: 'left' | 'right' | 'center';
+    /**
+     * @internal
+     */
+    colSpan?: string;
+    /**
+     * 自动高度
+     * @defaultValue false
+     */
+    autoHeight: boolean;
+    /**
+     * 子控件
+     */
+    children: RuntimeControl[];
+}
 /**
  * 列基本属性
  * @public
  */
-declare class ColumnControlProperty extends Property {
+declare class ColumnControlProperty extends Property implements ColumnControlPropertyInterface {
     static readonly Rules: typeof ColumnControlPropertyRules;
     /**
      * 宽度类型
@@ -57,6 +112,9 @@ declare class ColumnControlProperty extends Property {
      * @defaultValue false
      */
     autoHeight: boolean;
+    /**
+     * 子控件
+     */
     children: RuntimeControl[];
     constructor(props?: Partial<ColumnControlProperty>);
 }
@@ -71,4 +129,4 @@ declare class ColumnOptionAndDataSourcePropertyRules extends ColumnControlProper
     });
 }
 export default ColumnControlProperty;
-export { ColumnControlProperty, ColumnControlPropertyRules, ColumnOptionAndDataSourcePropertyRules, };
+export { ColumnControlProperty, ColumnControlPropertyInterface, ColumnControlPropertyRules, ColumnOptionAndDataSourcePropertyRules, };

package/dist/types/common/FormControl/property.d.ts

@@ -1,4 +1,4 @@
-import { Property, PropertyRules, PropertyRuntimeRules } from '../BaseControl';
+import { Property, PropertyInterface, PropertyRules, PropertyRuntimeRules } from '../BaseControl';
 import { RuleItem } from '../Validator';
 import { DataBind, DataSourceBind, ObjectDataBind, OptionSetting } from '../../framework';
 declare class BaseControlPropertyRules extends PropertyRules {
@@ -14,13 +14,7 @@ declare class BaseControlPropertyRules extends PropertyRules {
 declare class BaseControlPropertyRuntimeRules extends PropertyRuntimeRules {
     constructor(props: BaseControlProperty);
 }
-/**
- * 表单控件公共属性
- * @public
- */
-declare class BaseControlProperty extends Property {
-    static readonly Rules: typeof BaseControlPropertyRules;
-    static readonly RuntimeRules: typeof BaseControlPropertyRuntimeRules;
+interface BaseControlPropertyInterface extends PropertyInterface {
     /**
      * 标题
      * @defaultValue ''
@@ -45,6 +39,18 @@ declare class BaseControlProperty extends Property {
      * @public
      */
     isCaptionItalic: boolean;
+    /**
+     * 标题字重；取值：normal：常规；bold：粗体；lighter：更细；
+     * @defaultValue 'normal'
+     * @public
+     */
+    captionFontWeight: 'normal' | 'bold' | 'lighter';
+    /**
+     * 样式类
+     * @defaultValue []
+     * @public
+     */
+    className: string[];
     /**
      * 隐藏标题
      * @defaultValue false
@@ -102,6 +108,30 @@ declare class BaseControlProperty extends Property {
      * @defaultValue ''
      */
     requiredMessage: string;
+}
+/**
+ * 表单控件公共属性
+ * @public
+ */
+declare class BaseControlProperty extends Property implements BaseControlPropertyInterface {
+    static readonly Rules: typeof BaseControlPropertyRules;
+    static readonly RuntimeRules: typeof BaseControlPropertyRuntimeRules;
+    caption: string;
+    captionSize: string;
+    captionColor: string;
+    isCaptionItalic: boolean;
+    captionFontWeight: 'normal' | 'bold' | 'lighter';
+    className: string[];
+    isHideCaption: boolean;
+    isShowCaptionTip: boolean;
+    captionTip: string;
+    labelPosition: 'top' | 'left';
+    dataBind: DataBind | ObjectDataBind;
+    defaultValue: string | number | string[] | number[] | unknown;
+    placeholder: string;
+    defaultState: 'default' | 'readonly';
+    required: boolean;
+    requiredMessage: string;
     constructor(props?: Partial<BaseControlProperty>);
 }
 declare class OptionAndDataSourcePropertyRules extends BaseControlPropertyRules {
@@ -115,4 +145,4 @@ declare class OptionAndDataSourcePropertyRules extends BaseControlPropertyRules
     });
 }
 export default BaseControlProperty;
-export { BaseControlProperty, BaseControlPropertyRules, BaseControlPropertyRuntimeRules, OptionAndDataSourcePropertyRules, };
+export { BaseControlProperty, BaseControlPropertyInterface, BaseControlPropertyRules, BaseControlPropertyRuntimeRules, OptionAndDataSourcePropertyRules, };

package/dist/types/common/LayoutControl/property.d.ts

@@ -1,6 +1,12 @@
-import { Property } from '../BaseControl';
-declare class LayoutControlProperty extends Property {
+/**
+ * name: base_layout_control_property
+ * description: 布局控件基础属性定义。继承通用属性能力，为行、列、容器、页签等布局类控件提供统一的属性模型。
+ */
+import { Property, PropertyInterface } from '../BaseControl';
+interface LayoutControlPropertyInterface extends PropertyInterface {
+}
+declare class LayoutControlProperty extends Property implements LayoutControlPropertyInterface {
     constructor(props?: Partial<LayoutControlProperty>);
 }
 export default LayoutControlProperty;
-export { LayoutControlProperty };
+export { LayoutControlProperty, LayoutControlPropertyInterface };

package/dist/types/common/ListControl/property.d.ts

@@ -1,13 +1,62 @@
-import { DesignerControl, Property, RuntimeControl } from '../BaseControl';
+/**
+ * name: base_list_control_property
+ * description: 列表控件基础属性定义。提供表头、表尾、分页页码、每页条数、分页选项和总条数等列表通用配置。
+ */
+import { DesignerControl, Property, PropertyInterface, RuntimeControl } from '../BaseControl';
 import { ControlsKeys, BaseControlSchema, MODE } from '../../type';
 import { DesignerListControl } from './designer';
 import { RuntimeListControl } from './runtime';
-declare class ListControlProperty<Mode extends MODE | 'Schema', Control extends object = Mode extends 'Runtime' ? RuntimeControl : Mode extends 'Designer' ? DesignerControl : BaseControlSchema<ControlsKeys, any>> extends Property {
+type ControlType<Mode extends MODE | 'Schema'> = Mode extends 'Runtime' ? RuntimeControl : Mode extends 'Designer' ? DesignerControl : BaseControlSchema<ControlsKeys, any>;
+interface ListControlPropertyInterface<Mode extends MODE | 'Schema', Control extends object = ControlType<Mode>> extends PropertyInterface {
+    /**
+     * 表头控件
+     */
     headers: Control[];
+    /**
+     * 表尾控件
+     */
     footers?: Control[];
+    /**
+     * 当前页码
+     */
     pageIndex: number;
+    /**
+     * 每页条数
+     */
     pageSize: number;
+    /**
+     * 每页条数选项
+     */
     pageSizeOptions: number[];
+    /**
+     * 总条数
+     */
+    totalCount: number;
+}
+declare class ListControlProperty<Mode extends MODE | 'Schema', Control extends object = ControlType<Mode>> extends Property implements ListControlPropertyInterface<Mode, Control> {
+    /**
+     * 表头控件
+     */
+    headers: Control[];
+    /**
+     * 表尾控件
+     */
+    footers?: Control[];
+    /**
+     * 当前页码
+     */
+    pageIndex: number;
+    /**
+     * 每页条数
+     */
+    pageSize: number;
+    /**
+     * 每页条数选项
+     */
+    pageSizeOptions: number[];
+    /**
+     * 总条数
+     */
     totalCount: number;
     constructor(parent: DesignerListControl | RuntimeListControl, props?: Partial<ListControlProperty<Mode> & {
         headers: Control[];
@@ -15,4 +64,4 @@ declare class ListControlProperty<Mode extends MODE | 'Schema', Control extends
     }>, mode?: MODE);
 }
 export default ListControlProperty;
-export { ListControlProperty };
+export { ListControlProperty, ListControlPropertyInterface };

package/dist/types/common/SearchViewControl/property.d.ts

@@ -1,8 +1,21 @@
-import { LayoutControlProperty } from '../LayoutControl';
+/**
+ * name: base_search_control_property
+ * description: 查询控件基础属性定义。提供查询视图的数据项绑定配置，用于搜索区域控件与数据字段建立关联。
+ */
+import { LayoutControlProperty, LayoutControlPropertyInterface } from '../LayoutControl';
 import { DataBind } from '../../framework';
-declare class SearchControlProperty extends LayoutControlProperty {
+interface SearchControlPropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 绑定数据项
+     */
+    dataBind: DataBind;
+}
+declare class SearchControlProperty extends LayoutControlProperty implements SearchControlPropertyInterface {
+    /**
+     * 绑定数据项
+     */
     dataBind: DataBind;
     constructor(props?: Partial<SearchControlProperty>);
 }
 export default SearchControlProperty;
-export { SearchControlProperty };
+export { SearchControlProperty, SearchControlPropertyInterface };

package/dist/types/common/WrapControl/property.d.ts

@@ -1,6 +1,12 @@
-import { LayoutControlProperty } from '../LayoutControl';
-declare class WrapControlProperty extends LayoutControlProperty {
+/**
+ * name: base_wrap_control_property
+ * description: 包裹控件基础属性定义。继承布局属性能力，为外层包裹类控件提供统一的属性模型。
+ */
+import { LayoutControlProperty, LayoutControlPropertyInterface } from '../LayoutControl';
+interface WrapControlPropertyInterface extends LayoutControlPropertyInterface {
+}
+declare class WrapControlProperty extends LayoutControlProperty implements WrapControlPropertyInterface {
     constructor(props?: Partial<WrapControlProperty>);
 }
 export default WrapControlProperty;
-export { WrapControlProperty };
+export { WrapControlProperty, WrapControlPropertyInterface };