@sdata/web-vue 1.11.1 → 1.12.0

package/es/tabs/tabs.js

@@ -10,67 +10,147 @@ import { computed, createVNode, defineComponent, inject, nextTick, provide, reac
 var tabs_default = /* @__PURE__ */ defineComponent({
 	name: "Tabs",
 	props: {
+		/**
+		* @zh 当前选中的标签的 `key`
+		* @en The `key` of the currently selected label
+		* @vModel
+		*/
 		activeKey: {
 			type: [String, Number],
 			default: void 0
 		},
+		/**
+		* @zh 默认选中的标签的`key`（非受控状态，为空时选中第一个标签页）
+		* @en The `key` of the tab selected by default (uncontrolled state, select the first tab page when it is empty)
+		*/
 		defaultActiveKey: {
 			type: [String, Number],
 			default: void 0
 		},
+		/**
+		* @zh 选项卡的位置
+		* @en Position of the tab
+		* @values 'left', 'right', 'top', 'bottom'
+		*/
 		position: {
 			type: String,
 			default: "top"
 		},
+		/**
+		* @zh 选项卡的大小
+		* @en The size of the tab
+		* @values 'mini', 'small', 'medium', 'large'
+		*/
 		size: { type: String },
+		/**
+		* @zh 选项卡的类型
+		* @en The type of tab
+		* @values 'line', 'card', 'card-gutter', 'text', 'rounded', 'capsule'
+		*/
 		type: {
 			type: String,
 			default: "line"
 		},
+		/**
+		* @zh 选项卡的方向
+		* @en The direction of tab
+		* @values 'horizontal', 'vertical'
+		*/
 		direction: {
 			type: String,
 			default: "horizontal"
 		},
+		/**
+		* @zh 是否开启可编辑模式
+		* @en Whether to enable editable mode
+		*/
 		editable: {
 			type: Boolean,
 			default: false
 		},
+		/**
+		* @zh 是否显示增加按钮（仅在可编辑模式可用）
+		* @en Whether to display the add button (only available in editable mode)
+		*/
 		showAddButton: {
 			type: Boolean,
 			default: false
 		},
+		/**
+		* @zh 是否在不显示标签时销毁内容
+		* @en Whether to destroy the content when the label is not displayed
+		* @version 2.27.0
+		*/
 		destroyOnHide: {
 			type: Boolean,
 			default: false
 		},
+		/**
+		* @zh 是否在首次展示标签时挂载内容
+		* @en Whether to mount the content when the label is first displayed
+		*/
 		lazyLoad: {
 			type: Boolean,
 			default: false
 		},
+		/**
+		* @zh 高度撑满容器，只在水平模式下生效。
+		* @en The height of the container is fully supported, and it only takes effect in horizontal mode.
+		*/
 		justify: {
 			type: Boolean,
 			default: false
 		},
+		/**
+		* @zh 是否开启选项内容过渡动画
+		* @en Whether to enable option content transition animation
+		*/
 		animation: {
 			type: Boolean,
 			default: false
 		},
+		/**
+		* @zh 选项卡头部是否存在水平边距。仅对 `type` 等于 `line`、`text` 类型的选项卡生效
+		* @en Whether there is a horizontal margin on the header of the tab. Only valid for tabs with `type` equal to `line` and `text` type
+		* @version 2.10.0
+		*/
 		headerPadding: {
 			type: Boolean,
 			default: true
 		},
+		/**
+		* @zh 创建标签后是否切换到新标签（最后一个）
+		* @en Whether to switch to a new tab after creating a tab (the last one)
+		* @version 2.18.0
+		*/
 		autoSwitch: {
 			type: Boolean,
 			default: false
 		},
+		/**
+		* @zh 是否隐藏内容
+		* @en Whether to hide content
+		* @version 2.25.0
+		*/
 		hideContent: {
 			type: Boolean,
 			default: false
 		},
+		/**
+		* @zh 触发方式
+		* @en Trigger method
+		* @values 'hover','click'
+		* @version 2.34.0
+		*/
 		trigger: {
 			type: String,
 			default: "click"
 		},
+		/**
+		* @zh 被选中 tab 的滚动位置，默认 auto 即会将 activeTab 滚动到可见区域，但不会特意做位置调整
+		* @en The scroll position of the selected tab, the default auto will scroll the activeTab to the visible area, but will not adjust the position intentionally
+		* @values 'start', 'end', 'center', 'auto', number
+		*/
 		scrollPosition: {
 			type: [String, Number],
 			default: "auto"
@@ -78,11 +158,35 @@ var tabs_default = /* @__PURE__ */ defineComponent({
 	},
 	emits: {
 		"update:activeKey": (_key) => true,
+		/**
+		* @zh 当前标签值改变时触发
+		* @en Triggered when the current tag value changes
+		* @property { string | number } key
+		*/
 		"change": (_key) => true,
+		/**
+		* @zh 用户点击标签时触发
+		* @en Triggered when the user clicks on the tab
+		* @property { string | number } key
+		*/
 		"tabClick": (_key, _ev) => true,
+		/**
+		* @zh 用户点击增加按钮时触发
+		* @en Triggered when the user clicks the add button
+		*/
 		"add": (_ev) => true,
+		/**
+		* @zh 用户点击删除按钮时触发
+		* @en Triggered when the user clicks the delete button
+		* @property { string | number } key
+		*/
 		"delete": (_key, _ev) => true
 	},
+	/**
+	* @zh 选项卡额外内容
+	* @en Additional tab content
+	* @slot extra
+	*/
 	setup(props, { emit, slots }) {
 		const { size, lazyLoad, destroyOnHide, trigger } = toRefs(props);
 		const prefixCls = getPrefixCls("tabs");