@sdata/web-vue 1.11.1 → 1.13.0

package/es/form/form-item.vue.d.ts

@@ -56,8 +56,8 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
     labelColStyle: ObjectConstructor;
     wrapperColStyle: ObjectConstructor;
     rowProps: ObjectConstructor;
-    rowClass: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
-    contentClass: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+    rowClass: (ObjectConstructor | StringConstructor | ArrayConstructor)[];
+    contentClass: (ObjectConstructor | StringConstructor | ArrayConstructor)[];
     contentFlex: {
         type: BooleanConstructor;
         default: boolean;
@@ -150,8 +150,8 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
     labelColStyle: ObjectConstructor;
     wrapperColStyle: ObjectConstructor;
     rowProps: ObjectConstructor;
-    rowClass: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
-    contentClass: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+    rowClass: (ObjectConstructor | StringConstructor | ArrayConstructor)[];
+    contentClass: (ObjectConstructor | StringConstructor | ArrayConstructor)[];
     contentFlex: {
         type: BooleanConstructor;
         default: boolean;
@@ -530,13 +530,13 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
                             default: boolean;
                         };
                         contentClass: {
-                            type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+                            type: (ObjectConstructor | StringConstructor | ArrayConstructor)[];
                         };
                         contentStyle: {
                             type: PropType<import("vue").CSSProperties>;
                         };
                         arrowClass: {
-                            type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+                            type: (ObjectConstructor | StringConstructor | ArrayConstructor)[];
                         };
                         arrowStyle: {
                             type: PropType<import("vue").CSSProperties>;
@@ -594,7 +594,7 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
                             default: boolean;
                         };
                         openedClass: {
-                            type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+                            type: (ObjectConstructor | StringConstructor | ArrayConstructor)[];
                         };
                         autoFitPosition: {
                             type: BooleanConstructor;
@@ -617,8 +617,8 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
                             default: number;
                         };
                     }>> & Readonly<{
-                        onResize?: (() => any) | undefined;
                         onHide?: (() => any) | undefined;
+                        onResize?: (() => any) | undefined;
                         "onUpdate:popupVisible"?: ((_visible: boolean) => any) | undefined;
                         onPopupVisibleChange?: ((_visible: boolean) => any) | undefined;
                         onShow?: (() => any) | undefined;
@@ -721,13 +721,13 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
                             default: boolean;
                         };
                         contentClass: {
-                            type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+                            type: (ObjectConstructor | StringConstructor | ArrayConstructor)[];
                         };
                         contentStyle: {
                             type: PropType<import("vue").CSSProperties>;
                         };
                         arrowClass: {
-                            type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+                            type: (ObjectConstructor | StringConstructor | ArrayConstructor)[];
                         };
                         arrowStyle: {
                             type: PropType<import("vue").CSSProperties>;
@@ -785,7 +785,7 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
                             default: boolean;
                         };
                         openedClass: {
-                            type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+                            type: (ObjectConstructor | StringConstructor | ArrayConstructor)[];
                         };
                         autoFitPosition: {
                             type: BooleanConstructor;
@@ -808,8 +808,8 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
                             default: number;
                         };
                     }>> & Readonly<{
-                        onResize?: (() => any) | undefined;
                         onHide?: (() => any) | undefined;
+                        onResize?: (() => any) | undefined;
                         "onUpdate:popupVisible"?: ((_visible: boolean) => any) | undefined;
                         onPopupVisibleChange?: ((_visible: boolean) => any) | undefined;
                         onShow?: (() => any) | undefined;
@@ -903,13 +903,13 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
                         default: boolean;
                     };
                     contentClass: {
-                        type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+                        type: (ObjectConstructor | StringConstructor | ArrayConstructor)[];
                     };
                     contentStyle: {
                         type: PropType<import("vue").CSSProperties>;
                     };
                     arrowClass: {
-                        type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+                        type: (ObjectConstructor | StringConstructor | ArrayConstructor)[];
                     };
                     arrowStyle: {
                         type: PropType<import("vue").CSSProperties>;
@@ -967,7 +967,7 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
                         default: boolean;
                     };
                     openedClass: {
-                        type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+                        type: (ObjectConstructor | StringConstructor | ArrayConstructor)[];
                     };
                     autoFitPosition: {
                         type: BooleanConstructor;
@@ -990,8 +990,8 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
                         default: number;
                     };
                 }>> & Readonly<{
-                    onResize?: (() => any) | undefined;
                     onHide?: (() => any) | undefined;
+                    onResize?: (() => any) | undefined;
                     "onUpdate:popupVisible"?: ((_visible: boolean) => any) | undefined;
                     onPopupVisibleChange?: ((_visible: boolean) => any) | undefined;
                     onShow?: (() => any) | undefined;
@@ -1220,13 +1220,13 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
                         default: boolean;
                     };
                     contentClass: {
-                        type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+                        type: (ObjectConstructor | StringConstructor | ArrayConstructor)[];
                     };
                     contentStyle: {
                         type: PropType<import("vue").CSSProperties>;
                     };
                     arrowClass: {
-                        type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+                        type: (ObjectConstructor | StringConstructor | ArrayConstructor)[];
                     };
                     arrowStyle: {
                         type: PropType<import("vue").CSSProperties>;
@@ -1284,7 +1284,7 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
                         default: boolean;
                     };
                     openedClass: {
-                        type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+                        type: (ObjectConstructor | StringConstructor | ArrayConstructor)[];
                     };
                     autoFitPosition: {
                         type: BooleanConstructor;
@@ -1307,8 +1307,8 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
                         default: number;
                     };
                 }>> & Readonly<{
-                    onResize?: (() => any) | undefined;
                     onHide?: (() => any) | undefined;
+                    onResize?: (() => any) | undefined;
                     "onUpdate:popupVisible"?: ((_visible: boolean) => any) | undefined;
                     onPopupVisibleChange?: ((_visible: boolean) => any) | undefined;
                     onShow?: (() => any) | undefined;
@@ -1411,13 +1411,13 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
                         default: boolean;
                     };
                     contentClass: {
-                        type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+                        type: (ObjectConstructor | StringConstructor | ArrayConstructor)[];
                     };
                     contentStyle: {
                         type: PropType<import("vue").CSSProperties>;
                     };
                     arrowClass: {
-                        type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+                        type: (ObjectConstructor | StringConstructor | ArrayConstructor)[];
                     };
                     arrowStyle: {
                         type: PropType<import("vue").CSSProperties>;
@@ -1475,7 +1475,7 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
                         default: boolean;
                     };
                     openedClass: {
-                        type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+                        type: (ObjectConstructor | StringConstructor | ArrayConstructor)[];
                     };
                     autoFitPosition: {
                         type: BooleanConstructor;
@@ -1498,8 +1498,8 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
                         default: number;
                     };
                 }>> & Readonly<{
-                    onResize?: (() => any) | undefined;
                     onHide?: (() => any) | undefined;
+                    onResize?: (() => any) | undefined;
                     "onUpdate:popupVisible"?: ((_visible: boolean) => any) | undefined;
                     onPopupVisibleChange?: ((_visible: boolean) => any) | undefined;
                     onShow?: (() => any) | undefined;
@@ -1593,13 +1593,13 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
                     default: boolean;
                 };
                 contentClass: {
-                    type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+                    type: (ObjectConstructor | StringConstructor | ArrayConstructor)[];
                 };
                 contentStyle: {
                     type: PropType<import("vue").CSSProperties>;
                 };
                 arrowClass: {
-                    type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+                    type: (ObjectConstructor | StringConstructor | ArrayConstructor)[];
                 };
                 arrowStyle: {
                     type: PropType<import("vue").CSSProperties>;
@@ -1657,7 +1657,7 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
                     default: boolean;
                 };
                 openedClass: {
-                    type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+                    type: (ObjectConstructor | StringConstructor | ArrayConstructor)[];
                 };
                 autoFitPosition: {
                     type: BooleanConstructor;
@@ -1680,8 +1680,8 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
                     default: number;
                 };
             }>> & Readonly<{
-                onResize?: (() => any) | undefined;
                 onHide?: (() => any) | undefined;
+                onResize?: (() => any) | undefined;
                 "onUpdate:popupVisible"?: ((_visible: boolean) => any) | undefined;
                 onPopupVisibleChange?: ((_visible: boolean) => any) | undefined;
                 onShow?: (() => any) | undefined;

package/es/form/form-item.vue_vue_type_script_lang.js

@@ -1,5 +1,5 @@
 import { formInjectionKey, formItemInjectionKey } from "./context.js";
-import { _objectSpread2 } from "../_virtual/_@oxc-project_runtime@0.124.0/helpers/objectSpread2.js";
+import { _objectSpread2 } from "../_virtual/_@oxc-project_runtime@0.130.0/helpers/objectSpread2.js";
 import { getPrefixCls } from "../_utils/global-config.js";
 import { useI18n } from "../locale/index.js";
 import { getValueByPath, setValueByPath } from "../_utils/get-value-by-path.js";
@@ -8,8 +8,8 @@ import grid_row_default from "../grid/grid-row.js";
 import form_item_label_default from "./form-item-label.js";
 import form_item_message_default from "./form-item-message.js";
 import { getFinalValidateMessage, getFinalValidateStatus, getFormElementId } from "./utils.js";
-import { _objectDestructuringEmpty } from "../_virtual/_@oxc-project_runtime@0.124.0/helpers/objectDestructuringEmpty.js";
-import { _extends } from "../_virtual/_@oxc-project_runtime@0.124.0/helpers/extends.js";
+import { _objectDestructuringEmpty } from "../_virtual/_@oxc-project_runtime@0.130.0/helpers/objectDestructuringEmpty.js";
+import { _extends } from "../_virtual/_@oxc-project_runtime@0.130.0/helpers/extends.js";
 import { computed, defineComponent, inject, nextTick, onBeforeUnmount, onMounted, provide, reactive, ref, toRef, toRefs } from "vue";
 import { Schema } from "b-validate";
 //#region components/form/form-item.vue?vue&type=script&lang.ts
@@ -22,82 +22,225 @@ var form_item_vue_vue_type_script_lang_default = defineComponent({
 		FormItemMessage: form_item_message_default
 	},
 	props: {
+		/**
+		* @zh 表单元素在数据对象中的path（数据项必填）
+		* @en The path of the form element in the data object (required for the data item)
+		*/
 		field: {
 			type: String,
 			default: ""
 		},
+		/**
+		* @zh 标签的文本
+		* @en Label text
+		*/
 		label: String,
+		/**
+		* @zh 提示内容
+		* @en Tooltip text
+		* @version 2.41.0
+		*/
 		tooltip: { type: String },
+		/**
+		* @zh 是否显示冒号
+		* @en Whether to show a colon
+		*/
 		showColon: {
 			type: Boolean,
 			default: false
 		},
+		/**
+		* @zh 是否去除样式
+		* @en Whether to remove the style
+		*/
 		noStyle: {
 			type: Boolean,
 			default: false
 		},
+		/**
+		* @zh 是否禁用
+		* @en Whether to disable
+		*/
 		disabled: {
 			type: Boolean,
 			default: void 0
 		},
+		/**
+		* @zh 帮助文案
+		* @en Help copywriting
+		*/
 		help: String,
+		/**
+		* @zh 额外显示的文案
+		* @en Additional display copy
+		*/
 		extra: String,
+		/**
+		* @zh 是否必须填写
+		* @en Is it required
+		*/
 		required: {
 			type: Boolean,
 			default: false
 		},
+		/**
+		* @zh 可选择将星号置于 label 前/后
+		* @en Optionally place an asterisk before/after the label
+		* @values 'start', 'end'
+		* @version 2.41.0
+		*/
 		asteriskPosition: {
 			type: String,
 			default: "start"
 		},
+		/**
+		* @zh 表单项校验规则（优先级高于 form 的 rules）
+		* @en Form item validation rules (The priority is higher than the rules of form)
+		*/
 		rules: { type: [Object, Array] },
+		/**
+		* @zh 校验状态
+		* @en Validate status
+		* @values 'success', 'warning', 'error', 'validating'
+		*/
 		validateStatus: { type: String },
+		/**
+		* @zh 触发校验的事件
+		* @en The event that triggers the verification
+		* @values 'change', 'input', 'focus', 'blur'
+		*/
 		validateTrigger: {
 			type: [String, Array],
 			default: "change"
 		},
+		/**
+		* @zh 标签元素布局选项。参数同 `<col>` 组件一致
+		* @en Label element layout options. The parameters are the same as the `<col>` component
+		*/
 		labelColProps: Object,
+		/**
+		* @zh 表单控件布局选项。参数同 `<col>` 组件一致
+		* @en Form control layout options. The parameters are the same as the `<col>` component
+		*/
 		wrapperColProps: Object,
+		/**
+		* @zh 是否隐藏标签
+		* @en Whether to hide the label
+		*/
 		hideLabel: {
 			type: Boolean,
 			default: false
 		},
+		/**
+		* @zh 是否隐藏星号
+		* @en Whether to hide the asterisk
+		*/
 		hideAsterisk: {
 			type: Boolean,
 			default: false
 		},
+		/**
+		* @zh 标签元素布局组件的 style
+		* @en The style of the label element layout component
+		* @version 2.10.0
+		*/
 		labelColStyle: Object,
+		/**
+		* @zh 表单控件布局组件的 style
+		* @en The style of the form control layout component
+		* @version 2.10.0
+		*/
 		wrapperColStyle: Object,
+		/**
+		* @zh 表单项布局选项。参数同 `<row>` 组件一致
+		* @en Form item layout options. The parameters are the same as the `<row>` component
+		* @version 2.10.0
+		*/
 		rowProps: Object,
+		/**
+		* @zh 表单项布局组件的 class
+		* @en The class of the form item layout component
+		* @version 2.10.0
+		*/
 		rowClass: [
 			String,
 			Array,
 			Object
 		],
+		/**
+		* @zh 表单控件包裹层的 class
+		* @en The class of the form control wrapping layer
+		* @version 2.10.0
+		*/
 		contentClass: [
 			String,
 			Array,
 			Object
 		],
+		/**
+		* @zh 内容层是否开启 flex 布局
+		* @en Whether to enable flex layout in the content layer
+		* @version 2.13.0
+		*/
 		contentFlex: {
 			type: Boolean,
 			default: true
 		},
+		/**
+		* @zh （已废除）控制传递到子元素上的 Props。默认包括 disabled、error、size、 events 和 FormItem 上的额外属性。2.18.0 版本废除
+		* @en (Repealed) Control the Props passed to the child element. The default includes disabled, error, size, events and additional attributes on FormItem. Version 2.18.0 deprecated
+		* @version 2.13.0
+		*/
 		mergeProps: {
 			type: [Boolean, Function],
 			default: true
 		},
+		/**
+		* @zh 设置标签 `Col` 组件的 flex 属性。设置时表单 `Col` 组件的 flex 属性会被设置为 `auto`。
+		* @en Set the flex property of the label `Col` component. When set, the flex property of the form `Col` component will be set to `auto`.
+		* @version 2.13.0
+		*/
 		labelColFlex: { type: [Number, String] },
+		/**
+		* @zh 是否显示表单控件的反馈图标
+		* @en Whether to show the feedback icon for the form control
+		* @version 2.16.0
+		*/
 		feedback: {
 			type: Boolean,
 			default: false
 		},
+		/**
+		* @zh 表单项标签渲染的元素
+		* @en The element that the form item label renders
+		* @version 2.22.0
+		*/
 		labelComponent: {
 			type: String,
 			default: "label"
 		},
+		/**
+		* @zh 表单项元素的属性
+		* @en Attributes of the form item element
+		* @version 2.22.0
+		*/
 		labelAttrs: Object
 	},
+	/**
+	* @zh 标签
+	* @en Label
+	* @slot label
+	*/
+	/**
+	* @zh 帮助信息
+	* @en Help message
+	* @slot help
+	*/
+	/**
+	* @zh 额外内容
+	* @en Extra content
+	* @slot extra
+	*/
 	setup(props) {
 		const prefixCls = getPrefixCls("form-item");
 		const { field } = toRefs(props);

package/es/form/form.vue_vue_type_script_lang.js

@@ -8,15 +8,34 @@ import { computed, defineComponent, provide, reactive, ref, toRefs } from "vue";
 var form_vue_vue_type_script_lang_default = defineComponent({
 	name: "Form",
 	props: {
+		/**
+		* @zh 表单数据对象
+		* @en Form data object
+		*/
 		model: {
 			type: Object,
 			required: true
 		},
+		/**
+		* @zh 表单的布局方式，包括水平、垂直、多列
+		* @en The layout of the form, including horizontal, vertical, and multi-column
+		* @values 'horizontal', 'vertical', 'inline'
+		*/
 		layout: {
 			type: String,
 			default: "horizontal"
 		},
+		/**
+		* @zh 表单控件的尺寸
+		* @en The size of the form
+		* @values 'mini','small','medium','large'
+		* @defaultValue 'medium'
+		*/
 		size: { type: String },
+		/**
+		* @zh 标签元素布局选项。参数同 `<col>` 组件一致
+		* @en Label element layout options. The parameters are the same as the `<col>` component
+		*/
 		labelColProps: {
 			type: Object,
 			default: () => ({
@@ -24,6 +43,10 @@ var form_vue_vue_type_script_lang_default = defineComponent({
 				offset: 0
 			})
 		},
+		/**
+		* @zh 表单控件布局选项。参数同 `<col>` 组件一致
+		* @en Form control layout options. The parameters are the same as the `<col>` component
+		*/
 		wrapperColProps: {
 			type: Object,
 			default: () => ({
@@ -33,28 +56,73 @@ var form_vue_vue_type_script_lang_default = defineComponent({
 		},
 		labelColStyle: Object,
 		wrapperColStyle: Object,
+		/**
+		* @zh 标签的对齐方向
+		* @en Alignment direction of the label
+		* @values 'left', 'right'
+		*/
 		labelAlign: {
 			type: String,
 			default: "right"
 		},
+		/**
+		* @zh 是否禁用表单
+		* @en Whether to disable the form
+		*/
 		disabled: {
 			type: Boolean,
 			default: void 0
 		},
+		/**
+		* @zh 表单项校验规则
+		* @en Form item validation rules
+		*/
 		rules: { type: Object },
+		/**
+		* @zh 是否开启自动标签宽度，仅在 `layout="horizontal"` 下生效。
+		* @en Whether to enable automatic label width, it only takes effect under `layout="horizontal"`.
+		* @version 2.13.0
+		*/
 		autoLabelWidth: {
 			type: Boolean,
 			default: false
 		},
+		/**
+		* @zh 表单 `id` 属性和表单控件 `id` 前缀
+		* @en Form `id` attribute and form control `id` prefix
+		*/
 		id: { type: String },
+		/**
+		* @zh 验证失败后滚动到第一个错误字段
+		* @en Scroll to the first error field after verification fails
+		* @version 2.51.0
+		*/
 		scrollToFirstError: {
 			type: Boolean,
 			default: false
 		}
 	},
 	emits: {
+		/**
+		* @zh 表单提交时触发
+		* @en Triggered when the form is submitted
+		* @param {{values: Record<string, any>; errors: Record<string, ValidatedError> | undefined}} data
+		* @param {Event} ev
+		*/
 		submit: (_data, _ev) => true,
+		/**
+		* @zh 验证成功时触发
+		* @en Triggered when verification is successful
+		* @param {Record<string, any>} values
+		* @param {Event} ev
+		*/
 		submitSuccess: (_values, _ev) => true,
+		/**
+		* @zh 验证失败时触发
+		* @en Triggered when verification failed
+		* @param {{values: Record<string, any>; errors: Record<string, ValidatedError>}} data
+		* @param {Event} ev
+		*/
 		submitFailed: (_data, _ev) => true
 	},
 	setup(props, { emit }) {
@@ -209,21 +277,61 @@ var form_vue_vue_type_script_lang_default = defineComponent({
 		};
 	},
 	methods: {
+		/**
+		* @zh 校验全部表单数据
+		* @en Verify all form data
+		* @public
+		* @param {(errors: undefined | Record<string, ValidatedError>) => void} callback
+		* @returns {Promise<undefined | Record<string, ValidatedError>>}
+		*/
 		validate(callback) {
 			return this.innerValidate(callback);
 		},
+		/**
+		* @zh 校验部分表单数据
+		* @en Validate part of the form data
+		* @public
+		* @param {string | string[]} field
+		* @param {(errors: undefined | Record<string, ValidatedError>) => void} callback
+		* @returns {Promise<undefined | Record<string, ValidatedError>>}
+		*/
 		validateField(field, callback) {
 			return this.innerValidateField(field, callback);
 		},
+		/**
+		* @zh 重置表单数据
+		* @en Reset form data
+		* @public
+		* @param {string | string[]} field
+		*/
 		resetFields(field) {
 			return this.innerResetFields(field);
 		},
+		/**
+		* @zh 清除校验状态
+		* @en Clear verification status
+		* @public
+		* @param {string | string[]} field
+		*/
 		clearValidate(field) {
 			return this.innerClearValidate(field);
 		},
+		/**
+		* @zh 设置表单项的值和状态
+		* @en Set the value and status of the form item
+		* @param {Record<string, FieldData>} data
+		* @public
+		*/
 		setFields(data) {
 			return this.innerSetFields(data);
 		},
+		/**
+		* @zh 滚动到指定表单项
+		* @en Scroll to the specified form item
+		* @param {string} field
+		* @public
+		* @version 2.51.0
+		*/
 		scrollToField(field) {
 			return this.innerScrollToField(field);
 		}