@sdata/web-vue 1.11.1 → 1.13.0

package/es/list/list.js

@@ -1,5 +1,5 @@
 import { configProviderInjectionKey } from "../config-provider/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 { isNumber } from "../_utils/is.js";
 import { getAllElements } from "../_utils/vue-utils.js";
@@ -21,49 +21,144 @@ function _isSlot(s) {
 var list_default = /* @__PURE__ */ defineComponent({
 	name: "List",
 	props: {
+		/**
+		* @zh 列表数据，需要和 `item` 插槽同时使用
+		* @en List data, need to be used with `item` slot at the same time
+		*/
 		data: { type: Array },
+		/**
+		* @zh 列表大小
+		* @en List size
+		*/
 		size: {
 			type: String,
 			default: "medium"
 		},
+		/**
+		* @zh 是否显示边框
+		* @en Whether to show the border
+		*/
 		bordered: {
 			type: Boolean,
 			default: true
 		},
+		/**
+		* @zh 是否显示分割线
+		* @en Whether to show the dividing line
+		*/
 		split: {
 			type: Boolean,
 			default: true
 		},
+		/**
+		* @zh 是否为加载中状态
+		* @en Whether it is loading state
+		*/
 		loading: {
 			type: Boolean,
 			default: false
 		},
+		/**
+		* @zh 是否显示选中样式
+		* @en Whether to display the selected style
+		*/
 		hoverable: {
 			type: Boolean,
 			default: false
 		},
+		/**
+		* @zh 列表分页配置
+		* @en List pagination configuration
+		*/
 		paginationProps: { type: Object },
+		/**
+		* @zh 列表栅格配置
+		* @en List grid configuration
+		*/
 		gridProps: { type: Object },
+		/**
+		* @zh 列表的最大高度
+		* @en Maximum height of the list
+		*/
 		maxHeight: {
 			type: [String, Number],
 			default: 0
 		},
+		/**
+		* @zh 触发到达底部的距离阈值
+		* @en Trigger the distance threshold to reach the bottom
+		*/
 		bottomOffset: {
 			type: Number,
 			default: 0
 		},
+		/**
+		* @zh 传递虚拟列表属性，传入此参数以开启虚拟滚动 [VirtualListProps](#VirtualListProps)
+		* @en Pass virtual list properties, pass in this parameter to turn on virtual scrolling [VirtualListProps](#VirtualListProps)
+		*/
 		virtualListProps: { type: Object },
+		/**
+		* @zh 是否开启虚拟滚动条
+		* @en Whether to enable virtual scroll bar
+		* @version 2.38.0
+		*/
 		scrollbar: {
 			type: [Object, Boolean],
 			default: true
 		}
 	},
 	emits: {
+		/**
+		* @zh 列表滚动时触发
+		* @en Triggered when the list scrolls
+		*/
 		scroll: () => true,
+		/**
+		* @zh 当列表到达底部时触发
+		* @en Triggered when the list reaches the bottom
+		*/
 		reachBottom: () => true,
+		/**
+		* @zh 表格分页发生改变时触发
+		* @en Triggered when the table pagination changes
+		* @param {number} page
+		*/
 		pageChange: (_page) => true,
+		/**
+		* @zh 表格每页数据数量发生改变时触发
+		* @en Triggered when the number of data per page of the table changes
+		* @param {number} pageSize
+		*/
 		pageSizeChange: (_pageSize) => true
 	},
+	/**
+	* @zh 头部信息
+	* @en Header
+	* @slot header
+	*/
+	/**
+	* @zh 底部信息
+	* @en Footer
+	* @slot footer
+	*/
+	/**
+	* @zh 空白展示
+	* @en Empty
+	* @slot empty
+	*/
+	/**
+	* @zh 列表项
+	* @en List Item
+	* @slot item
+	* @binding {number} index
+	* @binding {any} item
+	*/
+	/**
+	* @zh 滚动加载状态时，滚动到底部的提示
+	* @en When scrolling loading state, scroll to the bottom tip
+	* @slot scroll-loading
+	* @version 2.20.0
+	*/
 	setup(props, { emit, slots }) {
 		const { scrollbar } = toRefs(props);
 		const prefixCls = getPrefixCls("list");
@@ -266,7 +361,14 @@ var list_default = /* @__PURE__ */ defineComponent({
 			render
 		};
 	},
-	methods: { scrollIntoView(options) {
+	methods: { 
+	/**
+	* @zh 虚拟滚动到某个元素
+	* @en Virtual scroll to an element
+	* @param {{ index?: number; key?: number | string; align: 'auto' | 'top' | 'bottom'}} options
+	* @public
+	*/
+scrollIntoView(options) {
 		if (this.virtualListRef) this.virtualListRef.scrollTo(options);
 	} },
 	render() {

package/es/mention/index.d.ts

@@ -33,11 +33,11 @@ declare const Mention: {
             default: boolean;
         };
     }>> & Readonly<{
+        onSearch?: ((_value: string, _prefix: string) => any) | undefined;
         onFocus?: ((_ev: FocusEvent) => any) | undefined;
         onChange?: ((_value: string) => any) | undefined;
         onBlur?: ((_ev: FocusEvent) => any) | undefined;
         onClear?: ((_ev: Event) => any) | undefined;
-        onSearch?: ((_value: string, _prefix: string) => any) | undefined;
         onSelect?: ((_value: string | number | Record<string, any> | undefined) => any) | undefined;
         "onUpdate:modelValue"?: ((_value: string) => any) | undefined;
     }>, {
@@ -56,10 +56,10 @@ declare const Mention: {
         blur: (_ev: FocusEvent) => true;
     }, import("vue").PublicProps, {
         type: "input" | "textarea";
+        split: string;
         disabled: boolean;
         defaultValue: string;
         data: (string | number | import("..").SelectOptionData | import("..").SelectOptionGroup)[];
-        split: string;
         prefix: string | string[];
         allowClear: boolean;
     }, true, {}, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, {}, any, import("vue").ComponentProvideOptions, {
@@ -100,11 +100,11 @@ declare const Mention: {
             default: boolean;
         };
     }>> & Readonly<{
+        onSearch?: ((_value: string, _prefix: string) => any) | undefined;
         onFocus?: ((_ev: FocusEvent) => any) | undefined;
         onChange?: ((_value: string) => any) | undefined;
         onBlur?: ((_ev: FocusEvent) => any) | undefined;
         onClear?: ((_ev: Event) => any) | undefined;
-        onSearch?: ((_value: string, _prefix: string) => any) | undefined;
         onSelect?: ((_value: string | number | Record<string, any> | undefined) => any) | undefined;
         "onUpdate:modelValue"?: ((_value: string) => any) | undefined;
     }>, {
@@ -115,10 +115,10 @@ declare const Mention: {
         blur(): void;
     }, {
         type: "input" | "textarea";
+        split: string;
         disabled: boolean;
         defaultValue: string;
         data: (string | number | import("..").SelectOptionData | import("..").SelectOptionGroup)[];
-        split: string;
         prefix: string | string[];
         allowClear: boolean;
     }>;
@@ -156,11 +156,11 @@ declare const Mention: {
         default: boolean;
     };
 }>> & Readonly<{
+    onSearch?: ((_value: string, _prefix: string) => any) | undefined;
     onFocus?: ((_ev: FocusEvent) => any) | undefined;
     onChange?: ((_value: string) => any) | undefined;
     onBlur?: ((_ev: FocusEvent) => any) | undefined;
     onClear?: ((_ev: Event) => any) | undefined;
-    onSearch?: ((_value: string, _prefix: string) => any) | undefined;
     onSelect?: ((_value: string | number | Record<string, any> | undefined) => any) | undefined;
     "onUpdate:modelValue"?: ((_value: string) => any) | undefined;
 }>, {
@@ -179,10 +179,10 @@ declare const Mention: {
     blur: (_ev: FocusEvent) => true;
 }, string, {
     type: "input" | "textarea";
+    split: string;
     disabled: boolean;
     defaultValue: string;
     data: (string | number | import("..").SelectOptionData | import("..").SelectOptionGroup)[];
-    split: string;
     prefix: string | string[];
     allowClear: boolean;
 }, {}, string, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, import("vue").ComponentProvideOptions> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & {

package/es/mention/mention.d.ts

@@ -75,19 +75,19 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         default: boolean;
     };
 }>> & Readonly<{
+    onSearch?: ((_value: string, _prefix: string) => any) | undefined;
     onFocus?: ((_ev: FocusEvent) => any) | undefined;
     onChange?: ((_value: string) => any) | undefined;
     onBlur?: ((_ev: FocusEvent) => any) | undefined;
     onClear?: ((_ev: Event) => any) | undefined;
-    onSearch?: ((_value: string, _prefix: string) => any) | undefined;
     onSelect?: ((_value: string | number | Record<string, any> | undefined) => any) | undefined;
     "onUpdate:modelValue"?: ((_value: string) => any) | undefined;
 }>, {
     type: "input" | "textarea";
+    split: string;
     disabled: boolean;
     defaultValue: string;
     data: (string | number | SelectOptionData | SelectOptionGroup)[];
-    split: string;
     prefix: string | string[];
     allowClear: boolean;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

package/es/mention/mention.js

@@ -1,5 +1,5 @@
 import { useFormItem } from "../_hooks/use-form-item.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 { isFunction, isNull, isUndefined } from "../_utils/is.js";
 import resize_observer_default from "../_components/resize-observer.js";
@@ -22,31 +22,65 @@ var mention_default = /* @__PURE__ */ defineComponent({
 	name: "Mention",
 	inheritAttrs: false,
 	props: {
+		/**
+		* @zh 绑定值
+		* @en Value
+		* @vModel
+		*/
 		modelValue: String,
+		/**
+		* @zh 默认值（非受控状态）
+		* @en Default value (uncontrolled state)
+		*/
 		defaultValue: {
 			type: String,
 			default: ""
 		},
+		/**
+		* @zh 用于自动补全的数据
+		* @en Data for automatic completion
+		*/
 		data: {
 			type: Array,
 			default: () => []
 		},
+		/**
+		* @zh 触发自动补全的关键字
+		* @en Keywords that trigger auto-completion
+		*/
 		prefix: {
 			type: [String, Array],
 			default: "@"
 		},
+		/**
+		* @zh 选中项的前后分隔符
+		* @en Before and after the selected item separator
+		*/
 		split: {
 			type: String,
 			default: " "
 		},
+		/**
+		* @zh 输入框或文本域
+		* @en default input or textarea
+		*/
 		type: {
 			type: String,
 			default: "input"
 		},
+		/**
+		* @zh 是否禁用
+		* @en Whether to disable
+		*/
 		disabled: {
 			type: Boolean,
 			default: false
 		},
+		/**
+		* @zh 是否允许清空输入框
+		* @en Whether to allow the input to be cleared
+		* @version 2.23.0
+		*/
 		allowClear: {
 			type: Boolean,
 			default: false
@@ -54,13 +88,53 @@ var mention_default = /* @__PURE__ */ defineComponent({
 	},
 	emits: {
 		"update:modelValue": (_value) => true,
+		/**
+		* @zh 值发生改变时触发
+		* @en Triggered when the value changes
+		* @property {string} value
+		*/
 		"change": (_value) => true,
+		/**
+		* @zh 动态搜索时触发，2.47.0 版本增加 prefix 参数
+		* @en Trigger on dynamic search prefix, version 2.47.0 adds prefix param
+		* @property {string} value
+		* @property {string} prefix
+		*/
 		"search": (_value, _prefix) => true,
+		/**
+		* @zh 选择下拉选项时触发
+		* @en Triggered when the drop-down option is selected
+		* @property {string | number | Record<string, any> | undefined} value
+		*/
 		"select": (_value) => true,
+		/**
+		* @zh 用户点击清除按钮时触发
+		* @en Triggered when the user clicks the clear button
+		* @version 2.23.0
+		*/
 		"clear": (_ev) => true,
+		/**
+		* @zh 文本框获取焦点时触发
+		* @en Emitted when the text box gets focus
+		* @param {FocusEvent} ev
+		* @version 2.42.0
+		*/
 		"focus": (_ev) => true,
+		/**
+		* @zh 文本框失去焦点时触发
+		* @en Emitted when the text box loses focus
+		* @param {FocusEvent} ev
+		* @version 2.42.0
+		*/
 		"blur": (_ev) => true
 	},
+	/**
+	* @zh 选项内容
+	* @en Display content of options
+	* @slot option
+	* @binding {OptionInfo} data
+	* @version 2.13.0
+	*/
 	setup(props, { emit, attrs, slots }) {
 		const prefixCls = getPrefixCls("mention");
 		const { mergedAllowClear } = useAllowClear(toRef(props, "allowClear"));
@@ -271,10 +345,22 @@ var mention_default = /* @__PURE__ */ defineComponent({
 		};
 	},
 	methods: {
+		/**
+		* @zh 使输入框获取焦点
+		* @en Make the input box focus
+		* @public
+		* @version 2.24.0
+		*/
 		focus() {
 			var _this$inputRef;
 			(_this$inputRef = this.inputRef) === null || _this$inputRef === void 0 || _this$inputRef.focus();
 		},
+		/**
+		* @zh 使输入框失去焦点
+		* @en Make the input box lose focus
+		* @public
+		* @version 2.24.0
+		*/
 		blur() {
 			var _this$inputRef2;
 			(_this$inputRef2 = this.inputRef) === null || _this$inputRef2 === void 0 || _this$inputRef2.blur();

package/es/menu/base-menu.vue.d.ts

@@ -189,7 +189,7 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
     "onMenu-item-click"?: ((...args: any[]) => any) | undefined;
     "onSub-menu-click"?: ((...args: any[]) => any) | undefined;
 }>, {
-    mode: "horizontal" | "vertical" | "pop" | "popButton";
+    mode: "pop" | "horizontal" | "vertical" | "popButton";
     popupMaxHeight: number | boolean;
     accordion: boolean;
     theme: "dark" | "light";

package/es/menu/base-menu.vue_vue_type_script_lang.js

@@ -24,40 +24,126 @@ var base_menu_vue_vue_type_script_lang_default = defineComponent({
 	inheritAttrs: false,
 	props: {
 		style: { type: Object },
+		/**
+		* @zh 菜单的主题
+		* @en Menu theme
+		*/
 		theme: {
 			type: String,
 			default: "light"
 		},
+		/**
+		* @zh 菜单的模式
+		* @en The mode of menu
+		*/
 		mode: {
 			type: String,
 			default: "vertical"
 		},
+		/**
+		* @zh 层级之间的缩进量
+		* @en Indentation between levels
+		*/
 		levelIndent: { type: Number },
+		/**
+		* @zh 默认展开所有多级菜单
+		* @en Expand all multi-level menus by default
+		*/
 		autoOpen: { type: Boolean },
+		/**
+		* @zh 是否折叠菜单
+		* @en Whether to collapse the menu
+		* @vModel
+		*/
 		collapsed: {
 			type: Boolean,
 			default: void 0
 		},
+		/**
+		* @zh 默认是否折叠菜单
+		* @en Whether to collapse the menu by default
+		*/
 		defaultCollapsed: { type: Boolean },
+		/**
+		* @zh 折叠菜单宽度
+		* @en Collapse menu width
+		*/
 		collapsedWidth: { type: Number },
+		/**
+		* @zh 开启手风琴效果
+		* @en Turn on the accordion effect
+		*/
 		accordion: { type: Boolean },
+		/**
+		* @zh 是否自动滚动选中项目到可见区域
+		* @en Whether to automatically scroll the selected item to the visible area
+		*/
 		autoScrollIntoView: { type: Boolean },
+		/**
+		* @zh 是否内置折叠按钮
+		* @en Whether built-in folding button
+		*/
 		showCollapseButton: { type: Boolean },
+		/**
+		* @zh 选中的菜单项 key 数组
+		* @en The selected menu item key array
+		* @vModel
+		*/
 		selectedKeys: { type: Array },
+		/**
+		* @zh 默认选中的菜单项 key 数组
+		* @en The key array of the menu items selected by default
+		*/
 		defaultSelectedKeys: {
 			type: Array,
 			default: () => []
 		},
+		/**
+		* @zh 展开的子菜单 key 数组
+		* @en Expanded submenu key array
+		* @vModel
+		*/
 		openKeys: { type: Array },
+		/**
+		* @zh 默认展开的子菜单 key 数组
+		* @en The default expanded submenu key array
+		*/
 		defaultOpenKeys: {
 			type: Array,
 			default: () => []
 		},
+		/**
+		* @zh 滚动到可见区域的配置项，接收所有[scroll-into-view-if-needed](https://github.com/stipsan/scroll-into-view-if-needed)的参数
+		* @en Scroll to the configuration items in the visible area and receive all the parameters of [scroll-into-view-if-needed](https://github.com/stipsan/scroll-into-view-if-needed)
+		*/
 		scrollConfig: { type: Object },
+		/**
+		* @zh 弹出模式下可接受所有 `Trigger` 的 `Props`
+		* @en Accept all `Props` of `Trigger` in pop-up mode
+		*/
 		triggerProps: { type: Object },
+		/**
+		* @zh 弹出模式下可接受所有 `ToolTip` 的 `Props`
+		* @en Accept all `Props` of `ToolTip` in pop-up mode
+		*/
 		tooltipProps: { type: Object },
+		/**
+		* @zh 默认展开选中的菜单
+		* @en Expand the selected menus by default
+		* @version 2.8.0
+		*/
 		autoOpenSelected: { type: Boolean },
+		/**
+		* @zh 响应式的断点, 详见[响应式栅格](/vue/component/grid)
+		* @en Responsive breakpoints, see [Responsive Grid](/vue/component/grid) for details
+		* @version 2.18.0
+		*/
 		breakpoint: { type: String },
+		/**
+		* @zh 弹出框的最大高度
+		* @en The maximum height of popover
+		* @version 2.23.0
+		*/
 		popupMaxHeight: {
 			type: [Boolean, Number],
 			default: true
@@ -75,6 +161,22 @@ var base_menu_vue_vue_type_script_lang_default = defineComponent({
 		"menu-item-click",
 		"sub-menu-click"
 	],
+	/**
+	* @zh 折叠图标
+	* @en Collapse icon
+	* @slot collapse-icon
+	* @binding {boolean} collapsed
+	*/
+	/**
+	* @zh 向下展开的图标
+	* @en Icon expand down
+	* @slot expand-icon-down
+	*/
+	/**
+	* @zh 向右展开的图标
+	* @en Icon expand right
+	* @slot expand-icon-right
+	*/
 	setup(props, { emit, slots }) {
 		const { style, mode, theme, levelIndent, accordion, showCollapseButton, scrollConfig, autoScrollIntoView, collapsedWidth, autoOpen, collapsed: propCollapsed, defaultCollapsed, selectedKeys: propSelectedKeys, defaultSelectedKeys, openKeys: propOpenKeys, defaultOpenKeys, triggerProps, tooltipProps, autoOpenSelected, breakpoint, popupMaxHeight, prefixCls, inTrigger, siderCollapsed, isRoot } = toRefs(props);
 		const { subMenuKeys, menuData } = useMenuDataCollector({ type: isRoot.value ? "menu" : "popupMenu" });

package/es/menu/item-group.vue_vue_type_script_lang.js

@@ -6,7 +6,17 @@ import { computed, defineComponent } from "vue";
 var item_group_vue_vue_type_script_lang_default = defineComponent({
 	name: "MenuItemGroup",
 	components: { MenuIndent: indent_default },
-	props: { title: { type: String } },
+	props: { 
+	/**
+	* @zh 菜单组的标题
+	* @en The title of the menu group
+	*/
+title: { type: String } },
+	/**
+	* @zh 标题
+	* @en Title
+	* @slot title
+	*/
 	setup() {
 		const { level } = useLevel();
 		provideLevel(computed(() => level.value === 1 ? level.value + 1 : level.value));

package/es/menu/item.d.ts

@@ -4,7 +4,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         default: boolean;
     };
 }>, {
-    menuContext: Partial<Readonly<Pick<import("./interface").InternalMenuProps, "mode" | "triggerProps" | "popupMaxHeight" | "theme" | "levelIndent" | "autoScrollIntoView" | "scrollConfig" | "inTrigger" | "tooltipProps"> & {
+    menuContext: Partial<Readonly<Pick<import("./interface").InternalMenuProps, "mode" | "triggerProps" | "popupMaxHeight" | "theme" | "tooltipProps" | "levelIndent" | "autoScrollIntoView" | "scrollConfig" | "inTrigger"> & {
         selectedKeys: string[];
         openKeys: string[];
         prefixCls: string;

package/es/menu/item.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 { omit } from "../_utils/omit.js";
 import Tooltip from "../tooltip/index.js";
 import useLevel from "./hooks/use-level.js";
@@ -12,11 +12,22 @@ import scrollIntoView from "scroll-into-view-if-needed";
 var item_default = /* @__PURE__ */ defineComponent({
 	name: "MenuItem",
 	inheritAttrs: false,
-	props: { disabled: {
+	props: { 
+	/**
+	* @zh 是否禁用
+	* @en Whether to disable
+	*/
+disabled: {
 		type: Boolean,
 		default: false
 	} },
 	emits: ["click"],
+	/**
+	* @zh 菜单的图标
+	* @en the icon of menu item
+	* @slot icon
+	* @version 2.11.0
+	*/
 	setup(props, { emit }) {
 		const { key } = useMenu();
 		const { level } = useLevel();

package/es/menu/menu.d.ts

@@ -16,7 +16,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         default: string;
     };
 }>> & Readonly<{}>, {
-    mode: "horizontal" | "vertical" | "pop" | "popButton";
+    mode: "pop" | "horizontal" | "vertical" | "popButton";
 }, {}, {
     BaseMenu: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
         style: {
@@ -205,7 +205,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         "onMenu-item-click"?: ((...args: any[]) => any) | undefined;
         "onSub-menu-click"?: ((...args: any[]) => any) | undefined;
     }>, {
-        mode: "horizontal" | "vertical" | "pop" | "popButton";
+        mode: "pop" | "horizontal" | "vertical" | "popButton";
         popupMaxHeight: number | boolean;
         accordion: boolean;
         theme: "dark" | "light";

package/es/menu/menu.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 { SiderInjectionKey } from "../layout/context.js";
 import { LevelInjectionKey, MenuInjectionKey } from "./context.js";
 import base_menu_default from "./base-menu.js";
@@ -10,6 +10,7 @@ var menu_default = /* @__PURE__ */ defineComponent({
 	components: { BaseMenu: base_menu_default },
 	inheritAttrs: false,
 	props: {
+		/** 菜单风格 */
 		theme: { type: String },
 		mode: {
 			type: String,