@sdata/web-vue 1.11.1 → 1.12.0

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);
 		}

package/es/grid/grid-col.vue_vue_type_script_lang.js

@@ -1,4 +1,4 @@
-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 { isNumber, isObject, isString } from "../_utils/is.js";
 import pick from "../_utils/pick.js";
@@ -19,18 +19,59 @@ function getAllowableFlexValue(flexValue) {
 var grid_col_vue_vue_type_script_lang_default = defineComponent({
 	name: "Col",
 	props: {
+		/**
+		* @zh 栅格占位格数
+		* @en Number of grid space
+		*/
 		span: {
 			type: Number,
 			default: 24
 		},
+		/**
+		* @zh 栅格左侧的间隔格数，间隔内不可以有栅格
+		* @en The number of grids on the left side of the grid. There can be no grids in the grid.
+		*/
 		offset: { type: Number },
+		/**
+		* @zh 对元素进行排序
+		* @en Sort elements
+		*/
 		order: { type: Number },
+		/**
+		* @zh < 576px 响应式栅格
+		* @en <576px responsive grid
+		*/
 		xs: { type: [Number, Object] },
+		/**
+		* @zh >= 576px 响应式栅格
+		* @en >= 576px responsive grid
+		*/
 		sm: { type: [Number, Object] },
+		/**
+		* @zh >= 768px 响应式栅格
+		* @en >= 768px responsive grid
+		*/
 		md: { type: [Number, Object] },
+		/**
+		* @zh >= 992px 响应式栅格
+		* @en >= 992px responsive grid
+		*/
 		lg: { type: [Number, Object] },
+		/**
+		* @zh >= 1200px 响应式栅格
+		* @en >= 1200px responsive grid
+		*/
 		xl: { type: [Number, Object] },
+		/**
+		* @zh >= 1600px 响应式栅格
+		* @en >= 1600px responsive grid
+		*/
 		xxl: { type: [Number, Object] },
+		/**
+		* @zh 设置 flex 布局属性
+		* @en Set flex layout properties
+		* @version 2.10.0
+		*/
 		flex: { type: [Number, String] }
 	},
 	setup(props) {

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

@@ -1,4 +1,4 @@
-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 { useIndex } from "../_hooks/use-index.js";
 import { useResponsiveState } from "./hook/use-responsive-state.js";
@@ -14,14 +14,26 @@ import { computed, defineComponent, inject, onUnmounted, ref, toRefs, watchEffec
 var grid_item_vue_vue_type_script_lang_default = defineComponent({
 	name: "GridItem",
 	props: {
+		/**
+		* @zh 跨越的格数
+		* @en Number of grids spanned
+		*/
 		span: {
 			type: [Number, Object],
 			default: 1
 		},
+		/**
+		* @zh 左侧的间隔格数
+		* @en Number of grids on the left
+		*/
 		offset: {
 			type: [Number, Object],
 			default: 0
 		},
+		/**
+		* @zh 是否是后缀元素
+		* @en Is it a suffix element
+		*/
 		suffix: {
 			type: Boolean,
 			default: false

package/es/grid/grid-row.vue_vue_type_script_lang.js

@@ -6,6 +6,10 @@ import { computed, defineComponent, provide, reactive, toRefs } from "vue";
 var grid_row_vue_vue_type_script_lang_default = defineComponent({
 	name: "Row",
 	props: {
+		/**
+		* @zh 栅格间隔，单位是`px` 栅格间隔。可传入响应式对象写法 { xs: 4, sm: 6, md: 12}，传入数组 [ 水平间距， 垂直间距 ] 来设置两个方向。
+		* @en Grid interval in `px`. Pass in the responsive object like {xs: 4, sm: 6, md: 12}. Pass in the array [horizontal spacing, vertical spacing] to set two directions.
+		*/
 		gutter: {
 			type: [
 				Number,
@@ -14,15 +18,32 @@ var grid_row_vue_vue_type_script_lang_default = defineComponent({
 			],
 			default: 0
 		},
+		/**
+		* @zh 水平对齐方式 (`justify-content`)
+		* @en Horizontal alignment (`justify-content`)
+		*/
 		justify: {
 			type: String,
 			default: "start"
 		},
+		/**
+		* @zh 竖直对齐方式 ( `align-items` )
+		* @en Vertical alignment (`align-items`)
+		*/
 		align: {
 			type: String,
 			default: "start"
 		},
+		/**
+		* @zh 开启这个选项`Row`和`Col`都会被当作div而不会附带任何Grid相关的类和样式
+		* @en Enabling this option `Row` and `Col` will be treated as divs without any Grid-related classes and styles
+		*/
 		div: { type: Boolean },
+		/**
+		* @zh `Col` 是否支持换行
+		* @en Whether `Col` can wrap onto multiple lines
+		* @version 2.13.0
+		*/
 		wrap: {
 			type: Boolean,
 			default: true

package/es/grid/grid.vue_vue_type_script_lang.js

@@ -12,22 +12,42 @@ import { computed, defineComponent, provide, reactive, toRefs, watchEffect } fro
 var grid_vue_vue_type_script_lang_default = defineComponent({
 	name: "Grid",
 	props: {
+		/**
+		* @zh 每一行展示的列数
+		* @en Number of columns displayed in each row
+		*/
 		cols: {
 			type: [Number, Object],
 			default: 24
 		},
+		/**
+		* @zh 行与行之间的间距
+		* @en The space in row-to-row
+		*/
 		rowGap: {
 			type: [Number, Object],
 			default: 0
 		},
+		/**
+		* @zh 列与列之间的间距
+		* @en The space in column-to-column
+		*/
 		colGap: {
 			type: [Number, Object],
 			default: 0
 		},
+		/**
+		* @zh 是否折叠
+		* @en Whether to collapsed
+		*/
 		collapsed: {
 			type: Boolean,
 			default: false
 		},
+		/**
+		* @zh 折叠时显示的行数
+		* @en Number of rows displayed when collapsed
+		*/
 		collapsedRows: {
 			type: Number,
 			default: 1

package/es/icon.js

@@ -2,7 +2,7 @@ import { computed, createElementBlock, createElementVNode, createStaticVNode, de
 //#region components/config-provider/context.ts
 var configProviderInjectionKey = Symbol("SDConfigProvider");
 //#endregion
-//#region \0@oxc-project+runtime@0.124.0/helpers/typeof.js
+//#region \0@oxc-project+runtime@0.130.0/helpers/typeof.js
 function _typeof(o) {
 	"@babel/helpers - typeof";
 	return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function(o) {
@@ -12,7 +12,7 @@ function _typeof(o) {
 	}, _typeof(o);
 }
 //#endregion
-//#region \0@oxc-project+runtime@0.124.0/helpers/toPrimitive.js
+//#region \0@oxc-project+runtime@0.130.0/helpers/toPrimitive.js
 function toPrimitive(t, r) {
 	if ("object" != _typeof(t) || !t) return t;
 	var e = t[Symbol.toPrimitive];
@@ -24,13 +24,13 @@ function toPrimitive(t, r) {
 	return ("string" === r ? String : Number)(t);
 }
 //#endregion
-//#region \0@oxc-project+runtime@0.124.0/helpers/toPropertyKey.js
+//#region \0@oxc-project+runtime@0.130.0/helpers/toPropertyKey.js
 function toPropertyKey(t) {
 	var i = toPrimitive(t, "string");
 	return "symbol" == _typeof(i) ? i : i + "";
 }
 //#endregion
-//#region \0@oxc-project+runtime@0.124.0/helpers/defineProperty.js
+//#region \0@oxc-project+runtime@0.130.0/helpers/defineProperty.js
 function _defineProperty(e, r, t) {
 	return (r = toPropertyKey(r)) in e ? Object.defineProperty(e, r, {
 		value: t,
@@ -40,7 +40,7 @@ function _defineProperty(e, r, t) {
 	}) : e[r] = t, e;
 }
 //#endregion
-//#region \0@oxc-project+runtime@0.124.0/helpers/objectSpread2.js
+//#region \0@oxc-project+runtime@0.130.0/helpers/objectSpread2.js
 function ownKeys(e, r) {
 	var t = Object.keys(e);
 	if (Object.getOwnPropertySymbols) {

package/es/image/image.js

@@ -1,4 +1,4 @@
-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 _plugin_vue_export_helper_default from "../_virtual/_plugin-vue_export-helper.js";
 import image_vue_vue_type_script_lang_default from "./image.vue_vue_type_script_lang.js";
 import { createBlock, createCommentVNode, createElementBlock, createElementVNode, createSlots, createVNode, mergeProps, normalizeClass, normalizeStyle, openBlock, renderSlot, resolveComponent, toDisplayString, withCtx } from "vue";