@byteluck-fe/model-driven-core 7.0.0-beta.4 → 7.0.0-beta.8

package/dist/esm/common/BaseControl/property.js

@@ -1,4 +1,7 @@
-function _assert_this_initialized(self) {
+/**
+ * name: base_property
+ * description: 基础属性定义。提供控件通用的隐藏状态、类名、样式、标题和默认状态配置，是表单、布局、列表等属性模型的公共基类。
+ */ function _assert_this_initialized(self) {
     if (self === void 0) {
         throw new ReferenceError("this hasn't been initialised - super() hasn't been called");
     }
@@ -141,11 +144,30 @@ var PropertyRuntimeRules = /*#__PURE__*/ function(Array1) {
     var caption = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : '';
     _class_call_check(this, Property);
     var _ref, _ref1;
-    _define_property(this, "isHide", void 0);
-    _define_property(this, "className", void 0);
-    _define_property(this, "style", void 0);
-    _define_property(this, "caption", void 0);
-    _define_property(this, "defaultState", void 0);
+    /**
+   * 是否隐藏
+   * @public
+   * @defaultValue false
+   */ _define_property(this, "isHide", void 0);
+    /**
+   * 类名
+   * @public
+   * @noSchema
+   */ _define_property(this, "className", void 0);
+    /**
+   * 样式
+   * @public
+   * @noSchema
+   */ _define_property(this, "style", void 0);
+    /**
+   * 标题
+   * @public
+   * @defaultValue ''
+   */ _define_property(this, "caption", void 0);
+    /**
+   * 默认状态
+   * @public
+   */ _define_property(this, "defaultState", void 0);
     this.isHide = (_ref = props === null || props === void 0 ? void 0 : props.isHide) !== null && _ref !== void 0 ? _ref : false;
     this.style = new BaseStyle(props === null || props === void 0 ? void 0 : props.style);
     this.caption = (_ref1 = props === null || props === void 0 ? void 0 : props.caption) !== null && _ref1 !== void 0 ? _ref1 : caption;

package/dist/esm/common/ColumnControl/property.js

@@ -70,7 +70,10 @@ function _is_native_reflect_construct() {
         return !!result;
     })();
 }
-import { Property, PropertyRules } from '../BaseControl';
+/**
+ * name: base_column_control_property
+ * description: 列控件基础属性定义。提供列宽、标题、数据绑定、自适应宽度、冻结、排序、对齐、跨列、自动高度和子控件配置。
+ */ import { Property, PropertyRules } from '../BaseControl';
 import { initOptionAndDataSourceRules } from '../initOptionAndDataSourceRules';
 import { DataBind, AutoWidth } from '../../framework';
 import { getLocaleText } from '@byteluck-fe/locale-message';
@@ -108,7 +111,34 @@ var ColumnControlPropertyRules = /*#__PURE__*/ function(PropertyRules) {
         var _ref, _ref1, _ref2, _ref3, _ref4;
         _this = _call_super(this, ColumnControlProperty, [
             props
-        ]), _define_property(_this, "widthType", void 0), _define_property(_this, "width", void 0), _define_property(_this, "caption", void 0), _define_property(_this, "dataBind", void 0), _define_property(_this, "autoWidth", void 0), _define_property(_this, "fixed", void 0), _define_property(_this, "sort", void 0), _define_property(_this, "align", void 0), _define_property(_this, "colSpan", void 0), _define_property(_this, "autoHeight", void 0), _define_property(_this, "children", void 0);
+        ]), /**
+   * 宽度类型
+   * @defaultValue 'auto'
+   */ _define_property(_this, "widthType", void 0), /**
+   * 宽度
+   * @defaultValue 150
+   */ _define_property(_this, "width", void 0), /**
+   * 标题
+   */ _define_property(_this, "caption", void 0), /**
+   * 绑定数据项
+   */ _define_property(_this, "dataBind", void 0), /**
+   * 自适应页面宽度
+   */ _define_property(_this, "autoWidth", void 0), /**
+   * 冻结
+   * @defaultValue 'none'
+   */ _define_property(_this, "fixed", void 0), /**
+   * 表头排序
+   * @defaultValue true
+   */ _define_property(_this, "sort", void 0), /**
+   * 对齐
+   */ _define_property(_this, "align", void 0), /**
+   * @internal
+   */ _define_property(_this, "colSpan", void 0), /**
+   * 自动高度
+   * @defaultValue false
+   */ _define_property(_this, "autoHeight", void 0), /**
+   * 子控件
+   */ _define_property(_this, "children", void 0);
         _this.width = (_ref = props === null || props === void 0 ? void 0 : props.width) !== null && _ref !== void 0 ? _ref : 150;
         _this.widthType = (props === null || props === void 0 ? void 0 : props.widthType) || 'auto';
         _this.caption = (_ref1 = props === null || props === void 0 ? void 0 : props.caption) !== null && _ref1 !== void 0 ? _ref1 : '';

