tdesign-vue-next
Version:
TDesign Component for vue-next
1,228 lines • 930 kB
JSON
{
"$schema": "http://json.schemastore.org/web-types",
"framework": "vue",
"name": "tdesign-vue-next",
"js-types-syntax": "typescript",
"description-markup": "markdown",
"contributions": {
"html": {
"vue-components": [
{
"name": "t-affix",
"source": {
"symbol": "Affix"
},
"description": "Affix\n\n固钉",
"doc-url": "https://tdesign.tencent.com/vue-next/components/affix",
"props": [
{
"name": "container",
"description": "指定滚动的容器。数据类型为 String 时,会被当作选择器处理,进行节点查询。示例:'body' 或 () => document.body",
"doc-url": "https://tdesign.tencent.com/vue-next/components/affix?tab=api#affix-props",
"type": "ScrollContainer",
"default": "() => (() => window)"
},
{
"name": "content",
"description": "内容",
"doc-url": "https://tdesign.tencent.com/vue-next/components/affix?tab=api#affix-props",
"type": "string | TNode"
},
{
"name": "default",
"description": "内容,同 content",
"doc-url": "https://tdesign.tencent.com/vue-next/components/affix?tab=api#affix-props",
"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",
"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",
"default": "0"
},
{
"name": "z-index",
"description": "固钉定位层级,样式默认为 500",
"doc-url": "https://tdesign.tencent.com/vue-next/components/affix?tab=api#affix-props",
"type": "number"
}
],
"js": {
"events": [
{
"name": "fixed-change",
"description": "固定状态发生变化时触发",
"doc-url": "https://tdesign.tencent.com/vue-next/components/affix?tab=api#affix-events"
}
]
},
"slots": [
{
"name": "content",
"description": "内容",
"doc-url": "https://tdesign.tencent.com/vue-next/components/affix?tab=api#affix-props"
},
{
"name": "default",
"description": "内容,同 content",
"doc-url": "https://tdesign.tencent.com/vue-next/components/affix?tab=api#affix-props"
}
]
},
{
"name": "t-alert",
"source": {
"symbol": "Alert"
},
"description": "Alert\n\n警告提示",
"doc-url": "https://tdesign.tencent.com/vue-next/components/alert",
"props": [
{
"name": "close",
"description": "Deprecated, use closeBtn instead.\n\n即将废弃,请使用 closeBtn 属性。关闭按钮。值为 true 则显示默认关闭按钮;值为 false 则不显示按钮;值类型为 string 则直接显示;值类型为 Function 则可以自定关闭按钮",
"doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-props",
"type": "string | boolean | TNode",
"default": "false"
},
{
"name": "close-btn",
"description": "Close button. Value \"true\" show the close button. Value \"False\" hide close button. Value type string display as is. Use TNode to custom the close trigger.\n\n关闭按钮。值为 true 则显示默认关闭按钮;值为 false 则不显示按钮;值类型为 string 则直接显示;值类型为 Function 则可以自定关闭按钮",
"doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-props",
"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"
},
{
"name": "icon",
"description": "图标",
"doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-props",
"type": "TNode"
},
{
"name": "max-line",
"description": "内容显示最大行数,超出的内容会折叠收起,用户点击后再展开。值为 0 表示不折叠",
"doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-props",
"type": "number",
"default": "0"
},
{
"name": "message",
"description": "内容(子元素)",
"doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-props",
"type": "string | TNode"
},
{
"name": "operation",
"description": "跟在告警内容后面的操作区",
"doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-props",
"type": "TNode"
},
{
"name": "theme",
"description": "组件风格",
"doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-props",
"type": "'success' | 'info' | 'warning' | 'error'",
"default": "info",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "success"
},
{
"name": "info"
},
{
"name": "warning"
},
{
"name": "error"
}
]
},
{
"name": "title",
"description": "标题",
"doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-props",
"type": "string | TNode"
}
],
"js": {
"events": [
{
"name": "close",
"description": "关闭按钮点击时触发",
"doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-events"
},
{
"name": "closed",
"description": "告警提示框关闭动画结束后触发",
"doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-events"
}
]
},
"slots": [
{
"name": "close",
"description": "Deprecated, use closeBtn instead.\n\n即将废弃,请使用 closeBtn 属性。关闭按钮。值为 true 则显示默认关闭按钮;值为 false 则不显示按钮;值类型为 string 则直接显示;值类型为 Function 则可以自定关闭按钮",
"doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-props"
},
{
"name": "closeBtn",
"description": "Close button. Value \"true\" show the close button. Value \"False\" hide close button. Value type string display as is. Use TNode to custom the close trigger.\n\n关闭按钮。值为 true 则显示默认关闭按钮;值为 false 则不显示按钮;值类型为 string 则直接显示;值类型为 Function 则可以自定关闭按钮类型和参数:string | boolean | TNode",
"doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-props"
},
{
"name": "close-btn",
"description": "Close button. Value \"true\" show the close button. Value \"False\" hide close button. Value type string display as is. Use TNode to custom the close trigger.\n\n关闭按钮。值为 true 则显示默认关闭按钮;值为 false 则不显示按钮;值类型为 string 则直接显示;值类型为 Function 则可以自定关闭按钮类型和参数:string | boolean | TNode",
"doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-props"
},
{
"name": "default",
"description": "内容,同 message",
"doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-props"
},
{
"name": "icon",
"description": "图标",
"doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-props"
},
{
"name": "message",
"description": "内容(子元素)",
"doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-props"
},
{
"name": "operation",
"description": "跟在告警内容后面的操作区",
"doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-props"
},
{
"name": "title",
"description": "标题",
"doc-url": "https://tdesign.tencent.com/vue-next/components/alert?tab=api#alert-props"
}
]
},
{
"name": "t-anchor",
"source": {
"symbol": "Anchor"
},
"description": "Anchor\n\n锚点",
"doc-url": "https://tdesign.tencent.com/vue-next/components/anchor",
"props": [
{
"name": "affix-props",
"description": "透传 Affix 组件属性,即让 Anchor 组件支持所有 Affix 组件特性",
"doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchor-props",
"type": "AffixProps"
},
{
"name": "bounds",
"description": "锚点区域边界",
"doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchor-props",
"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": "ScrollContainer",
"default": "() => (() => window)"
},
{
"name": "cursor",
"description": "用于自定义选中项左侧游标",
"doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchor-props",
"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": "(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": "SizeEnum",
"default": "medium",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "small"
},
{
"name": "medium"
},
{
"name": "large"
}
]
},
{
"name": "target-offset",
"description": "锚点滚动偏移量",
"doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchor-props",
"type": "number",
"default": "0"
}
],
"js": {
"events": [
{
"name": "change",
"description": "锚点改变时触发",
"doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchor-events"
},
{
"name": "click",
"description": "锚点被点击时触发",
"doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchor-events"
}
]
},
"slots": [
{
"name": "cursor",
"description": "用于自定义选中项左侧游标",
"doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchor-props"
}
]
},
{
"name": "t-anchor-item",
"source": {
"symbol": "AnchorItem"
},
"description": "AnchorItem\n\n锚点项",
"doc-url": "https://tdesign.tencent.com/vue-next/components/anchor",
"props": [
{
"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",
"default": "false"
},
{
"name": "href",
"description": "锚点链接, 如果是 hash 模式需要加上当前 path",
"doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchoritem-props",
"type": "string"
},
{
"name": "target",
"description": "锚点文本",
"doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchoritem-props",
"type": "'_self' | '_blank' | '_parent' | '_top'",
"default": "_self",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "_self"
},
{
"name": "_blank"
},
{
"name": "_parent"
},
{
"name": "_top"
}
]
},
{
"name": "title",
"description": "锚点文本",
"doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchoritem-props",
"type": "string | TNode",
"default": "''"
}
],
"slots": [
{
"name": "title",
"description": "锚点文本",
"doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchoritem-props"
}
]
},
{
"name": "t-anchor-target",
"source": {
"symbol": "AnchorTarget"
},
"description": "AnchorTarget\n\n锚点目标",
"doc-url": "https://tdesign.tencent.com/vue-next/components/anchor",
"props": [
{
"name": "id",
"description": "目标内容 id",
"doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchortarget-props",
"type": "string"
},
{
"name": "tag",
"description": "渲染的标签",
"doc-url": "https://tdesign.tencent.com/vue-next/components/anchor?tab=api#anchortarget-props",
"type": "string",
"default": "div"
}
],
"slots": []
},
{
"name": "t-aside",
"source": {
"symbol": "Aside"
},
"description": "Aside\n\n布局-侧边栏",
"doc-url": "https://tdesign.tencent.com/vue-next/components/layout",
"props": [
{
"name": "width",
"description": "侧边栏宽度。样式表(class)中定义的默认宽度为:232px",
"doc-url": "https://tdesign.tencent.com/vue-next/components/layout?tab=api#aside-props",
"type": "string"
}
],
"slots": []
},
{
"name": "t-auto-complete",
"source": {
"symbol": "AutoComplete"
},
"description": "AutoComplete\n\n自动填充",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete",
"props": [
{
"name": "autofocus",
"description": "自动获取焦点",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props",
"type": "boolean"
},
{
"name": "borderless",
"description": "无边框模式",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props",
"type": "boolean",
"default": "false"
},
{
"name": "clearable",
"description": "是否允许清空",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props",
"type": "boolean"
},
{
"name": "default",
"description": "触发显示联想词下拉框的元素,同 `triggerElement`",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props",
"type": "string | TNode"
},
{
"name": "disabled",
"description": "是否禁用",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props",
"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"
},
{
"name": "filter",
"description": "自定义过滤规则,用于对现有数据进行搜索过滤,判断是否过滤某一项数据。参数 `filterWords` 表示搜索词,`option`表示单个选项内容,返回值为 `true` 保留该选项,返回值为 `false` 则隐藏该选项。使用该方法时无需设置 `filterable`",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props",
"type": "(filterWords: string, option: T) => boolean | Promise<boolean>"
},
{
"name": "filterable",
"description": "是否根据输入内容过滤联想词。默认过滤规则不区分大小写,全文本任意位置匹配。如果默认搜索规则不符合业务需求,可以更为使用 `filter` 自定义过滤规则。部分场景下输入关键词和下拉联想词完全不同,此时可以设置为 `false`",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props",
"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",
"default": "true"
},
{
"name": "input-props",
"description": "透传 Input 组件全部特性",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props",
"type": "InputProps"
},
{
"name": "options",
"description": "下拉联想词列表。示例一:`['联想词一', '联想词二']`。示例二:`{ label: () => <div>联想词元素</div>, text: '用于搜索的纯联想词' }`",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props",
"type": "Array<T>"
},
{
"name": "panel-bottom-content",
"description": "面板内的底部内容",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props",
"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"
},
{
"name": "placeholder",
"description": "输入框为空时的占位提示。组件本身默认值为 `undefined`,但全局配置存在默认值,不同语言全局默认值不同",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props",
"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": "PopupProps"
},
{
"name": "readonly",
"description": "是否只读",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "size",
"description": "组件尺寸",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props",
"type": "SizeEnum",
"default": "medium",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "small"
},
{
"name": "medium"
},
{
"name": "large"
}
]
},
{
"name": "status",
"description": "输入框状态",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props",
"type": "'default' | 'success' | 'warning' | 'error'",
"default": "default",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "default"
},
{
"name": "success"
},
{
"name": "warning"
},
{
"name": "error"
}
]
},
{
"name": "textarea-props",
"description": "透传 Textarea 组件全部特性",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props",
"type": "TextareaProps"
},
{
"name": "tips",
"description": "输入框下方提示文本,会根据不同的 `status` 呈现不同的样式",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props",
"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"
},
{
"name": "value",
"description": "输入框的值,即当前指定的联想词",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props",
"type": "string"
}
],
"js": {
"events": [
{
"name": "blur",
"description": "失去焦点时触发",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-events"
},
{
"name": "change",
"description": "输入框值发生变化时触发",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-events"
},
{
"name": "clear",
"description": "清空按钮点击时触发",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-events"
},
{
"name": "compositionend",
"description": "trigger on compositionend\n\n中文输入结束时触发",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-events"
},
{
"name": "compositionstart",
"description": "trigger on compositionstart\n\n中文输入开始时触发",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-events"
},
{
"name": "enter",
"description": "回车键按下时触发",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-events"
},
{
"name": "focus",
"description": "获得焦点时触发",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-events"
},
{
"name": "select",
"description": "选中联想词时触发",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-events"
}
]
},
"slots": [
{
"name": "default",
"description": "触发显示联想词下拉框的元素,同 `triggerElement`",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props"
},
{
"name": "empty",
"description": "当下拉联想词列表为空时显示的内容",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props"
},
{
"name": "panelBottomContent",
"description": "面板内的底部内容",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props"
},
{
"name": "panel-bottom-content",
"description": "面板内的底部内容",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props"
},
{
"name": "panelTopContent",
"description": "面板内的顶部内容",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props"
},
{
"name": "panel-top-content",
"description": "面板内的顶部内容",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props"
},
{
"name": "tips",
"description": "输入框下方提示文本,会根据不同的 `status` 呈现不同的样式",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props"
},
{
"name": "triggerElement",
"description": "触发显示联想词下拉框的元素,默认为 Input 组件,可以使用 `trigger` 自定义为 Textarea 组件或其他组件",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props"
},
{
"name": "trigger-element",
"description": "触发显示联想词下拉框的元素,默认为 Input 组件,可以使用 `trigger` 自定义为 Textarea 组件或其他组件",
"doc-url": "https://tdesign.tencent.com/vue-next/components/auto-complete?tab=api#autocomplete-props"
}
]
},
{
"name": "t-avatar",
"source": {
"symbol": "Avatar"
},
"description": "Avatar\n\n头像",
"doc-url": "https://tdesign.tencent.com/vue-next/components/avatar",
"props": [
{
"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"
},
{
"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"
},
{
"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"
},
{
"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",
"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"
},
{
"name": "image",
"description": "images url\n\n图片地址",
"doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatar-props",
"type": "string"
},
{
"name": "image-props",
"description": "透传至 Image 组件",
"doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatar-props",
"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": "ShapeEnum",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "circle"
},
{
"name": "round"
}
]
},
{
"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"
}
],
"js": {
"events": [
{
"name": "click",
"description": "trigger on click\n\n点击时触发",
"doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatar-events"
},
{
"name": "contextmenu",
"description": "trigger on context menu\n\n右键点击时触发",
"doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatar-events"
},
{
"name": "error",
"description": "trigger on image load failed\n\n图片加载失败时触发",
"doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatar-events"
},
{
"name": "hover",
"description": "trigger on mouse enter\n\n鼠标移入时触发",
"doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatar-events"
}
]
},
"slots": [
{
"name": "content",
"description": "content slot or props.content\n\n子元素内容",
"doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatar-props"
},
{
"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"
},
{
"name": "icon",
"description": "use icon to fill\n\n图标",
"doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatar-props"
}
]
},
{
"name": "t-avatar-group",
"source": {
"symbol": "AvatarGroup"
},
"description": "AvatarGroup\n\n头像组",
"doc-url": "https://tdesign.tencent.com/vue-next/components/avatar",
"props": [
{
"name": "cascading",
"description": "multiple images cascading\n\n图片之间的层叠关系,可选值:左侧图片在上和右侧图片在上",
"doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatargroup-props",
"type": "CascadingValue",
"default": "'right-up'",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "left-up"
},
{
"name": "right-up"
}
]
},
{
"name": "collapse-avatar",
"description": "头像数量超出时,会出现一个头像折叠元素。该元素内容可自定义。默认为 `+N`。示例:`+5`,`...`, `更多`",
"doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatargroup-props",
"type": "string | TNode"
},
{
"name": "max",
"description": "能够同时显示的最多头像数量",
"doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatargroup-props",
"type": "number"
},
{
"name": "popup-props",
"description": "头像右上角提示信息",
"doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatargroup-props",
"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": "ShapeEnum",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "circle"
},
{
"name": "round"
}
]
},
{
"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"
}
],
"js": {
"events": [
{
"name": "collapsed-item-click",
"description": "点击头像折叠元素触发",
"doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatargroup-events"
}
]
},
"slots": [
{
"name": "collapseAvatar",
"description": "头像数量超出时,会出现一个头像折叠元素。该元素内容可自定义。默认为 `+N`。示例:`+5`,`...`, `更多`",
"doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatargroup-props"
},
{
"name": "collapse-avatar",
"description": "头像数量超出时,会出现一个头像折叠元素。该元素内容可自定义。默认为 `+N`。示例:`+5`,`...`, `更多`",
"doc-url": "https://tdesign.tencent.com/vue-next/components/avatar?tab=api#avatargroup-props"
}
]
},
{
"name": "t-back-top",
"source": {
"symbol": "BackTop"
},
"description": "BackTop\n\n回到顶部",
"doc-url": "https://tdesign.tencent.com/vue-next/components/back-top",
"props": [
{
"name": "container",
"description": "监听滚动的容器。数据类型为 String 时,会被当作选择器处理,进行节点查询。示例:'body' 或 () => document.body",
"doc-url": "https://tdesign.tencent.com/vue-next/components/back-top?tab=api#backtop-props",
"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"
},
{
"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"
},
{
"name": "duration",
"description": "回到顶部的耗时单位:毫秒",
"doc-url": "https://tdesign.tencent.com/vue-next/components/back-top?tab=api#backtop-props",
"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<string | number>",
"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": "BackTopShapeEnum ",
"default": "square",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "circle"
},
{
"name": "square"
}
]
},
{
"name": "size",
"description": "size of BackTop\n\n组件尺寸",
"doc-url": "https://tdesign.tencent.com/vue-next/components/back-top?tab=api#backtop-props",
"type": "'medium' | 'small'",
"default": "medium",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "medium"
},
{
"name": "small"
}
]
},
{
"name": "target",
"description": "指定回到该对象。数据类型为 String 时,会被当作选择器处理,进行节点查询。示例:'body' 或 () => document.body",
"doc-url": "https://tdesign.tencent.com/vue-next/components/back-top?tab=api#backtop-props",
"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": "'light' | 'primary' | 'dark'",
"default": "light",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "light"
},
{
"name": "primary"
},
{
"name": "dark"
}
]
},
{
"name": "visible-height",
"description": "滚动高度达到此参数值才出现",
"doc-url": "https://tdesign.tencent.com/vue-next/components/back-top?tab=api#backtop-props",
"type": "string | number",
"default": "'200px'"
}
],
"js": {
"events": [
{
"name": "click",
"description": "点击回到顶部时触发",
"doc-url": "https://tdesign.tencent.com/vue-next/components/back-top?tab=api#backtop-events"
}
]
},
"slots": [
{
"name": "content",
"description": "Backtop's children elements\n\n回到顶部内容",
"doc-url": "https://tdesign.tencent.com/vue-next/components/back-top?tab=api#backtop-props"
},
{
"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"
}
]
},
{
"name": "t-badge",
"source": {
"symbol": "Badge"
},
"description": "Badge\n\n徽标数",
"doc-url": "https://tdesign.tencent.com/vue-next/components/badge",
"props": [
{
"name": "color",
"description": "颜色",
"doc-url": "https://tdesign.tencent.com/vue-next/components/badge?tab=api#badge-props",
"type": "string"
},
{
"name": "content",
"description": "徽标内容",
"doc-url": "https://tdesign.tencent.com/vue-next/components/badge?tab=api#badge-props",
"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",
"default": "0"
},
{
"name": "default",
"description": "徽标内容,默认插槽,同 content",
"doc-url": "https://tdesign.tencent.com/vue-next/components/badge?tab=api#badge-props",
"type": "string | TNode"
},
{
"name": "dot",
"description": "是否为红点",
"doc-url": "https://tdesign.tencent.com/vue-next/components/badge?tab=api#badge-props",
"type": "boolean",
"default": "false"
},
{
"name": "max-count",
"description": "封顶的数字值",
"doc-url": "https://tdesign.tencent.com/vue-next/components/badge?tab=api#badge-props",
"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<string | number>"
},
{
"name": "shape",
"description": "形状",
"doc-url": "https://tdesign.tencent.com/vue-next/components/badge?tab=api#badge-props",
"type": "'circle' | 'round'",
"default": "circle",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "circle"
},
{
"name": "round"
}
]
},
{
"name": "show-zero",
"description": "当数值为 0 时,是否展示徽标",
"doc-url": "https://tdesign.tencent.com/vue-next/components/badge?tab=api#badge-props",
"type": "boolean",
"default": "false"
},
{
"name": "size",
"description": "尺寸",
"doc-url": "https://tdesign.tencent.com/vue-next/components/badge?tab=api#badge-props",
"type": "'small' | 'medium'",
"default": "medium",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "small"
},
{
"name": "medium"
}
]
}
],
"slots": [
{
"name": "content",
"description": "徽标内容",
"doc-url": "https://tdesign.tencent.com/vue-next/components/badge?tab=api#badge-props"
},
{
"name": "count",
"description": "徽标右上角内容。可以是数字,也可以是文字。如:'new'/3/99+",
"doc-url": "https://tdesign.tencent.com/vue-next/components/badge?tab=api#badge-props"
},
{
"name": "default",
"description": "徽标内容,默认插槽,同 content",
"doc-url": "https://tdesign.tencent.com/vue-next/components/badge?tab=api#badge-props"
}
]
},
{
"name": "t-base-table",
"source": {
"symbol": "BaseTable"
},
"description": "BaseTable\n\n基础表格",
"doc-url": "https://tdesign.tencent.com/vue-next/components/table",
"props": [
{
"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<string | number>",
"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": "'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",
"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": "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",
"default": "false"
},
{
"name": "bottom-content",
"description": "表格底部内容,可以用于自定义列设置等",
"doc-url": "https://tdesign.tencent.com/vue-next/components/table?tab=api#basetable-props",
"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<BaseTableCellParams<T>>"
},
{
"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<BaseTableCol<T>>",
"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<T>",
"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",
"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",
"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": "stri