From 1ba6d1002ab5d537a592cfb9974cfdd8c4e4e3cb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=BB=8E=E4=BC=9F=E6=9D=B0?= <674416404@qq.com> Date: Sat, 1 Mar 2025 22:33:57 +0800 Subject: [PATCH 1/3] fix(webstorm): fix ts type --- packages/scripts/helper/index.js | 6 ++++-- packages/scripts/types/index.js | 1 + 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/packages/scripts/helper/index.js b/packages/scripts/helper/index.js index 8b938d86..e71cf4ef 100644 --- a/packages/scripts/helper/index.js +++ b/packages/scripts/helper/index.js @@ -18,6 +18,7 @@ const uniq = require('lodash/uniq'); const chalk = require('chalk'); const prettier = require('prettier'); const prettierConfig = require('../config/prettier'); +const { formatType } = require('../types'); /** * framework 参数可选值：Vue(PC)/VueNext(PC)/Vue(Mobile) */ @@ -96,8 +97,9 @@ function getHelperData(baseData, framework) { const attributeKey = `${componentName}/${prop}`; const apiDocs = `${componentDocs}?tab=api#${key.toLowerCase()}`; const apiDescription = `${api.field_desc_en ? `${api.field_desc_en}\n\n` : ''}${api.field_desc_zh || ''}`; - + const rType = formatType(api,framework); switch (api.field_category_text) { + case 'Props': props.push(prop); const attributesData = { @@ -113,7 +115,7 @@ function getHelperData(baseData, framework) { name: prop, description: apiDescription, 'doc-url': `${apiDocs}-props`, - type: api.field_type_text, + type: rType ? rType.type : api.field_type_text, default: api.field_default_value || undefined, 'attribute-value': api.field_enum ? { type: /^string$/i.test(api.field_type_text.join('')) ? 'enum' : 'of-match' } diff --git a/packages/scripts/types/index.js b/packages/scripts/types/index.js index d8c7ed58..664910d1 100644 --- a/packages/scripts/types/index.js +++ b/packages/scripts/types/index.js @@ -760,6 +760,7 @@ function generateTypes(baseData, framework) { } module.exports = { + formatType, generateTypes, getTypesByComponent, }; From 1737bb1f6fcf2a8a0b75152d58ed2205f1a6c821 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=BB=8E=E4=BC=9F=E6=9D=B0?= <674416404@qq.com> Date: Tue, 4 Mar 2025 16:28:34 +0800 Subject: [PATCH 2/3] wip --- .../packages/tdesign-vue-next/global.d.ts | 4 + .../tdesign-vue-next/helper/attributes.json | 99 + .../tdesign-vue-next/helper/tags.json | 40 + .../tdesign-vue-next/helper/web-types.json | 6524 +++++------------ packages/scripts/helper/index.js | 7 + 5 files changed, 1852 insertions(+), 4822 deletions(-) diff --git a/packages/products/tdesign-vue-next/packages/tdesign-vue-next/global.d.ts b/packages/products/tdesign-vue-next/packages/tdesign-vue-next/global.d.ts index c5adb082..a65eb744 100644 --- a/packages/products/tdesign-vue-next/packages/tdesign-vue-next/global.d.ts +++ b/packages/products/tdesign-vue-next/packages/tdesign-vue-next/global.d.ts @@ -121,6 +121,10 @@ declare module 'vue' { TTransfer: typeof import('tdesign-vue-next')['Transfer']; TTree: typeof import('tdesign-vue-next')['Tree']; TTreeSelect: typeof import('tdesign-vue-next')['TreeSelect']; + TTypography: typeof import('tdesign-vue-next')['Typography']; + TTypographyParagraph: typeof import('tdesign-vue-next')['TypographyParagraph']; + TTypographyText: typeof import('tdesign-vue-next')['TypographyText']; + TTypographyTitle: typeof import('tdesign-vue-next')['TypographyTitle']; TUpload: typeof import('tdesign-vue-next')['Upload']; TWatermark: typeof import('tdesign-vue-next')['Watermark']; } diff --git a/packages/products/tdesign-vue-next/packages/tdesign-vue-next/helper/attributes.json b/packages/products/tdesign-vue-next/packages/tdesign-vue-next/helper/attributes.json index 47972e34..f8ced46c 100644 --- a/packages/products/tdesign-vue-next/packages/tdesign-vue-next/helper/attributes.json +++ b/packages/products/tdesign-vue-next/packages/tdesign-vue-next/helper/attributes.json @@ -3603,6 +3603,10 @@ "type": "event", "description": "关闭时触发，事件参数包含触发关闭的来源：关闭按钮、遮罩层、ESC 键\n\n[docs](https://tdesign.tencent.com/vue-next/components/image-viewer?tab=api#imageviewer-events)" }, + "t-image-viewer/download": { + "type": "event", + "description": "自定义预览图片下载操作，url为图片链接\n\n[docs](https://tdesign.tencent.com/vue-next/components/image-viewer?tab=api#imageviewer-events)" + }, "t-image-viewer/index-change": { "type": "event", "description": "预览图片切换时触发，`context.prev` 切换到上一张图片，`context.next` 切换到下一张图片\n\n[docs](https://tdesign.tencent.com/vue-next/components/image-viewer?tab=api#imageviewer-events)" @@ -4526,14 +4530,26 @@ "type": "String|TNode", "description": "content of paragraph\n\n段落内容\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#paragraph-props)" }, + "t-typography-paragraph/content": { + "type": "String|TNode", + "description": "content of paragraph\n\n段落内容\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#paragraph-props)" + }, "t-paragraph/default": { "type": "String|TNode", "description": "default slot of paragraph\n\n段落内容\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#paragraph-props)" }, + "t-typography-paragraph/default": { + "type": "String|TNode", + "description": "default slot of paragraph\n\n段落内容\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#paragraph-props)" + }, "t-paragraph/ellipsis": { "type": "Boolean|Object", "description": "add ellipsis style\n\n是否省略展示，可通过配置参数自定义省略操作的具体功能和样式\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#paragraph-props)" }, + "t-typography-paragraph/ellipsis": { + "type": "Boolean|Object", + "description": "add ellipsis style\n\n是否省略展示，可通过配置参数自定义省略操作的具体功能和样式\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#paragraph-props)" + }, "t-popconfirm/cancel-btn": { "type": "String|Object|TNode", "description": "取消按钮，可自定义。值为 null 则不显示取消按钮。值类型为字符串，则表示自定义按钮文本，值类型为 Object 则表示透传 Button 组件属性。使用 TNode 自定义按钮时，需自行控制取消事件\n\ndefault: ''\n\n[docs](https://tdesign.tencent.com/vue-next/components/popconfirm?tab=api#popconfirm-props)" @@ -6821,46 +6837,90 @@ "type": "Boolean", "description": "add code style\n\n是否添加代码样式\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" }, + "t-typography-text/code": { + "type": "Boolean", + "description": "add code style\n\n是否添加代码样式\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" + }, "t-text/content": { "type": "String|TNode", "description": "content of text\n\n文本内容\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" }, + "t-typography-text/content": { + "type": "String|TNode", + "description": "content of text\n\n文本内容\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" + }, "t-text/copyable": { "type": "Boolean|Object", "description": "add copyable style\n\n是否可复制，可通过配置参数自定义复制操作的具体功能和样式\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" }, + "t-typography-text/copyable": { + "type": "Boolean|Object", + "description": "add copyable style\n\n是否可复制，可通过配置参数自定义复制操作的具体功能和样式\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" + }, "t-text/default": { "type": "String|TNode", "description": "default slot of text\n\n文本内容\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" }, + "t-typography-text/default": { + "type": "String|TNode", + "description": "default slot of text\n\n文本内容\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" + }, "t-text/delete": { "type": "Boolean", "description": "add delete line style\n\n是否添加删除线样式\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" }, + "t-typography-text/delete": { + "type": "Boolean", + "description": "add delete line style\n\n是否添加删除线样式\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" + }, "t-text/disabled": { "type": "Boolean", "description": "add disabled style\n\n是否添加不可用样式\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" }, + "t-typography-text/disabled": { + "type": "Boolean", + "description": "add disabled style\n\n是否添加不可用样式\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" + }, "t-text/ellipsis": { "type": "Boolean|Object", "description": "add ellipsis style\n\n是否省略展示，可通过配置参数自定义省略操作的具体功能和样式\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" }, + "t-typography-text/ellipsis": { + "type": "Boolean|Object", + "description": "add ellipsis style\n\n是否省略展示，可通过配置参数自定义省略操作的具体功能和样式\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" + }, "t-text/italic": { "type": "Boolean", "description": "add italic style\n\n文本是否为斜体\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" }, + "t-typography-text/italic": { + "type": "Boolean", + "description": "add italic style\n\n文本是否为斜体\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" + }, "t-text/keyboard": { "type": "Boolean", "description": "add keyboard style\n\n是否添加键盘样式\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" }, + "t-typography-text/keyboard": { + "type": "Boolean", + "description": "add keyboard style\n\n是否添加键盘样式\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" + }, "t-text/mark": { "type": "String|Boolean", "description": "add mark style\n\n是否添加标记样式，默认为黄色，可通过配置颜色修改标记样式，如#0052D9\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" }, + "t-typography-text/mark": { + "type": "String|Boolean", + "description": "add mark style\n\n是否添加标记样式，默认为黄色，可通过配置颜色修改标记样式，如#0052D9\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" + }, "t-text/strong": { "type": "Boolean", "description": "add bold style\n\n文本是否加粗\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" }, + "t-typography-text/strong": { + "type": "Boolean", + "description": "add bold style\n\n文本是否加粗\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" + }, "t-text/theme": { "type": "String", "options": [ @@ -6872,10 +6932,25 @@ ], "description": "theme of text\n\n主题\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" }, + "t-typography-text/theme": { + "type": "String", + "options": [ + "primary", + "secondary", + "success", + "warning", + "error" + ], + "description": "theme of text\n\n主题\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" + }, "t-text/underline": { "type": "Boolean", "description": "add underline style\n\n是否添加下划线样式\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" }, + "t-typography-text/underline": { + "type": "Boolean", + "description": "add underline style\n\n是否添加下划线样式\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props)" + }, "t-textarea/allow-input-over-max": { "type": "Boolean", "description": "超出maxlength或maxcharacter之后是否还允许输入\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/vue-next/components/textarea?tab=api#textarea-props)" @@ -7253,14 +7328,26 @@ "type": "String|TNode", "description": "content of title\n\n段落内容\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#title-props)" }, + "t-typography-title/content": { + "type": "String|TNode", + "description": "content of title\n\n段落内容\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#title-props)" + }, "t-title/default": { "type": "String|TNode", "description": "default slot of title\n\n标题内容\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#title-props)" }, + "t-typography-title/default": { + "type": "String|TNode", + "description": "default slot of title\n\n标题内容\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#title-props)" + }, "t-title/ellipsis": { "type": "Boolean|Object", "description": "add ellipsis style\n\n是否省略展示，可通过配置参数自定义省略操作的具体功能和样式\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#title-props)" }, + "t-typography-title/ellipsis": { + "type": "Boolean|Object", + "description": "add ellipsis style\n\n是否省略展示，可通过配置参数自定义省略操作的具体功能和样式\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#title-props)" + }, "t-title/level": { "type": "String", "options": [ @@ -7273,6 +7360,18 @@ ], "description": "level of title\n\n标题等级\n\ndefault: h1\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#title-props)" }, + "t-typography-title/level": { + "type": "String", + "options": [ + "h1", + "h2", + "h3", + "h4", + "h5", + "h6" + ], + "description": "level of title\n\n标题等级\n\ndefault: h1\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography?tab=api#title-props)" + }, "t-tooltip/delay": { "type": "Number|Array", "description": "delay to show or hide popover\n\n延时显示或隐藏浮层，[延迟显示的时间，延迟隐藏的时间]，单位：毫秒。直接透传到 Popup 组件。如果只有一个时间，则表示显示和隐藏的延迟时间相同。示例 `'300'` 或者 `[200, 200]`。默认为：[250, 150]\n\n[docs](https://tdesign.tencent.com/vue-next/components/tooltip?tab=api#tooltip-props)" diff --git a/packages/products/tdesign-vue-next/packages/tdesign-vue-next/helper/tags.json b/packages/products/tdesign-vue-next/packages/tdesign-vue-next/helper/tags.json index a15a3816..79fbb736 100644 --- a/packages/products/tdesign-vue-next/packages/tdesign-vue-next/helper/tags.json +++ b/packages/products/tdesign-vue-next/packages/tdesign-vue-next/helper/tags.json @@ -1039,6 +1039,7 @@ "visible", "z-index", "close", + "download", "index-change" ], "description": "ImageViewer\n\n图片预览\n\n[docs](https://tdesign.tencent.com/vue-next/components/image-viewer)" @@ -1344,6 +1345,14 @@ ], "description": "Paragraph\n\n段落\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography)" }, + "t-typography-paragraph": { + "attributes": [ + "content", + "default", + "ellipsis" + ], + "description": "Paragraph\n\n段落\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography)" + }, "t-popconfirm": { "attributes": [ "cancel-btn", @@ -1969,6 +1978,24 @@ ], "description": "Text\n\n文本\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography)" }, + "t-typography-text": { + "attributes": [ + "code", + "content", + "copyable", + "default", + "delete", + "disabled", + "ellipsis", + "italic", + "keyboard", + "mark", + "strong", + "theme", + "underline" + ], + "description": "Text\n\n文本\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography)" + }, "t-textarea": { "attributes": [ "allow-input-over-max", @@ -2083,6 +2110,15 @@ ], "description": "Title\n\n标题\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography)" }, + "t-typography-title": { + "attributes": [ + "content", + "default", + "ellipsis", + "level" + ], + "description": "Title\n\n标题\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography)" + }, "t-tooltip": { "attributes": [ "delay", @@ -2321,5 +2357,9 @@ "z-index" ], "description": "Watermark\n\n水印\n\n[docs](https://tdesign.tencent.com/vue-next/components/watermark)" + }, + "t-typography": { + "attributes": [], + "description": "Typography\n\n排版\n\n[docs](https://tdesign.tencent.com/vue-next/components/typography)" } } \ No newline at end of file diff --git a/packages/products/tdesign-vue-next/packages/tdesign-vue-next/helper/web-types.json b/packages/products/tdesign-vue-next/packages/tdesign-vue-next/helper/web-types.json index f277c2af..2e5a3d6f 100644 --- a/packages/products/tdesign-vue-next/packages/tdesign-vue-next/helper/web-types.json +++ b/packages/products/tdesign-vue-next/packages/tdesign-vue-next/helper/web-types.json @@ -19,55 +19,40 @@ "name": "container", "description": "指定滚动的容器。数据类型为 String 时，会被当作选择器处理，进行节点查询。示例：'body' 或 () => document.body", "doc-url": "https://tdesign.tencent.com/vue-next/components/affix?tab=api#affix-props", - "type": [ - "String", - "Function" - ], + "type": "ScrollContainer", "default": "() => (() => window)" }, { "name": "content", "description": "内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/affix?tab=api#affix-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "default", "description": "内容，同 content", "doc-url": "https://tdesign.tencent.com/vue-next/components/affix?tab=api#affix-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "offset-bottom", "description": "When the distance from the bottom of the container reaches the specified distance, the trigger is fixed\n\n 距离容器底部达到指定距离后触发固定", "doc-url": "https://tdesign.tencent.com/vue-next/components/affix?tab=api#affix-props", - "type": [ - "Number" - ], + "type": "number", "default": "0" }, { "name": "offset-top", "description": "When the distance from the top of the container reaches the specified distance, the trigger is fixed\n\n 距离容器顶部达到指定距离后触发固定", "doc-url": "https://tdesign.tencent.com/vue-next/components/affix?tab=api#affix-props", - "type": [ - "Number" - ], + "type": "number", "default": "0" }, { "name": "z-index", "description": "固钉定位层级，样式默认为 500", "doc-url": "https://tdesign.tencent.com/vue-next/components/affix?tab=api#affix-props", - "type": [ - "Number" - ] + "type": "number" } ], "js": { @@ -104,63 +89,45 @@ "name": "close", "description": "关闭按钮。值为 true 则显示默认关闭按钮；值为 false 则不显示按钮；值类型为 string 则直接显示；值类型为 Function 则可以自定关闭按钮", "doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-props", - "type": [ - "String", - "Boolean", - "TNode" - ], + "type": "string | boolean | TNode", "default": "false" }, { "name": "default", "description": "内容，同 message", "doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "icon", "description": "图标", "doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-props", - "type": [ - "TNode" - ] + "type": "TNode" }, { "name": "max-line", "description": "内容显示最大行数，超出的内容会折叠收起，用户点击后再展开。值为 0 表示不折叠", "doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-props", - "type": [ - "Number" - ], + "type": "number", "default": "0" }, { "name": "message", "description": "内容（子元素）", "doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "operation", "description": "跟在告警内容后面的操作区", "doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-props", - "type": [ - "TNode" - ] + "type": "TNode" }, { "name": "theme", "description": "组件风格", "doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-props", - "type": [ - "String" - ], + "type": "'success' | 'info' | 'warning' | 'error'", "default": "info", "attribute-value": { "type": "enum" @@ -184,10 +151,7 @@ "name": "title", "description": "标题", "doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" } ], "js": { @@ -249,52 +213,39 @@ "name": "affix-props", "description": "透传 Affix 组件属性，即让 Anchor 组件支持所有 Affix 组件特性", "doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchor-props", - "type": [ - "Object" - ] + "type": "AffixProps" }, { "name": "bounds", "description": "锚点区域边界", "doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchor-props", - "type": [ - "Number" - ], + "type": "number", "default": "5" }, { "name": "container", "description": "指定滚动的容器。数据类型为 String 时，会被当作选择器处理，进行节点查询。示例：'body' 或 () => document.body", "doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchor-props", - "type": [ - "String", - "Function" - ], + "type": "ScrollContainer", "default": "() => (() => window)" }, { "name": "cursor", "description": "用于自定义选中项左侧游标", "doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchor-props", - "type": [ - "TNode" - ] + "type": "TNode" }, { "name": "get-current-anchor", "description": "Custom Highlighted Anchor Points\n\n自定义高亮的锚点\t", "doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchor-props", - "type": [ - "Function" - ] + "type": "(activeLink: string) => string" }, { "name": "size", "description": "组件尺寸，small(120px)，medium(200px)，large(320px)", "doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchor-props", - "type": [ - "String" - ], + "type": "SizeEnum", "default": "medium", "attribute-value": { "type": "enum" @@ -315,9 +266,7 @@ "name": "target-offset", "description": "锚点滚动偏移量", "doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchor-props", - "type": [ - "Number" - ], + "type": "number", "default": "0" } ], @@ -355,26 +304,20 @@ "name": "custom-scroll", "description": "custom scroll effect, when set to true, clicking on an anchor link will not use JavaScript animation to smoothly scroll to the anchor target element.\n\n自定义滚动效果，为true时点击锚点链接后不会使用js动画平滑滚动到锚点目标元素", "doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchoritem-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "href", "description": "锚点链接, 如果是 hash 模式需要加上当前 path", "doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchoritem-props", - "type": [ - "String" - ] + "type": "string" }, { "name": "target", "description": "锚点文本", "doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchoritem-props", - "type": [ - "String" - ], + "type": "'_self' | '_blank' | '_parent' | '_top'", "default": "_self", "attribute-value": { "type": "enum" @@ -398,10 +341,7 @@ "name": "title", "description": "锚点文本", "doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchoritem-props", - "type": [ - "String", - "TNode" - ], + "type": "string | TNode", "default": "''" } ], @@ -425,17 +365,13 @@ "name": "id", "description": "目标内容 id", "doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchortarget-props", - "type": [ - "String" - ] + "type": "string" }, { "name": "tag", "description": "渲染的标签", "doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchortarget-props", - "type": [ - "String" - ], + "type": "string", "default": "div" } ], @@ -453,9 +389,7 @@ "name": "width", "description": "侧边栏宽度。样式表（class）中定义的默认宽度为：232px", "doc-url": "https://tdesign.tencent.com/vue-next/components/layout?tab=api#aside-props", - "type": [ - "String" - ] + "type": "string" } ], "slots": [] @@ -472,147 +406,109 @@ "name": "autofocus", "description": "自动获取焦点", "doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props", - "type": [ - "Boolean" - ] + "type": "boolean" }, { "name": "borderless", "description": "无边框模式", "doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "clearable", "description": "是否允许清空", "doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props", - "type": [ - "Boolean" - ] + "type": "boolean" }, { "name": "default", "description": "触发显示联想词下拉框的元素，同 `triggerElement`", "doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "disabled", "description": "是否禁用", "doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "undefined" }, { "name": "empty", "description": "当下拉联想词列表为空时显示的内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "filter", "description": "自定义过滤规则，用于对现有数据进行搜索过滤，判断是否过滤某一项数据。参数 `filterWords` 表示搜索词，`option`表示单个选项内容，返回值为 `true` 保留该选项，返回值为 `false` 则隐藏该选项。使用该方法时无需设置 `filterable`", "doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props", - "type": [ - "Function" - ] + "type": "(filterWords: string, option: T) => boolean | Promise" }, { "name": "filterable", "description": "是否根据输入内容过滤联想词。默认过滤规则不区分大小写，全文本任意位置匹配。如果默认搜索规则不符合业务需求，可以更为使用 `filter` 自定义过滤规则。部分场景下输入关键词和下拉联想词完全不同，此时可以设置为 `false`", "doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "highlight-keyword", "description": "是否高亮联想词中和输入值的相同部分", "doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "input-props", "description": "透传 Input 组件全部特性", "doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props", - "type": [ - "Object" - ] + "type": "InputProps" }, { "name": "options", "description": "下拉联想词列表。示例一：`['联想词一', '联想词二']`。示例二：`{ label: () =>
联想词元素
, text: '用于搜索的纯联想词' }`", "doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props", - "type": [ - "Array" - ] + "type": "Array" }, { "name": "panel-bottom-content", "description": "面板内的底部内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "panel-top-content", "description": "面板内的顶部内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "placeholder", "description": "输入框为空时的占位提示。组件本身默认值为 `undefined`，但全局配置存在默认值，不同语言全局默认值不同", "doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props", - "type": [ - "String" - ], + "type": "string", "default": "undefined" }, { "name": "popup-props", "description": "透传 Popup 组件全部属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props", - "type": [ - "Object" - ] + "type": "PopupProps" }, { "name": "readonly", "description": "是否只读", "doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "undefined" }, { "name": "size", "description": "组件尺寸", "doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props", - "type": [ - "String" - ], + "type": "SizeEnum", "default": "medium", "attribute-value": { "type": "enum" @@ -633,9 +529,7 @@ "name": "status", "description": "输入框状态", "doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props", - "type": [ - "String" - ], + "type": "'default' | 'success' | 'warning' | 'error'", "default": "default", "attribute-value": { "type": "enum" @@ -659,35 +553,25 @@ "name": "textarea-props", "description": "透传 Textarea 组件全部特性", "doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props", - "type": [ - "Object" - ] + "type": "TextareaProps" }, { "name": "tips", "description": "输入框下方提示文本，会根据不同的 `status` 呈现不同的样式", "doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "trigger-element", "description": "触发显示联想词下拉框的元素，默认为 Input 组件，可以使用 `trigger` 自定义为 Textarea 组件或其他组件", "doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "value", "description": "输入框的值，即当前指定的联想词", "doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props", - "type": [ - "String" - ] + "type": "string" } ], "js": { @@ -794,68 +678,50 @@ "name": "alt", "description": "show it when url is not valid\n\n头像替换文本，仅当图片加载失败时有效", "doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatar-props", - "type": [ - "String" - ] + "type": "string" }, { "name": "content", "description": "content slot or props.content\n\n子元素内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatar-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "default", "description": "default slot or props.default, same as `content`\n\n子元素内容，同 content", "doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatar-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "hide-on-load-failed", "description": "hide image when loading image failed\n\n加载失败时隐藏图片", "doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatar-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "icon", "description": "use icon to fill\n\n图标", "doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatar-props", - "type": [ - "TNode" - ] + "type": "TNode" }, { "name": "image", "description": "images url\n\n图片地址", "doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatar-props", - "type": [ - "String" - ] + "type": "string" }, { "name": "image-props", "description": "透传至 Image 组件", "doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatar-props", - "type": [ - "Object" - ] + "type": "ImageProps" }, { "name": "shape", "description": "shape\n\n形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.shape 决定", "doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatar-props", - "type": [ - "String" - ], + "type": "ShapeEnum", "attribute-value": { "type": "enum" }, @@ -872,9 +738,7 @@ "name": "size", "description": "size\n\n尺寸，示例值：small/medium/large/24px/38px 等。优先级高于 AvatarGroup.size 。Avatar 单独存在时，默认值为 medium。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.size 决定", "doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatar-props", - "type": [ - "String" - ] + "type": "string" } ], "js": { @@ -931,9 +795,7 @@ "name": "cascading", "description": "multiple images cascading\n\n图片之间的层叠关系，可选值：左侧图片在上和右侧图片在上", "doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatargroup-props", - "type": [ - "String" - ], + "type": "CascadingValue", "default": "'right-up'", "attribute-value": { "type": "enum" @@ -951,34 +813,25 @@ "name": "collapse-avatar", "description": "头像数量超出时，会出现一个头像折叠元素。该元素内容可自定义。默认为 `+N`。示例：`+5`，`...`, `更多`", "doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatargroup-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "max", "description": "能够同时显示的最多头像数量", "doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatargroup-props", - "type": [ - "Number" - ] + "type": "number" }, { "name": "popup-props", "description": "头像右上角提示信息", "doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatargroup-props", - "type": [ - "Object" - ] + "type": "PopupProps" }, { "name": "shape", "description": "shape\n\n形状。优先级低于 Avatar.shape", "doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatargroup-props", - "type": [ - "String" - ], + "type": "ShapeEnum", "attribute-value": { "type": "enum" }, @@ -995,9 +848,7 @@ "name": "size", "description": "size\n\n尺寸，示例值：small/medium/large/24px/38px 等。优先级低于 Avatar.size", "doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatargroup-props", - "type": [ - "String" - ] + "type": "string" } ], "js": { @@ -1034,55 +885,40 @@ "name": "container", "description": "监听滚动的容器。数据类型为 String 时，会被当作选择器处理，进行节点查询。示例：'body' 或 () => document.body", "doc-url": "https://tdesign.tencent.com/vue-next/components/back-top?tab=api#backtop-props", - "type": [ - "String", - "Function" - ], + "type": "AttachNode", "default": "'body'" }, { "name": "content", "description": "Backtop's children elements\n\n回到顶部内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/back-top?tab=api#backtop-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "default", "description": "Backtop's children elements, same as `content`\n\n回到顶部内容，同 `content`", "doc-url": "https://tdesign.tencent.com/vue-next/components/back-top?tab=api#backtop-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "duration", "description": "回到顶部的耗时单位：毫秒", "doc-url": "https://tdesign.tencent.com/vue-next/components/back-top?tab=api#backtop-props", - "type": [ - "Number" - ], + "type": "number", "default": "200" }, { "name": "offset", "description": "回到顶部相对右下角的位置偏移，示例：[10, 20] 或 ['10em', '8rem']", "doc-url": "https://tdesign.tencent.com/vue-next/components/back-top?tab=api#backtop-props", - "type": [ - "Array" - ], + "type": "Array", "default": "[\"24px\", \"80px\"]" }, { "name": "shape", "description": "shape of BackTop element\n\n回到顶部的形状", "doc-url": "https://tdesign.tencent.com/vue-next/components/back-top?tab=api#backtop-props", - "type": [ - "String" - ], + "type": "BackTopShapeEnum ", "default": "square", "attribute-value": { "type": "enum" @@ -1100,9 +936,7 @@ "name": "size", "description": "size of BackTop\n\n组件尺寸", "doc-url": "https://tdesign.tencent.com/vue-next/components/back-top?tab=api#backtop-props", - "type": [ - "String" - ], + "type": "'medium' | 'small'", "default": "medium", "attribute-value": { "type": "enum" @@ -1120,19 +954,14 @@ "name": "target", "description": "指定回到该对象。数据类型为 String 时，会被当作选择器处理，进行节点查询。示例：'body' 或 () => document.body", "doc-url": "https://tdesign.tencent.com/vue-next/components/back-top?tab=api#backtop-props", - "type": [ - "String", - "Function" - ], + "type": "AttachNode", "default": "'body'" }, { "name": "theme", "description": "theme of BackTop\n\n组件主题风格，浅色、主色、深色", "doc-url": "https://tdesign.tencent.com/vue-next/components/back-top?tab=api#backtop-props", - "type": [ - "String" - ], + "type": "'light' | 'primary' | 'dark'", "default": "light", "attribute-value": { "type": "enum" @@ -1153,10 +982,7 @@ "name": "visible-height", "description": "滚动高度达到此参数值才出现", "doc-url": "https://tdesign.tencent.com/vue-next/components/back-top?tab=api#backtop-props", - "type": [ - "String", - "Number" - ], + "type": "string | number", "default": "'200px'" } ], @@ -1194,72 +1020,52 @@ "name": "color", "description": "颜色", "doc-url": "https://tdesign.tencent.com/vue-next/components/badge?tab=api#badge-props", - "type": [ - "String" - ] + "type": "string" }, { "name": "content", "description": "徽标内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/badge?tab=api#badge-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "count", "description": "徽标右上角内容。可以是数字，也可以是文字。如：'new'/3/99+", "doc-url": "https://tdesign.tencent.com/vue-next/components/badge?tab=api#badge-props", - "type": [ - "String", - "Number", - "TNode" - ], + "type": "string | number | TNode", "default": "0" }, { "name": "default", "description": "徽标内容，默认插槽，同 content", "doc-url": "https://tdesign.tencent.com/vue-next/components/badge?tab=api#badge-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "dot", "description": "是否为红点", "doc-url": "https://tdesign.tencent.com/vue-next/components/badge?tab=api#badge-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "max-count", "description": "封顶的数字值", "doc-url": "https://tdesign.tencent.com/vue-next/components/badge?tab=api#badge-props", - "type": [ - "Number" - ], + "type": "number", "default": "99" }, { "name": "offset", "description": "设置状态点的位置偏移，示例：[-10, 20] 或 ['10em', '8rem']", "doc-url": "https://tdesign.tencent.com/vue-next/components/badge?tab=api#badge-props", - "type": [ - "Array" - ] + "type": "Array" }, { "name": "shape", "description": "形状", "doc-url": "https://tdesign.tencent.com/vue-next/components/badge?tab=api#badge-props", - "type": [ - "String" - ], + "type": "'circle' | 'round'", "default": "circle", "attribute-value": { "type": "enum" @@ -1277,18 +1083,14 @@ "name": "show-zero", "description": "当数值为 0 时，是否展示徽标", "doc-url": "https://tdesign.tencent.com/vue-next/components/badge?tab=api#badge-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "size", "description": "尺寸", "doc-url": "https://tdesign.tencent.com/vue-next/components/badge?tab=api#badge-props", - "type": [ - "String" - ], + "type": "'small' | 'medium'", "default": "medium", "attribute-value": { "type": "enum" @@ -1333,366 +1135,265 @@ "name": "active-row-keys", "description": "keys of highlight rows, used to mock area selection behavior, just like macOS or windows area selection\n\n高亮行，支持鼠标键盘操作(Shift)连续高亮行，可用于处理行选中等批量操作，模拟操作系统区域选择行为", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Array" - ], + "type": "Array", "default": "[]" }, { "name": "active-row-type", "description": "make nodes can be highlight on clicked\n\n默认不会高亮点击行，`activeRowType=single` 表示鼠标点击仅允许同时高亮一行，Shift 键盘操作加鼠标操作依然可以高亮多行，因为这属于明显的区域选择行为。`activeRowType= multiple ` 表示允许鼠标点击同时高亮多行", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String" - ] + "type": "'single' | 'multiple'" }, { "name": "allow-resize-column-width", "description": "allow to resize column width\n\n是否允许调整列宽。请更为使用 `resizable`", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "undefined" }, { "name": "attach", "description": "elements with popup would be attached to `attach`\n\n超出省略等所有浮层元素统一绑定到 `attach`，可根据实际情况调整挂载元素", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String", - "Function" - ] + "type": "AttachNode" }, { "name": "bordered", "description": "show table bordered\n\n是否显示表格边框", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "bottom-content", "description": "表格底部内容，可以用于自定义列设置等", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "cell-empty-content", "description": "单元格数据为空时呈现的内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode>" }, { "name": "columns", "description": "table column configs\n\n列配置，泛型 T 指表格数据类型", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Array" - ], + "type": "Array>", "default": "[]" }, { "name": "data", "description": "table data\n\n数据源，泛型 T 指表格数据类型", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Array" - ], + "type": "Array", "default": "[]" }, { "name": "disable-data-page", "description": "是否禁用本地数据分页。当 `data` 数据长度超过分页大小时，会自动进行本地数据分页。如果 `disableDataPage` 设置为 true，则无论何时，都不会进行本地数据分页", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "disable-space-inactive-row", "description": "can not set row to be inactive with Space keydown\n\n默认重复按下 Space 键可取消当前行高亮，是否禁用取消", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "undefined" }, { "name": "empty", "description": "empty text or empty element\n\n空表格呈现样式，支持全局配置 `GlobalConfigProvider`", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String", - "TNode" - ], + "type": "string | TNode", "default": "''" }, { "name": "first-full-row", "description": "首行内容，横跨所有列", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "fixed-rows", "description": "固定行（冻结行），示例：[M, N]，表示冻结表头 M 行和表尾 N 行。M 和 N 值为 0 时，表示不冻结行", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Array" - ] + "type": "Array" }, { "name": "foot-data", "description": "table foot data\n\n表尾数据源，泛型 T 指表格数据类型", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Array" - ], + "type": "Array", "default": "[]" }, { "name": "footer-affix-props", "description": "affix props\n\n请更为使用 `footerAffixedBottom`。表尾吸底基于 Affix 组件开发，透传全部 Affix 组件属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Object" - ] + "type": "Partial" }, { "name": "footer-affixed-bottom", "description": "affix foot to viewport bottom\n\n表尾吸底。使用该功能，需要非常注意表格是相对于哪一个父元素进行滚动。值为 `true`，则表示相对于整个窗口吸底。如果表格滚动的父元素不是整个窗口，请通过 `footerAffixedBottom.container` 调整固钉的吸顶范围。基于 Affix 组件开发，透传全部 Affix 组件属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean", - "Object" - ], + "type": "boolean | Partial", "default": "false" }, { "name": "footer-summary", "description": "footer summary content\n\n表尾总结行", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "header-affix-props", "description": "affix props\n\n请更为使用 `headerAffixedTop`。表头吸顶基于 Affix 组件开发，透传全部 Affix 组件属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Object" - ] + "type": "Partial" }, { "name": "header-affixed-top", "description": "affix header to viewport top\n\n表头吸顶。使用该功能，需要非常注意表格是相对于哪一个父元素进行滚动。值为 `true`，表示相对于整个窗口吸顶。如果表格滚动的父元素不是整个窗口，请通过 `headerAffixedTop.container` 调整吸顶的位置。基于 Affix 组件开发，透传全部 Affix 组件属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean", - "Object" - ], + "type": "boolean | Partial", "default": "false" }, { "name": "height", "description": "table height\n\n表格高度，超出后会出现滚动条。示例：100, '30%', '300'。值为数字类型，会自动加上单位 px。如果不是绝对固定表格高度，建议使用 `maxHeight`", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String", - "Number" - ] + "type": "string | number" }, { "name": "horizontal-scroll-affixed-bottom", "description": "affix props\n\n滚动条吸底。基于 Affix 组件开发，透传全部 Affix 组件属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean", - "Object" - ] + "type": "boolean | Partial" }, { "name": "hover", "description": "show hover style\n\n是否显示鼠标悬浮状态", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "keyboard-row-hover", "description": "make table row to be hover by keydown ArrowUp/ArrowDown\n\n键盘操作行显示悬浮效果，一般用于键盘操作行选中、行展开、行高亮等功能", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "last-full-row", "description": "尾行内容，横跨所有列", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "lazy-load", "description": "load table content when it entering the visible area, all elements in table are not rendered before it become visible\n\n是否启用整个表格元素的懒加载，当页面滚动到可视区域后再渲染表格。注意和表格内部行滚动懒加载的区别，内部行滚动无论表格是否在可视区域都会默认渲染第一屏的行元素", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "loading", "description": "loading state table\n\n加载中状态。值为 `true` 会显示默认加载中样式，可以通过 Function 和 插槽 自定义加载状态呈现内容和样式。值为 `false` 则会取消加载状态", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean", - "TNode" - ], + "type": "boolean | TNode", "default": "undefined" }, { "name": "loading-props", "description": "透传加载组件全部属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Object" - ] + "type": "Partial" }, { "name": "locale", "description": "table locale config\n\n语言配置", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Object" - ] + "type": "TableConfig" }, { "name": "max-height", "description": "table max height\n\n表格最大高度，超出后会出现滚动条。示例：100, '30%', '300'。值为数字类型，会自动加上单位 px", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String", - "Number" - ] + "type": "string | number" }, { "name": "pagination", "description": "you can use all props of pagination component with paginationProps\n\n分页配置，值为空则不显示。具体 API 参考分页组件。当 `data` 数据长度超过分页大小时，会自动对本地数据 `data` 进行排序，如果不希望对于 `data` 进行排序，可以设置 `disableDataPage = true`", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Object" - ] + "type": "PaginationProps" }, { "name": "pagination-affixed-bottom", "description": "affix props\n\n分页吸底。基于 Affix 组件开发，透传全部 Affix 组件属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean", - "Object" - ] + "type": "boolean | Partial" }, { "name": "resizable", "description": "allow to resize column width, set `tableLayout=fixed` would be better\n\n是否允许调整列宽，设置 `tableLayout=fixed` 效果更友好，此时不允许通过 CSS 设置 `table`元素宽度，也不允许设置 `tableContentWidth`。一般不建议在列宽调整场景使用 `tableLayout: auto`。如果想要配置宽度可调整的最小值和最大值，请使用 `column.resize`，示例：`columns: [{ resize: { minWidth: 120, maxWidth: 300 } }]`。
默认规则：因列宽超出存在横向滚动条时，列宽调整仅影响当前列宽和总列宽；表格列较少没有横向滚动条时，列宽调整表现为自身宽度和相邻宽度变化", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "row-attributes", "description": "`tr` attributes\n\nHTML 标签 `tr` 的属性。类型为 Function 时，参数说明：`params.row` 表示行数据；`params.rowIndex` 表示行下标；`params.type=body` 表示属性作用于 `tbody` 中的元素；`params.type=foot` 表示属性作用于 `tfoot` 中的元素。
示例一：{ draggable: true }，
示例二：[{ draggable: true }, { title: '超出省略显示' }]。
示例三：() => [{ draggable: true }]", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Object", - "Array", - "Function" - ] + "type": "TableRowAttributes" }, { "name": "row-class-name", "description": "table `th` classname\n\n行类名，泛型 T 指表格数据类型。`params.row` 表示行数据；`params.rowIndex` 表示行下标；`params.type=body` 表示类名作用于 `tbody` 中的元素；`params.type= tfoot` 表示类名作用于 `tfoot` 中的元素", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String", - "Object", - "Array", - "Function" - ] + "type": "ClassName | ((params: RowClassNameParams) => ClassName)" }, { "name": "row-key", "description": "unique key for each row data\n\n唯一标识一行数据的字段名，来源于 `data` 中的字段。如果是字段嵌套多层，可以设置形如 `item.a.id` 的方法", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String" - ], + "type": "string", "default": "'id'" }, { "name": "rowspan-and-colspan", "description": "rowspan and colspan\n\n用于自定义合并单元格，泛型 T 指表格数据类型。示例：`({ row, col, rowIndex, colIndex }) => { rowspan: 2, colspan: 3 }`", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Function" - ] + "type": "TableRowspanAndColspanFunc" }, { "name": "rowspan-and-colspan-in-footer", "description": "rowspan and colspan for footer\n\n用于自定义表尾的合并单元格，泛型 T 指表格数据类型。示例：`({ row, col, rowIndex, colIndex }) => { rowspan: 2, colspan: 3 }`", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Function" - ] + "type": "TableRowspanAndColspanFunc" }, { "name": "scroll", "description": "lazy load and virtual scroll\n\n懒加载和虚拟滚动。为保证组件收益最大化，当数据量小于阈值 `scroll.threshold` 时，无论虚拟滚动的配置是否存在，组件内部都不会开启虚拟滚动，`scroll.threshold` 默认为 `100`", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Object" - ] + "type": "TScroll" }, { "name": "show-header", "description": "show table header\n\n是否显示表头", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "size", "description": "table size, support `GlobalConfigProvider`, default value is `medium`\n\n表格尺寸，支持全局配置 `GlobalConfigProvider`，默认全局配置值为 `medium`", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String" - ], + "type": "SizeEnum", "attribute-value": { "type": "enum" }, @@ -1712,26 +1413,20 @@ "name": "stripe", "description": "show stripe style\n\n是否显示斑马纹", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "table-content-width", "description": "表格内容的总宽度，注意不是表格可见宽度。主要应用于 `table-layout: auto` 模式下的固定列显示。`tableContentWidth` 内容宽度的值必须大于表格可见宽度", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String" - ] + "type": "string" }, { "name": "table-layout", "description": "table-layout css properties, [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout). set value to be `fixed` on `resizable=true` please\n\n表格布局方式，`` 元素原生属性。[MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout)。注意，在列宽调整下场景只能使用 `fixed` 模式", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String" - ], + "type": "'auto' | 'fixed'", "default": "fixed", "attribute-value": { "type": "enum" @@ -1749,18 +1444,13 @@ "name": "top-content", "description": "表格顶部内容，可以用于自定义列设置、顶部查询条件等", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "vertical-align", "description": "vertical align\n\n行内容上下方向对齐", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String" - ], + "type": "'top' | 'middle' | 'bottom'", "default": "middle", "attribute-value": { "type": "enum" @@ -1942,366 +1632,265 @@ "name": "active-row-keys", "description": "keys of highlight rows, used to mock area selection behavior, just like macOS or windows area selection\n\n高亮行，支持鼠标键盘操作(Shift)连续高亮行，可用于处理行选中等批量操作，模拟操作系统区域选择行为", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Array" - ], + "type": "Array", "default": "[]" }, { "name": "active-row-type", "description": "make nodes can be highlight on clicked\n\n默认不会高亮点击行，`activeRowType=single` 表示鼠标点击仅允许同时高亮一行，Shift 键盘操作加鼠标操作依然可以高亮多行，因为这属于明显的区域选择行为。`activeRowType= multiple ` 表示允许鼠标点击同时高亮多行", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String" - ] + "type": "'single' | 'multiple'" }, { "name": "allow-resize-column-width", "description": "allow to resize column width\n\n是否允许调整列宽。请更为使用 `resizable`", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "undefined" }, { "name": "attach", "description": "elements with popup would be attached to `attach`\n\n超出省略等所有浮层元素统一绑定到 `attach`，可根据实际情况调整挂载元素", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String", - "Function" - ] + "type": "AttachNode" }, { "name": "bordered", "description": "show table bordered\n\n是否显示表格边框", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "bottom-content", "description": "表格底部内容，可以用于自定义列设置等", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "cell-empty-content", "description": "单元格数据为空时呈现的内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode>" }, { "name": "columns", "description": "table column configs\n\n列配置，泛型 T 指表格数据类型", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Array" - ], + "type": "Array>", "default": "[]" }, { "name": "data", "description": "table data\n\n数据源，泛型 T 指表格数据类型", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Array" - ], + "type": "Array", "default": "[]" }, { "name": "disable-data-page", "description": "是否禁用本地数据分页。当 `data` 数据长度超过分页大小时，会自动进行本地数据分页。如果 `disableDataPage` 设置为 true，则无论何时，都不会进行本地数据分页", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "disable-space-inactive-row", "description": "can not set row to be inactive with Space keydown\n\n默认重复按下 Space 键可取消当前行高亮，是否禁用取消", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "undefined" }, { "name": "empty", "description": "empty text or empty element\n\n空表格呈现样式，支持全局配置 `GlobalConfigProvider`", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String", - "TNode" - ], + "type": "string | TNode", "default": "''" }, { "name": "first-full-row", "description": "首行内容，横跨所有列", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "fixed-rows", "description": "固定行（冻结行），示例：[M, N]，表示冻结表头 M 行和表尾 N 行。M 和 N 值为 0 时，表示不冻结行", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Array" - ] + "type": "Array" }, { "name": "foot-data", "description": "table foot data\n\n表尾数据源，泛型 T 指表格数据类型", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Array" - ], + "type": "Array", "default": "[]" }, { "name": "footer-affix-props", "description": "affix props\n\n请更为使用 `footerAffixedBottom`。表尾吸底基于 Affix 组件开发，透传全部 Affix 组件属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Object" - ] + "type": "Partial" }, { "name": "footer-affixed-bottom", "description": "affix foot to viewport bottom\n\n表尾吸底。使用该功能，需要非常注意表格是相对于哪一个父元素进行滚动。值为 `true`，则表示相对于整个窗口吸底。如果表格滚动的父元素不是整个窗口，请通过 `footerAffixedBottom.container` 调整固钉的吸顶范围。基于 Affix 组件开发，透传全部 Affix 组件属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean", - "Object" - ], + "type": "boolean | Partial", "default": "false" }, { "name": "footer-summary", "description": "footer summary content\n\n表尾总结行", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "header-affix-props", "description": "affix props\n\n请更为使用 `headerAffixedTop`。表头吸顶基于 Affix 组件开发，透传全部 Affix 组件属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Object" - ] + "type": "Partial" }, { "name": "header-affixed-top", "description": "affix header to viewport top\n\n表头吸顶。使用该功能，需要非常注意表格是相对于哪一个父元素进行滚动。值为 `true`，表示相对于整个窗口吸顶。如果表格滚动的父元素不是整个窗口，请通过 `headerAffixedTop.container` 调整吸顶的位置。基于 Affix 组件开发，透传全部 Affix 组件属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean", - "Object" - ], + "type": "boolean | Partial", "default": "false" }, { "name": "height", "description": "table height\n\n表格高度，超出后会出现滚动条。示例：100, '30%', '300'。值为数字类型，会自动加上单位 px。如果不是绝对固定表格高度，建议使用 `maxHeight`", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String", - "Number" - ] + "type": "string | number" }, { "name": "horizontal-scroll-affixed-bottom", "description": "affix props\n\n滚动条吸底。基于 Affix 组件开发，透传全部 Affix 组件属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean", - "Object" - ] + "type": "boolean | Partial" }, { "name": "hover", "description": "show hover style\n\n是否显示鼠标悬浮状态", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "keyboard-row-hover", "description": "make table row to be hover by keydown ArrowUp/ArrowDown\n\n键盘操作行显示悬浮效果，一般用于键盘操作行选中、行展开、行高亮等功能", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "last-full-row", "description": "尾行内容，横跨所有列", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "lazy-load", "description": "load table content when it entering the visible area, all elements in table are not rendered before it become visible\n\n是否启用整个表格元素的懒加载，当页面滚动到可视区域后再渲染表格。注意和表格内部行滚动懒加载的区别，内部行滚动无论表格是否在可视区域都会默认渲染第一屏的行元素", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "loading", "description": "loading state table\n\n加载中状态。值为 `true` 会显示默认加载中样式，可以通过 Function 和 插槽 自定义加载状态呈现内容和样式。值为 `false` 则会取消加载状态", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean", - "TNode" - ], + "type": "boolean | TNode", "default": "undefined" }, { "name": "loading-props", "description": "透传加载组件全部属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Object" - ] + "type": "Partial" }, { "name": "locale", "description": "table locale config\n\n语言配置", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Object" - ] + "type": "TableConfig" }, { "name": "max-height", "description": "table max height\n\n表格最大高度，超出后会出现滚动条。示例：100, '30%', '300'。值为数字类型，会自动加上单位 px", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String", - "Number" - ] + "type": "string | number" }, { "name": "pagination", "description": "you can use all props of pagination component with paginationProps\n\n分页配置，值为空则不显示。具体 API 参考分页组件。当 `data` 数据长度超过分页大小时，会自动对本地数据 `data` 进行排序，如果不希望对于 `data` 进行排序，可以设置 `disableDataPage = true`", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Object" - ] + "type": "PaginationProps" }, { "name": "pagination-affixed-bottom", "description": "affix props\n\n分页吸底。基于 Affix 组件开发，透传全部 Affix 组件属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean", - "Object" - ] + "type": "boolean | Partial" }, { "name": "resizable", "description": "allow to resize column width, set `tableLayout=fixed` would be better\n\n是否允许调整列宽，设置 `tableLayout=fixed` 效果更友好，此时不允许通过 CSS 设置 `table`元素宽度，也不允许设置 `tableContentWidth`。一般不建议在列宽调整场景使用 `tableLayout: auto`。如果想要配置宽度可调整的最小值和最大值，请使用 `column.resize`，示例：`columns: [{ resize: { minWidth: 120, maxWidth: 300 } }]`。
默认规则：因列宽超出存在横向滚动条时，列宽调整仅影响当前列宽和总列宽；表格列较少没有横向滚动条时，列宽调整表现为自身宽度和相邻宽度变化", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "row-attributes", "description": "`tr` attributes\n\nHTML 标签 `tr` 的属性。类型为 Function 时，参数说明：`params.row` 表示行数据；`params.rowIndex` 表示行下标；`params.type=body` 表示属性作用于 `tbody` 中的元素；`params.type=foot` 表示属性作用于 `tfoot` 中的元素。
示例一：{ draggable: true }，
示例二：[{ draggable: true }, { title: '超出省略显示' }]。
示例三：() => [{ draggable: true }]", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Object", - "Array", - "Function" - ] + "type": "TableRowAttributes" }, { "name": "row-class-name", "description": "table `th` classname\n\n行类名，泛型 T 指表格数据类型。`params.row` 表示行数据；`params.rowIndex` 表示行下标；`params.type=body` 表示类名作用于 `tbody` 中的元素；`params.type= tfoot` 表示类名作用于 `tfoot` 中的元素", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String", - "Object", - "Array", - "Function" - ] + "type": "ClassName | ((params: RowClassNameParams) => ClassName)" }, { "name": "row-key", "description": "unique key for each row data\n\n唯一标识一行数据的字段名，来源于 `data` 中的字段。如果是字段嵌套多层，可以设置形如 `item.a.id` 的方法", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String" - ], + "type": "string", "default": "'id'" }, { "name": "rowspan-and-colspan", "description": "rowspan and colspan\n\n用于自定义合并单元格，泛型 T 指表格数据类型。示例：`({ row, col, rowIndex, colIndex }) => { rowspan: 2, colspan: 3 }`", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Function" - ] + "type": "TableRowspanAndColspanFunc" }, { "name": "rowspan-and-colspan-in-footer", "description": "rowspan and colspan for footer\n\n用于自定义表尾的合并单元格，泛型 T 指表格数据类型。示例：`({ row, col, rowIndex, colIndex }) => { rowspan: 2, colspan: 3 }`", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Function" - ] + "type": "TableRowspanAndColspanFunc" }, { "name": "scroll", "description": "lazy load and virtual scroll\n\n懒加载和虚拟滚动。为保证组件收益最大化，当数据量小于阈值 `scroll.threshold` 时，无论虚拟滚动的配置是否存在，组件内部都不会开启虚拟滚动，`scroll.threshold` 默认为 `100`", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Object" - ] + "type": "TScroll" }, { "name": "show-header", "description": "show table header\n\n是否显示表头", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "size", "description": "table size, support `GlobalConfigProvider`, default value is `medium`\n\n表格尺寸，支持全局配置 `GlobalConfigProvider`，默认全局配置值为 `medium`", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String" - ], + "type": "SizeEnum", "attribute-value": { "type": "enum" }, @@ -2321,26 +1910,20 @@ "name": "stripe", "description": "show stripe style\n\n是否显示斑马纹", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "table-content-width", "description": "表格内容的总宽度，注意不是表格可见宽度。主要应用于 `table-layout: auto` 模式下的固定列显示。`tableContentWidth` 内容宽度的值必须大于表格可见宽度", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String" - ] + "type": "string" }, { "name": "table-layout", "description": "table-layout css properties, [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout). set value to be `fixed` on `resizable=true` please\n\n表格布局方式，`
` 元素原生属性。[MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout)。注意，在列宽调整下场景只能使用 `fixed` 模式", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String" - ], + "type": "'auto' | 'fixed'", "default": "fixed", "attribute-value": { "type": "enum" @@ -2358,18 +1941,13 @@ "name": "top-content", "description": "表格顶部内容，可以用于自定义列设置、顶部查询条件等", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "vertical-align", "description": "vertical align\n\n行内容上下方向对齐", "doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props", - "type": [ - "String" - ], + "type": "'top' | 'middle' | 'bottom'", "default": "middle", "attribute-value": { "type": "enum" @@ -2551,35 +2129,26 @@ "name": "max-item-width", "description": "单项最大宽度，超出后会以省略号形式呈现", "doc-url": "https://tdesign.tencent.com/vue-next/components/breadcrumb?tab=api#breadcrumb-props", - "type": [ - "String" - ], + "type": "string", "default": "undefined" }, { "name": "options", "description": "面包屑项，功能同 BreadcrumbItem", "doc-url": "https://tdesign.tencent.com/vue-next/components/breadcrumb?tab=api#breadcrumb-props", - "type": [ - "Array" - ] + "type": "Array" }, { "name": "separator", "description": "自定义分隔符", "doc-url": "https://tdesign.tencent.com/vue-next/components/breadcrumb?tab=api#breadcrumb-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "theme", "description": "组件风格", "doc-url": "https://tdesign.tencent.com/vue-next/components/breadcrumb?tab=api#breadcrumb-props", - "type": [ - "String" - ], + "type": "'light'", "default": "light", "attribute-value": { "type": "enum" @@ -2611,77 +2180,57 @@ "name": "content", "description": "子元素", "doc-url": "https://tdesign.tencent.com/vue-next/components/breadcrumb?tab=api#breadcrumbitem-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "default", "description": "子元素，同 content", "doc-url": "https://tdesign.tencent.com/vue-next/components/breadcrumb?tab=api#breadcrumbitem-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "disabled", "description": "是否禁用当前项点击", "doc-url": "https://tdesign.tencent.com/vue-next/components/breadcrumb?tab=api#breadcrumbitem-props", - "type": [ - "Boolean" - ] + "type": "boolean" }, { "name": "href", "description": "跳转链接", "doc-url": "https://tdesign.tencent.com/vue-next/components/breadcrumb?tab=api#breadcrumbitem-props", - "type": [ - "String" - ] + "type": "string" }, { "name": "icon", "description": "prefix icon in breadcrumb item\n\n面板屑项内的前置图标", "doc-url": "https://tdesign.tencent.com/vue-next/components/breadcrumb?tab=api#breadcrumbitem-props", - "type": [ - "TNode" - ] + "type": "TNode" }, { "name": "max-width", "description": "最大宽度，超出后会以省略号形式呈现。优先级高于 Breadcrumb 中的 maxItemWidth", "doc-url": "https://tdesign.tencent.com/vue-next/components/breadcrumb?tab=api#breadcrumbitem-props", - "type": [ - "String" - ], + "type": "string", "default": "undefined" }, { "name": "replace", "description": "路由跳转是否采用覆盖的方式（覆盖后将没有浏览器历史记录）", "doc-url": "https://tdesign.tencent.com/vue-next/components/breadcrumb?tab=api#breadcrumbitem-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "router", "description": "路由对象。如果项目存在 Router，则默认使用 Router", "doc-url": "https://tdesign.tencent.com/vue-next/components/breadcrumb?tab=api#breadcrumbitem-props", - "type": [ - "Object" - ] + "type": "any" }, { "name": "target", "description": "链接或路由跳转方式", "doc-url": "https://tdesign.tencent.com/vue-next/components/breadcrumb?tab=api#breadcrumbitem-props", - "type": [ - "String" - ], + "type": "'_blank' | '_self' | '_parent' | '_top'", "default": "_self", "attribute-value": { "type": "enum" @@ -2705,10 +2254,7 @@ "name": "to", "description": "路由跳转目标，当且仅当 Router 存在时，该 API 有效", "doc-url": "https://tdesign.tencent.com/vue-next/components/breadcrumb?tab=api#breadcrumbitem-props", - "type": [ - "String", - "Object" - ] + "type": "string | Route" } ], "js": { @@ -2750,96 +2296,72 @@ "name": "block", "description": "make button to be a block-level element\n\n是否为块级元素", "doc-url": "https://tdesign.tencent.com/vue-next/components/button?tab=api#button-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "content", "description": "button's children elements\n\n按钮内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/button?tab=api#button-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "default", "description": "default slot\n\n按钮内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/button?tab=api#button-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "disabled", "description": "disable the button, make it can not be clicked\n\n禁用状态。优先级：Button.disabled > Form.disabled", "doc-url": "https://tdesign.tencent.com/vue-next/components/button?tab=api#button-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "undefined" }, { "name": "form", "description": " native `form` attribute，which supports triggering events for a form with a specified id through the use of the form attribute\n\n原生的form属性，支持用于通过 form 属性触发对应 id 的 form 的表单事件", "doc-url": "https://tdesign.tencent.com/vue-next/components/button?tab=api#button-props", - "type": [ - "String" - ], + "type": "string", "default": "undefined" }, { "name": "ghost", "description": "make background-color to be transparent\n\n是否为幽灵按钮（镂空按钮）", "doc-url": "https://tdesign.tencent.com/vue-next/components/button?tab=api#button-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "href", "description": "跳转地址。href 存在时，按钮标签默认使用 `` 渲染；如果指定了 `tag` 则使用指定的标签渲染", "doc-url": "https://tdesign.tencent.com/vue-next/components/button?tab=api#button-props", - "type": [ - "String" - ] + "type": "string" }, { "name": "icon", "description": "use it to set left icon in button\n\n按钮内部图标，可完全自定义", "doc-url": "https://tdesign.tencent.com/vue-next/components/button?tab=api#button-props", - "type": [ - "TNode" - ] + "type": "TNode" }, { "name": "loading", "description": "set button to be loading state\n\n是否显示为加载状态", "doc-url": "https://tdesign.tencent.com/vue-next/components/button?tab=api#button-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "loading-props", "description": "透传 Loading 组件全部属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/button?tab=api#button-props", - "type": [ - "Object" - ] + "type": "LoadingProps" }, { "name": "shape", "description": "button shape\n\n按钮形状，有 4 种：长方形、正方形、圆角长方形、圆形", "doc-url": "https://tdesign.tencent.com/vue-next/components/button?tab=api#button-props", - "type": [ - "String" - ], + "type": "'rectangle' | 'square' | 'round' | 'circle'", "default": "rectangle", "attribute-value": { "type": "enum" @@ -2863,9 +2385,7 @@ "name": "size", "description": "a button has four size\n\n组件尺寸", "doc-url": "https://tdesign.tencent.com/vue-next/components/button?tab=api#button-props", - "type": [ - "String" - ], + "type": "SizeEnum", "default": "medium", "attribute-value": { "type": "enum" @@ -2886,17 +2406,13 @@ "name": "suffix", "description": "右侧内容，可用于定义右侧图标", "doc-url": "https://tdesign.tencent.com/vue-next/components/button?tab=api#button-props", - "type": [ - "TNode" - ] + "type": "TNode" }, { "name": "tag", "description": "HTML Tag Element\n\n渲染按钮的 HTML 标签，默认使用标签 ` }`", "doc-url": "https://tdesign.tencent.com/vue-next/components/slider?tab=api#slider-props", - "type": [ - "Object", - "Array" - ] + "type": "Array | SliderMarks" }, { "name": "max", "description": "滑块范围最大值", "doc-url": "https://tdesign.tencent.com/vue-next/components/slider?tab=api#slider-props", - "type": [ - "Number" - ], + "type": "number", "default": "100" }, { "name": "min", "description": "滑块范围最小值", "doc-url": "https://tdesign.tencent.com/vue-next/components/slider?tab=api#slider-props", - "type": [ - "Number" - ], + "type": "number", "default": "0" }, { "name": "range", "description": "双游标滑块", "doc-url": "https://tdesign.tencent.com/vue-next/components/slider?tab=api#slider-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "show-step", "description": "控制步长刻度值显示", "doc-url": "https://tdesign.tencent.com/vue-next/components/slider?tab=api#slider-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "step", "description": "步长", "doc-url": "https://tdesign.tencent.com/vue-next/components/slider?tab=api#slider-props", - "type": [ - "Number" - ], + "type": "number", "default": "1" }, { "name": "tooltip-props", "description": "透传提示组件属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/slider?tab=api#slider-props", - "type": [ - "Object" - ] + "type": "TooltipProps" }, { "name": "value", "description": "滑块值", "doc-url": "https://tdesign.tencent.com/vue-next/components/slider?tab=api#slider-props", - "type": [ - "Number", - "Array" - ], + "type": "SliderValue", "default": "0" } ], @@ -16098,9 +13607,7 @@ "name": "align", "description": "alignment\n\n对齐方式", "doc-url": "https://tdesign.tencent.com/vue-next/components/space?tab=api#space-props", - "type": [ - "String" - ], + "type": "'start' | 'end' | 'center' | 'baseline'", "attribute-value": { "type": "enum" }, @@ -16123,18 +13630,14 @@ "name": "break-line", "description": "Whether to wrap, valid only in horizontal\n\n是否自动换行，仅在 horizontal 时有效\t", "doc-url": "https://tdesign.tencent.com/vue-next/components/space?tab=api#space-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "direction", "description": "Spacing direction\n\n间距方向", "doc-url": "https://tdesign.tencent.com/vue-next/components/space?tab=api#space-props", - "type": [ - "String" - ], + "type": "'vertical' | 'horizontal'", "default": "horizontal", "attribute-value": { "type": "enum" @@ -16152,20 +13655,13 @@ "name": "separator", "description": "separator\n\n分隔符", "doc-url": "https://tdesign.tencent.com/vue-next/components/space?tab=api#space-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "size", "description": "Spacing\n\n间距大小", "doc-url": "https://tdesign.tencent.com/vue-next/components/space?tab=api#space-props", - "type": [ - "String", - "Number", - "Array" - ], + "type": "SpaceSize | SpaceSize[]", "default": "'medium'" } ], @@ -16189,26 +13685,20 @@ "name": "animation", "description": "Animation effect control, `duration` refers to the transition time of the animation `unit: millisecond`, `valueFrom` refers to the initial value of the animation. `{ duration, valueFrom }`\n\n动画效果控制，`duration` 指动画的过渡时间`单位：毫秒`，`valueFrom` 指动画的起始数值。`{ duration, valueFrom }`", "doc-url": "https://tdesign.tencent.com/vue-next/components/statistic?tab=api#statistic-props", - "type": [ - "Object" - ] + "type": "animation" }, { "name": "animation-start", "description": "Whether to start animation\n\n是否开始动画", "doc-url": "https://tdesign.tencent.com/vue-next/components/statistic?tab=api#statistic-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "color", "description": "Color style, followed by TDesign style black, blue, red, orange, green.Can also be any RGB equivalent supported by [CSS color](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value)\n\n颜色风格，依次为 TDesign 风格的黑色、蓝色、红色、橙色、绿色。也可以为任何 [CSS color](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value) 支持的 RGB 等值", "doc-url": "https://tdesign.tencent.com/vue-next/components/statistic?tab=api#statistic-props", - "type": [ - "String" - ], + "type": "'black' | 'blue' | 'red' | 'orange' | 'green'", "attribute-value": { "type": "enum" }, @@ -16234,79 +13724,57 @@ "name": "decimal-places", "description": " Decimal places\n\n小数保留位数", "doc-url": "https://tdesign.tencent.com/vue-next/components/statistic?tab=api#statistic-props", - "type": [ - "Number" - ] + "type": "number" }, { "name": "extra", "description": " Additional display content\n\n额外的显示内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/statistic?tab=api#statistic-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "format", "description": "Format numeric display value\n\n格式化数值显示值", "doc-url": "https://tdesign.tencent.com/vue-next/components/statistic?tab=api#statistic-props", - "type": [ - "Function" - ] + "type": "(value: number) => number" }, { "name": "loading", "description": "Loading\n\n是否加载中", "doc-url": "https://tdesign.tencent.com/vue-next/components/statistic?tab=api#statistic-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "prefix", "description": "Prefix content, display priority is higher than trend\n\n前缀内容，展示优先级高于 trend", "doc-url": "https://tdesign.tencent.com/vue-next/components/statistic?tab=api#statistic-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "separator", "description": "Thousands separator is displayed by default, and can be customized to other content, and the default separator is displayed when `separator = ''` is set to an empty string/null/undefined\n\n默认展示千位分隔符，可以自定义为其他内容，`separator = ''` 设置为空字符串/null/undefined 时展示默认分隔符", "doc-url": "https://tdesign.tencent.com/vue-next/components/statistic?tab=api#statistic-props", - "type": [ - "String" - ], + "type": "string", "default": "," }, { "name": "suffix", "description": " Suffix content, display priority is higher than trend\n\n后缀内容，展示优先级高于 trend", "doc-url": "https://tdesign.tencent.com/vue-next/components/statistic?tab=api#statistic-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "title", "description": "The title of Statistic\n\n数值显示的标题", "doc-url": "https://tdesign.tencent.com/vue-next/components/statistic?tab=api#statistic-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "trend", "description": "trend\n\n趋势", "doc-url": "https://tdesign.tencent.com/vue-next/components/statistic?tab=api#statistic-props", - "type": [ - "String" - ], + "type": "'increase' | 'decrease'", "attribute-value": { "type": "enum" }, @@ -16323,9 +13791,7 @@ "name": "trend-placement", "description": "Position of trending placements\n\n趋势展示位置", "doc-url": "https://tdesign.tencent.com/vue-next/components/statistic?tab=api#statistic-props", - "type": [ - "String" - ], + "type": "'left' | 'right'", "default": "left", "attribute-value": { "type": "enum" @@ -16343,18 +13809,13 @@ "name": "unit", "description": "Unit content\n\n单位内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/statistic?tab=api#statistic-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "value", "description": "The value of Statistic\n\n数值显示的值", "doc-url": "https://tdesign.tencent.com/vue-next/components/statistic?tab=api#statistic-props", - "type": [ - "Number" - ] + "type": "number" } ], "slots": [ @@ -16397,47 +13858,33 @@ "name": "content", "description": "步骤描述", "doc-url": "https://tdesign.tencent.com/vue-next/components/steps?tab=api#stepitem-props", - "type": [ - "String", - "TNode" - ], + "type": "string | TNode", "default": "''" }, { "name": "default", "description": "步骤描述，同 content", "doc-url": "https://tdesign.tencent.com/vue-next/components/steps?tab=api#stepitem-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "extra", "description": "显示在步骤描述下方的额外内容，比如：操作项", "doc-url": "https://tdesign.tencent.com/vue-next/components/steps?tab=api#stepitem-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "icon", "description": "图标，默认显示内置图标，也可以自定义图标，值为 false 则不显示图标。优先级大于 `status` 定义的图标", "doc-url": "https://tdesign.tencent.com/vue-next/components/steps?tab=api#stepitem-props", - "type": [ - "Boolean", - "TNode" - ], + "type": "boolean | TNode", "default": "true" }, { "name": "status", "description": "当前步骤的状态：默认状态（未开始）、进行中状态、完成状态、错误状态", "doc-url": "https://tdesign.tencent.com/vue-next/components/steps?tab=api#stepitem-props", - "type": [ - "String" - ], + "type": "StepStatus", "default": "default", "attribute-value": { "type": "enum" @@ -16461,20 +13908,14 @@ "name": "title", "description": "标题", "doc-url": "https://tdesign.tencent.com/vue-next/components/steps?tab=api#stepitem-props", - "type": [ - "String", - "TNode" - ], + "type": "string | TNode", "default": "''" }, { "name": "value", "description": "当前步骤标识", "doc-url": "https://tdesign.tencent.com/vue-next/components/steps?tab=api#stepitem-props", - "type": [ - "String", - "Number" - ] + "type": "string | number" } ], "slots": [ @@ -16517,18 +13958,13 @@ "name": "current", "description": "当前步骤，即整个步骤条进度。默认根据步骤下标判断步骤的完成状态，当前步骤为进行中，当前步骤之前的步骤为已完成，当前步骤之后的步骤为未开始。如果每个步骤没有设置 value，current 值为步骤长度则表示所有步骤已完成。如果每个步骤设置了自定义 value，则 current = 'FINISH' 表示所有状态完成", "doc-url": "https://tdesign.tencent.com/vue-next/components/steps?tab=api#steps-props", - "type": [ - "String", - "Number" - ] + "type": "string | number" }, { "name": "layout", "description": "步骤条方向，有两种：横向和纵向", "doc-url": "https://tdesign.tencent.com/vue-next/components/steps?tab=api#steps-props", - "type": [ - "String" - ], + "type": "'horizontal' | 'vertical'", "default": "horizontal", "attribute-value": { "type": "enum" @@ -16546,26 +13982,20 @@ "name": "options", "description": "步骤条数据列表（作用和 StepItem 效果一样）", "doc-url": "https://tdesign.tencent.com/vue-next/components/steps?tab=api#steps-props", - "type": [ - "Array" - ] + "type": "Array" }, { "name": "readonly", "description": "只读状态", "doc-url": "https://tdesign.tencent.com/vue-next/components/steps?tab=api#steps-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "undefined" }, { "name": "separator", "description": "步骤条分割符", "doc-url": "https://tdesign.tencent.com/vue-next/components/steps?tab=api#steps-props", - "type": [ - "String" - ], + "type": "'line' | 'dashed' | 'arrow'", "default": "line", "attribute-value": { "type": "enum" @@ -16586,9 +14016,7 @@ "name": "sequence", "description": "步骤条顺序", "doc-url": "https://tdesign.tencent.com/vue-next/components/steps?tab=api#steps-props", - "type": [ - "String" - ], + "type": "'positive' | 'reverse'", "default": "positive", "attribute-value": { "type": "enum" @@ -16606,9 +14034,7 @@ "name": "theme", "description": "步骤条风格", "doc-url": "https://tdesign.tencent.com/vue-next/components/steps?tab=api#steps-props", - "type": [ - "String" - ], + "type": "'default' | 'dot'", "default": "default", "attribute-value": { "type": "enum" @@ -16646,43 +14072,31 @@ "name": "icon", "description": "图标", "doc-url": "https://tdesign.tencent.com/vue-next/components/sticky-tool?tab=api#stickyitem-props", - "type": [ - "TNode" - ] + "type": "TNode" }, { "name": "label", "description": "名称", "doc-url": "https://tdesign.tencent.com/vue-next/components/sticky-tool?tab=api#stickyitem-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "popup", "description": "浮层内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/sticky-tool?tab=api#stickyitem-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "popup-props", "description": "透传 Popup 组件全部属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/sticky-tool?tab=api#stickyitem-props", - "type": [ - "Object" - ] + "type": "PopupProps" }, { "name": "trigger", "description": "触发浮层显示的方式", "doc-url": "https://tdesign.tencent.com/vue-next/components/sticky-tool?tab=api#stickyitem-props", - "type": [ - "String" - ], + "type": "'hover' | 'click'", "default": "hover", "attribute-value": { "type": "enum" @@ -16727,26 +14141,20 @@ "name": "list", "description": "列表", "doc-url": "https://tdesign.tencent.com/vue-next/components/sticky-tool?tab=api#stickytool-props", - "type": [ - "Array" - ], + "type": "Array", "default": "[]" }, { "name": "offset", "description": "相对于 placement 的偏移量，示例：[-10, 20] 或 ['10em', '8rem']", "doc-url": "https://tdesign.tencent.com/vue-next/components/sticky-tool?tab=api#stickytool-props", - "type": [ - "Array" - ] + "type": "Array" }, { "name": "placement", "description": "固定位置", "doc-url": "https://tdesign.tencent.com/vue-next/components/sticky-tool?tab=api#stickytool-props", - "type": [ - "String" - ], + "type": "'right-top' | 'right-center' | 'right-bottom' | 'left-top' | 'left-center' | 'left-bottom'", "default": "right-bottom", "attribute-value": { "type": "enum" @@ -16776,17 +14184,13 @@ "name": "popup-props", "description": "透传 Popup 组件全部属性，优先级低于 StickyItem.popupProps", "doc-url": "https://tdesign.tencent.com/vue-next/components/sticky-tool?tab=api#stickytool-props", - "type": [ - "Object" - ] + "type": "PopupProps" }, { "name": "shape", "description": "stickytool shape\n\n侧边栏菜单形状，有 2 种：方形、圆形", "doc-url": "https://tdesign.tencent.com/vue-next/components/sticky-tool?tab=api#stickytool-props", - "type": [ - "String" - ], + "type": "'square' | 'round'", "default": "square", "attribute-value": { "type": "enum" @@ -16804,9 +14208,7 @@ "name": "type", "description": "stickytool type\n\n侧边栏菜单类型，有 2 种：常规型和紧凑型", "doc-url": "https://tdesign.tencent.com/vue-next/components/sticky-tool?tab=api#stickytool-props", - "type": [ - "String" - ], + "type": "'normal' | 'compact'", "default": "normal", "attribute-value": { "type": "enum" @@ -16824,10 +14226,7 @@ "name": "width", "description": "宽度", "doc-url": "https://tdesign.tencent.com/vue-next/components/sticky-tool?tab=api#stickytool-props", - "type": [ - "String", - "Number" - ] + "type": "string | number" } ], "js": { @@ -16858,61 +14257,43 @@ "name": "content", "description": "菜单项内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/menu?tab=api#submenu-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "default", "description": "菜单项内容，同 content", "doc-url": "https://tdesign.tencent.com/vue-next/components/menu?tab=api#submenu-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "disabled", "description": "是否禁用菜单项展开/收起/跳转等功能", "doc-url": "https://tdesign.tencent.com/vue-next/components/menu?tab=api#submenu-props", - "type": [ - "Boolean" - ] + "type": "boolean" }, { "name": "icon", "description": "菜单项图标", "doc-url": "https://tdesign.tencent.com/vue-next/components/menu?tab=api#submenu-props", - "type": [ - "TNode" - ] + "type": "TNode" }, { "name": "popup-props", "description": "Transparent all feature props of the Popup\n\n透传 Popup 组件全部属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/menu?tab=api#submenu-props", - "type": [ - "Object" - ] + "type": "PopupProps" }, { "name": "title", "description": "二级菜单内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/menu?tab=api#submenu-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "value", "description": "菜单项唯一标识", "doc-url": "https://tdesign.tencent.com/vue-next/components/menu?tab=api#submenu-props", - "type": [ - "String", - "Number" - ] + "type": "MenuValue" } ], "slots": [ @@ -16950,9 +14331,7 @@ "name": "animation", "description": "轮播切换动画效果类型：滑动、淡入淡出等", "doc-url": "https://tdesign.tencent.com/vue-next/components/swiper?tab=api#swiper-props", - "type": [ - "String" - ], + "type": "'slide' | 'fade'", "default": "slide", "attribute-value": { "type": "enum" @@ -16970,27 +14349,21 @@ "name": "autoplay", "description": "是否自动播放", "doc-url": "https://tdesign.tencent.com/vue-next/components/swiper?tab=api#swiper-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "current", "description": "当前轮播在哪一项（下标）", "doc-url": "https://tdesign.tencent.com/vue-next/components/swiper?tab=api#swiper-props", - "type": [ - "Number" - ], + "type": "number", "default": "0" }, { "name": "direction", "description": "轮播滑动方向，包括横向滑动和纵向滑动两个方向", "doc-url": "https://tdesign.tencent.com/vue-next/components/swiper?tab=api#swiper-props", - "type": [ - "String" - ], + "type": "'horizontal' | 'vertical'", "default": "horizontal", "attribute-value": { "type": "enum" @@ -17008,62 +14381,47 @@ "name": "duration", "description": "滑动动画时长", "doc-url": "https://tdesign.tencent.com/vue-next/components/swiper?tab=api#swiper-props", - "type": [ - "Number" - ], + "type": "number", "default": "300" }, { "name": "height", "description": "当使用垂直方向滚动时的高度", "doc-url": "https://tdesign.tencent.com/vue-next/components/swiper?tab=api#swiper-props", - "type": [ - "Number" - ] + "type": "number" }, { "name": "interval", "description": "轮播间隔时间", "doc-url": "https://tdesign.tencent.com/vue-next/components/swiper?tab=api#swiper-props", - "type": [ - "Number" - ], + "type": "number", "default": "5000" }, { "name": "loop", "description": "是否循环播放", "doc-url": "https://tdesign.tencent.com/vue-next/components/swiper?tab=api#swiper-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "navigation", "description": "导航器全部配置", "doc-url": "https://tdesign.tencent.com/vue-next/components/swiper?tab=api#swiper-props", - "type": [ - "Object", - "TNode" - ] + "type": "SwiperNavigation | TNode" }, { "name": "stop-on-hover", "description": "是否悬浮时停止轮播", "doc-url": "https://tdesign.tencent.com/vue-next/components/swiper?tab=api#swiper-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "theme", "description": "深色模式和浅色模式", "doc-url": "https://tdesign.tencent.com/vue-next/components/swiper?tab=api#swiper-props", - "type": [ - "String" - ], + "type": "'light' | 'dark'", "default": "light", "attribute-value": { "type": "enum" @@ -17081,9 +14439,7 @@ "name": "trigger", "description": "触发切换的方式：悬浮、点击等", "doc-url": "https://tdesign.tencent.com/vue-next/components/swiper?tab=api#swiper-props", - "type": [ - "String" - ], + "type": "'hover' | 'click'", "default": "hover", "attribute-value": { "type": "enum" @@ -17101,9 +14457,7 @@ "name": "type", "description": "样式类型：默认样式、卡片样式", "doc-url": "https://tdesign.tencent.com/vue-next/components/swiper?tab=api#swiper-props", - "type": [ - "String" - ], + "type": "'default' | 'card'", "default": "default", "attribute-value": { "type": "enum" @@ -17147,53 +14501,40 @@ "name": "before-change", "description": "Switch 切换状态前的回调方法，常用于需要发起异步请求的场景，回调返回值支持布尔和 Promise 类型，返回`false`或 Promise reject不继续执行change，否则则继续执行", "doc-url": "https://tdesign.tencent.com/vue-next/components/switch?tab=api#switch-props", - "type": [ - "Function" - ] + "type": "() => boolean | Promise" }, { "name": "custom-value", "description": "用于自定义开关的值，[打开时的值，关闭时的值]。默认为 [true, false]。示例：[1, 0]、['open', 'close']", "doc-url": "https://tdesign.tencent.com/vue-next/components/switch?tab=api#switch-props", - "type": [ - "Array" - ] + "type": "Array" }, { "name": "disabled", "description": "是否禁用组件。优先级：Switch.disabled > Form.disabled", "doc-url": "https://tdesign.tencent.com/vue-next/components/switch?tab=api#switch-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "undefined" }, { "name": "label", "description": "开关内容，[开启时内容，关闭时内容]。示例：['开', '关'] 或 (value) => value ? '开' : '关'", "doc-url": "https://tdesign.tencent.com/vue-next/components/switch?tab=api#switch-props", - "type": [ - "Array", - "TNode" - ], + "type": "Array | TNode<{ value: SwitchValue }>", "default": "[]" }, { "name": "loading", "description": "是否处于加载中状态", "doc-url": "https://tdesign.tencent.com/vue-next/components/switch?tab=api#switch-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "size", "description": "开关尺寸", "doc-url": "https://tdesign.tencent.com/vue-next/components/switch?tab=api#switch-props", - "type": [ - "String" - ], + "type": "'small' | 'medium' | 'large'", "default": "medium", "attribute-value": { "type": "enum" @@ -17214,11 +14555,7 @@ "name": "value", "description": "开关值", "doc-url": "https://tdesign.tencent.com/vue-next/components/switch?tab=api#switch-props", - "type": [ - "String", - "Number", - "Boolean" - ] + "type": "T" } ], "js": { @@ -17250,81 +14587,60 @@ "name": "default", "description": "用于自定义选项卡导航，同 panel", "doc-url": "https://tdesign.tencent.com/vue-next/components/tabs?tab=api#tabpanel-props", - "type": [ - "TNode" - ] + "type": "TNode" }, { "name": "destroy-on-hide", "description": "选项卡内容隐藏时是否销毁", "doc-url": "https://tdesign.tencent.com/vue-next/components/tabs?tab=api#tabpanel-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "disabled", "description": "是否禁用当前选项卡", "doc-url": "https://tdesign.tencent.com/vue-next/components/tabs?tab=api#tabpanel-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "draggable", "description": "选项卡组件开启允许拖动排序时，当前选项卡是否允许拖动", "doc-url": "https://tdesign.tencent.com/vue-next/components/tabs?tab=api#tabpanel-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "label", "description": "选项卡名称，可自定义选项卡导航内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/tabs?tab=api#tabpanel-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "lazy", "description": "Enable tab lazy loading\n\n是否启用选项卡懒加载", "doc-url": "https://tdesign.tencent.com/vue-next/components/tabs?tab=api#tabpanel-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "panel", "description": "用于自定义选项卡面板内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/tabs?tab=api#tabpanel-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "removable", "description": "当前选项卡是否允许移除", "doc-url": "https://tdesign.tencent.com/vue-next/components/tabs?tab=api#tabpanel-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "value", "description": "选项卡的值，唯一标识", "doc-url": "https://tdesign.tencent.com/vue-next/components/tabs?tab=api#tabpanel-props", - "type": [ - "String", - "Number" - ] + "type": "TabValue" } ], "js": { @@ -17366,53 +14682,40 @@ "name": "action", "description": "选项卡右侧的操作区域", "doc-url": "https://tdesign.tencent.com/vue-next/components/tabs?tab=api#tabs-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "addable", "description": "选项卡是否可增加", "doc-url": "https://tdesign.tencent.com/vue-next/components/tabs?tab=api#tabs-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "disabled", "description": "是否禁用选项卡", "doc-url": "https://tdesign.tencent.com/vue-next/components/tabs?tab=api#tabs-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "drag-sort", "description": "是否开启拖拽调整顺序", "doc-url": "https://tdesign.tencent.com/vue-next/components/tabs?tab=api#tabs-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "list", "description": "选项卡列表", "doc-url": "https://tdesign.tencent.com/vue-next/components/tabs?tab=api#tabs-props", - "type": [ - "Array" - ] + "type": "Array" }, { "name": "placement", "description": "选项卡位置", "doc-url": "https://tdesign.tencent.com/vue-next/components/tabs?tab=api#tabs-props", - "type": [ - "String" - ], + "type": "'left' | 'top' | 'bottom' | 'right'", "default": "top", "attribute-value": { "type": "enum" @@ -17436,9 +14739,7 @@ "name": "scroll-position", "description": "The final position where the tab item stops scrolling after being selected\n\nTab较多的时候，选中滑块滚动最终停留的位置", "doc-url": "https://tdesign.tencent.com/vue-next/components/tabs?tab=api#tabs-props", - "type": [ - "String" - ], + "type": "'auto' | 'start' | 'center' | 'end'", "default": "auto", "attribute-value": { "type": "enum" @@ -17462,9 +14763,7 @@ "name": "size", "description": "组件尺寸", "doc-url": "https://tdesign.tencent.com/vue-next/components/tabs?tab=api#tabs-props", - "type": [ - "String" - ], + "type": "'medium' | 'large'", "default": "medium", "attribute-value": { "type": "enum" @@ -17482,9 +14781,7 @@ "name": "theme", "description": "选项卡风格，包含 默认风格 和 卡片风格两种", "doc-url": "https://tdesign.tencent.com/vue-next/components/tabs?tab=api#tabs-props", - "type": [ - "String" - ], + "type": "'normal' | 'card'", "default": "normal", "attribute-value": { "type": "enum" @@ -17502,10 +14799,7 @@ "name": "value", "description": "激活的选项卡值", "doc-url": "https://tdesign.tencent.com/vue-next/components/tabs?tab=api#tabs-props", - "type": [ - "String", - "Number" - ] + "type": "TabValue" } ], "js": { @@ -17552,71 +14846,52 @@ "name": "closable", "description": "标签是否可关闭", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag?tab=api#tag-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "color", "description": "self-defined tag color \n\n自定义标签颜色", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag?tab=api#tag-props", - "type": [ - "String" - ] + "type": "string" }, { "name": "content", "description": "组件子元素", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag?tab=api#tag-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "default", "description": "组件子元素，同 `content`", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag?tab=api#tag-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "disabled", "description": "标签禁用态，失效标签不能触发事件。默认风格（theme=default）才有禁用态", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag?tab=api#tag-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "icon", "description": "标签中的图标，可自定义图标呈现", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag?tab=api#tag-props", - "type": [ - "TNode" - ], + "type": "TNode", "default": "undefined" }, { "name": "max-width", "description": "标签最大宽度，宽度超出后会出现省略号。示例：'50px' / 80", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag?tab=api#tag-props", - "type": [ - "String", - "Number" - ] + "type": "string | number" }, { "name": "shape", "description": "标签类型，有三种：方形、圆角方形、标记型", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag?tab=api#tag-props", - "type": [ - "String" - ], + "type": "'square' | 'round' | 'mark'", "default": "square", "attribute-value": { "type": "enum" @@ -17637,9 +14912,7 @@ "name": "size", "description": "标签尺寸", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag?tab=api#tag-props", - "type": [ - "String" - ], + "type": "SizeEnum", "default": "medium", "attribute-value": { "type": "enum" @@ -17660,9 +14933,7 @@ "name": "theme", "description": "组件风格，用于描述组件不同的应用场景", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag?tab=api#tag-props", - "type": [ - "String" - ], + "type": "'default' | 'primary' | 'warning' | 'danger' | 'success'", "default": "default", "attribute-value": { "type": "enum" @@ -17689,17 +14960,13 @@ "name": "title", "description": "title of tag\n\n标签标题，在标签hover时展示，默认为标签内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag?tab=api#tag-props", - "type": [ - "String" - ] + "type": "string" }, { "name": "variant", "description": "标签风格变体", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag?tab=api#tag-props", - "type": [ - "String" - ], + "type": "'dark' | 'light' | 'outline' | 'light-outline'", "default": "dark", "attribute-value": { "type": "enum" @@ -17764,62 +15031,48 @@ "name": "auto-width", "description": "宽度随内容自适应", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag-input?tab=api#taginput-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "borderless", "description": "无边框模式", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag-input?tab=api#taginput-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "clearable", "description": "是否可清空", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag-input?tab=api#taginput-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "collapsed-items", "description": "标签过多的情况下，折叠项内容，默认为 `+N`。如果需要悬浮就显示其他内容，可以使用 collapsedItems 自定义。`value` 表示当前存在的所有标签，`collapsedSelectedItems` 表示折叠的标签，`count` 表示折叠的数量，`onClose` 表示移除标签的事件回调", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag-input?tab=api#taginput-props", - "type": [ - "TNode" - ] + "type": "TNode<{ value: TagInputValue; collapsedSelectedItems: TagInputValue; count: number; onClose: (context: { index: number, e?: MouseEvent }) => void }>" }, { "name": "disabled", "description": "是否禁用标签输入框", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag-input?tab=api#taginput-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "undefined" }, { "name": "drag-sort", "description": "拖拽调整标签顺序", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag-input?tab=api#taginput-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "excess-tags-display-type", "description": "标签超出时的呈现方式，有两种：横向滚动显示 和 换行显示", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag-input?tab=api#taginput-props", - "type": [ - "String" - ], + "type": "'scroll' | 'break-line'", "default": "break-line", "attribute-value": { "type": "enum" @@ -17837,79 +15090,59 @@ "name": "input-props", "description": "透传 Input 输入框组件全部属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag-input?tab=api#taginput-props", - "type": [ - "Object" - ] + "type": "InputProps" }, { "name": "input-value", "description": "input value\n\n输入框的值", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag-input?tab=api#taginput-props", - "type": [ - "String", - "Number" - ], + "type": "string", "default": "''" }, { "name": "label", "description": "左侧文本", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag-input?tab=api#taginput-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "max", "description": "max tag number\n\n最大允许输入的标签数量", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag-input?tab=api#taginput-props", - "type": [ - "Number" - ] + "type": "number" }, { "name": "min-collapsed-num", "description": "最小折叠数量，用于标签数量过多的情况下折叠选中项，超出该数值的选中项折叠。值为 0 则表示不折叠", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag-input?tab=api#taginput-props", - "type": [ - "Number" - ], + "type": "number", "default": "0" }, { "name": "placeholder", "description": "placeholder description\n\n占位符", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag-input?tab=api#taginput-props", - "type": [ - "String" - ], + "type": "string", "default": "undefined" }, { "name": "prefix-icon", "description": "组件前置图标", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag-input?tab=api#taginput-props", - "type": [ - "TNode" - ] + "type": "TNode" }, { "name": "readonly", "description": "只读状态，值为真会隐藏标签移除按钮和输入框", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag-input?tab=api#taginput-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "undefined" }, { "name": "size", "description": "组件尺寸", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag-input?tab=api#taginput-props", - "type": [ - "String" - ], + "type": "SizeEnum", "default": "medium", "attribute-value": { "type": "enum" @@ -17930,9 +15163,7 @@ "name": "status", "description": "输入框状态", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag-input?tab=api#taginput-props", - "type": [ - "String" - ], + "type": "'default' | 'success' | 'warning' | 'error'", "attribute-value": { "type": "enum" }, @@ -17955,62 +15186,44 @@ "name": "suffix", "description": "后置图标前的后置内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag-input?tab=api#taginput-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "suffix-icon", "description": "组件后置图标", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag-input?tab=api#taginput-props", - "type": [ - "TNode" - ] + "type": "TNode" }, { "name": "tag", "description": "自定义标签的内部内容，每一个标签的当前值。注意和 `valueDisplay` 区分，`valueDisplay` 是用来定义全部标签内容，而非某一个标签", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag-input?tab=api#taginput-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode<{ value: string | number }>" }, { "name": "tag-props", "description": "透传 Tag 组件全部属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag-input?tab=api#taginput-props", - "type": [ - "Object" - ] + "type": "TagProps" }, { "name": "tips", "description": "输入框下方提示文本，会根据不同的 `status` 呈现不同的样式", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag-input?tab=api#taginput-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "value", "description": "value\n\n值", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag-input?tab=api#taginput-props", - "type": [ - "Array" - ], + "type": "TagInputValue", "default": "[]" }, { "name": "value-display", "description": "自定义值呈现的全部内容，参数为所有标签的值", "doc-url": "https://tdesign.tencent.com/vue-next/components/tag-input?tab=api#taginput-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode<{ value: TagInputValue; onClose: (index: number, item?: any) => void }>" } ], "js": { @@ -18152,111 +15365,212 @@ "name": "code", "description": "add code style\n\n是否添加代码样式", "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "content", "description": "content of text\n\n文本内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "copyable", "description": "add copyable style\n\n是否可复制，可通过配置参数自定义复制操作的具体功能和样式", "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", - "type": [ - "Boolean", - "Object" - ], + "type": "boolean | TypographyCopyable", "default": "false" }, { "name": "default", "description": "default slot of text\n\n文本内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", - "type": [ - "String", - "TNode" + "type": "string | TNode" + }, + { + "name": "delete", + "description": "add delete line style\n\n是否添加删除线样式", + "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", + "type": "boolean", + "default": "false" + }, + { + "name": "disabled", + "description": "add disabled style\n\n是否添加不可用样式", + "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", + "type": "boolean", + "default": "false" + }, + { + "name": "ellipsis", + "description": "add ellipsis style\n\n是否省略展示，可通过配置参数自定义省略操作的具体功能和样式", + "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", + "type": "boolean | TypographyEllipsis", + "default": "false" + }, + { + "name": "italic", + "description": "add italic style\n\n文本是否为斜体", + "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", + "type": "boolean", + "default": "false" + }, + { + "name": "keyboard", + "description": "add keyboard style\n\n是否添加键盘样式", + "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", + "type": "boolean", + "default": "false" + }, + { + "name": "mark", + "description": "add mark style\n\n是否添加标记样式，默认为黄色，可通过配置颜色修改标记样式，如#0052D9", + "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", + "type": "string | boolean", + "default": "false" + }, + { + "name": "strong", + "description": "add bold style\n\n文本是否加粗", + "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", + "type": "boolean", + "default": "false" + }, + { + "name": "theme", + "description": "theme of text\n\n主题", + "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", + "type": "'primary' | 'secondary' | 'success' | 'warning' | 'error'", + "attribute-value": { + "type": "enum" + }, + "values": [ + { + "name": "primary" + }, + { + "name": "secondary" + }, + { + "name": "success" + }, + { + "name": "warning" + }, + { + "name": "error" + } ] }, + { + "name": "underline", + "description": "add underline style\n\n是否添加下划线样式", + "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", + "type": "boolean", + "default": "false" + } + ], + "slots": [ + { + "name": "content", + "description": "content of text\n\n文本内容", + "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props" + }, + { + "name": "default", + "description": "default slot of text\n\n文本内容", + "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props" + } + ] + }, + { + "name": "t-typography-text", + "source": { + "symbol": "Text" + }, + "description": "Text\n\n文本", + "doc-url": "https://tdesign.tencent.com/vue-next/components/typography", + "props": [ + { + "name": "code", + "description": "add code style\n\n是否添加代码样式", + "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", + "type": "boolean", + "default": "false" + }, + { + "name": "content", + "description": "content of text\n\n文本内容", + "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", + "type": "string | TNode" + }, + { + "name": "copyable", + "description": "add copyable style\n\n是否可复制，可通过配置参数自定义复制操作的具体功能和样式", + "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", + "type": "boolean | TypographyCopyable", + "default": "false" + }, + { + "name": "default", + "description": "default slot of text\n\n文本内容", + "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", + "type": "string | TNode" + }, { "name": "delete", "description": "add delete line style\n\n是否添加删除线样式", "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "disabled", "description": "add disabled style\n\n是否添加不可用样式", "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "ellipsis", "description": "add ellipsis style\n\n是否省略展示，可通过配置参数自定义省略操作的具体功能和样式", "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", - "type": [ - "Boolean", - "Object" - ], + "type": "boolean | TypographyEllipsis", "default": "false" }, { "name": "italic", "description": "add italic style\n\n文本是否为斜体", "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "keyboard", "description": "add keyboard style\n\n是否添加键盘样式", "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "mark", "description": "add mark style\n\n是否添加标记样式，默认为黄色，可通过配置颜色修改标记样式，如#0052D9", "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", - "type": [ - "String", - "Boolean" - ], + "type": "string | boolean", "default": "false" }, { "name": "strong", "description": "add bold style\n\n文本是否加粗", "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "theme", "description": "theme of text\n\n主题", "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", - "type": [ - "String" - ], + "type": "'primary' | 'secondary' | 'success' | 'warning' | 'error'", "attribute-value": { "type": "enum" }, @@ -18282,9 +15596,7 @@ "name": "underline", "description": "add underline style\n\n是否添加下划线样式", "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#text-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" } ], @@ -18313,89 +15625,67 @@ "name": "allow-input-over-max", "description": "超出maxlength或maxcharacter之后是否还允许输入", "doc-url": "https://tdesign.tencent.com/vue-next/components/textarea?tab=api#textarea-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "autofocus", "description": "自动聚焦，拉起键盘", "doc-url": "https://tdesign.tencent.com/vue-next/components/textarea?tab=api#textarea-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "autosize", "description": "高度自动撑开。 autosize = true 表示组件高度自动撑开，同时，依旧允许手动拖高度。如果设置了 autosize.maxRows 或者 autosize.minRows 则不允许手动调整高度", "doc-url": "https://tdesign.tencent.com/vue-next/components/textarea?tab=api#textarea-props", - "type": [ - "Boolean", - "Object" - ], + "type": "boolean | { minRows?: number; maxRows?: number }", "default": "false" }, { "name": "disabled", "description": "是否禁用文本框", "doc-url": "https://tdesign.tencent.com/vue-next/components/textarea?tab=api#textarea-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "undefined" }, { "name": "maxcharacter", "description": "用户最多可以输入的字符个数，一个中文汉字表示两个字符长度", "doc-url": "https://tdesign.tencent.com/vue-next/components/textarea?tab=api#textarea-props", - "type": [ - "Number" - ] + "type": "number" }, { "name": "maxlength", "description": "用户最多可以输入的字符个数", "doc-url": "https://tdesign.tencent.com/vue-next/components/textarea?tab=api#textarea-props", - "type": [ - "String", - "Number" - ] + "type": "string | number" }, { "name": "name", "description": "名称，HTML 元素原生属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/textarea?tab=api#textarea-props", - "type": [ - "String" - ] + "type": "string" }, { "name": "placeholder", "description": "占位符", "doc-url": "https://tdesign.tencent.com/vue-next/components/textarea?tab=api#textarea-props", - "type": [ - "String" - ], + "type": "string", "default": "undefined" }, { "name": "readonly", "description": "只读状态", "doc-url": "https://tdesign.tencent.com/vue-next/components/textarea?tab=api#textarea-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "undefined" }, { "name": "status", "description": "文本框状态", "doc-url": "https://tdesign.tencent.com/vue-next/components/textarea?tab=api#textarea-props", - "type": [ - "String" - ], + "type": "'default' | 'success' | 'warning' | 'error'", "default": "default", "attribute-value": { "type": "enum" @@ -18419,19 +15709,13 @@ "name": "tips", "description": "输入框下方提示文本，会根据不同的 `status` 呈现不同的样式", "doc-url": "https://tdesign.tencent.com/vue-next/components/textarea?tab=api#textarea-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "value", "description": "文本框值", "doc-url": "https://tdesign.tencent.com/vue-next/components/textarea?tab=api#textarea-props", - "type": [ - "String", - "Number" - ] + "type": "TextareaValue" } ], "js": { @@ -18493,121 +15777,92 @@ "name": "allow-input", "description": "是否允许直接输入时间", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timepicker-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "borderless", "description": "无边框模式", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timepicker-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "clearable", "description": "是否允许清除选中值", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timepicker-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "disable-time", "description": "disable time config function\n\n禁用时间项的配置函数", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timepicker-props", - "type": [ - "Function" - ] + "type": "(h: number, m: number, s: number, ms: number) => Partial<{ hour: Array, minute: Array, second: Array, millisecond: Array }>" }, { "name": "disabled", "description": "是否禁用组件", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timepicker-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "undefined" }, { "name": "format", "description": "用于格式化时间，[详细文档](https://day.js.org/docs/en/display/format)", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timepicker-props", - "type": [ - "String" - ], + "type": "string", "default": "HH:mm:ss" }, { "name": "hide-disabled-time", "description": "是否隐藏禁用状态的时间项", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timepicker-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "input-props", "description": "透传给输入框（Input）组件的参数", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timepicker-props", - "type": [ - "Object" - ] + "type": "InputProps" }, { "name": "label", "description": "左侧文本", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timepicker-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "placeholder", "description": "占位符", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timepicker-props", - "type": [ - "String" - ], + "type": "string", "default": "undefined" }, { "name": "popup-props", "description": "透传 Popup 组件全部属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timepicker-props", - "type": [ - "Object" - ] + "type": "PopupProps" }, { "name": "presets", "description": "预设快捷时间选择，示例：`{ '前一小时': '11:00:00' }`", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timepicker-props", - "type": [ - "Object" - ] + "type": "PresetTime" }, { "name": "select-input-props", "description": "透传 SelectInput 筛选器输入框组件的全部属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timepicker-props", - "type": [ - "Object" - ] + "type": "SelectInputProps" }, { "name": "size", "description": "尺寸", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timepicker-props", - "type": [ - "String" - ], + "type": "'small' | 'medium' | 'large'", "default": "medium", "attribute-value": { "type": "enum" @@ -18628,9 +15883,7 @@ "name": "status", "description": "输入框状态", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timepicker-props", - "type": [ - "String" - ], + "type": "'default' | 'success' | 'warning' | 'error'", "default": "default", "attribute-value": { "type": "enum" @@ -18654,36 +15907,26 @@ "name": "steps", "description": "时间间隔步数，数组排列 [小时, 分钟, 秒]，示例：[2, 1, 1] 或者 ['2', '1', '1']", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timepicker-props", - "type": [ - "Array" - ], + "type": "Array", "default": "[1, 1, 1]" }, { "name": "tips", "description": "输入框下方提示文本，会根据不同的 `status` 呈现不同的样式", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timepicker-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "value", "description": "选中值", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timepicker-props", - "type": [ - "String" - ] + "type": "TimePickerValue" }, { "name": "value-display", "description": "`MouseEvent`\n\n自定义选中项呈现的内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timepicker-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode<{ value: TimePickerValue }>" } ], "js": { @@ -18760,124 +16003,93 @@ "name": "allow-input", "description": "是否允许直接输入时间", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timerangepicker-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "auto-swap", "description": "是否自动调换左右区间的顺序，默认为 true；若需要支持跨天的场景，可以设置为 false", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timerangepicker-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "borderless", "description": "无边框模式", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timerangepicker-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "clearable", "description": "是否允许清除选中值", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timerangepicker-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "disable-time", "description": "禁用时间项", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timerangepicker-props", - "type": [ - "Function" - ] + "type": "(h: number, m: number, s: number, ms: number, context: { partial: TimeRangePickerPartial }) =>Partial<{ hour: Array, minute: Array, second: Array }>" }, { "name": "disabled", "description": "是否禁用组件，值为数组表示可分别控制开始日期和结束日期是否禁用", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timerangepicker-props", - "type": [ - "Boolean", - "Array" - ], + "type": "boolean | Array", "default": "undefined" }, { "name": "format", "description": "用于格式化时间，[详细文档](https://day.js.org/docs/en/display/format)", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timerangepicker-props", - "type": [ - "String" - ], + "type": "string", "default": "HH:mm:ss" }, { "name": "hide-disabled-time", "description": "是否隐藏禁用状态的时间项", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timerangepicker-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "label", "description": "左侧文本", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timerangepicker-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "placeholder", "description": "占位符，值为数组表示可分别为开始日期和结束日期设置占位符", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timerangepicker-props", - "type": [ - "String", - "Array" - ], + "type": "string | Array", "default": "undefined" }, { "name": "popup-props", "description": "透传 Popup 组件全部属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timerangepicker-props", - "type": [ - "Object" - ] + "type": "PopupProps" }, { "name": "presets", "description": "预设快捷时间范围选择，示例：{ '下午': ['13:00:00', '18:00:00'] }", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timerangepicker-props", - "type": [ - "Object" - ] + "type": "PresetTimeRange" }, { "name": "range-input-props", "description": "透传给范围输入框 RangeInput 组件的参数", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timerangepicker-props", - "type": [ - "Object" - ] + "type": "RangeInputProps" }, { "name": "size", "description": "尺寸", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timerangepicker-props", - "type": [ - "String" - ], + "type": "'small' | 'medium' | 'large'", "default": "medium", "attribute-value": { "type": "enum" @@ -18898,9 +16110,7 @@ "name": "status", "description": "输入框状态", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timerangepicker-props", - "type": [ - "String" - ], + "type": "'default' | 'success' | 'warning' | 'error'", "default": "default", "attribute-value": { "type": "enum" @@ -18924,27 +16134,20 @@ "name": "steps", "description": "时间间隔步数，数组排列 [小时, 分钟, 秒]，示例：[2, 1, 1] 或者 ['2', '1', '1']", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timerangepicker-props", - "type": [ - "Array" - ], + "type": "Array", "default": "[1, 1, 1]" }, { "name": "tips", "description": "输入框下方提示文本，会根据不同的 `status` 呈现不同的样式", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timerangepicker-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "value", "description": "选中值", "doc-url": "https://tdesign.tencent.com/vue-next/components/time-picker?tab=api#timerangepicker-props", - "type": [ - "Array" - ] + "type": "TimeRangeValue" } ], "js": { @@ -19001,9 +16204,7 @@ "name": "label-align", "description": "label info placement\n\n标签信息放在时间轴的位置，`mode='alternate'` 时生效。纵向时间轴信息位置：左侧、右侧或两侧，默认信息在时间轴右侧。横向时间轴信息位置：上方、下方、两侧", "doc-url": "https://tdesign.tencent.com/vue-next/components/timeline?tab=api#timeline-props", - "type": [ - "String" - ], + "type": "'left' | 'right' | 'alternate' | 'top' | 'bottom'", "default": "left", "attribute-value": { "type": "enum" @@ -19030,9 +16231,7 @@ "name": "layout", "description": "time line layout\n\n时间轴方向：水平方向、垂直方向", "doc-url": "https://tdesign.tencent.com/vue-next/components/timeline?tab=api#timeline-props", - "type": [ - "String" - ], + "type": "'horizontal' | 'vertical'", "default": "vertical", "attribute-value": { "type": "enum" @@ -19050,9 +16249,7 @@ "name": "mode", "description": "The position relationship between the label and the content text, 'alternate' is displayed on both sides of the axis, and 'same' is displayed on the same side\n\n标签与内容文本的位置关系，`alternate` 为展示在轴两侧，`same` 为展示在同一侧", "doc-url": "https://tdesign.tencent.com/vue-next/components/timeline?tab=api#timeline-props", - "type": [ - "String" - ], + "type": "'alternate' | 'same'", "default": "alternate", "attribute-value": { "type": "enum" @@ -19070,18 +16267,14 @@ "name": "reverse", "description": "时间轴是否表现为倒序", "doc-url": "https://tdesign.tencent.com/vue-next/components/timeline?tab=api#timeline-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "theme", "description": "时间轴风格", "doc-url": "https://tdesign.tencent.com/vue-next/components/timeline?tab=api#timeline-props", - "type": [ - "String" - ], + "type": "'default' | 'dot'", "default": "default", "attribute-value": { "type": "enum" @@ -19110,44 +16303,32 @@ "name": "content", "description": "描述内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/timeline?tab=api#timelineitem-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "dot", "description": "用于自定义时间轴节点元素", "doc-url": "https://tdesign.tencent.com/vue-next/components/timeline?tab=api#timelineitem-props", - "type": [ - "TNode" - ] + "type": "TNode" }, { "name": "dot-color", "description": "时间轴颜色，内置 `primary/warning/error/default` 四种色值，可传入 16 进制颜色码或 RGB 颜色值", "doc-url": "https://tdesign.tencent.com/vue-next/components/timeline?tab=api#timelineitem-props", - "type": [ - "String" - ], + "type": "string", "default": "primary" }, { "name": "label", "description": "标签文本内容，可完全自定义", "doc-url": "https://tdesign.tencent.com/vue-next/components/timeline?tab=api#timelineitem-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "label-align", "description": "标签信息相对于时间轴的位置，在 `mode='alternate'` 时生效，优先级高于 `Timeline.labelAlign`", "doc-url": "https://tdesign.tencent.com/vue-next/components/timeline?tab=api#timelineitem-props", - "type": [ - "String" - ], + "type": "'left' | 'right' | 'top' | 'bottom'", "attribute-value": { "type": "enum" }, @@ -19170,9 +16351,7 @@ "name": "loading", "description": "Whether it is in the loading state\n\n是否处在加载状态", "doc-url": "https://tdesign.tencent.com/vue-next/components/timeline?tab=api#timelineitem-props", - "type": [ - "Boolean" - ] + "type": "boolean" } ], "js": { @@ -19214,37 +16393,97 @@ "name": "content", "description": "content of title\n\n段落内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#title-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "default", "description": "default slot of title\n\n标题内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#title-props", - "type": [ - "String", - "TNode" + "type": "string | TNode" + }, + { + "name": "ellipsis", + "description": "add ellipsis style\n\n是否省略展示，可通过配置参数自定义省略操作的具体功能和样式", + "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#title-props", + "type": "boolean | TypographyEllipsis", + "default": "false" + }, + { + "name": "level", + "description": "level of title\n\n标题等级", + "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#title-props", + "type": "'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'", + "default": "h1", + "attribute-value": { + "type": "enum" + }, + "values": [ + { + "name": "h1" + }, + { + "name": "h2" + }, + { + "name": "h3" + }, + { + "name": "h4" + }, + { + "name": "h5" + }, + { + "name": "h6" + } ] + } + ], + "slots": [ + { + "name": "content", + "description": "content of title\n\n段落内容", + "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#title-props" + }, + { + "name": "default", + "description": "default slot of title\n\n标题内容", + "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#title-props" + } + ] + }, + { + "name": "t-typography-title", + "source": { + "symbol": "Title" + }, + "description": "Title\n\n标题", + "doc-url": "https://tdesign.tencent.com/vue-next/components/typography", + "props": [ + { + "name": "content", + "description": "content of title\n\n段落内容", + "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#title-props", + "type": "string | TNode" + }, + { + "name": "default", + "description": "default slot of title\n\n标题内容", + "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#title-props", + "type": "string | TNode" }, { "name": "ellipsis", "description": "add ellipsis style\n\n是否省略展示，可通过配置参数自定义省略操作的具体功能和样式", "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#title-props", - "type": [ - "Boolean", - "Object" - ], + "type": "boolean | TypographyEllipsis", "default": "false" }, { "name": "level", "description": "level of title\n\n标题等级", "doc-url": "https://tdesign.tencent.com/vue-next/components/typography?tab=api#title-props", - "type": [ - "String" - ], + "type": "'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'", "default": "h1", "attribute-value": { "type": "enum" @@ -19296,53 +16535,40 @@ "name": "delay", "description": "delay to show or hide popover\n\n延时显示或隐藏浮层，[延迟显示的时间，延迟隐藏的时间]，单位：毫秒。直接透传到 Popup 组件。如果只有一个时间，则表示显示和隐藏的延迟时间相同。示例 `'300'` 或者 `[200, 200]`。默认为：[250, 150]", "doc-url": "https://tdesign.tencent.com/vue-next/components/tooltip?tab=api#tooltip-props", - "type": [ - "Number", - "Array" - ] + "type": "number | Array" }, { "name": "destroy-on-close", "description": "是否在关闭浮层时销毁浮层", "doc-url": "https://tdesign.tencent.com/vue-next/components/tooltip?tab=api#tooltip-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "duration", "description": "用于设置提示默认显示多长时间之后消失，初始第一次有效，单位：毫秒", "doc-url": "https://tdesign.tencent.com/vue-next/components/tooltip?tab=api#tooltip-props", - "type": [ - "Number" - ] + "type": "number" }, { "name": "placement", "description": "浮层出现位置", "doc-url": "https://tdesign.tencent.com/vue-next/components/tooltip?tab=api#tooltip-props", - "type": [ - "String" - ], + "type": "PopupPlacement", "default": "top" }, { "name": "show-arrow", "description": "是否显示浮层箭头", "doc-url": "https://tdesign.tencent.com/vue-next/components/tooltip?tab=api#tooltip-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "theme", "description": "文字提示风格", "doc-url": "https://tdesign.tencent.com/vue-next/components/tooltip?tab=api#tooltip-props", - "type": [ - "String" - ], + "type": "'default' | 'primary' | 'success' | 'danger' | 'warning' | 'light'", "default": "default", "attribute-value": { "type": "enum" @@ -19383,18 +16609,13 @@ "name": "content", "description": "tip content\n\n文字提示内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/tooltip?tab=api#tooltiplite-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "placement", "description": "提示浮层出现的位置", "doc-url": "https://tdesign.tencent.com/vue-next/components/tooltip?tab=api#tooltiplite-props", - "type": [ - "String" - ], + "type": "'top' | 'bottom' | 'mouse'", "default": "top", "attribute-value": { "type": "enum" @@ -19415,27 +16636,21 @@ "name": "show-arrow", "description": "是否显示箭头", "doc-url": "https://tdesign.tencent.com/vue-next/components/tooltip?tab=api#tooltiplite-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "show-shadow", "description": "文字提示浮层是否需要阴影", "doc-url": "https://tdesign.tencent.com/vue-next/components/tooltip?tab=api#tooltiplite-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "theme", "description": "组件风格，有亮色模式和暗色模式两种", "doc-url": "https://tdesign.tencent.com/vue-next/components/tooltip?tab=api#tooltiplite-props", - "type": [ - "String" - ], + "type": "'light' | 'default'", "default": "default", "attribute-value": { "type": "enum" @@ -19453,10 +16668,7 @@ "name": "trigger-element", "description": "触发元素", "doc-url": "https://tdesign.tencent.com/vue-next/components/tooltip?tab=api#tooltiplite-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" } ], "slots": [ @@ -19489,35 +16701,27 @@ "name": "checkbox-props", "description": "用于控制复选框属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/transfer?tab=api#transfer-props", - "type": [ - "Object" - ] + "type": "CheckboxProps" }, { "name": "checked", "description": "数据列表选中项", "doc-url": "https://tdesign.tencent.com/vue-next/components/transfer?tab=api#transfer-props", - "type": [ - "Array" - ], + "type": "Array", "default": "[]" }, { "name": "data", "description": "全量数据", "doc-url": "https://tdesign.tencent.com/vue-next/components/transfer?tab=api#transfer-props", - "type": [ - "Array" - ], + "type": "Array", "default": "[]" }, { "name": "direction", "description": "穿梭框可操作方向", "doc-url": "https://tdesign.tencent.com/vue-next/components/transfer?tab=api#transfer-props", - "type": [ - "String" - ], + "type": "'left' | 'right' | 'both'", "default": "both", "attribute-value": { "type": "enum" @@ -19538,94 +16742,65 @@ "name": "disabled", "description": "禁用全部操作：搜索、选中、移动、分页等。[源列表, 目标列表]，示例：[true, false] 或者 true", "doc-url": "https://tdesign.tencent.com/vue-next/components/transfer?tab=api#transfer-props", - "type": [ - "Boolean", - "Array" - ] + "type": "boolean | Array" }, { "name": "empty", "description": "列表为空时呈现的内容。值类型为数组，则表示分别控制源列表和目标列表数据为空的呈现内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/transfer?tab=api#transfer-props", - "type": [ - "String", - "Array", - "TNode" - ], + "type": "EmptyType | Array | TNode ", "default": "''" }, { "name": "footer", "description": "穿梭框底部内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/transfer?tab=api#transfer-props", - "type": [ - "Array", - "TNode" - ] + "type": "Array | TNode<{ type: TransferListType }>" }, { "name": "keys", "description": "alias field name in data\n\n用来定义 value / label / disabled 在 `data` 中对应的字段别名，示例：`{ label: 'text', value: 'id' }`，表示选项文本取 `text` 字段，选项值取 `id` 字段", "doc-url": "https://tdesign.tencent.com/vue-next/components/transfer?tab=api#transfer-props", - "type": [ - "Object" - ] + "type": "KeysType" }, { "name": "operation", "description": "方向操作按钮。默认显示组件内置操作图标。自定义操作图标示例：['向左', '向右'] 或者 `[() => , () => ]` 或者 `(h, direction) => direction === 'left' ? '《' : '》'`", "doc-url": "https://tdesign.tencent.com/vue-next/components/transfer?tab=api#transfer-props", - "type": [ - "Array", - "TNode" - ] + "type": "Array | TNode<{ direction: 'left' | 'right' }>" }, { "name": "pagination", "description": "分页配置，值为空则不显示。具体 API 参考分页组件。值类型为数组，表示可分别控制源列表和目标列表分页组件", "doc-url": "https://tdesign.tencent.com/vue-next/components/transfer?tab=api#transfer-props", - "type": [ - "Object", - "Array" - ] + "type": "PaginationProps | Array" }, { "name": "search", "description": "搜索框配置，值为 false 表示不显示搜索框；值为 true 表示显示默认搜索框；值类型为对象，用于透传 Props 到 Input 组件；值类型为数组，则分别表示控制两侧搜索框", "doc-url": "https://tdesign.tencent.com/vue-next/components/transfer?tab=api#transfer-props", - "type": [ - "Boolean", - "Object", - "Array" - ], + "type": "SearchOption | Array", "default": "false" }, { "name": "show-check-all", "description": "是否显示全选，值类型为数组则表示分别控制源列表和目标列表", "doc-url": "https://tdesign.tencent.com/vue-next/components/transfer?tab=api#transfer-props", - "type": [ - "Boolean", - "Array" - ], + "type": "boolean | Array", "default": "true" }, { "name": "target-draggable", "description": "allowed to sort the target list by dragging\n\n是否允许通过拖拽对目标列表进行排序", "doc-url": "https://tdesign.tencent.com/vue-next/components/transfer?tab=api#transfer-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "target-sort", "description": "目标数据列表排列顺序", "doc-url": "https://tdesign.tencent.com/vue-next/components/transfer?tab=api#transfer-props", - "type": [ - "String" - ], + "type": "'original' | 'push' | 'unshift'", "default": "original", "attribute-value": { "type": "enum" @@ -19646,35 +16821,26 @@ "name": "title", "description": "穿梭框标题，示例：['源列表', '目标列表'] 或者 `[() => 'A', () => 'B']` 或者 `({ type }) => type === 'source' ? '源' : '目标'`", "doc-url": "https://tdesign.tencent.com/vue-next/components/transfer?tab=api#transfer-props", - "type": [ - "Array", - "TNode" - ], + "type": "Array | TNode<{ type: TransferListType }>", "default": "[]" }, { "name": "transfer-item", "description": "自定义渲染节点", "doc-url": "https://tdesign.tencent.com/vue-next/components/transfer?tab=api#transfer-props", - "type": [ - "TNode" - ] + "type": "TNode>" }, { "name": "tree", "description": "传入 Tree 组件定义树形结构", "doc-url": "https://tdesign.tencent.com/vue-next/components/transfer?tab=api#transfer-props", - "type": [ - "TNode" - ] + "type": "(tree: TreeProps) => TNode" }, { "name": "value", "description": "目标数据列表数据", "doc-url": "https://tdesign.tencent.com/vue-next/components/transfer?tab=api#transfer-props", - "type": [ - "Array" - ], + "type": "Array", "default": "[]" } ], @@ -19757,301 +16923,225 @@ "name": "activable", "description": "make nodes can be highlight\n\n节点是否可高亮", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "active-multiple", "description": "是否允许多个节点同时高亮", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "actived", "description": "高亮的节点值", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Array" - ] + "type": "Array" }, { "name": "allow-drop", "description": "Determine whether the node can execute the drop operation\n\n判断节点是否可以执行 drop 操作，泛型 `T` 表示树节点 TS 类型", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Function" - ] + "type": "(context: { e: DragEvent; dragNode: TreeNodeModel; dropNode: TreeNodeModel; dropPosition: number; }) => boolean" }, { "name": "allow-fold-node-on-filter", "description": "是否允许在过滤时节点折叠节点", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "check-props", "description": "透传属性到 checkbox 组件。参考 checkbox 组件 API", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Object" - ] + "type": "CheckboxProps" }, { "name": "check-strictly", "description": "父子节点选中状态不再关联，可各自选中或取消", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "checkable", "description": "隐藏节点复选框", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "data", "description": "树数据，泛型 `T` 表示树节点 TS 类型", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Array" - ], + "type": "Array", "default": "[]" }, { "name": "disable-check", "description": "禁用复选框，可支持禁用不同的行", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Boolean", - "Function" - ], + "type": "boolean | ((node: TreeNodeModel) => boolean)", "default": "false" }, { "name": "disabled", "description": "是否禁用树操作", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Boolean" - ] + "type": "boolean" }, { "name": "draggable", "description": "节点是否可拖拽", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Boolean" - ] + "type": "boolean" }, { "name": "empty", "description": "数据为空时展示的文本", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "String", - "TNode" - ], + "type": "string | TNode", "default": "''" }, { "name": "expand-all", "description": "是否展开全部节点", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "expand-level", "description": "默认展开的级别，第一层为 0", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Number" - ], + "type": "number", "default": "0" }, { "name": "expand-mutex", "description": "同级别展开互斥，手风琴效果", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "expand-on-click-node", "description": "是否支持点击节点也能展开收起", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "expand-parent", "description": "展开子节点时是否自动展开父节点", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "expanded", "description": "展开的节点值", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Array" - ], + "type": "Array", "default": "[]" }, { "name": "filter", "description": "节点过滤方法，只呈现返回值为 true 的节点，泛型 `T` 表示树节点 TS 类型", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Function" - ] + "type": "(node: TreeNodeModel) => boolean" }, { "name": "height", "description": "The height of tree. Scrollbar will appear after the content is overflow. Examples: 100, '30%', '300'. The value should be a number and will automatically be converted to a pixel value. If the tree height is not fixed, it is recommended to use `maxHeight`\n\n树的高度，超出后会出现滚动条。示例：100, '30%', '300'。值为数字类型，会自动加上单位 px。如果不是绝对固定树的高度，建议使用 `maxHeight`", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "String", - "Number" - ] + "type": "string | number" }, { "name": "hover", "description": "节点是否有悬浮状态", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Boolean" - ] + "type": "boolean" }, { "name": "icon", "description": "节点图标，可自定义", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Boolean", - "TNode" - ], + "type": "boolean | TNode>", "default": "true" }, { "name": "keys", "description": "alias field name in data\n\n用来定义 `value / label / disabled / children` 在 `data` 数据中对应的字段别名，示例：`{ value: 'key', label 'name', children: 'list' }`。其中，disabled 待开发", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Object" - ] + "type": "TreeKeysType" }, { "name": "label", "description": "自定义节点内容，值为 `false` 不显示，值为 `true` 显示默认 label，值为字符串直接输出该字符串。泛型 `T` 表示树节点 TS 类型。
如果期望只有点击复选框才选中，而点击节点不选中，可以使用 `label` 自定义节点，然后加上点击事件 `e.preventDefault()`，通过调整自定义节点的宽度和高度决定禁止点击选中的范围", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "String", - "Boolean", - "TNode" - ], + "type": "string | boolean | TNode>", "default": "true" }, { "name": "lazy", "description": "延迟加载 children 为 true 的节点的子节点数据，即使 expandAll 被设置为 true，也同样延迟加载", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "line", "description": "连接线。值为 false 不显示连接线；值为 true 显示默认连接线；值类型为 Function 表示自定义连接线", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Boolean", - "TNode" - ], + "type": "boolean | TNode", "default": "false" }, { "name": "load", "description": "加载子数据的方法，在展开节点时调用（仅当节点 children 为 true 时生效），泛型 `T` 表示树节点 TS 类型", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Function" - ] + "type": "(node: TreeNodeModel) => Promise>" }, { "name": "max-height", "description": "The max height of tree. Scrollbar will appear after the content is overflow. Examples: 100, '30%', '300'. \n\n树的最大高度，超出后会出现滚动条。示例：100, '30%', '300'。值为数字类型，会自动加上单位 px", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "String", - "Number" - ] + "type": "string | number" }, { "name": "operations", "description": "自定义节点操作项，泛型 `T` 表示树节点 TS 类型", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "TNode" - ] + "type": "TNode>" }, { "name": "scroll", "description": "lazy load and virtual scroll\n\n懒加载和虚拟滚动。为保证组件收益最大化，当数据量小于阈值 `scroll.threshold` 时，无论虚拟滚动的配置是否存在，组件内部都不会开启虚拟滚动，`scroll.threshold` 默认为 `100`", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Object" - ] + "type": "TScroll" }, { "name": "transition", "description": "节点展开折叠时是否使用过渡动画", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "value", "description": "选中值，组件为可选状态时有效", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "Array" - ], + "type": "Array", "default": "[]" }, { "name": "value-mode", "description": "选中值模式。all 表示父节点和子节点全部会出现在选中值里面；parentFirst 表示当子节点全部选中时，仅父节点在选中值里面；onlyLeaf 表示无论什么情况，选中值仅呈现叶子节点", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree?tab=api#tree-props", - "type": [ - "String" - ], + "type": "'onlyLeaf' | 'parentFirst' | 'all'", "default": "onlyLeaf", "attribute-value": { "type": "enum" @@ -20168,254 +17258,190 @@ "name": "auto-width", "description": "宽度随内容自适应", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "autofocus", "description": "自动聚焦", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "borderless", "description": "无边框模式", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "clearable", "description": "是否允许清空", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "collapsed-items", "description": "多选情况下，用于设置折叠项内容，默认为 `+N`。如果需要悬浮就显示其他内容，可以使用 collapsedItems 自定义。`value` 表示当前存在的所有标签，`collapsedSelectedItems` 表示折叠的标签，`count` 表示折叠的数量，`onClose` 表示移除标签的事件回调", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "TNode" - ] + "type": "TNode<{ value: DataOption[]; collapsedSelectedItems: DataOption[]; count: number; onClose: (context: { index: number, e?: MouseEvent }) => void }>" }, { "name": "data", "description": "树选择的数据列表。结构：`[{ label: TNode, value: string | number, text: string, ... }]`，其中 `label` 表示选项呈现的内容，可自定义；`value` 表示选项的唯一值；表示当 `label` 用于选项复杂内容呈现时，`text` 用于搜索功能。
其中 `label` 和 `value` 可以使用 `keys` 属性定义别名", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "Array" - ], + "type": "Array", "default": "[]" }, { "name": "disabled", "description": "是否禁用组件", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "undefined" }, { "name": "empty", "description": "当下拉列表为空时显示的内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "filter", "description": "过滤方法，用于对现有数据进行搜索过滤，判断是否过滤某一项数据", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "Function" - ] + "type": "(filterWords: string, option: DataOption) => boolean" }, { "name": "filterable", "description": "是否可搜索", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "input-props", "description": "透传给 输入框 Input 组件的全部属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "Object" - ] + "type": "InputProps" }, { "name": "input-value", "description": "input value\n\n输入框的值", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "String", - "Number" - ] + "type": "string" }, { "name": "keys", "description": "alias filed name in data\n\n用来定义 `value / label / disabled / children` 在 `data` 数据中对应的字段别名，示例：`{ value: 'key', label: 'name', children: 'list' }`", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "Object" - ] + "type": "TreeKeysType" }, { "name": "label", "description": "左侧文本", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "loading", "description": "是否正在加载数据", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "loading-text", "description": "远程加载时显示的文字，支持自定义。如加上超链接", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "max", "description": "用于控制多选数量，值为 0 则不限制", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "Number" - ], + "type": "number", "default": "0" }, { "name": "min-collapsed-num", "description": "最小折叠数量，用于多选情况下折叠选中项，超出该数值的选中项折叠。值为 0 则表示不折叠", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "Number" - ], + "type": "number", "default": "0" }, { "name": "multiple", "description": "是否允许多选", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "panel-bottom-content", "description": "面板内的底部内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "panel-top-content", "description": "面板内的顶部内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "placeholder", "description": "占位符", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "String" - ], + "type": "string", "default": "undefined" }, { "name": "popup-props", "description": "透传 Popup 组件全部属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "Object" - ] + "type": "PopupProps" }, { "name": "popup-visible", "description": "show popup\n\n是否显示下拉框", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "undefined" }, { "name": "prefix-icon", "description": "组件前置图标", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "TNode" - ] + "type": "TNode" }, { "name": "readonly", "description": "只读状态，值为真会隐藏输入框，且无法打开下拉框", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "undefined" }, { "name": "reserve-keyword", "description": "多选且可搜索时，是否在选中一个选项后保留当前的搜索关键词", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "select-input-props", "description": "【开发中】透传 SelectInput 筛选器输入框组件的全部属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "Object" - ] + "type": "SelectInputProps" }, { "name": "size", "description": "尺寸", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "String" - ], + "type": "'small' | 'medium' | 'large'", "default": "medium", "attribute-value": { "type": "enum" @@ -20436,9 +17462,7 @@ "name": "status", "description": "输入框状态", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "String" - ], + "type": "'default' | 'success' | 'warning' | 'error'", "default": "default", "attribute-value": { "type": "enum" @@ -20462,70 +17486,49 @@ "name": "suffix", "description": "后置图标前的后置内容", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "suffix-icon", "description": "组件后置图标", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "TNode" - ] + "type": "TNode" }, { "name": "tag-props", "description": "透传 Tag 标签组件全部属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "Object" - ] + "type": "TagProps" }, { "name": "tips", "description": "输入框下方提示文本，会根据不同的 `status` 呈现不同的样式", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "tree-props", "description": "透传 Tree 组件的全部属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "Object" - ] + "type": "TreeProps" }, { "name": "value", "description": "选中值，泛型 `TreeValueType` 继承自 `TreeSelectValue`", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "String", - "Number", - "Object", - "Array" - ] + "type": "TreeValueType" }, { "name": "value-display", "description": "自定义选中项呈现方式", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "TNode" - ] + "type": "string | TNode<{ value: TreeOptionData | TreeOptionData[]; onClose: (index: number) => void }>" }, { "name": "value-type", "description": "用于控制选中值的类型。假设数据选项为：`[{ label: '姓名', value: 'name' }]`，value 表示值仅返回数据选项中的 value， object 表示值返回全部数据", "doc-url": "https://tdesign.tencent.com/vue-next/components/tree-select?tab=api#treeselect-props", - "type": [ - "String" - ], + "type": "'value' | 'object'", "default": "value", "attribute-value": { "type": "enum" @@ -20694,219 +17697,164 @@ "name": "abridge-name", "description": "ellipsis text of medium file name\n\n文件名过长时，需要省略中间的文本，保留首尾文本。示例：[10, 7]，表示首尾分别保留的文本长度", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Array" - ] + "type": "Array" }, { "name": "accept", "description": "File types that can be accepted. [W3C](https://www.w3schools.com/tags/att_input_accept.asp)，[MDN](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/Input/file)\n\n接受上传的文件类型，[查看 W3C示例](https://www.w3schools.com/tags/att_input_accept.asp)，[查看 MDN 示例](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/Input/file)", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "String" - ] + "type": "string" }, { "name": "action", "description": "Uploading URL\n\n上传接口。设接口响应数据为字段 `response`，那么 `response.error` 存在时会判断此次上传失败，并显示错误文本信息；`response.url` 会作为文件上传成功后的地址，并使用该地址显示图片或文件", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "String" - ] + "type": "string" }, { "name": "allow-upload-duplicate-file", "description": "allow to upload duplicate name files\n\n是否允许重复上传相同文件名的文件", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "auto-upload", "description": "post upload request automatically after files being selected\n\n是否在选择文件后自动发起请求上传文件", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "before-all-files-upload", "description": "before all files upload, return false can stop uploading file\n\n如果是自动上传模式 `autoUpload=true`，表示全部文件上传之前的钩子函数，函数参数为上传的文件，函数返回值决定是否继续上传，若返回值为 `false` 则终止上传。
如果是非自动上传模式 `autoUpload=false`，则函数返回值为 `false` 时表示本次选中的文件不会加入到文件列表中，即不触发 `onChange` 事件", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Function" - ] + "type": "(file: UploadFile[]) => boolean | Promise" }, { "name": "before-upload", "description": "stop one of files to upload\n\n如果是自动上传模式 `autoUpload=true`，表示单个文件上传之前的钩子函数，若函数返回值为 `false` 则表示不上传当前文件。
如果是非自动上传模式 `autoUpload=false`，函数返回值为 `false` 时表示从上传文件中剔除当前文件", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Function" - ] + "type": "(file: UploadFile) => boolean | Promise" }, { "name": "cancel-upload-button", "description": "cancel upload button props, which showed on `autoUpload=false` and multiple files/images upload\n\n批量文件/图片上传，`autoUpload=false` 场景下，透传“取消上传”按钮属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Object", - "TNode" - ] + "type": "null | ButtonProps | TNode<{ disabled: boolean; cancelUploadText: string; cancelUpload: (ctx: { e: MouseEvent }) => void }>" }, { "name": "data", "description": "extra request data of uploading. `formatRequest` can redefine all request data\n\n上传请求所需的额外字段，默认字段有 `file`，表示文件信息。可以添加额外的文件名字段，如：`{file_name: \"custom-file-name.txt\"}`。`autoUpload=true` 时有效。也可以使用 `formatRequest` 完全自定义上传请求的字段", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Object" - ] + "type": "Record | ((files: UploadFile[]) => Record)" }, { "name": "default", "description": "非拖拽场景，指触发上传的元素，如：“选择文件”。如果是拖拽场景，则是指拖拽区域", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "disabled", "description": "make upload to be disabled\n\n是否禁用组件", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "undefined" }, { "name": "drag-content", "description": "define drag content nodes, it works on `theme=custom`\n\n用于自定义拖拽区域，`theme=custom` 且 `draggable=true` 时有效", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "String", - "TNode" - ] + "type": "TNode | TNode" }, { "name": "draggable", "description": "if drag uploading allowed, works on `theme=file` or `theme=image`\n\n是否启用拖拽上传，不同的组件风格默认值不同。`theme=file` 或 `theme=image` 时有效", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "undefined" }, { "name": "file-list-display", "description": "used to render file list UI\n\n用于完全自定义文件列表界面内容(UI)，单文件和多文件均有效", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "TNode" - ] + "type": "TNode<{ files: UploadFile[]; dragEvents?: UploadDisplayDragEvents }>" }, { "name": "files", "description": "已上传文件列表，同 `value`。TS 类型：`UploadFile`", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Array" - ], + "type": "Array", "default": "[]" }, { "name": "format", "description": "to redefine `UploadFile` data structure\n\n转换文件 `UploadFile` 的数据结构，可新增或修改 `UploadFile` 的属性，注意不能删除 `UploadFile` 属性。`action` 存在时有效", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Function" - ] + "type": "(file: File) => UploadFile" }, { "name": "format-request", "description": "redefine request data\n\n用于新增或修改文件上传请求 参数。`action` 存在时有效。一个请求上传一个文件时，默认请求字段有 `file`。
一个请求上传多个文件时，默认字段有 `file[0]/file[1]/file[2]/.../length`，其中 `length` 表示本次上传的文件数量。
⚠️非常注意，此处的 `file[0]/file[1]` 仅仅是一个字段名，并非表示 `file` 是一个数组，接口获取字段时注意区分。
可以使用 `name` 定义 `file` 字段的别名。
也可以使用 `formatRequest` 自定义任意字段，如添加一个字段 `fileList` ，存储文件数组", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Function" - ] + "type": "(requestData: { [key: string]: any }) => { [key: string]: any }" }, { "name": "format-response", "description": "redefine response data structure\n\n用于格式化文件上传后的接口响应数据，`response` 便是接口响应的原始数据。`action` 存在时有效。
示例返回值：`{ error, url, status, files }`
此函数的返回值 `error` 会作为错误文本提醒，表示上传失败的原因，如果存在会判定为本次上传失败。
此函数的返回值 `url` 会作为单个文件上传成功后的链接。
`files` 表示一个请求同时上传多个文件后的文件列表", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Function" - ] + "type": "(response: any, context: FormatResponseContext) => ResponseType " }, { "name": "headers", "description": "HTTP Request Header\n\n设置上传的请求头部，`action` 存在时有效", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Object" - ] + "type": "{[key: string]: string}" }, { "name": "image-props", "description": "用于在上传图片场景下，透传属性配置至 Image 组件", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Object" - ] + "type": "object" }, { "name": "image-viewer-props", "description": "ImageViewer Component Props\n\n透传图片预览组件全部属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Object" - ] + "type": "ImageViewerProps" }, { "name": "input-attributes", "description": "add attributes to HTML element `input`\n\n用于添加属性到 HTML 元素 `input`", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Object" - ] + "type": "CSSProperties" }, { "name": "is-batch-upload", "description": "make all files to be a whole package, files can only be replaced or deleted together, can not add more files\n\n多个文件是否作为一个独立文件包，整体替换，整体删除。不允许追加文件，只允许替换文件。`theme=file-flow` 时有效", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "locale", "description": "upload language config, priority of `locale` is higher than global language config\n\n上传组件文本语言配置，支持自定义配置组件中的全部文本。优先级高于全局配置中语言", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Object" - ] + "type": "UploadConfig" }, { "name": "max", "description": "max count of files limit\n\n用于控制文件上传数量，值为 0 则不限制。注意，单文件上传场景，请勿设置 `max` 属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Number" - ], + "type": "number", "default": "0" }, { "name": "method", "description": "HTTP request method\n\nHTTP 请求类型", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "String" - ], + "type": "'POST' | 'GET' | 'PUT' | 'OPTIONS' | 'PATCH' | 'post' | 'get' | 'put' | 'options' | 'patch'", "default": "POST", "attribute-value": { "type": "enum" @@ -20948,87 +17896,66 @@ "name": "mock-progress-duration", "description": "mock progress duration time. more large files more duration time\n\n模拟进度间隔时间，单位：毫秒，默认：300。由于原始的上传请求，小文件上传进度只有 0 和 100，故而新增模拟进度，每间隔 `mockProgressDuration` 毫秒刷新一次模拟进度。小文件设置小一点，大文件设置大一点。注意：当 `useMockProgress` 为真时，当前设置有效", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Number" - ] + "type": "number" }, { "name": "multiple", "description": "multiple files uploading\n\n支持多文件上传", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "name", "description": "field name of files in upload request data\n\n文件上传时的名称", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "String" - ], + "type": "string", "default": "file" }, { "name": "placeholder", "description": "placeholder\n\n占位符", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "String" - ] + "type": "string" }, { "name": "request-method", "description": "custom upload request method\n\n自定义上传方法。返回值 `status` 表示上传成功或失败；`error` 或 `response.error` 表示上传失败的原因；
`response` 表示请求上传成功后的返回数据，`response.url` 表示上传成功后的图片/文件地址，`response.files` 表示一个请求上传多个文件/图片后的返回值。
示例一：`{ status: 'fail', error: '上传失败', response }`。
示例二：`{ status: 'success', response: { url: 'https://tdesign.gtimg.com/site/avatar.jpg' } }`。
示例三：`{ status: 'success', files: [{ url: 'https://xxx.png', name: 'xxx.png' }]}`", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Function" - ] + "type": "(files: UploadFile | UploadFile[]) => Promise" }, { "name": "show-image-file-name", "description": "show image's name\n\n是否显示图片的文件名称", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "show-thumbnail", "description": "show thumbnail before file name, only works on `theme=file-flow` \n\n是否在文件列表中显示缩略图，`theme=file-flow` 时有效", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "show-upload-progress", "description": "show upload progress nodes\n\n是否显示上传进度", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "size-limit", "description": "files size limit\n\n图片文件大小限制，默认单位 KB。可选单位有：`'B' | 'KB' | 'MB' | 'GB'`。示例一：`1000`。示例二：`{ size: 2, unit: 'MB', message: '图片大小不超过 {sizeLimit} MB' }`", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Number", - "Object" - ] + "type": "number | SizeLimitObj" }, { "name": "status", "description": "tips status\n\n文件上传提示文本状态", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "String" - ], + "type": "'default' | 'success' | 'warning' | 'error'", "attribute-value": { "type": "enum" }, @@ -21051,9 +17978,7 @@ "name": "theme", "description": "different upload UI styles\n\n组件风格。custom 表示完全自定义风格；file 表示默认文件上传风格；file-input 表示输入框形式的文件上传；file-flow 表示文件批量上传；image 表示默认图片上传风格；image-flow 表示图片批量上传", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "String" - ], + "type": "'custom' | 'file' | 'file-input' | 'file-flow' | 'image' | 'image-flow'", "default": "file", "attribute-value": { "type": "enum" @@ -21083,79 +18008,59 @@ "name": "tips", "description": "tips text below upload component, define it's color with `status`\n\n组件下方文本提示，可以使用 `status` 定义文本", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "trigger", "description": "trigger elements UI\n\n触发上传的元素，`files` 指本次显示的全部文件", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "TNode" - ] + "type": "TNode" }, { "name": "trigger-button-props", "description": "trigger button props, it can be used to change color/size/href/... of the trigger button\n\n透传选择按钮全部属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Object" - ] + "type": "ButtonProps" }, { "name": "upload-all-files-in-one-request", "description": "uploading all files in one request\n\n是否在同一个请求中上传全部文件，默认一个请求上传一个文件。多文件上传时有效", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "upload-button", "description": "upload button props, which showed on `autoUpload=false` and multiple files/images upload\n\n批量文件/图片上传，`autoUpload=false` 场景下，透传“点击上传”按钮属性", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Object", - "TNode" - ] + "type": "null | ButtonProps | TNode<{ disabled: boolean; uploading: boolean; uploadFiles: () => void; uploadText: string }>" }, { "name": "upload-pasted-files", "description": "allow to upload files in clipboard after pasting\n\n是否允许粘贴上传剪贴板中的文件", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "use-mock-progress", "description": "use mock progress, instead of real progress\n\n是否在请求时间超过 300ms 后显示模拟进度。上传进度有模拟进度和真实进度两种。一般大小的文件上传，真实的上传进度只有 0 和 100，不利于交互呈现，因此组件内置模拟上传进度。真实上传进度一般用于大文件上传", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "value", "description": "file list\n\n已上传文件列表，同 `files`。TS 类型：`UploadFile`", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Array" - ], + "type": "Array", "default": "[]" }, { "name": "with-credentials", "description": "uploading request with cookie\n\n上传请求时是否携带 cookie", "doc-url": "https://tdesign.tencent.com/vue-next/components/upload?tab=api#upload-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" } ], @@ -21308,139 +18213,104 @@ "name": "alpha", "description": "水印整体透明度，取值范围 [0-1]", "doc-url": "https://tdesign.tencent.com/vue-next/components/watermark?tab=api#watermark-props", - "type": [ - "Number" - ], + "type": "number", "default": "1" }, { "name": "content", "description": "水印所覆盖的内容节点", "doc-url": "https://tdesign.tencent.com/vue-next/components/watermark?tab=api#watermark-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "default", "description": "水印所覆盖的内容节点，同 `content`", "doc-url": "https://tdesign.tencent.com/vue-next/components/watermark?tab=api#watermark-props", - "type": [ - "String", - "TNode" - ] + "type": "string | TNode" }, { "name": "height", "description": "水印高度", "doc-url": "https://tdesign.tencent.com/vue-next/components/watermark?tab=api#watermark-props", - "type": [ - "Number" - ] + "type": "number" }, { "name": "is-repeat", "description": "水印是否重复出现", "doc-url": "https://tdesign.tencent.com/vue-next/components/watermark?tab=api#watermark-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "line-space", "description": "行间距，只作用在多行（`content` 配置为数组）情况下", "doc-url": "https://tdesign.tencent.com/vue-next/components/watermark?tab=api#watermark-props", - "type": [ - "Number" - ], + "type": "number", "default": "16" }, { "name": "movable", "description": "水印是否可移动", "doc-url": "https://tdesign.tencent.com/vue-next/components/watermark?tab=api#watermark-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "false" }, { "name": "move-interval", "description": "水印发生运动位移的间隙，单位：毫秒", "doc-url": "https://tdesign.tencent.com/vue-next/components/watermark?tab=api#watermark-props", - "type": [ - "Number" - ], + "type": "number", "default": "3000" }, { "name": "offset", "description": "水印在画布上绘制的水平和垂直偏移量，正常情况下水印绘制在中间位置，即 `offset = [gapX / 2, gapY / 2]`", "doc-url": "https://tdesign.tencent.com/vue-next/components/watermark?tab=api#watermark-props", - "type": [ - "Array" - ] + "type": "Array" }, { "name": "removable", "description": "水印是否可被删除", "doc-url": "https://tdesign.tencent.com/vue-next/components/watermark?tab=api#watermark-props", - "type": [ - "Boolean" - ], + "type": "boolean", "default": "true" }, { "name": "rotate", "description": "水印旋转的角度，单位 °", "doc-url": "https://tdesign.tencent.com/vue-next/components/watermark?tab=api#watermark-props", - "type": [ - "Number" - ], + "type": "number", "default": "-22" }, { "name": "watermark-content", "description": "水印内容，需要显示多行情况下可配置为数组", "doc-url": "https://tdesign.tencent.com/vue-next/components/watermark?tab=api#watermark-props", - "type": [ - "Object", - "Array" - ] + "type": "WatermarkText|WatermarkImage|Array" }, { "name": "width", "description": "水印宽度", "doc-url": "https://tdesign.tencent.com/vue-next/components/watermark?tab=api#watermark-props", - "type": [ - "Number" - ] + "type": "number" }, { "name": "x", "description": "水印之间的水平间距", "doc-url": "https://tdesign.tencent.com/vue-next/components/watermark?tab=api#watermark-props", - "type": [ - "Number" - ] + "type": "number" }, { "name": "y", "description": "水印之间的垂直间距", "doc-url": "https://tdesign.tencent.com/vue-next/components/watermark?tab=api#watermark-props", - "type": [ - "Number" - ] + "type": "number" }, { "name": "z-index", "description": "水印元素的 `z-index`，默认值写在 CSS 中", "doc-url": "https://tdesign.tencent.com/vue-next/components/watermark?tab=api#watermark-props", - "type": [ - "Number" - ] + "type": "number" } ], "slots": [ @@ -21455,6 +18325,16 @@ "doc-url": "https://tdesign.tencent.com/vue-next/components/watermark?tab=api#watermark-props" } ] + }, + { + "name": "t-typography", + "source": { + "symbol": "Typography" + }, + "description": "Typography\n\n排版", + "doc-url": "https://tdesign.tencent.com/vue-next/components/typography", + "props": [], + "slots": [] } ] } diff --git a/packages/scripts/helper/index.js b/packages/scripts/helper/index.js index e71cf4ef..cdeff5fe 100644 --- a/packages/scripts/helper/index.js +++ b/packages/scripts/helper/index.js @@ -32,6 +32,9 @@ const aliasComponents = { ['BaseTable']: 'Table', ['Radio']: 'RadioButton', ['IconSVG']: 'Icon', + ['Text']: 'TypographyText', + ['Title']: 'TypographyTitle', + ['Paragraph']: 'TypographyParagraph', }; start(); @@ -45,6 +48,10 @@ function start() { const frameworkMap = formatArrayToMap(map.data, 'platform_framework'); // Vue2 和 Vue3 同为 Vue，API 相同 const frameworkData = groupByComponent(ALL_API, frameworkMap[framework === 'VueNext(PC)' ? 'Vue(PC)' : framework]); + if (['Vue(PC)', 'VueNext(PC)'].includes(framework)) { + // Typography 是空定义组件，特殊处理 + frameworkData['Typography'] = []; + } // 生成代码提示文件 generateHelper(frameworkData, framework); } From 48309c11cbea7013e25d0775d2c49a57db9da888 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=BB=8E=E4=BC=9F=E6=9D=B0?= <674416404@qq.com> Date: Tue, 4 Mar 2025 16:55:40 +0800 Subject: [PATCH 3/3] fix: tooltipProps --- db/TDesign.db | Bin 1011712 -> 1011712 bytes .../packages/components/typography/type.ts | 6 +++--- .../components/typography/typography.en-US.md | 4 ++-- .../components/typography/typography.md | 4 ++-- .../packages/components/typography/type.ts | 6 +++--- .../components/typography/typography.en-US.md | 4 ++-- .../components/typography/typography.md | 4 ++-- .../tdesign-vue/src/typography/type.ts | 6 +++--- .../src/typography/typography.en-US.md | 4 ++-- .../tdesign-vue/src/typography/typography.md | 4 ++-- packages/scripts/api.json | 4 ++-- 11 files changed, 23 insertions(+), 23 deletions(-) diff --git a/db/TDesign.db b/db/TDesign.db index c8e31791756dd3f53901d503ae33c69595a51952..f834e6ccccd27699a058512586f0333e2e79edc2 100644 GIT binary patch delta 102 zcmZp8VB7G(c7inH?ujzajJq2XS`!#s6PQ{Pm|GKAS`%1X6WCf4*jp1gS`#>16S!Iv vxLXr=wkGh#D>H^nKcLJjKK=A16S!Iv wxLXr=wkGh#D>If%KcLJj4y4Z9W>nbzLz(xQB&t|DyB#kO^KECh`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -tooltipProps | Object | - | Configuration of the tooltip that appears on the ellipsis icon when the cursor is over it。Typescript：`tooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/typography/type.ts) | N +tooltipProps | Object | - | Configuration of the tooltip that appears on the ellipsis icon when the cursor is over it。Typescript：`TooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/typography/type.ts) | N onExpand | Function | | Typescript：`(expanded:boolean) => void`
| N ### TypographyCopyable @@ -61,5 +61,5 @@ name | type | default | description | required -- | -- | -- | -- | -- text | String | - | copied content | N suffix | TElement | - | custom element configuration for copy icon。Typescript：`TNode<{ copied: boolean }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -tooltipProps | Object | - | Configuration of the tooltip that appears on the copy icon when the cursor is over it。Typescript：`tooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/typography/type.ts) | N +tooltipProps | Object | - | Configuration of the tooltip that appears on the copy icon when the cursor is over it。Typescript：`TooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/typography/type.ts) | N onCopy | Function | | Typescript：`() => void`
| N diff --git a/packages/products/tdesign-react/packages/components/typography/typography.md b/packages/products/tdesign-react/packages/components/typography/typography.md index fadbeb75..a9c769c6 100644 --- a/packages/products/tdesign-react/packages/components/typography/typography.md +++ b/packages/products/tdesign-react/packages/components/typography/typography.md @@ -52,7 +52,7 @@ collapsible | Boolean | true | 展开后是否可以重新收起 | N expandable | Boolean | true | 是否可展开 | N row | Number | 1 | 省略配置默认展示行数 | N suffix | TElement | - | 自定义省略触发元素，一般用于自定义折叠图标。TS 类型：`TNode<{ expanded: boolean }>`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -tooltipProps | Object | - | 光标在省略图标上出现的tooltip的配置。TS 类型：`tooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/typography/type.ts) | N +tooltipProps | Object | - | 光标在省略图标上出现的tooltip的配置。TS 类型：`TooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/typography/type.ts) | N onExpand | Function | | TS 类型：`(expanded:boolean) => void`
点击省略按钮的回调 | N ### TypographyCopyable @@ -61,5 +61,5 @@ onExpand | Function | | TS 类型：`(expanded:boolean) => void`
点击省 -- | -- | -- | -- | -- text | String | - | 复制的文本内容，默认为全部文本 | N suffix | TElement | - | 自定义复制触发元素，一般用于自定义复制图标。TS 类型：`TNode<{ copied: boolean }>`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -tooltipProps | Object | - | 光标在复制图标上出现的tooltip的配置。TS 类型：`tooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/typography/type.ts) | N +tooltipProps | Object | - | 光标在复制图标上出现的tooltip的配置。TS 类型：`TooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/typography/type.ts) | N onCopy | Function | | TS 类型：`() => void`
点击复制按钮的回调 | N diff --git a/packages/products/tdesign-vue-next/packages/components/typography/type.ts b/packages/products/tdesign-vue-next/packages/components/typography/type.ts index 30012e89..ecc19bce 100644 --- a/packages/products/tdesign-vue-next/packages/components/typography/type.ts +++ b/packages/products/tdesign-vue-next/packages/components/typography/type.ts @@ -4,7 +4,7 @@ * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC * */ -import { tooltipProps } from '../tooltip'; +import { TooltipProps } from '../tooltip'; import { TNode } from '../common'; export interface TdTextProps { @@ -132,7 +132,7 @@ export interface TypographyEllipsis { /** * 光标在省略图标上出现的tooltip的配置 */ - tooltipProps?: tooltipProps; + tooltipProps?: TooltipProps; /** * 点击省略按钮的回调 */ @@ -152,7 +152,7 @@ export interface TypographyCopyable { /** * 光标在复制图标上出现的tooltip的配置 */ - tooltipProps?: tooltipProps; + tooltipProps?: TooltipProps; /** * 点击复制按钮的回调 */ diff --git a/packages/products/tdesign-vue-next/packages/components/typography/typography.en-US.md b/packages/products/tdesign-vue-next/packages/components/typography/typography.en-US.md index 03bfff86..30c6d14b 100644 --- a/packages/products/tdesign-vue-next/packages/components/typography/typography.en-US.md +++ b/packages/products/tdesign-vue-next/packages/components/typography/typography.en-US.md @@ -47,7 +47,7 @@ collapsible | Boolean | true | collapsible after expanding | N expandable | Boolean | true | expandable | N row | Number | 1 | default row number of ellipsis | N suffix | Slot / Function | - | custom element configuration for ellipsis and collapse icon。Typescript：`TNode<{ expanded: boolean }>`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N -tooltipProps | Object | - | Configuration of the tooltip that appears on the ellipsis icon when the cursor is over it。Typescript：`tooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/typography/type.ts) | N +tooltipProps | Object | - | Configuration of the tooltip that appears on the ellipsis icon when the cursor is over it。Typescript：`TooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/typography/type.ts) | N onExpand | Function | | Typescript：`(expanded:boolean) => void`
| N ### TypographyEllipsis @@ -61,7 +61,7 @@ name | type | default | description | required -- | -- | -- | -- | -- text | String | - | copied content | N suffix | Slot / Function | - | custom element configuration for copy icon。Typescript：`TNode<{ copied: boolean }>`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N -tooltipProps | Object | - | Configuration of the tooltip that appears on the copy icon when the cursor is over it。Typescript：`tooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/typography/type.ts) | N +tooltipProps | Object | - | Configuration of the tooltip that appears on the copy icon when the cursor is over it。Typescript：`TooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/typography/type.ts) | N onCopy | Function | | Typescript：`() => void`
| N ### TypographyCopyable diff --git a/packages/products/tdesign-vue-next/packages/components/typography/typography.md b/packages/products/tdesign-vue-next/packages/components/typography/typography.md index c648ac41..cb88e640 100644 --- a/packages/products/tdesign-vue-next/packages/components/typography/typography.md +++ b/packages/products/tdesign-vue-next/packages/components/typography/typography.md @@ -47,7 +47,7 @@ collapsible | Boolean | true | 展开后是否可以重新收起 | N expandable | Boolean | true | 是否可展开 | N row | Number | 1 | 省略配置默认展示行数 | N suffix | Slot / Function | - | 自定义省略触发元素，一般用于自定义折叠图标。TS 类型：`TNode<{ expanded: boolean }>`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N -tooltipProps | Object | - | 光标在省略图标上出现的tooltip的配置。TS 类型：`tooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/typography/type.ts) | N +tooltipProps | Object | - | 光标在省略图标上出现的tooltip的配置。TS 类型：`TooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/typography/type.ts) | N onExpand | Function | | TS 类型：`(expanded:boolean) => void`
点击省略按钮的回调 | N ### TypographyEllipsis @@ -61,7 +61,7 @@ expand | `(expanded:boolean)` | 点击省略按钮的回调 -- | -- | -- | -- | -- text | String | - | 复制的文本内容，默认为全部文本 | N suffix | Slot / Function | - | 自定义复制触发元素，一般用于自定义复制图标。TS 类型：`TNode<{ copied: boolean }>`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N -tooltipProps | Object | - | 光标在复制图标上出现的tooltip的配置。TS 类型：`tooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/typography/type.ts) | N +tooltipProps | Object | - | 光标在复制图标上出现的tooltip的配置。TS 类型：`TooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/typography/type.ts) | N onCopy | Function | | TS 类型：`() => void`
点击复制按钮的回调 | N ### TypographyCopyable diff --git a/packages/products/tdesign-vue/src/typography/type.ts b/packages/products/tdesign-vue/src/typography/type.ts index 30012e89..ecc19bce 100644 --- a/packages/products/tdesign-vue/src/typography/type.ts +++ b/packages/products/tdesign-vue/src/typography/type.ts @@ -4,7 +4,7 @@ * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC * */ -import { tooltipProps } from '../tooltip'; +import { TooltipProps } from '../tooltip'; import { TNode } from '../common'; export interface TdTextProps { @@ -132,7 +132,7 @@ export interface TypographyEllipsis { /** * 光标在省略图标上出现的tooltip的配置 */ - tooltipProps?: tooltipProps; + tooltipProps?: TooltipProps; /** * 点击省略按钮的回调 */ @@ -152,7 +152,7 @@ export interface TypographyCopyable { /** * 光标在复制图标上出现的tooltip的配置 */ - tooltipProps?: tooltipProps; + tooltipProps?: TooltipProps; /** * 点击复制按钮的回调 */ diff --git a/packages/products/tdesign-vue/src/typography/typography.en-US.md b/packages/products/tdesign-vue/src/typography/typography.en-US.md index 930906ea..41adca75 100644 --- a/packages/products/tdesign-vue/src/typography/typography.en-US.md +++ b/packages/products/tdesign-vue/src/typography/typography.en-US.md @@ -47,7 +47,7 @@ collapsible | Boolean | true | collapsible after expanding | N expandable | Boolean | true | expandable | N row | Number | 1 | default row number of ellipsis | N suffix | Slot / Function | - | custom element configuration for ellipsis and collapse icon。Typescript：`TNode<{ expanded: boolean }>`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N -tooltipProps | Object | - | Configuration of the tooltip that appears on the ellipsis icon when the cursor is over it。Typescript：`tooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/typography/type.ts) | N +tooltipProps | Object | - | Configuration of the tooltip that appears on the ellipsis icon when the cursor is over it。Typescript：`TooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/typography/type.ts) | N onExpand | Function | | Typescript：`(expanded:boolean) => void`
| N ### TypographyEllipsis @@ -61,7 +61,7 @@ name | type | default | description | required -- | -- | -- | -- | -- text | String | - | copied content | N suffix | Slot / Function | - | custom element configuration for copy icon。Typescript：`TNode<{ copied: boolean }>`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N -tooltipProps | Object | - | Configuration of the tooltip that appears on the copy icon when the cursor is over it。Typescript：`tooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/typography/type.ts) | N +tooltipProps | Object | - | Configuration of the tooltip that appears on the copy icon when the cursor is over it。Typescript：`TooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/typography/type.ts) | N onCopy | Function | | Typescript：`() => void`
| N ### TypographyCopyable diff --git a/packages/products/tdesign-vue/src/typography/typography.md b/packages/products/tdesign-vue/src/typography/typography.md index f1d6a497..18e96022 100644 --- a/packages/products/tdesign-vue/src/typography/typography.md +++ b/packages/products/tdesign-vue/src/typography/typography.md @@ -47,7 +47,7 @@ collapsible | Boolean | true | 展开后是否可以重新收起 | N expandable | Boolean | true | 是否可展开 | N row | Number | 1 | 省略配置默认展示行数 | N suffix | Slot / Function | - | 自定义省略触发元素，一般用于自定义折叠图标。TS 类型：`TNode<{ expanded: boolean }>`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N -tooltipProps | Object | - | 光标在省略图标上出现的tooltip的配置。TS 类型：`tooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/typography/type.ts) | N +tooltipProps | Object | - | 光标在省略图标上出现的tooltip的配置。TS 类型：`TooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/typography/type.ts) | N onExpand | Function | | TS 类型：`(expanded:boolean) => void`
点击省略按钮的回调 | N ### TypographyEllipsis @@ -61,7 +61,7 @@ expand | `(expanded:boolean)` | 点击省略按钮的回调 -- | -- | -- | -- | -- text | String | - | 复制的文本内容，默认为全部文本 | N suffix | Slot / Function | - | 自定义复制触发元素，一般用于自定义复制图标。TS 类型：`TNode<{ copied: boolean }>`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N -tooltipProps | Object | - | 光标在复制图标上出现的tooltip的配置。TS 类型：`tooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/typography/type.ts) | N +tooltipProps | Object | - | 光标在复制图标上出现的tooltip的配置。TS 类型：`TooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/typography/type.ts) | N onCopy | Function | | TS 类型：`() => void`
点击复制按钮的回调 | N ### TypographyCopyable diff --git a/packages/scripts/api.json b/packages/scripts/api.json index ef46db37..9824e5b9 100644 --- a/packages/scripts/api.json +++ b/packages/scripts/api.json @@ -135465,7 +135465,7 @@ "create_time": "2024-01-30 18:09:32", "update_time": "2024-01-30 18:09:32", "event_output": null, - "custom_field_type": "tooltipProps【import { tooltipProps } from '@Tooltip'】", + "custom_field_type": "TooltipProps【import { TooltipProps } from '@Tooltip'】", "syntactic_sugar": null, "readonly": 1, "html_attribute": 0, @@ -135707,7 +135707,7 @@ "create_time": "2024-01-30 17:55:02", "update_time": "2024-01-30 17:55:02", "event_output": null, - "custom_field_type": "tooltipProps【import { tooltipProps } from '@Tooltip'】", + "custom_field_type": "TooltipProps【import { TooltipProps } from '@Tooltip'】", "syntactic_sugar": null, "readonly": 1, "html_attribute": 0,