package/dist/esm/common/FormControl/property.js

@@ -1,4 +1,7 @@
-function _assert_this_initialized(self) {
+/**
+ * name: base_form_control_property
+ * description: 表单控件基础属性定义。提供字段绑定、标题展示、占位提示、默认值、必填校验、只读状态和气泡提示等表单通用配置。
+ */ function _assert_this_initialized(self) {
     if (self === void 0) {
         throw new ReferenceError("this hasn't been initialised - super() hasn't been called");
     }

package/dist/esm/common/LayoutControl/property.js

@@ -57,7 +57,10 @@ function _is_native_reflect_construct() {
         return !!result;
     })();
 }
-import { Property } from '../BaseControl';
+/**
+ * name: base_layout_control_property
+ * description: 布局控件基础属性定义。继承通用属性能力，为行、列、容器、页签等布局类控件提供统一的属性模型。
+ */ import { Property } from '../BaseControl';
 var LayoutControlProperty = /*#__PURE__*/ function(Property) {
     "use strict";
     _inherits(LayoutControlProperty, Property);

package/dist/esm/common/ListControl/property.js

@@ -70,7 +70,10 @@ function _is_native_reflect_construct() {
         return !!result;
     })();
 }
-import { Property } from '../BaseControl';
+/**
+ * name: base_list_control_property
+ * description: 列表控件基础属性定义。提供表头、表尾、分页页码、每页条数、分页选项和总条数等列表通用配置。
+ */ import { Property } from '../BaseControl';
 import { defineControlArrayToProperty } from '../ControlArray';
 var ListControlProperty = /*#__PURE__*/ function(Property) {
     "use strict";
@@ -81,7 +84,19 @@ var ListControlProperty = /*#__PURE__*/ function(Property) {
         var _ref, _ref1, _ref2, _ref3;
         _this = _call_super(this, ListControlProperty, [
             props
-        ]), _define_property(_this, "headers", void 0), _define_property(_this, "footers", void 0), _define_property(_this, "pageIndex", void 0), _define_property(_this, "pageSize", void 0), _define_property(_this, "pageSizeOptions", void 0), _define_property(_this, "totalCount", void 0);
+        ]), /**
+   * 表头控件
+   */ _define_property(_this, "headers", void 0), /**
+   * 表尾控件
+   */ _define_property(_this, "footers", void 0), /**
+   * 当前页码
+   */ _define_property(_this, "pageIndex", void 0), /**
+   * 每页条数
+   */ _define_property(_this, "pageSize", void 0), /**
+   * 每页条数选项
+   */ _define_property(_this, "pageSizeOptions", void 0), /**
+   * 总条数
+   */ _define_property(_this, "totalCount", void 0);
         defineControlArrayToProperty(_this, 'headers', props === null || props === void 0 ? void 0 : props.headers, parent, mode);
         defineControlArrayToProperty(_this, 'footers', props === null || props === void 0 ? void 0 : props.footers, parent);
         _this.pageIndex = (_ref = props === null || props === void 0 ? void 0 : props.pageIndex) !== null && _ref !== void 0 ? _ref : 1;

package/dist/esm/common/SearchViewControl/property.js

@@ -70,7 +70,10 @@ function _is_native_reflect_construct() {
         return !!result;
     })();
 }
