@sdata/web-vue 1.11.0 → 1.12.0

package/es/tree/tree.vue_vue_type_script_lang.js

@@ -1,7 +1,7 @@
-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 { isArray, isFunction, isUndefined } from "../_utils/is.js";
-import { _asyncToGenerator } from "../_virtual/_@oxc-project_runtime@0.124.0/helpers/asyncToGenerator.js";
+import { _asyncToGenerator } from "../_virtual/_@oxc-project_runtime@0.130.0/helpers/asyncToGenerator.js";
 import virtual_list_default from "../_components/virtual-list/index.js";
 import useMergeState from "../_hooks/use-merge-state.js";
 import usePickSlots from "../_hooks/use-pick-slots.js";
@@ -26,16 +26,36 @@ var tree_vue_vue_type_script_lang_default = defineComponent({
 		TreeNode: node_default
 	},
 	props: {
+		/**
+		* @zh 尺寸
+		* @en Size
+		*/
 		size: {
 			type: String,
 			default: "medium"
 		},
+		/**
+		* @zh 节点是否占据一行
+		* @en Whether the node occupies a row
+		*/
 		blockNode: { type: Boolean },
+		/**
+		* @zh 是否默认展开父节点
+		* @en Whether to expand the parent node by default
+		*/
 		defaultExpandAll: {
 			type: Boolean,
 			default: true
 		},
+		/**
+		* @zh 是否支持多选
+		* @en Whether to support multiple selection
+		*/
 		multiple: { type: Boolean },
+		/**
+		* @zh 是否在节点前添加复选框，从 `2.27.0` 开始支持函数格式
+		* @en Whether to add a checkbox before the node, function format is supported since `2.27.0`
+		*/
 		checkable: {
 			type: [
 				Boolean,
@@ -44,51 +64,154 @@ var tree_vue_vue_type_script_lang_default = defineComponent({
 			],
 			default: false
 		},
+		/**
+		* @zh 是否支持选择，从 `2.27.0` 开始支持函数格式
+		* @en Whether to support selection, function format is supported since `2.27.0`
+		* */
 		selectable: {
 			type: [Boolean, Function],
 			default: true
 		},
+		/**
+		* @zh 是否取消父子节点关联
+		* @en Whether to cancel the parent-child node association
+		* */
 		checkStrictly: { type: Boolean },
+		/**
+		* @zh 定制回填方式 <br/> all: 返回所有选中的节点  <br/> parent: 父子节点都选中时只返回父节点 <br/> child: 只返回子节点
+		* @en Customized backfill method <br/> all: return all selected nodes <br/> parent: return only parent node when both parent and child nodes are selected <br/> child: return only child nodes
+		* */
 		checkedStrategy: {
 			type: String,
 			default: "all"
 		},
+		/**
+		* @zh 默认选中的树节点
+		* @en Tree node selected by default
+		* */
 		defaultSelectedKeys: { type: Array },
+		/**
+		* @zh 选中的树节点
+		* @en Selected tree node
+		* @vModel
+		*/
 		selectedKeys: { type: Array },
+		/**
+		* @zh 默认选中复选框的树节点
+		* @en Tree node with checkbox selected by default
+		* */
 		defaultCheckedKeys: { type: Array },
+		/**
+		* @zh 选中复选框的树节点
+		* @en Tree node with check box selected
+		* @vModel
+		*/
 		checkedKeys: { type: Array },
+		/**
+		* @zh 默认展开的节点
+		* @en Nodes expanded by default
+		* */
 		defaultExpandedKeys: { type: Array },
+		/**
+		* @zh 展开的节点
+		* @en Expanded node
+		* @vModel
+		*/
 		expandedKeys: { type: Array },
+		/**
+		* @zh 传入`data`,生成对应的树结构
+		* @en Pass in `data` to generate the corresponding tree structure
+		* */
 		data: {
 			type: Array,
 			default: () => []
 		},
+		/**
+		* @zh 指定节点数据中的字段名
+		* @en Specify the field name in the node data
+		* */
 		fieldNames: { type: Object },
+		/**
+		* @zh 是否展示连接线
+		* @en Whether to display the connection line
+		* */
 		showLine: { type: Boolean },
+		/**
+		* @zh 异步加载数据的回调，返回一个 `Promise`
+		* @en A callback for loading data asynchronously, returning a `Promise`
+		* */
 		loadMore: { type: Function },
+		/**
+		* @zh 是否可以拖拽
+		* @en Whether it can be dragged
+		* */
 		draggable: { type: Boolean },
+		/**
+		* @zh 拖拽时是否允许在某节点上释放
+		* @en Whether to allow release on a node when dragging
+		* */
 		allowDrop: { type: Function },
 		filterTreeNode: { type: Function },
 		searchValue: {
 			type: String,
 			default: ""
 		},
+		/**
+		* @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 expand the parent node of the selected node by default
+		* @version 2.9.0
+		*/
 		defaultExpandSelected: { type: Boolean },
+		/**
+		* @zh 是否默认展开已选中复选框节点的父节点
+		* @en Whether to expand the parent node of the checked node by default
+		* @version 2.9.0
+		*/
 		defaultExpandChecked: { type: Boolean },
+		/**
+		* @zh 是否自动展开已展开节点的父节点
+		* @en Whether to automatically expand the parent node of the expanded node
+		* @version 2.9.0
+		*/
 		autoExpandParent: {
 			type: Boolean,
 			default: true
 		},
+		/**
+		* @zh 半选状态的节点.仅在 checkable 且 checkStrictly 时生效
+		* @en The keys of half checked. Only valid when checkable and checkStrictly
+		* @version 2.19.0
+		* @vModel
+		*/
 		halfCheckedKeys: { type: Array },
+		/**
+		* @zh 开启后 checkedKeys 只处理叶子节点，父节点状态由子节点决定（仅在 checkable 且 checkStrictly 为 false 时生效）
+		* @en When enabled, checkedKeys is only for checked leaf nodes, and the status of the parent node is determined by the child node.(Only valid when checkable and checkStrictly is false)
+		* @version 2.21.0
+		*/
 		onlyCheckLeaf: {
 			type: Boolean,
 			default: false
 		},
+		/**
+		* @zh 是否开启展开时的过渡动效
+		* @en Whether to enable expand transition animation
+		* @version 2.21.0
+		*/
 		animation: {
 			type: Boolean,
 			default: true
 		},
+		/**
+		* @zh 点击节点的时候触发的动作
+		* @en The action triggered when the node is clicked
+		* @version 2.27.0
+		*/
 		actionOnNodeClick: { type: String },
 		disableSelectActionOnly: {
 			type: Boolean,
@@ -96,19 +219,100 @@ var tree_vue_vue_type_script_lang_default = defineComponent({
 		}
 	},
 	emits: {
+		/**
+		* @zh 点击树节点时触发
+		* @en Triggered when the tree node is clicked
+		* @param {Array<string | number>} selectedKeys
+		* @param {{ selected?: boolean; selectedNodes: TreeNodeData[]; node?: TreeNodeData; e?: Event; }} data
+		*/
 		"select": (_selectedKeys, _data) => true,
 		"update:selectedKeys": (_selectedKeys) => true,
+		/**
+		* @zh 点击树节点复选框时触发。`halfCheckedKeys` 和 `halfCheckedNodes` 从 `2.19.0` 开始支持。
+		* @en Triggered when the tree node checkbox is clicked. `halfCheckedKeys` and `halfCheckedNodes` support from `2.19.0`.
+		* @param {Array<string | number>} checkedKeys
+		* @param {{ checked?: boolean; checkedNodes: TreeNodeData[]; node?: TreeNodeData; e?: Event; halfCheckedKeys: (string | number)[]; halfCheckedNodes: TreeNodeData[]; }} data
+		*/
 		"check": (_checkedKeys, _data) => true,
 		"update:checkedKeys": (_checkedKeys) => true,
 		"update:halfCheckedKeys": (_halfCheckedKeys) => true,
+		/**
+		* @zh 展开/关闭
+		* @en Expand/close
+		* @param {Array<string | number>} expandKeys
+		* @param {{ expanded?: boolean; expandNodes: TreeNodeData[]; node?: TreeNodeData; e?: Event; }} data
+		*/
 		"expand": (_expandKeys, _data) => true,
 		"update:expandedKeys": (_expandKeys) => true,
+		/**
+		* @zh 节点开始拖拽
+		* @en Node starts dragging
+		* @param {DragEvent} ev
+		* @param {TreeNodeData} node
+		*/
 		"dragStart": (_ev, _node) => true,
+		/**
+		* @zh 节点结束拖拽
+		* @en Node end drag
+		* @param {DragEvent} ev
+		* @param {TreeNodeData} node
+		*/
 		"dragEnd": (_ev, _node) => true,
+		/**
+		* @zh 节点被拖拽至可释放目标
+		* @en The node is dragged to the releasable target
+		* @param {DragEvent} ev
+		* @param {TreeNodeData} node
+		*/
 		"dragOver": (_ev, _node) => true,
+		/**
+		* @zh 节点离开可释放目标
+		* @en Node leaves to release the target
+		* @param {DragEvent} ev
+		* @param {TreeNodeData} node
+		*/
 		"dragLeave": (_ev, _node) => true,
+		/**
+		* @zh 节点在可释放目标上释放
+		* @en The node is released on a releasable target
+		* @param {{ e: DragEvent; dragNode: TreeNodeData; dropNode: TreeNodeData; dropPosition: number; }} data
+		*/
 		"drop": (_data) => true
 	},
+	/**
+	* @zh 定制节点图标
+	* @en Custom node icon
+	* @slot icon
+	* @binding {TreeNodeData} node
+	* @version 2.18.0
+	*/
+	/**
+	* @zh 定制 switcher 图标
+	* @en Custom switcher icon
+	* @slot switcher-icon
+	*/
+	/**
+	* @zh 定制 loading 图标
+	* @en Custom loading icon
+	* @slot loading-icon
+	*/
+	/**
+	* @zh 定制 drag 图标
+	* @en Custom drag icon
+	* @slot drag-icon
+	* @binding {TreeNodeData} node
+	*/
+	/**
+	* @zh 渲染额外的节点内容
+	* @en Render additional node content
+	* @slot extra
+	*/
+	/**
+	* @zh 标题
+	* @en Title
+	* @slot title
+	* @binding {string} title
+	*/
 	setup(props, { emit, slots }) {
 		const { data: propTreeData, showLine, multiple, loadMore, checkStrictly, checkedKeys: propCheckedKeys, defaultCheckedKeys, selectedKeys: propSelectedKeys, defaultSelectedKeys, expandedKeys: propExpandedKeys, defaultExpandedKeys, checkedStrategy, selectable, checkable, blockNode, fieldNames, size, defaultExpandAll, filterTreeNode, draggable, allowDrop, defaultExpandSelected, defaultExpandChecked, autoExpandParent, halfCheckedKeys, onlyCheckLeaf, animation, virtualListProps } = toRefs(props);
 		const prefixCls = getPrefixCls("tree");
@@ -514,23 +718,65 @@ var tree_vue_vue_type_script_lang_default = defineComponent({
 			const node = key2TreeNode.get(key);
 			if (node && isNodeCheckable(node)) onCheck(checked, key, e);
 		},
+		/**
+		* @zh 虚拟列表滚动某个元素
+		* @en Virtual list scroll to an element
+		* @param {{ index?: number; key?: number | string; align: 'auto' | 'top' | 'bottom'}} options
+		* @public
+		*/
 		scrollIntoView(options) {
 			this.virtualListRef && this.virtualListRef.scrollTo(options);
 		},
+		/**
+		* @zh 获取选中的节点
+		* @en Get selected nodes
+		* @returns {TreeNodeData[]}
+		* @public
+		* @version 2.19.0
+		*/
 		getSelectedNodes() {
 			return this.getNodes(this.computedSelectedKeys);
 		},
+		/**
+		* @zh 获取选中复选框的节点。支持传入 `checkedStrategy`，没有传则取组件的配置。
+		* @en Get checked nodes. Supports passing in `checkedStrategy`, if not passed, the configuration of the component is taken.
+		* @param { checkedStrategy?: 'all' | 'parent' | 'child'; includeHalfChecked?: boolean; } options
+		* @returns {TreeNodeData[]}
+		* @public
+		* @version 2.19.0
+		*/
 		getCheckedNodes(options = {}) {
 			const { checkedStrategy, includeHalfChecked } = options;
 			const checkedKeys = this.getPublicCheckedKeys(this.computedCheckedKeys, checkedStrategy);
 			return [...this.getNodes(checkedKeys), ...includeHalfChecked ? this.getHalfCheckedNodes() : []];
 		},
+		/**
+		* @zh 获取复选框半选的节点
+		* @en Get half checked nodes
+		* @returns {TreeNodeData[]}
+		* @public
+		* @version 2.19.0
+		*/
 		getHalfCheckedNodes() {
 			return this.getNodes(this.computedIndeterminateKeys);
 		},
+		/**
+		* @zh 获取展开的节点
+		* @en Get expanded nodes
+		* @returns {TreeNodeData[]}
+		* @public
+		* @version 2.19.0
+		*/
 		getExpandedNodes() {
 			return this.getNodes(this.computedExpandedKeys);
 		},
+		/**
+		* @zh 设置全部节点的复选框状态
+		* @en Set the checkbox state of all nodes
+		* @param { boolean } checked
+		* @public
+		* @version 2.20.0
+		*/
 		checkAll(checked = true) {
 			const { key2TreeNode } = this.treeContext;
 			const newKeys = checked ? [...key2TreeNode.keys()].filter((key) => {
@@ -539,6 +785,15 @@ var tree_vue_vue_type_script_lang_default = defineComponent({
 			}) : [];
 			this.internalSetCheckedKeys(newKeys);
 		},
+		/**
+		* @zh 设置指定节点的复选框状态
+		* @en Sets the checkbox state of the specified node
+		* @param { TreeNodeKey | TreeNodeKey[] } key
+		* @param { boolean } checked
+		* @param { boolean } onlyCheckLeaf
+		* @public
+		* @version 2.20.0，onlyCheckLeaf from 2.21.0
+		*/
 		checkNode(key, checked = true, onlyCheckLeaf = false) {
 			const { checkStrictly, treeContext } = this;
 			const { key2TreeNode } = treeContext;
@@ -549,6 +804,13 @@ var tree_vue_vue_type_script_lang_default = defineComponent({
 			});
 			this.internalCheckNodes(keys, checked, isBatch ? void 0 : key);
 		},
+		/**
+		* @zh 设置全部节点的选中状态
+		* @en Set the selected state of all nodes
+		* @param { boolean } selected
+		* @public
+		* @version 2.20.0
+		*/
 		selectAll(selected = true) {
 			const { key2TreeNode } = this.treeContext;
 			const newKeys = selected ? [...key2TreeNode.keys()].filter((key) => {
@@ -557,6 +819,14 @@ var tree_vue_vue_type_script_lang_default = defineComponent({
 			}) : [];
 			this.internalSetSelectedKeys(newKeys);
 		},
+		/**
+		* @zh 设置指定节点的选中状态
+		* @en Sets the selected state of the specified node
+		* @param { TreeNodeKey | TreeNodeKey[] } key
+		* @param { boolean } selected
+		* @public
+		* @version 2.20.0
+		*/
 		selectNode(key, selected = true) {
 			const { key2TreeNode } = this.treeContext;
 			const isBatch = isArray(key);
@@ -566,6 +836,13 @@ var tree_vue_vue_type_script_lang_default = defineComponent({
 			});
 			this.internalSelectNodes(keys, selected, isBatch ? void 0 : key);
 		},
+		/**
+		* @zh 设置全部节点的展开状态
+		* @en Set the expanded state of all nodes
+		* @param { boolean } expanded
+		* @public
+		* @version 2.20.0
+		*/
 		expandAll(expanded = true) {
 			const { key2TreeNode } = this.treeContext;
 			const newKeys = expanded ? [...key2TreeNode.keys()].filter((key) => {
@@ -574,6 +851,14 @@ var tree_vue_vue_type_script_lang_default = defineComponent({
 			}) : [];
 			this.internalSetExpandedKeys(newKeys);
 		},
+		/**
+		* @zh 设置指定节点的展开状态
+		* @en Sets the expanded state of the specified node
+		* @param { TreeNodeKey | TreeNodeKey[] } key
+		* @param { boolean } expanded
+		* @public
+		* @version 2.20.0
+		*/
 		expandNode(key, expanded = true) {
 			const { key2TreeNode } = this.treeContext;
 			const isBatch = isArray(key);

package/es/tree/utils/tree-data.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 { isFunction, isUndefined } from "../../_utils/is.js";
 import { omit } from "../../_utils/omit.js";
 //#region components/tree/utils/tree-data.ts

package/es/tree-select/hooks/use-selected-state.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 { isArray, isFunction, isObject } from "../../_utils/is.js";
 import { computed, ref, toRefs, watch, watchEffect } from "vue";
 //#region components/tree-select/hooks/use-selected-state.ts

package/es/tree-select/panel.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 { useScrollbar } from "../_hooks/use-scrollbar.js";
 import Scrollbar from "../scrollbar/index.js";

package/es/tree-select/tree-select.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 tree_select_vue_vue_type_script_lang_default from "./tree-select.vue_vue_type_script_lang.js";
 import { createBlock, createCommentVNode, createElementBlock, createElementVNode, createSlots, createVNode, guardReactiveProps, mergeProps, normalizeClass, normalizeProps, normalizeStyle, openBlock, renderSlot, resolveComponent, resolveDynamicComponent, withCtx } from "vue";