-import { LayoutControlProperty } from '../LayoutControl';
+/**
+ * name: base_search_control_property
+ * description: 查询控件基础属性定义。提供查询视图的数据项绑定配置，用于搜索区域控件与数据字段建立关联。
+ */ import { LayoutControlProperty } from '../LayoutControl';
 import { DataBind } from '../../framework';
 var SearchControlProperty = /*#__PURE__*/ function(LayoutControlProperty) {
     "use strict";
@@ -80,7 +83,9 @@ var SearchControlProperty = /*#__PURE__*/ function(LayoutControlProperty) {
         var _this;
         _this = _call_super(this, SearchControlProperty, [
             props
-        ]), _define_property(_this, "dataBind", void 0);
+        ]), /**
+   * 绑定数据项
+   */ _define_property(_this, "dataBind", void 0);
         _this.dataBind = new DataBind(props === null || props === void 0 ? void 0 : props.dataBind);
         return _this;
     }

package/dist/esm/common/WrapControl/property.js

@@ -57,7 +57,10 @@ function _is_native_reflect_construct() {
         return !!result;
     })();
 }
-import { LayoutControlProperty } from '../LayoutControl';
+/**
+ * name: base_wrap_control_property
+ * description: 包裹控件基础属性定义。继承布局属性能力，为外层包裹类控件提供统一的属性模型。
+ */ import { LayoutControlProperty } from '../LayoutControl';
 var WrapControlProperty = /*#__PURE__*/ function(LayoutControlProperty) {
     "use strict";
     _inherits(WrapControlProperty, LayoutControlProperty);

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';
@@ -52,10 +56,34 @@ declare class Property implements PropertyInterface {
     static mode: MODE;
     static readonly Rules: typeof PropertyRules;
     static readonly RuntimeRules: typeof PropertyRuntimeRules;
+    /**
+     * 是否隐藏
+     * @public
+     * @defaultValue false
+     */
     isHide: boolean;
+    /**
+     * 类名
+     * @public
+     * @noSchema
+     */
     className?: string[];
+    /**
+     * 样式
+     * @public
+     * @noSchema
+     */
     style: BaseStyle;
+    /**
+     * 标题
+     * @public
+     * @defaultValue ''
+     */
     caption: string;
+    /**
+     * 默认状态
+     * @public
+     */
     defaultState: 'readonly' | 'default';
     constructor(props?: Partial<Property>, caption?: string);
 }

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

@@ -1,3 +1,7 @@
+/**
+ * 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';
@@ -63,16 +67,54 @@ interface ColumnControlPropertyInterface extends PropertyInterface {
  */
 declare class ColumnControlProperty extends Property implements ColumnControlPropertyInterface {
     static readonly Rules: typeof ColumnControlPropertyRules;
+    /**
+     * 宽度类型
+     * @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[];
     constructor(props?: Partial<ColumnControlProperty>);
 }

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

@@ -1,3 +1,7 @@
+/**
+ * name: base_layout_control_property
+ * description: 布局控件基础属性定义。继承通用属性能力，为行、列、容器、页签等布局类控件提供统一的属性模型。
+ */
 import { Property, PropertyInterface } from '../BaseControl';
 interface LayoutControlPropertyInterface extends PropertyInterface {
 }

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

@@ -1,3 +1,7 @@
+/**
+ * name: base_list_control_property
+ * description: 列表控件基础属性定义。提供表头、表尾、分页页码、每页条数、分页选项和总条数等列表通用配置。
+ */
 import { DesignerControl, Property, PropertyInterface, RuntimeControl } from '../BaseControl';
 import { ControlsKeys, BaseControlSchema, MODE } from '../../type';
 import { DesignerListControl } from './designer';
@@ -30,11 +34,29 @@ interface ListControlPropertyInterface<Mode extends MODE | 'Schema', Control ext
     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[];

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

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

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

@@ -1,3 +1,7 @@
+/**
+ * name: base_wrap_control_property
+ * description: 包裹控件基础属性定义。继承布局属性能力，为外层包裹类控件提供统一的属性模型。
+ */
 import { LayoutControlProperty, LayoutControlPropertyInterface } from '../LayoutControl';
 interface WrapControlPropertyInterface extends LayoutControlPropertyInterface {
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byteluck-fe/model-driven-core",
-  "version": "7.0.0-beta.4",
+  "version": "7.0.0-beta.8",
   "description": "model engine core",
   "author": "郝晨光 <2293885211@qq.com>",
   "homepage": "",
@@ -30,5 +30,5 @@
     "async-validator": "3.5.1",
     "tslib": "^2.1.0"
   },
-  "gitHead": "e2c32b376c328fe4c114106e071884f112c11f2e"
+  "gitHead": "06eb423735c35d0dbb0bb16f3d2030ac53f8633c"
 }