tdesign-mobile-vue
Version:
tdesign-mobile-vue
9,352 lines • 400 kB
JSON
{
"$schema": "http://json.schemastore.org/web-types",
"framework": "vue",
"name": "tdesign-mobile-vue",
"js-types-syntax": "typescript",
"description-markup": "markdown",
"contributions": {
"html": {
"vue-components": [
{
"name": "t-action-sheet",
"source": {
"symbol": "ActionSheet"
},
"description": "ActionSheet\n\n动作面板",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/action-sheet",
"props": [
{
"name": "align",
"description": "水平对齐方式",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/action-sheet?tab=api#actionsheet-props",
"type": "'center' | 'left'",
"default": "center",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "center"
},
{
"name": "left"
}
]
},
{
"name": "cancel-text",
"description": "设置取消按钮的文本",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/action-sheet?tab=api#actionsheet-props",
"type": "string"
},
{
"name": "count",
"description": "设置每页展示菜单的数量，仅当 type=grid 时有效",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/action-sheet?tab=api#actionsheet-props",
"type": "number",
"default": "8"
},
{
"name": "description",
"description": "动作面板描述文字",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/action-sheet?tab=api#actionsheet-props",
"type": "string"
},
{
"name": "items",
"description": "菜单项",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/action-sheet?tab=api#actionsheet-props",
"type": "Array<string | ActionSheetItem>"
},
{
"name": "popup-props",
"description": "透传 Popup 组件全部属性",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/action-sheet?tab=api#actionsheet-props",
"type": "PopupProps",
"default": "{}"
},
{
"name": "show-cancel",
"description": "是否显示取消按钮",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/action-sheet?tab=api#actionsheet-props",
"type": "boolean",
"default": "true"
},
{
"name": "show-overlay",
"description": "是否显示遮罩层",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/action-sheet?tab=api#actionsheet-props",
"type": "boolean",
"default": "true"
},
{
"name": "theme",
"description": "展示类型，列表和表格形式展示",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/action-sheet?tab=api#actionsheet-props",
"type": "'list' | 'grid'",
"default": "list",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "list"
},
{
"name": "grid"
}
]
},
{
"name": "visible",
"description": "显示与隐藏",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/action-sheet?tab=api#actionsheet-props",
"type": "boolean",
"default": "false"
}
],
"js": {
"events": [
{
"name": "cancel",
"description": "点击取消按钮时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/action-sheet?tab=api#actionsheet-events"
},
{
"name": "close",
"description": "关闭时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/action-sheet?tab=api#actionsheet-events"
},
{
"name": "selected",
"description": "选择菜单项时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/action-sheet?tab=api#actionsheet-events"
}
]
},
"slots": []
},
{
"name": "t-avatar",
"source": {
"symbol": "Avatar"
},
"description": "Avatar\n\n头像",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/avatar",
"props": [
{
"name": "alt",
"description": "show it when url is not valid\n\n头像替换文本，仅当图片加载失败时有效",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/avatar?tab=api#avatar-props",
"type": "string"
},
{
"name": "badge-props",
"description": "头像右上角提示信息，继承 Badge 组件的全部特性。如：小红点，或者数字",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/avatar?tab=api#avatar-props",
"type": "BadgeProps"
},
{
"name": "hide-on-load-failed",
"description": "hide image when loading image failed\n\n加载失败时隐藏图片",
"doc-url": "https://tdesign.tencent.com/mobile-vue/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/mobile-vue/components/avatar?tab=api#avatar-props",
"type": "TNode"
},
{
"name": "image",
"description": "images url\n\n图片地址",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/avatar?tab=api#avatar-props",
"type": "string"
},
{
"name": "image-props",
"description": "透传至 Image 组件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/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/mobile-vue/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/mobile-vue/components/avatar?tab=api#avatar-props",
"type": "string"
}
],
"js": {
"events": [
{
"name": "error",
"description": "trigger on image load failed\n\n图片加载失败时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/avatar?tab=api#avatar-events"
}
]
},
"slots": [
{
"name": "icon",
"description": "use icon to fill\n\n图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/avatar?tab=api#avatar-props"
}
]
},
{
"name": "t-avatar-group",
"source": {
"symbol": "AvatarGroup"
},
"description": "AvatarGroup\n\n头像组",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/avatar",
"props": [
{
"name": "cascading",
"description": "multiple images cascading\n\n图片之间的层叠关系，可选值：左侧图片在上和右侧图片在上",
"doc-url": "https://tdesign.tencent.com/mobile-vue/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/mobile-vue/components/avatar?tab=api#avatargroup-props",
"type": "string | TNode"
},
{
"name": "max",
"description": "能够同时显示的最多头像数量",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/avatar?tab=api#avatargroup-props",
"type": "number"
},
{
"name": "shape",
"description": "shape\n\n形状。优先级低于 Avatar.shape",
"doc-url": "https://tdesign.tencent.com/mobile-vue/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/mobile-vue/components/avatar?tab=api#avatargroup-props",
"type": "string"
}
],
"js": {
"events": [
{
"name": "collapsed-item-click",
"description": "点击头像折叠元素触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/avatar?tab=api#avatargroup-events"
}
]
},
"slots": [
{
"name": "collapseAvatar",
"description": "头像数量超出时，会出现一个头像折叠元素。该元素内容可自定义。默认为 `+N`。示例：`+5`，`...`, `更多`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/avatar?tab=api#avatargroup-props"
},
{
"name": "collapse-avatar",
"description": "头像数量超出时，会出现一个头像折叠元素。该元素内容可自定义。默认为 `+N`。示例：`+5`，`...`, `更多`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/avatar?tab=api#avatargroup-props"
}
]
},
{
"name": "t-back-top",
"source": {
"symbol": "BackTop"
},
"description": "BackTop\n\n回到顶部",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/back-top",
"props": [
{
"name": "container",
"description": "滚动的容器",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/back-top?tab=api#backtop-props",
"type": "() => HTMLElement"
},
{
"name": "fixed",
"description": "是否绝对定位固定到屏幕右下方",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/back-top?tab=api#backtop-props",
"type": "boolean",
"default": "true"
},
{
"name": "icon",
"description": "图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/back-top?tab=api#backtop-props",
"type": "boolean | TNode",
"default": "true"
},
{
"name": "target",
"description": "定位滚动到指定对象",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/back-top?tab=api#backtop-props",
"type": "() => HTMLElement"
},
{
"name": "text",
"description": "文案",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/back-top?tab=api#backtop-props",
"type": "string",
"default": "''"
},
{
"name": "theme",
"description": "预设的样式类型",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/back-top?tab=api#backtop-props",
"type": "'round' | 'half-round' | 'round-dark' | 'half-round-dark'",
"default": "round",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "round"
},
{
"name": "half-round"
},
{
"name": "round-dark"
},
{
"name": "half-round-dark"
}
]
},
{
"name": "visibility-height",
"description": "滚动高度达到此参数值才出现",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/back-top?tab=api#backtop-props",
"type": "number",
"default": "200"
}
],
"js": {
"events": [
{
"name": "to-top",
"description": "点击触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/back-top?tab=api#backtop-events"
}
]
},
"slots": [
{
"name": "icon",
"description": "图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/back-top?tab=api#backtop-props"
}
]
},
{
"name": "t-badge",
"source": {
"symbol": "Badge"
},
"description": "Badge\n\n徽标数",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/badge",
"props": [
{
"name": "color",
"description": "颜色",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/badge?tab=api#badge-props",
"type": "string"
},
{
"name": "content",
"description": "徽标内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/badge?tab=api#badge-props",
"type": "string | TNode"
},
{
"name": "count",
"description": "徽标右上角内容。可以是数字，也可以是文字。如：'new'/3/99+",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/badge?tab=api#badge-props",
"type": "string | number | TNode",
"default": "0"
},
{
"name": "dot",
"description": "是否为红点",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/badge?tab=api#badge-props",
"type": "boolean",
"default": "false"
},
{
"name": "max-count",
"description": "封顶的数字值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/badge?tab=api#badge-props",
"type": "number",
"default": "99"
},
{
"name": "offset",
"description": "设置状态点的位置偏移，示例：[-10, 20] 或 ['10em', '8rem']",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/badge?tab=api#badge-props",
"type": "Array<string | number>"
},
{
"name": "shape",
"description": "形状",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/badge?tab=api#badge-props",
"type": "'circle' | 'square' | 'bubble' | 'ribbon'",
"default": "circle",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "circle"
},
{
"name": "square"
},
{
"name": "bubble"
},
{
"name": "ribbon"
}
]
},
{
"name": "show-zero",
"description": "当数值为 0 时，是否展示徽标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/badge?tab=api#badge-props",
"type": "boolean",
"default": "false"
},
{
"name": "size",
"description": "尺寸",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/badge?tab=api#badge-props",
"type": "'medium' | 'large'",
"default": "medium",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "medium"
},
{
"name": "large"
}
]
}
],
"slots": [
{
"name": "content",
"description": "徽标内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/badge?tab=api#badge-props"
},
{
"name": "count",
"description": "徽标右上角内容。可以是数字，也可以是文字。如：'new'/3/99+",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/badge?tab=api#badge-props"
}
]
},
{
"name": "t-table",
"source": {
"symbol": "BaseTable"
},
"description": "BaseTable\n\n基础表格",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/table",
"props": [
{
"name": "bordered",
"description": "show table bordered\n\n是否显示表格边框",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/table?tab=api#basetable-props",
"type": "boolean",
"default": "false"
},
{
"name": "cell-empty-content",
"description": "单元格数据为空时呈现的内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/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/mobile-vue/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/mobile-vue/components/table?tab=api#basetable-props",
"type": "Array<T>",
"default": "[]"
},
{
"name": "empty",
"description": "empty text or empty element\n\n空表格呈现样式，支持全局配置 `GlobalConfigProvider`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/table?tab=api#basetable-props",
"type": "string | TNode",
"default": "''"
},
{
"name": "fixed-rows",
"description": "固定行（冻结行），示例：[M, N]，表示冻结表头 M 行和表尾 N 行。M 和 N 值为 0 时，表示不冻结行",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/table?tab=api#basetable-props",
"type": "Array<number>"
},
{
"name": "height",
"description": "table height\n\n表格高度，超出后会出现滚动条。示例：100, '30%', '300'。值为数字类型，会自动加上单位 px。如果不是绝对固定表格高度，建议使用 `maxHeight`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/table?tab=api#basetable-props",
"type": "string | number"
},
{
"name": "loading",
"description": "loading state table\n\n加载中状态。值为 `true` 会显示默认加载中样式，可以通过 Function 和 插槽 自定义加载状态呈现内容和样式。值为 `false` 则会取消加载状态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/table?tab=api#basetable-props",
"type": "boolean | TNode",
"default": "undefined"
},
{
"name": "loading-props",
"description": "透传加载组件全部属性",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/table?tab=api#basetable-props",
"type": "Partial<LoadingProps>"
},
{
"name": "max-height",
"description": "table max height\n\n表格最大高度，超出后会出现滚动条。示例：100, '30%', '300'。值为数字类型，会自动加上单位 px",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/table?tab=api#basetable-props",
"type": "string | number"
},
{
"name": "row-attributes",
"description": "`tr` attributes\n\nHTML 标签 `tr` 的属性。类型为 Function 时，参数说明：`params.row` 表示行数据；`params.rowIndex` 表示行下标；`params.type=body` 表示属性作用于 `tbody` 中的元素；`params.type=foot` 表示属性作用于 `tfoot` 中的元素。<br />示例一：{ draggable: true }，<br />示例二：[{ draggable: true }, { title: '超出省略显示' }]。<br /> 示例三：() => [{ draggable: true }]",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/table?tab=api#basetable-props",
"type": "TableRowAttributes<T>"
},
{
"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/mobile-vue/components/table?tab=api#basetable-props",
"type": "ClassName | ((params: RowClassNameParams<T>) => ClassName)"
},
{
"name": "row-key",
"description": "unique key for each row data\n\n唯一标识一行数据的字段名，来源于 `data` 中的字段。如果是字段嵌套多层，可以设置形如 `item.a.id` 的方法",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/table?tab=api#basetable-props",
"type": "string",
"default": "'id'"
},
{
"name": "show-header",
"description": "show table header\n\n是否显示表头",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/table?tab=api#basetable-props",
"type": "boolean",
"default": "true"
},
{
"name": "stripe",
"description": "show stripe style\n\n是否显示斑马纹",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/table?tab=api#basetable-props",
"type": "boolean",
"default": "false"
},
{
"name": "table-content-width",
"description": "表格内容的总宽度，注意不是表格可见宽度。主要应用于 `table-layout: auto` 模式下的固定列显示。`tableContentWidth` 内容宽度的值必须大于表格可见宽度",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/table?tab=api#basetable-props",
"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表格布局方式",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/table?tab=api#basetable-props",
"type": "'auto' | 'fixed'",
"default": "fixed",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "auto"
},
{
"name": "fixed"
}
]
},
{
"name": "vertical-align",
"description": "vertical align\n\n行内容上下方向对齐",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/table?tab=api#basetable-props",
"type": "'top' | 'middle' | 'bottom'",
"default": "middle",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "top"
},
{
"name": "middle"
},
{
"name": "bottom"
}
]
}
],
"js": {
"events": [
{
"name": "cell-click",
"description": "trigger on cell clicked\n\n单元格点击时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/table?tab=api#basetable-events"
},
{
"name": "row-click",
"description": "trigger on row click\n\n行点击时触发，泛型 T 指表格数据类型",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/table?tab=api#basetable-events"
},
{
"name": "scroll",
"description": "trigger on table content scroll\n\n表格内容滚动时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/table?tab=api#basetable-events"
}
]
},
"slots": [
{
"name": "cellEmptyContent",
"description": "单元格数据为空时呈现的内容类型和参数：string | TNode<BaseTableCellParams<T>>",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/table?tab=api#basetable-props"
},
{
"name": "cell-empty-content",
"description": "单元格数据为空时呈现的内容类型和参数：string | TNode<BaseTableCellParams<T>>",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/table?tab=api#basetable-props"
},
{
"name": "empty",
"description": "empty text or empty element\n\n空表格呈现样式，支持全局配置 `GlobalConfigProvider`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/table?tab=api#basetable-props"
},
{
"name": "loading",
"description": "loading state table\n\n加载中状态。值为 `true` 会显示默认加载中样式，可以通过 Function 和 插槽 自定义加载状态呈现内容和样式。值为 `false` 则会取消加载状态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/table?tab=api#basetable-props"
}
]
},
{
"name": "t-button",
"source": {
"symbol": "Button"
},
"description": "Button\n\n按钮",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/button",
"props": [
{
"name": "block",
"description": "make button to be a block-level element\n\n是否为块级元素",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/button?tab=api#button-props",
"type": "boolean",
"default": "false"
},
{
"name": "content",
"description": "button's children elements\n\n按钮内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/button?tab=api#button-props",
"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/mobile-vue/components/button?tab=api#button-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "ghost",
"description": "make background-color to be transparent\n\n是否为幽灵按钮（镂空按钮）",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/button?tab=api#button-props",
"type": "boolean",
"default": "false"
},
{
"name": "icon",
"description": "use it to set left icon in button\n\n按钮内部图标，可完全自定义",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/button?tab=api#button-props",
"type": "TNode"
},
{
"name": "loading",
"description": "set button to be loading state\n\n是否显示为加载状态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/button?tab=api#button-props",
"type": "boolean",
"default": "false"
},
{
"name": "loading-props",
"description": "透传 Loading 组件全部属性",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/button?tab=api#button-props",
"type": "LoadingProps"
},
{
"name": "shape",
"description": "button shape\n\n按钮形状，有 4 种：长方形、正方形、圆角长方形、圆形",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/button?tab=api#button-props",
"type": "'rectangle' | 'square' | 'round' | 'circle'",
"default": "rectangle",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "rectangle"
},
{
"name": "square"
},
{
"name": "round"
},
{
"name": "circle"
}
]
},
{
"name": "size",
"description": "a button has four size\n\n组件尺寸",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/button?tab=api#button-props",
"type": "'extra-small' | 'small' | 'medium' | 'large'",
"default": "medium",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "extra-small"
},
{
"name": "small"
},
{
"name": "medium"
},
{
"name": "large"
}
]
},
{
"name": "suffix",
"description": "右侧内容，可用于定义右侧图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/button?tab=api#button-props",
"type": "TNode"
},
{
"name": "theme",
"description": "button theme\n\n组件风格，依次为品牌色、危险色",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/button?tab=api#button-props",
"type": "'default' | 'primary' | 'danger' | 'light'",
"default": "default",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "default"
},
{
"name": "primary"
},
{
"name": "danger"
},
{
"name": "light"
}
]
},
{
"name": "type",
"description": "type of button element in html\n\n按钮类型",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/button?tab=api#button-props",
"type": "'submit' | 'reset' | 'button'",
"default": "button",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "submit"
},
{
"name": "reset"
},
{
"name": "button"
}
]
},
{
"name": "variant",
"description": "variant of button\n\n按钮形式，基础、线框、虚线、文字",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/button?tab=api#button-props",
"type": "'base' | 'outline' | 'dashed' | 'text'",
"default": "base",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "base"
},
{
"name": "outline"
},
{
"name": "dashed"
},
{
"name": "text"
}
]
}
],
"js": {
"events": [
{
"name": "click",
"description": "trigger on click\n\n点击时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/button?tab=api#button-events"
}
]
},
"slots": [
{
"name": "content",
"description": "button's children elements\n\n按钮内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/button?tab=api#button-props"
},
{
"name": "icon",
"description": "use it to set left icon in button\n\n按钮内部图标，可完全自定义",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/button?tab=api#button-props"
},
{
"name": "suffix",
"description": "右侧内容，可用于定义右侧图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/button?tab=api#button-props"
}
]
},
{
"name": "t-calendar",
"source": {
"symbol": "Calendar"
},
"description": "Calendar\n\n日历",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/calendar",
"props": [
{
"name": "allow-same-day",
"description": "是否允许区间选择日历的起止时间相同，仅当 `type='range'` 时有效",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/calendar?tab=api#calendar-props",
"type": "boolean",
"default": "false"
},
{
"name": "confirm-btn",
"description": "确认按钮。值为 null 则不显示确认按钮。值类型为字符串，则表示自定义按钮文本，值类型为 Object 则表示透传 Button 组件属性",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/calendar?tab=api#calendar-props",
"type": "string | ButtonProps | TNode | null",
"default": "''"
},
{
"name": "first-day-of-week",
"description": "第一天从星期几开始，默认 0 = 周日",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/calendar?tab=api#calendar-props",
"type": "number",
"default": "0"
},
{
"name": "format",
"description": "用于格式化日期的函数",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/calendar?tab=api#calendar-props",
"type": "CalendarFormatType "
},
{
"name": "max-date",
"description": "最大可选的日期，不传则默认半年后",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/calendar?tab=api#calendar-props",
"type": " number | Date"
},
{
"name": "min-date",
"description": "最小可选的日期，不传则默认今天",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/calendar?tab=api#calendar-props",
"type": " number | Date"
},
{
"name": "readonly",
"description": "是否只读，只读状态下不能选择日期",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/calendar?tab=api#calendar-props",
"type": "boolean"
},
{
"name": "switch-mode",
"description": "切换模式。 `none` 表示平铺展示所有月份； `month` 表示支持按月切换， `year-month` 表示既按年切换，也支持按月切换",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/calendar?tab=api#calendar-props",
"type": "'none' | 'month' | 'year-month'",
"default": "none",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "none"
},
{
"name": "month"
},
{
"name": "year-month"
}
]
},
{
"name": "title",
"description": "标题，不传默认为“请选择日期”",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/calendar?tab=api#calendar-props",
"type": "string | TNode"
},
{
"name": "type",
"description": "日历的选择类型，single = 单选；multiple = 多选; range = 区间选择",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/calendar?tab=api#calendar-props",
"type": "'single' | 'multiple' | 'range'",
"default": "single",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "single"
},
{
"name": "multiple"
},
{
"name": "range"
}
]
},
{
"name": "use-popup",
"description": "是否使用弹出层包裹日历",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/calendar?tab=api#calendar-props",
"type": "boolean",
"default": "true"
},
{
"name": "value",
"description": "当前选择的日期，不传则选用 minDate 属性值或今天，优先级：minDate > today。当 type = multiple 或 range 时传入数组",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/calendar?tab=api#calendar-props",
"type": "CalendarValue"
},
{
"name": "visible",
"description": "是否显示日历；`usePopup` 为 true 时有效",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/calendar?tab=api#calendar-props",
"type": "boolean",
"default": "false"
}
],
"js": {
"events": [
{
"name": "change",
"description": "不显示 confirm-btn 时，完成选择时触发（暂不支持 type = multiple）",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/calendar?tab=api#calendar-events"
},
{
"name": "close",
"description": "关闭按钮时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/calendar?tab=api#calendar-events"
},
{
"name": "confirm",
"description": "点击确认按钮时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/calendar?tab=api#calendar-events"
},
{
"name": "panel-change",
"description": "切换月或年时触发（switch-mode 不为 none 时有效）",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/calendar?tab=api#calendar-events"
},
{
"name": "scroll",
"description": "triggered when scrolling\n\n滚动时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/calendar?tab=api#calendar-events"
},
{
"name": "select",
"description": "点击日期时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/calendar?tab=api#calendar-events"
}
]
},
"slots": [
{
"name": "confirmBtn",
"description": "确认按钮。值为 null 则不显示确认按钮。值类型为字符串，则表示自定义按钮文本，值类型为 Object 则表示透传 Button 组件属性类型和参数：string | ButtonProps | TNode | null【import { ButtonProps } from '@Button'】",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/calendar?tab=api#calendar-props"
},
{
"name": "confirm-btn",
"description": "确认按钮。值为 null 则不显示确认按钮。值类型为字符串，则表示自定义按钮文本，值类型为 Object 则表示透传 Button 组件属性类型和参数：string | ButtonProps | TNode | null【import { ButtonProps } from '@Button'】",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/calendar?tab=api#calendar-props"
},
{
"name": "title",
"description": "标题，不传默认为“请选择日期”",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/calendar?tab=api#calendar-props"
}
]
},
{
"name": "t-cascader",
"source": {
"symbol": "Cascader"
},
"description": "Cascader\n\n级联选择",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader",
"props": [
{
"name": "check-strictly",
"description": "父子节点选中状态不再关联，可各自选中或取消",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props",
"type": "boolean",
"default": "false"
},
{
"name": "close-btn",
"description": "关闭按钮",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props",
"type": "boolean | TNode",
"default": "true"
},
{
"name": "header",
"description": "头部",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props",
"type": "TNode"
},
{
"name": "keys",
"description": "用来定义 value / label / children / disabled 在 `options` 中对应的字段别名",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props",
"type": "CascaderKeysType"
},
{
"name": "load",
"description": "loading subtree data (only effective when the node's children value is true)\n\n加载子树数据的方法（仅当节点 children 为 true 时生效）",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props",
"type": "(node: CascaderOption) => Promise<Array<CascaderOption>>"
},
{
"name": "middle-content",
"description": "中间内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props",
"type": "TNode"
},
{
"name": "options",
"description": "可选项数据源",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props",
"type": "Array<CascaderOption>",
"default": "[]"
},
{
"name": "overlay-props",
"description": "遮罩层的属性，透传至 overlay",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props",
"type": "OverlayProps",
"default": "{}"
},
{
"name": "placeholder",
"description": "未选中时的提示文案",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props",
"type": "string | TNode",
"default": "'选择选项'"
},
{
"name": "sub-titles",
"description": "每级展示的次标题",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props",
"type": "Array<string>",
"default": "[]"
},
{
"name": "theme",
"description": "展示风格",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props",
"type": "'step' | 'tab'",
"default": "step",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "step"
},
{
"name": "tab"
}
]
},
{
"name": "title",
"description": "标题",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props",
"type": "string | TNode"
},
{
"name": "value",
"description": "选项值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props",
"type": "string | number"
},
{
"name": "visible",
"description": "是否展示",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props",
"type": "boolean",
"default": "false"
}
],
"js": {
"events": [
{
"name": "change",
"description": "值发生变更时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-events"
},
{
"name": "close",
"description": "关闭时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-events"
},
{
"name": "pick",
"description": "选择后触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-events"
}
]
},
"slots": [
{
"name": "closeBtn",
"description": "关闭按钮",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props"
},
{
"name": "close-btn",
"description": "关闭按钮",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props"
},
{
"name": "header",
"description": "头部",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props"
},
{
"name": "middleContent",
"description": "中间内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props"
},
{
"name": "middle-content",
"description": "中间内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props"
},
{
"name": "placeholder",
"description": "未选中时的提示文案",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props"
},
{
"name": "title",
"description": "标题",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props"
}
]
},
{
"name": "t-cell",
"source": {
"symbol": "Cell"
},
"description": "Cell\n\n单元格",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cell",
"props": [
{
"name": "align",
"description": "右侧内容的对齐方式，默认居中对齐",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cell?tab=api#cell-props",
"type": "'top' | 'middle' | 'bottom'",
"default": "middle",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "top"
},
{
"name": "middle"
},
{
"name": "bottom"
}
]
},
{
"name": "arrow",
"description": "是否显示右侧箭头",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cell?tab=api#cell-props",
"type": "boolean",
"default": "false"
},
{
"name": "bordered",
"description": "是否显示下边框",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cell?tab=api#cell-props",
"type": "boolean",
"default": "true"
},
{
"name": "description",
"description": "下方内容描述",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cell?tab=api#cell-props",
"type": "string | TNode"
},
{
"name": "hover",
"description": "是否开启点击反馈",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cell?tab=api#cell-props",
"type": "boolean"
},
{
"name": "image",
"description": "主图",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cell?tab=api#cell-props",
"type": "string | TNode"
},
{
"name": "left-icon",
"description": "左侧图标，出现在单元格标题的左侧",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cell?tab=api#cell-props",
"type": "TNode"
},
{
"name": "note",
"description": "和标题同行的说明文字",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cell?tab=api#cell-props",
"type": "string | TNode"
},
{
"name": "required",
"description": "是否显示表单必填星号",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cell?tab=api#cell-props",
"type": "boolean",
"default": "false"
},
{
"name": "right-icon",
"description": "最右侧图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cell?tab=api#cell-props",
"type": "TNode"
},
{
"name": "title",
"description": "标题",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cell?tab=api#cell-props",
"type": "string | TNode"
}
],
"js": {
"events": [
{
"name": "click",
"description": "右侧内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cell?tab=api#cell-events"
}
]
},
"slots": [
{
"name": "description",
"description": "下方内容描述",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cell?tab=api#cell-props"
},
{
"name": "image",
"description": "主图",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cell?tab=api#cell-props"
},
{
"name": "leftIcon",
"description": "左侧图标，出现在单元格标题的左侧",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cell?tab=api#cell-props"
},
{
"name": "left-icon",
"description": "左侧图标，出现在单元格标题的左侧",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cell?tab=api#cell-props"
},
{
"name": "note",
"description": "和标题同行的说明文字",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cell?tab=api#cell-props"
},
{
"name": "rightIcon",
"description": "最右侧图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cell?tab=api#cell-props"
},
{
"name": "right-icon",
"description": "最右侧图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cell?tab=api#cell-props"
},
{
"name": "title",
"description": "标题",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cell?tab=api#cell-props"
}
]
},
{
"name": "t-cell-group",
"source": {
"symbol": "CellGroup"
},
"description": "CellGroup\n\n单元格组",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cell",
"props": [
{
"name": "bordered",
"description": "是否显示组边框",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cell?tab=api#cellgroup-props",
"type": "boolean",
"default": "false"
},
{
"name": "theme",
"description": "单元格组风格",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cell?tab=api#cellgroup-props",
"type": "'default' | 'card'",
"default": "default",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "default"
},
{
"name": "card"
}
]
},
{
"name": "title",
"description": "单元格组标题",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/cell?tab=api#cellgroup-props",
"type": "string"
}
],
"slots": []
},
{
"name": "t-check-tag",
"source": {
"symbol": "CheckTag"
},
"description": "CheckTag\n\n可选标签",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag",
"props": [
{
"name": "checked",
"description": "标签选中的状态，默认风格（theme=default）才有选中态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#checktag-props",
"type": "boolean"
},
{
"name": "closable",
"description": "标签是否可关闭",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#checktag-props",
"type": "boolean",
"default": "false"
},
{
"name": "content",
"description": "组件子元素；传入数组时：[选中内容，非选中内容]",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#checktag-props",
"type": "string | number | string[] | TNode"
},
{
"name": "default",
"description": "组件子元素，默认插槽",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#checktag-props",
"type": "string | TNode"
},
{
"name": "disabled",
"description": "标签禁用态，失效标签不能触发事件。默认风格（theme=default）才有禁用态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#checktag-props",
"type": "boolean",
"default": "false"
},
{
"name": "icon",
"description": "标签中的图标，可自定义图标呈现",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#checktag-props",
"type": "TNode"
},
{
"name": "shape",
"description": "标签类型，有三种：方形、圆角方形、标记型",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#checktag-props",
"type": "'square' | 'round' | 'mark'",
"default": "square",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "square"
},
{
"name": "round"
},
{
"name": "mark"
}
]
},
{
"name": "size",
"description": "标签尺寸",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#checktag-props",
"type": "SizeEnum",
"default": "medium",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "small"
},
{
"name": "medium"
},
{
"name": "large"
}
]
},
{
"name": "variant",
"description": "标签风格变体",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#checktag-props",
"type": "'dark' | 'light' | 'outline' | 'light-outline'",
"default": "dark",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "outline"
},
{
"name": "light-outline"
}
]
}
],
"js": {
"events": [
{
"name": "change",
"description": "状态切换时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#checktag-events"
},
{
"name": "click",
"description": "点击标签时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#checktag-events"
},
{
"name": "close",
"description": "如果关闭按钮存在，点击关闭按钮时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#checktag-events"
}
]
},
"slots": [
{
"name": "content",
"description": "组件子元素；传入数组时：[选中内容，非选中内容]类型和参数：string | number | string[] | TNode",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#checktag-props"
},
{
"name": "default",
"description": "组件子元素，默认插槽",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#checktag-props"
},
{
"name": "icon",
"description": "标签中的图标，可自定义图标呈现",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#checktag-props"
}
]
},
{
"name": "t-checkbox",
"source": {
"symbol": "Checkbox"
},
"description": "Checkbox\n\n多选框",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox",
"props": [
{
"name": "block",
"description": "是否为块级元素",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-props",
"type": "boolean",
"default": "true"
},
{
"name": "borderless",
"description": "是否开启无边框模式",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "check-all",
"description": "用于标识是否为「全选选项」。单独使用无效，需在 CheckboxGroup 中使用",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-props",
"type": "boolean",
"default": "false"
},
{
"name": "checked",
"description": "是否选中",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-props",
"type": "boolean",
"default": "false"
},
{
"name": "content",
"description": "多选框内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-props",
"type": "string | TNode"
},
{
"name": "content-disabled",
"description": "是否禁用组件内容（content）触发选中",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-props",
"type": "boolean"
},
{
"name": "default",
"description": "多选框内容，同 label",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-props",
"type": "string | TNode"
},
{
"name": "disabled",
"description": "是否禁用组件。如果父组件存在 CheckboxGroup，默认值由 CheckboxGroup.disabled 控制。优先级：Checkbox.disabled > CheckboxGroup.disabled > Form.disabled",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "icon",
"description": "自定义选中图标和非选中图标。使用 Array 时表示：[选中态图标，非选中态图标]。使用 String 时，值为 circle 表示填充圆形图标、值为 line 表示描边型图标、值为 rectangle 表示填充矩形图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-props",
"type": "'circle' | 'line' | 'rectangle' | boolean | Array<TNode | String>",
"default": "'circle'"
},
{
"name": "indeterminate",
"description": "是否为半选",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-props",
"type": "boolean",
"default": "false"
},
{
"name": "label",
"description": "主文案",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-props",
"type": "string | TNode"
},
{
"name": "max-content-row",
"description": "内容最大行数限制",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-props",
"type": "number",
"default": "5"
},
{
"name": "max-label-row",
"description": "主文案最大行数限制",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-props",
"type": "number",
"default": "3"
},
{
"name": "name",
"description": "HTML 元素原生属性",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-props",
"type": "string"
},
{
"name": "placement",
"description": "多选框和内容相对位置",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-props",
"type": "'left' | 'right'",
"default": "left",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "left"
},
{
"name": "right"
}
]
},
{
"name": "readonly",
"description": "只读状态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "value",
"description": "value of checkbox\n\n多选框的值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-props",
"type": "string | number | boolean"
}
],
"js": {
"events": [
{
"name": "change",
"description": "值变化时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-events"
}
]
},
"slots": [
{
"name": "content",
"description": "多选框内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-props"
},
{
"name": "default",
"description": "多选框内容，同 label",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-props"
},
{
"name": "label",
"description": "主文案",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-props"
}
]
},
{
"name": "t-checkbox-group",
"source": {
"symbol": "CheckboxGroup"
},
"description": "CheckboxGroup\n\n多选框组",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox",
"props": [
{
"name": "borderless",
"description": "是否开启无边框模式。优先级低于 Checkbox.borderless",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkboxgroup-props",
"type": "boolean",
"default": "false"
},
{
"name": "disabled",
"description": "是否禁用组件。优先级：Form.disabled < CheckboxGroup.disabled < Checkbox.disabled",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkboxgroup-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "keys",
"description": "用来定义 value / label / disabled 在 `options` 中对应的字段别名",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkboxgroup-props",
"type": "KeysType"
},
{
"name": "max",
"description": "支持最多选中的数量",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkboxgroup-props",
"type": "number",
"default": "undefined"
},
{
"name": "name",
"description": "统一设置内部复选框 HTML 属性",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkboxgroup-props",
"type": "string"
},
{
"name": "options",
"description": "以配置形式设置子元素。示例1：`['北京', '上海']` ，示例2: `[{ label: '全选', checkAll: true }, { label: '上海', value: 'shanghai' }]`。checkAll 值为 true 表示当前选项为「全选选项」",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkboxgroup-props",
"type": "Array<CheckboxOption>"
},
{
"name": "readonly",
"description": "只读状态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkboxgroup-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "value",
"description": "选中值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkboxgroup-props",
"type": "T",
"default": "[]"
}
],
"js": {
"events": [
{
"name": "change",
"description": "值变化时触发。`context.current` 表示当前变化的数据项，如果是全选则为空；`context.type` 表示引起选中数据变化的是选中或是取消选中，`context.option` 表示当前变化的数据项",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkboxgroup-events"
}
]
},
"slots": []
},
{
"name": "t-col",
"source": {
"symbol": "Col"
},
"description": "Col\n\n栅格-纵向",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/col",
"props": [
{
"name": "offset",
"description": "列的偏移量（默认单位px）",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/col?tab=api#col-props",
"type": "string | number"
},
{
"name": "span",
"description": "列的宽度（默认单位px）",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/col?tab=api#col-props",
"type": "string | number"
}
],
"slots": []
},
{
"name": "t-collapse",
"source": {
"symbol": "Collapse"
},
"description": "Collapse\n\n折叠",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse",
"props": [
{
"name": "default-expand-all",
"description": "默认是否展开全部",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapse-props",
"type": "boolean",
"default": "false"
},
{
"name": "disabled",
"description": "是否禁用面板展开/收起操作",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapse-props",
"type": "boolean"
},
{
"name": "expand-icon",
"description": "展开图标。值为 undefined 或 false 则不显示展开图标；值为 true 显示默认图标；值类型为函数，则表示完全自定义展开图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapse-props",
"type": "boolean | TNode",
"default": "true"
},
{
"name": "expand-mutex",
"description": "每个面板互斥展开，每次只展开一个面板",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapse-props",
"type": "boolean",
"default": "false"
},
{
"name": "theme",
"description": "折叠面板风格",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapse-props",
"type": "'default' | 'card'",
"default": "default",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "default"
},
{
"name": "card"
}
]
},
{
"name": "value",
"description": "展开的面板集合",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapse-props",
"type": "CollapseValue",
"default": "[]"
}
],
"js": {
"events": [
{
"name": "change",
"description": "切换面板时触发，返回变化的值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapse-events"
}
]
},
"slots": [
{
"name": "expandIcon",
"description": "展开图标。值为 undefined 或 false 则不显示展开图标；值为 true 显示默认图标；值类型为函数，则表示完全自定义展开图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapse-props"
},
{
"name": "expand-icon",
"description": "展开图标。值为 undefined 或 false 则不显示展开图标；值为 true 显示默认图标；值类型为函数，则表示完全自定义展开图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapse-props"
}
]
},
{
"name": "t-collapse-panel",
"source": {
"symbol": "CollapsePanel"
},
"description": "CollapsePanel\n\n折叠面板",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse",
"props": [
{
"name": "content",
"description": "折叠面板内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapsepanel-props",
"type": "string | TNode"
},
{
"name": "default",
"description": "折叠面板内容，同 content",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapsepanel-props",
"type": "string | TNode"
},
{
"name": "destroy-on-collapse",
"description": "当前面板处理折叠状态时，是否销毁面板内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapsepanel-props",
"type": "boolean",
"default": "false"
},
{
"name": "disabled",
"description": "禁止当前面板展开，优先级大于 Collapse 的同名属性",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapsepanel-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "expand-icon",
"description": "当前折叠面板展开图标，优先级大于 Collapse 的同名属性",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapsepanel-props",
"type": "boolean | TNode",
"default": "undefined"
},
{
"name": "header",
"description": "面板头内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapsepanel-props",
"type": "string | TNode"
},
{
"name": "header-left-icon",
"description": "面板头左侧图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapsepanel-props",
"type": "TNode"
},
{
"name": "header-right-content",
"description": "面板头的右侧区域，一般用于呈现面板操作",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapsepanel-props",
"type": "string | TNode"
},
{
"name": "placement",
"description": "选项卡内容的位置",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapsepanel-props",
"type": "'bottom' | 'top'",
"default": "bottom",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "bottom"
},
{
"name": "top"
}
]
},
{
"name": "value",
"description": "当前面板唯一标识，如果值为空则取当前面下标兜底作为唯一标识",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapsepanel-props",
"type": "string | number"
}
],
"slots": [
{
"name": "content",
"description": "折叠面板内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapsepanel-props"
},
{
"name": "default",
"description": "折叠面板内容，同 content",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapsepanel-props"
},
{
"name": "expandIcon",
"description": "当前折叠面板展开图标，优先级大于 Collapse 的同名属性",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapsepanel-props"
},
{
"name": "expand-icon",
"description": "当前折叠面板展开图标，优先级大于 Collapse 的同名属性",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapsepanel-props"
},
{
"name": "header",
"description": "面板头内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapsepanel-props"
},
{
"name": "headerLeftIcon",
"description": "面板头左侧图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapsepanel-props"
},
{
"name": "header-left-icon",
"description": "面板头左侧图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapsepanel-props"
},
{
"name": "headerRightContent",
"description": "面板头的右侧区域，一般用于呈现面板操作",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapsepanel-props"
},
{
"name": "header-right-content",
"description": "面板头的右侧区域，一般用于呈现面板操作",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse?tab=api#collapsepanel-props"
}
]
},
{
"name": "t-color-picker",
"source": {
"symbol": "ColorPicker"
},
"description": "ColorPicker\n\n颜色选择器",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/color-picker",
"props": [
{
"name": "clearable",
"description": "是否可清空",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/color-picker?tab=api#colorpicker-props",
"type": "boolean",
"default": "false"
},
{
"name": "color-modes",
"description": "颜色模式选择。同时支持单色和渐变两种模式，可仅使用单色或者渐变其中一种模式，也可以同时使用。`monochrome` 表示单色，`linear-gradient` 表示渐变色",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/color-picker?tab=api#colorpicker-props",
"type": "colorModesEnum | colorModesEnum[] ",
"default": "\"monochrome\""
},
{
"name": "enable-alpha",
"description": "是否开启透明通道",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/color-picker?tab=api#colorpicker-props",
"type": "boolean",
"default": "false"
},
{
"name": "enable-multiple-gradient",
"description": "是否允许开启通过点击渐变轴增加渐变梯度，默认开启，关闭时只会存在起始和结束两个颜色",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/color-picker?tab=api#colorpicker-props",
"type": "boolean",
"default": "true"
},
{
"name": "fixed",
"description": "如果 color-picker 是在一个 `position:fixed` 的区域，需要显式指定属性 fixed 为 true",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/color-picker?tab=api#colorpicker-props",
"type": "boolean",
"default": "false"
},
{
"name": "format",
"description": "When `enableAlpha` is true, `HEX8/RGBA/HSLA/HSVA` are valid\n\n格式化色值。`enableAlpha` 为真时，`HEX8/RGBA/HSLA/HSVA` 有效",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/color-picker?tab=api#colorpicker-props",
"type": "'HEX' | 'HEX8' | 'RGB' | 'RGBA' | 'HSL' | 'HSLA' | 'HSV' | 'HSVA' | 'CMYK' | 'CSS'",
"default": "RGB",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "HEX"
},
{
"name": "HEX8"
},
{
"name": "RGB"
},
{
"name": "RGBA"
},
{
"name": "HSL"
},
{
"name": "HSLA"
},
{
"name": "HSV"
},
{
"name": "HSVA"
},
{
"name": "CMYK"
},
{
"name": "CSS"
}
]
},
{
"name": "swatch-colors",
"description": "swatch colors\n\n系统预设的颜色样例，值为 `null` 或 `[]` 则不显示系统色，值为 `undefined` 会显示组件内置的系统默认色",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/color-picker?tab=api#colorpicker-props",
"type": "Array<string> | null | undefined",
"default": "undefined"
},
{
"name": "type",
"description": "颜色选择器类型。（base 表示仅展示系统预设内容; multiple 表示展示色板和系统预设内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/color-picker?tab=api#colorpicker-props",
"type": "TypeEnum ",
"default": "base",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "base"
},
{
"name": "multiple"
}
]
},
{
"name": "value",
"description": "color value\n\n色值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/color-picker?tab=api#colorpicker-props",
"type": "string"
}
],
"js": {
"events": [
{
"name": "change",
"description": "选中的色值发生变化时触发，第一个参数 `value` 表示新色值，`context.color` 表示当前调色板控制器的色值，`context.trigger` 表示触发颜色变化的来源",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/color-picker?tab=api#colorpicker-events"
},
{
"name": "palette-bar-change",
"description": "调色板控制器的值变化时触发，`context.color` 指调色板控制器的值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/color-picker?tab=api#colorpicker-events"
}
]
},
"slots": []
},
{
"name": "t-config-provider",
"source": {
"symbol": "ConfigProvider"
},
"description": "ConfigProvider\n\n全局特性配置",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/config-provider",
"props": [
{
"name": "global-config",
"description": "global config\n\n全局配置",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/config-provider?tab=api#configprovider-props",
"type": "GlobalConfigProvider"
}
],
"slots": []
},
{
"name": "t-count-down",
"source": {
"symbol": "CountDown"
},
"description": "CountDown\n\n倒计时",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/count-down",
"props": [
{
"name": "auto-start",
"description": "是否自动开始倒计时",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/count-down?tab=api#countdown-props",
"type": "boolean",
"default": "true"
},
{
"name": "content",
"description": "最终倒计时的展示内容，值为'default'时使用默认的格式，否则使用自定义样式插槽",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/count-down?tab=api#countdown-props",
"type": "string | TNode",
"default": "'default'"
},
{
"name": "format",
"description": "时间格式，DD-日，HH-时，mm-分，ss-秒，SSS-毫秒",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/count-down?tab=api#countdown-props",
"type": "string",
"default": "HH:mm:ss"
},
{
"name": "millisecond",
"description": "是否开启毫秒级渲染",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/count-down?tab=api#countdown-props",
"type": "boolean",
"default": "false"
},
{
"name": "size",
"description": "倒计时尺寸",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/count-down?tab=api#countdown-props",
"type": "'small' | 'medium' | 'large'",
"default": "'medium'",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "small"
},
{
"name": "medium"
},
{
"name": "large"
}
]
},
{
"name": "split-with-unit",
"description": "使用时间单位分割",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/count-down?tab=api#countdown-props",
"type": "boolean",
"default": "false"
},
{
"name": "theme",
"description": "倒计时风格",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/count-down?tab=api#countdown-props",
"type": "'default' | 'round' | 'square'",
"default": "'default'",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "default"
},
{
"name": "round"
},
{
"name": "square"
}
]
},
{
"name": "time",
"description": "倒计时时长，单位毫秒",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/count-down?tab=api#countdown-props",
"type": "number",
"default": "0"
}
],
"js": {
"events": [
{
"name": "change",
"description": "时间变化时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/count-down?tab=api#countdown-events"
},
{
"name": "finish",
"description": "倒计时结束时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/count-down?tab=api#countdown-events"
}
]
},
"slots": [
{
"name": "content",
"description": "最终倒计时的展示内容，值为'default'时使用默认的格式，否则使用自定义样式插槽",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/count-down?tab=api#countdown-props"
}
]
},
{
"name": "t-date-time-picker",
"source": {
"symbol": "DateTimePicker"
},
"description": "DateTimePicker\n\n日期时间选择器",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/date-time-picker",
"props": [
{
"name": "auto-close",
"description": "自动关闭；在确认、取消、点击遮罩层自动关闭，不需要手动设置 visible",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/date-time-picker?tab=api#datetimepicker-props",
"type": "boolean",
"default": "false"
},
{
"name": "cancel-btn",
"description": "取消按钮文字",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/date-time-picker?tab=api#datetimepicker-props",
"type": "string",
"default": "取消"
},
{
"name": "confirm-btn",
"description": "确定按钮文字",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/date-time-picker?tab=api#datetimepicker-props",
"type": "string"
},
{
"name": "end",
"description": "选择器的最大可选时间，默认为当前时间+10年",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/date-time-picker?tab=api#datetimepicker-props",
"type": "string | number"
},
{
"name": "filter",
"description": "列选项过滤函数，支持自定义列内容。(type 值可为: year, month, date, hour, minute, second)",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/date-time-picker?tab=api#datetimepicker-props",
"type": "(type: TimeModeValues, columns: DateTimePickerColumn) => DateTimePickerColumn"
},
{
"name": "footer",
"description": "底部内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/date-time-picker?tab=api#datetimepicker-props",
"type": "TNode"
},
{
"name": "format",
"description": "用于格式化 pick、change、confirm 事件返回的值，全局配置默认为：'YYYY-MM-DD HH:mm:ss' [详细文档](https://day.js.org/docs/en/display/format)",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/date-time-picker?tab=api#datetimepicker-props",
"type": "string",
"default": "undefined"
},
{
"name": "header",
"description": "头部内容。值为 true 显示空白头部，值为 false 不显示任何内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/date-time-picker?tab=api#datetimepicker-props",
"type": "boolean | TNode",
"default": "true"
},
{
"name": "mode",
"description": "year = 年；month = 年月；date = 年月日；hour = 年月日时； minute = 年月日时分；当类型为数组时，第一个值控制年月日，第二个值控制时分秒",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/date-time-picker?tab=api#datetimepicker-props",
"type": "DateTimePickerMode",
"default": "'date'"
},
{
"name": "render-label",
"description": "自定义label",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/date-time-picker?tab=api#datetimepicker-props",
"type": "(type: string, value: number) => string"
},
{
"name": "show-week",
"description": "是否在日期旁边显示周几（如周一，周二，周日等）",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/date-time-picker?tab=api#datetimepicker-props",
"type": "boolean",
"default": "false"
},
{
"name": "start",
"description": "选择器的最小可选时间，默认为当前时间-10年",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/date-time-picker?tab=api#datetimepicker-props",
"type": "string | number"
},
{
"name": "steps",
"description": "时间间隔步数，示例：`{ minute: 5 }`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/date-time-picker?tab=api#datetimepicker-props",
"type": "{ [key in TimeModeValues]?: number }",
"default": "{}"
},
{
"name": "title",
"description": "title of picker\n\n标题",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/date-time-picker?tab=api#datetimepicker-props",
"type": "string",
"default": "'选择时间'"
},
{
"name": "use-popup",
"description": "是否使用弹出层包裹",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/date-time-picker?tab=api#datetimepicker-props",
"type": "boolean",
"default": "true"
},
{
"name": "value",
"description": "选中值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/date-time-picker?tab=api#datetimepicker-props",
"type": "DateValue"
}
],
"js": {
"events": [
{
"name": "cancel",
"description": "取消按钮点击时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/date-time-picker?tab=api#datetimepicker-events"
},
{
"name": "change",
"description": "value改变时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/date-time-picker?tab=api#datetimepicker-events"
},
{
"name": "confirm",
"description": "确认按钮点击时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/date-time-picker?tab=api#datetimepicker-events"
},
{
"name": "pick",
"description": "选中值发生变化时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/date-time-picker?tab=api#datetimepicker-events"
}
]
},
"slots": [
{
"name": "footer",
"description": "底部内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/date-time-picker?tab=api#datetimepicker-props"
},
{
"name": "header",
"description": "头部内容。值为 true 显示空白头部，值为 false 不显示任何内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/date-time-picker?tab=api#datetimepicker-props"
}
]
},
{
"name": "t-dialog",
"source": {
"symbol": "Dialog"
},
"description": "Dialog\n\n对话框",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog",
"props": [
{
"name": "actions",
"description": "操作栏",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props",
"type": "Array<ButtonProps>"
},
{
"name": "button-layout",
"description": "多按钮排列方式",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props",
"type": "'horizontal' | 'vertical'",
"default": "horizontal",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "horizontal"
},
{
"name": "vertical"
}
]
},
{
"name": "cancel-btn",
"description": "取消按钮，可自定义。值为 null 则不显示取消按钮。值类型为字符串，则表示自定义按钮文本，值类型为 Object 则表示透传 Button 组件属性。使用 TNode 自定义按钮时，需自行控制取消事件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props",
"type": "string | ButtonProps | TNode | null"
},
{
"name": "close-btn",
"description": "多按钮排列方式。可选项：true/false",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props",
"type": "boolean",
"default": "false"
},
{
"name": "close-on-overlay-click",
"description": "点击蒙层时是否触发关闭事件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props",
"type": "boolean",
"default": "false"
},
{
"name": "confirm-btn",
"description": "确认按钮。值为 null 则不显示确认按钮。值类型为字符串，则表示自定义按钮文本，值类型为 Object 则表示透传 Button 组件属性。使用 TNode 自定义按钮时，需自行控制确认事件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props",
"type": "string | ButtonProps | TNode | null"
},
{
"name": "content",
"description": "内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props",
"type": "string | TNode"
},
{
"name": "destroy-on-close",
"description": "是否在关闭弹框的时候销毁子元素",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props",
"type": "boolean",
"default": "false"
},
{
"name": "middle",
"description": "中间自定义内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props",
"type": "TNode"
},
{
"name": "overlay-props",
"description": "透传至 Overlay 组件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props",
"type": "OverlayProps",
"default": "{}"
},
{
"name": "prevent-scroll-through",
"description": "防止滚动穿透",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props",
"type": "boolean",
"default": "true"
},
{
"name": "show-overlay",
"description": "是否显示遮罩层",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props",
"type": "boolean",
"default": "true"
},
{
"name": "title",
"description": "标题",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props",
"type": "string | TNode"
},
{
"name": "top",
"description": "顶部自定义内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props",
"type": "TNode"
},
{
"name": "visible",
"description": "控制对话框是否显示",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props",
"type": "boolean"
},
{
"name": "width",
"description": "对话框宽度，示例：320, '500px', '80%'",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props",
"type": "string | number"
},
{
"name": "z-index",
"description": "对话框层级，Web 侧样式默认为 2500，移动端和小程序样式默认为 1500",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props",
"type": "number"
}
],
"js": {
"events": [
{
"name": "cancel",
"description": "如果“取消”按钮存在，则点击“取消”按钮时触发，同时触发关闭事件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-events"
},
{
"name": "close",
"description": "关闭事件，点击 取消按钮 或 点击蒙层 时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-events"
},
{
"name": "closed",
"description": "对话框消失动画效果结束后触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-events"
},
{
"name": "confirm",
"description": "如果“确认”按钮存在，则点击“确认”按钮时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-events"
},
{
"name": "overlay-click",
"description": "如果蒙层存在，点击蒙层时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-events"
}
]
},
"slots": [
{
"name": "actions",
"description": "操作栏类型和参数：Array<ButtonProps>【import { ButtonProps } from '@Button'】",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props"
},
{
"name": "cancelBtn",
"description": "取消按钮，可自定义。值为 null 则不显示取消按钮。值类型为字符串，则表示自定义按钮文本，值类型为 Object 则表示透传 Button 组件属性。使用 TNode 自定义按钮时，需自行控制取消事件类型和参数：string | ButtonProps | TNode | null【import { ButtonProps } from '@Button'】",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props"
},
{
"name": "cancel-btn",
"description": "取消按钮，可自定义。值为 null 则不显示取消按钮。值类型为字符串，则表示自定义按钮文本，值类型为 Object 则表示透传 Button 组件属性。使用 TNode 自定义按钮时，需自行控制取消事件类型和参数：string | ButtonProps | TNode | null【import { ButtonProps } from '@Button'】",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props"
},
{
"name": "confirmBtn",
"description": "确认按钮。值为 null 则不显示确认按钮。值类型为字符串，则表示自定义按钮文本，值类型为 Object 则表示透传 Button 组件属性。使用 TNode 自定义按钮时，需自行控制确认事件类型和参数：string | ButtonProps | TNode | null",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props"
},
{
"name": "confirm-btn",
"description": "确认按钮。值为 null 则不显示确认按钮。值类型为字符串，则表示自定义按钮文本，值类型为 Object 则表示透传 Button 组件属性。使用 TNode 自定义按钮时，需自行控制确认事件类型和参数：string | ButtonProps | TNode | null",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props"
},
{
"name": "content",
"description": "内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props"
},
{
"name": "middle",
"description": "中间自定义内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props"
},
{
"name": "title",
"description": "标题",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props"
},
{
"name": "top",
"description": "顶部自定义内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props"
}
]
},
{
"name": "t-divider",
"source": {
"symbol": "Divider"
},
"description": "Divider\n\n分割线",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/divider",
"props": [
{
"name": "align",
"description": "文本位置（仅在水平分割线有效）",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/divider?tab=api#divider-props",
"type": "'left' | 'right' | 'center'",
"default": "center",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "left"
},
{
"name": "right"
},
{
"name": "center"
}
]
},
{
"name": "content",
"description": "子元素",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/divider?tab=api#divider-props",
"type": "string | TNode"
},
{
"name": "dashed",
"description": "是否虚线（仅在水平分割线有效）",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/divider?tab=api#divider-props",
"type": "boolean",
"default": "false"
},
{
"name": "default",
"description": "子元素，同 content",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/divider?tab=api#divider-props",
"type": "string | TNode"
},
{
"name": "layout",
"description": "分隔线类型有两种：水平和垂直",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/divider?tab=api#divider-props",
"type": "'horizontal' | 'vertical'",
"default": "horizontal",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "horizontal"
},
{
"name": "vertical"
}
]
},
{
"name": "size",
"description": "Spacing size\n\n间距大小",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/divider?tab=api#divider-props",
"type": "string | number"
}
],
"slots": [
{
"name": "content",
"description": "子元素",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/divider?tab=api#divider-props"
},
{
"name": "default",
"description": "子元素，同 content",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/divider?tab=api#divider-props"
}
]
},
{
"name": "t-drawer",
"source": {
"symbol": "Drawer"
},
"description": "Drawer\n\n模态抽屉",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/drawer",
"props": [
{
"name": "attach",
"description": "抽屉挂载的节点，默认挂在组件本身的位置。数据类型为 String 时，会被当作选择器处理，进行节点查询。示例：'body' 或 () => document.body",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/drawer?tab=api#drawer-props",
"type": "AttachNode"
},
{
"name": "close-on-overlay-click",
"description": "点击蒙层时是否触发抽屉关闭事件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/drawer?tab=api#drawer-props",
"type": "boolean",
"default": "true"
},
{
"name": "destroy-on-close",
"description": "抽屉关闭时是否销毁节点",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/drawer?tab=api#drawer-props",
"type": "boolean",
"default": "false"
},
{
"name": "footer",
"description": "抽屉的底部",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/drawer?tab=api#drawer-props",
"type": "TNode"
},
{
"name": "items",
"description": "抽屉里的列表项",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/drawer?tab=api#drawer-props",
"type": "DrawerItem[] "
},
{
"name": "overlay-props",
"description": "遮罩层的属性，透传至 overlay",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/drawer?tab=api#drawer-props",
"type": "OverlayProps",
"default": "{}"
},
{
"name": "placement",
"description": "抽屉方向",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/drawer?tab=api#drawer-props",
"type": "'left' | 'right'",
"default": "right",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "left"
},
{
"name": "right"
}
]
},
{
"name": "show-overlay",
"description": "是否显示遮罩层",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/drawer?tab=api#drawer-props",
"type": "boolean",
"default": "true"
},
{
"name": "title",
"description": "抽屉的标题",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/drawer?tab=api#drawer-props",
"type": "string | TNode"
},
{
"name": "visible",
"description": "组件是否可见",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/drawer?tab=api#drawer-props",
"type": "boolean",
"default": "false"
},
{
"name": "z-index",
"description": "抽屉层级，样式默认为 1500",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/drawer?tab=api#drawer-props",
"type": "number"
}
],
"js": {
"events": [
{
"name": "close",
"description": "关闭时触发。",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/drawer?tab=api#drawer-events"
},
{
"name": "item-click",
"description": "点击抽屉里的列表项",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/drawer?tab=api#drawer-events"
},
{
"name": "overlay-click",
"description": "如果蒙层存在，点击蒙层时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/drawer?tab=api#drawer-events"
}
]
},
"slots": [
{
"name": "footer",
"description": "抽屉的底部",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/drawer?tab=api#drawer-props"
},
{
"name": "title",
"description": "抽屉的标题",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/drawer?tab=api#drawer-props"
}
]
},
{
"name": "t-dropdown-item",
"source": {
"symbol": "DropdownItem"
},
"description": "DropdownItem\n\n下拉菜单选项",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dropdown-item",
"props": [
{
"name": "disabled",
"description": "是否禁用操作项",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dropdown-item?tab=api#dropdownitem-props",
"type": "boolean",
"default": "false"
},
{
"name": "footer",
"description": "底部",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dropdown-item?tab=api#dropdownitem-props",
"type": "TNode"
},
{
"name": "icon",
"description": "自定义菜单子项图标，值为 `undefined` 表示使用默认图标。[面板打开时的图标，面板关闭时的图标]",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dropdown-item?tab=api#dropdownitem-props",
"type": "TNode | TNode[] | undefined",
"default": "undefined"
},
{
"name": "keys",
"description": "用来定义 value / label / disabled 在 `options` 中对应的字段别名",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dropdown-item?tab=api#dropdownitem-props",
"type": "KeysType"
},
{
"name": "label",
"description": "标题",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dropdown-item?tab=api#dropdownitem-props",
"type": "string"
},
{
"name": "multiple",
"description": "是否多选",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dropdown-item?tab=api#dropdownitem-props",
"type": "boolean",
"default": "false"
},
{
"name": "options",
"description": "选项数据",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dropdown-item?tab=api#dropdownitem-props",
"type": "Array<DropdownOption>",
"default": "[]"
},
{
"name": "options-columns",
"description": "选项分栏（1-3）",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dropdown-item?tab=api#dropdownitem-props",
"type": "string | number",
"default": "1"
},
{
"name": "placement",
"description": "复选框和内容相对位置，仅单选菜单栏有效",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dropdown-item?tab=api#dropdownitem-props",
"type": "'left' | 'right'",
"default": "left",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "left"
},
{
"name": "right"
}
]
},
{
"name": "value",
"description": "选中值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dropdown-item?tab=api#dropdownitem-props",
"type": "DropdownValue ",
"default": "undefined"
}
],
"js": {
"events": [
{
"name": "change",
"description": "值改变时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dropdown-item?tab=api#dropdownitem-events"
},
{
"name": "confirm",
"description": "点击确认时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dropdown-item?tab=api#dropdownitem-events"
},
{
"name": "reset",
"description": "点击重置时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dropdown-item?tab=api#dropdownitem-events"
}
]
},
"slots": [
{
"name": "footer",
"description": "底部",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dropdown-item?tab=api#dropdownitem-props"
},
{
"name": "icon",
"description": "自定义菜单子项图标，值为 `undefined` 表示使用默认图标。[面板打开时的图标，面板关闭时的图标]类型和参数：TNode | TNode[] | undefined",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dropdown-item?tab=api#dropdownitem-props"
}
]
},
{
"name": "t-dropdown-menu",
"source": {
"symbol": "DropdownMenu"
},
"description": "DropdownMenu\n\n下拉菜单",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dropdown-menu",
"props": [
{
"name": "close-on-click-overlay",
"description": "是否在点击遮罩层后关闭菜单",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dropdown-menu?tab=api#dropdownmenu-props",
"type": "boolean",
"default": "true"
},
{
"name": "direction",
"description": "菜单展开方向",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dropdown-menu?tab=api#dropdownmenu-props",
"type": "'down' | 'up'",
"default": "down",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "down"
},
{
"name": "up"
}
]
},
{
"name": "duration",
"description": "动画时长",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dropdown-menu?tab=api#dropdownmenu-props",
"type": "string | number",
"default": "200"
},
{
"name": "show-overlay",
"description": "是否显示遮罩层",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dropdown-menu?tab=api#dropdownmenu-props",
"type": "boolean",
"default": "true"
},
{
"name": "z-index",
"description": "菜单栏 z-index 层级",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dropdown-menu?tab=api#dropdownmenu-props",
"type": "number",
"default": "11600"
}
],
"slots": []
},
{
"name": "t-empty",
"source": {
"symbol": "Empty"
},
"description": "Empty\n\n空状态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/empty",
"props": [
{
"name": "action",
"description": "action block\n\n操作按钮",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/empty?tab=api#empty-props",
"type": "TNode"
},
{
"name": "description",
"description": "empty component description\n\n描述文字",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/empty?tab=api#empty-props",
"type": "string | TNode"
},
{
"name": "icon",
"description": "图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/empty?tab=api#empty-props",
"type": "string | TNode"
},
{
"name": "image",
"description": "image url, or Image component props, or custom any node you need\n\n图片地址",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/empty?tab=api#empty-props",
"type": "string | TNode"
}
],
"slots": [
{
"name": "action",
"description": "action block\n\n操作按钮",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/empty?tab=api#empty-props"
},
{
"name": "description",
"description": "empty component description\n\n描述文字",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/empty?tab=api#empty-props"
},
{
"name": "icon",
"description": "图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/empty?tab=api#empty-props"
},
{
"name": "image",
"description": "image url, or Image component props, or custom any node you need\n\n图片地址",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/empty?tab=api#empty-props"
}
]
},
{
"name": "t-fab",
"source": {
"symbol": "Fab"
},
"description": "Fab\n\n悬浮按钮",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/fab",
"props": [
{
"name": "button-props",
"description": "透传至 Button 组件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/fab?tab=api#fab-props",
"type": "ButtonProps"
},
{
"name": "draggable",
"description": "是否可拖拽。`true` / `'all'`可拖动<br>`'vertical'`可垂直拖动<br>`'horizontal'`可水平拖动<br>`false`禁止拖动",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/fab?tab=api#fab-props",
"type": "boolean | FabDirectionEnum ",
"default": "false"
},
{
"name": "icon",
"description": "图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/fab?tab=api#fab-props",
"type": "TNode"
},
{
"name": "style",
"description": "悬浮按钮的样式，常用于调整位置",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/fab?tab=api#fab-props",
"type": "string | Styles",
"default": "'right: 16px; bottom: 32px;'"
},
{
"name": "text",
"description": "文本内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/fab?tab=api#fab-props",
"type": "string"
},
{
"name": "y-bounds",
"description": "设置垂直方向边界限制，示例：[48, 48] 或 ['96px', 80]",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/fab?tab=api#fab-props",
"type": "Array<string | number>"
}
],
"js": {
"events": [
{
"name": "click",
"description": "悬浮按钮点击事件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/fab?tab=api#fab-events"
},
{
"name": "drag-end",
"description": "结束拖拽时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/fab?tab=api#fab-events"
},
{
"name": "drag-start",
"description": "开始拖拽时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/fab?tab=api#fab-events"
}
]
},
"slots": [
{
"name": "icon",
"description": "图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/fab?tab=api#fab-props"
}
]
},
{
"name": "t-footer",
"source": {
"symbol": "Footer"
},
"description": "Footer\n\n布局-底部内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/footer",
"props": [
{
"name": "links",
"description": "链接列表。name 表示链接名称， url 表示跳转链接，target 表示跳转方式，如：当前页面打开、新页面打开等，同 HTML 属性 target 含义相同",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/footer?tab=api#footer-props",
"type": "Array<LinkObj>",
"default": "[]"
},
{
"name": "logo",
"description": "图标配置。`logo.icon` 表示图标链接地址，`logo.title` 表示标题文本，`logo.url` 表示链接跳转地址，`logo.target` 表示跳转方式",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/footer?tab=api#footer-props",
"type": "FooterLogo"
},
{
"name": "text",
"description": "版权信息",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/footer?tab=api#footer-props",
"type": "string",
"default": "''"
}
],
"slots": []
},
{
"name": "t-form",
"source": {
"symbol": "Form"
},
"description": "Form\n\n表单",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form",
"props": [
{
"name": "colon",
"description": "是否在表单标签字段右侧显示冒号",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#form-props",
"type": "boolean",
"default": "false"
},
{
"name": "content-align",
"description": "表单内容对齐方式：左对齐、右对齐",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#form-props",
"type": "'left' | 'right'",
"default": "left",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "left"
},
{
"name": "right"
}
]
},
{
"name": "data",
"description": "表单数据",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#form-props",
"type": "FormData",
"default": "{}"
},
{
"name": "disabled",
"description": "是否禁用整个表单",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#form-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "error-message",
"description": "表单错误信息配置，示例：`{ idcard: '请输入正确的身份证号码', max: '字符长度不能超过 ${max}' }`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#form-props",
"type": "FormErrorMessage"
},
{
"name": "id",
"description": " native id attribute of the form，which supports being used in conjunction with non-form buttons through the form attribute to trigger form events\n\n表单原生的id属性，支持用于配合非表单内的按钮通过form属性来触发表单事件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#form-props",
"type": "string",
"default": "undefined"
},
{
"name": "label-align",
"description": "表单字段标签对齐方式：左对齐、右对齐、顶部对齐",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#form-props",
"type": "'left' | 'right' | 'top'",
"default": "right",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "left"
},
{
"name": "right"
},
{
"name": "top"
}
]
},
{
"name": "label-width",
"description": "可以整体设置label标签宽度，默认为81px",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#form-props",
"type": "string | number",
"default": "'81px'"
},
{
"name": "prevent-submit-default",
"description": "是否阻止表单提交默认事件（表单提交默认事件会刷新页面），设置为 `true` 可以避免刷新",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#form-props",
"type": "boolean",
"default": "true"
},
{
"name": "readonly",
"description": "是否整个表单只读",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#form-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "required-mark",
"description": "是否显示必填符号（*），默认显示",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#form-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "required-mark-position",
"description": "Display position of required symbols\n\n表单必填符号（*）显示位置",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#form-props",
"type": "'left' | 'right'",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "left"
},
{
"name": "right"
}
]
},
{
"name": "reset-type",
"description": "重置表单的方式，值为 empty 表示重置表单为空，值为 initial 表示重置表单数据为初始值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#form-props",
"type": "'empty' | 'initial'",
"default": "empty",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "empty"
},
{
"name": "initial"
}
]
},
{
"name": "rules",
"description": "表单字段校验规则",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#form-props",
"type": "FormRules<FormData>"
},
{
"name": "scroll-to-first-error",
"description": "表单校验不通过时，是否自动滚动到第一个校验不通过的字段，平滑滚动或是瞬间直达。值为空则表示不滚动",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#form-props",
"type": "'' | 'smooth' | 'auto'",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "''"
},
{
"name": "smooth"
},
{
"name": "auto"
}
]
},
{
"name": "show-error-message",
"description": "校验不通过时，是否显示错误提示信息，统一控制全部表单项。如果希望控制单个表单项，请给 FormItem 设置该属性",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#form-props",
"type": "boolean",
"default": "true"
},
{
"name": "submit-with-warning-message",
"description": "【讨论中】当校验结果只有告警信息时，是否触发 `submit` 提交事件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#form-props",
"type": "boolean",
"default": "false"
}
],
"js": {
"events": [
{
"name": "reset",
"description": "表单重置时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#form-events"
},
{
"name": "submit",
"description": "表单提交时触发。其中 `context.validateResult` 表示校验结果，`context.firstError` 表示校验不通过的第一个规则提醒。`context.validateResult` 值为 `true` 表示校验通过；如果校验不通过，`context.validateResult` 值为校验结果列表。<br />【注意】⚠️ 默认情况，输入框按下 Enter 键会自动触发提交事件，如果希望禁用这个默认行为，可以给输入框添加 enter 事件，并在事件中设置 `e.preventDefault()`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#form-events"
},
{
"name": "validate",
"description": "校验结束后触发，result 值为 true 表示校验通过；如果校验不通过，result 值为校验结果列表",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#form-events"
}
]
},
"slots": []
},
{
"name": "t-form-item",
"source": {
"symbol": "FormItem"
},
"description": "FormItem\n\n表单元素",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form",
"props": [
{
"name": "arrow",
"description": "是否显示右侧箭头",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#formitem-props",
"type": "boolean",
"default": "false"
},
{
"name": "content-align",
"description": "表单内容对齐方式，优先级高于 Form.contentAlign",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#formitem-props",
"type": "'left' | 'right'",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "left"
},
{
"name": "right"
}
]
},
{
"name": "for",
"description": "label 原生属性",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#formitem-props",
"type": "string"
},
{
"name": "help",
"description": "表单项说明内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#formitem-props",
"type": "string | TNode"
},
{
"name": "label",
"description": "字段标签名称",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#formitem-props",
"type": "string | TNode",
"default": "''"
},
{
"name": "label-align",
"description": "表单字段标签对齐方式：左对齐、右对齐、顶部对齐。默认使用 Form 的对齐方式，优先级高于 Form.labelAlign",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#formitem-props",
"type": "'left' | 'right' | 'top'",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "left"
},
{
"name": "right"
},
{
"name": "top"
}
]
},
{
"name": "label-width",
"description": "可以整体设置标签宽度，优先级高于 Form.labelWidth",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#formitem-props",
"type": "string | number"
},
{
"name": "name",
"description": "表单字段名称",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#formitem-props",
"type": "string"
},
{
"name": "required-mark",
"description": "是否显示必填符号（*），优先级高于 Form.requiredMark",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#formitem-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "rules",
"description": "表单字段校验规则",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#formitem-props",
"type": "Array<FormRule>"
},
{
"name": "show-error-message",
"description": "校验不通过时，是否显示错误提示信息，优先级高于 `Form.showErrorMessage`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#formitem-props",
"type": "boolean",
"default": "undefined"
}
],
"slots": [
{
"name": "help",
"description": "表单项说明内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#formitem-props"
},
{
"name": "label",
"description": "字段标签名称",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form?tab=api#formitem-props"
}
]
},
{
"name": "t-grid",
"source": {
"symbol": "Grid"
},
"description": "Grid\n\n栅格",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/grid",
"props": [
{
"name": "align",
"description": "内容对齐方式",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/grid?tab=api#grid-props",
"type": "'left' | 'center'",
"default": "center",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "left"
},
{
"name": "center"
}
]
},
{
"name": "border",
"description": "是否显示边框",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/grid?tab=api#grid-props",
"type": "boolean",
"default": "false"
},
{
"name": "column",
"description": "每一行的列数量；为 0 时等于固定大小",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/grid?tab=api#grid-props",
"type": "number",
"default": "4"
},
{
"name": "gutter",
"description": "间隔大小",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/grid?tab=api#grid-props",
"type": "number"
},
{
"name": "hover",
"description": "是否开启点击反馈",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/grid?tab=api#grid-props",
"type": "boolean",
"default": "false"
},
{
"name": "theme",
"description": "宫格的风格",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/grid?tab=api#grid-props",
"type": "'default' | 'card'",
"default": "default",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "default"
},
{
"name": "card"
}
]
}
],
"slots": []
},
{
"name": "t-grid-item",
"source": {
"symbol": "GridItem"
},
"description": "GridItem\n\n宫格子项",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/grid-item",
"props": [
{
"name": "badge",
"description": "透传至 Badge 属性",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/grid-item?tab=api#griditem-props",
"type": "BadgeProps",
"default": "null"
},
{
"name": "description",
"description": "文本以外的更多描述，辅助信息。可以通过 Props 传入文本，也可以自定义标题节点",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/grid-item?tab=api#griditem-props",
"type": "string | TNode"
},
{
"name": "icon",
"description": "图标名称。",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/grid-item?tab=api#griditem-props",
"type": "TNode"
},
{
"name": "image",
"description": "图片，可以是图片地址，也可以自定义图片节点，如果传入对象则透传至 image 组件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/grid-item?tab=api#griditem-props",
"type": "String | TNode | ImageProps"
},
{
"name": "layout",
"description": "内容布局方式",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/grid-item?tab=api#griditem-props",
"type": "'vertical' | 'horizontal'",
"default": "vertical",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "vertical"
},
{
"name": "horizontal"
}
]
},
{
"name": "text",
"description": "文本，可以通过 Props 传入文本，也可以自定义标题节点",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/grid-item?tab=api#griditem-props",
"type": "string | TNode"
}
],
"slots": [
{
"name": "description",
"description": "文本以外的更多描述，辅助信息。可以通过 Props 传入文本，也可以自定义标题节点",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/grid-item?tab=api#griditem-props"
},
{
"name": "icon",
"description": "图标名称。",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/grid-item?tab=api#griditem-props"
},
{
"name": "image",
"description": "图片，可以是图片地址，也可以自定义图片节点，如果传入对象则透传至 image 组件类型和参数：String | TNode | ImageProps【import { ImageProps } from '@Image'】",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/grid-item?tab=api#griditem-props"
},
{
"name": "text",
"description": "文本，可以通过 Props 传入文本，也可以自定义标题节点",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/grid-item?tab=api#griditem-props"
}
]
},
{
"name": "t-guide",
"source": {
"symbol": "Guide"
},
"description": "Guide\n\n引导",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/guide",
"props": [
{
"name": "back-button-props",
"description": "透传 返回按钮 的全部属性，示例：`{ content: '返回', theme: 'default' }`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props",
"type": "ButtonProps"
},
{
"name": "current",
"description": "当前步骤，即整个引导的进度。-1 则不展示，用于需要中断展示的场景",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props",
"type": "number"
},
{
"name": "finish-button-props",
"description": "透传 完成按钮 的全部属性，示例：`{ content: '完成', theme: 'primary' }`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props",
"type": "ButtonProps"
},
{
"name": "hide-back",
"description": "是否隐藏返回按钮",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props",
"type": "boolean",
"default": "false"
},
{
"name": "hide-counter",
"description": "是否隐藏计数",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props",
"type": "boolean",
"default": "false"
},
{
"name": "hide-skip",
"description": "是否隐藏跳过按钮",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props",
"type": "boolean",
"default": "false"
},
{
"name": "highlight-padding",
"description": "高亮框的内边距",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props",
"type": "number",
"default": "8"
},
{
"name": "mode",
"description": "引导框的类型",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props",
"type": "'popover' | 'dialog'",
"default": "popover",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "popover"
},
{
"name": "dialog"
}
]
},
{
"name": "next-button-props",
"description": "透传 下一步按钮 的全部属性，示例：{ content: '下一步', theme: 'primary' }",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props",
"type": "ButtonProps"
},
{
"name": "show-overlay",
"description": "是否出现遮罩层",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props",
"type": "boolean",
"default": "true"
},
{
"name": "skip-button-props",
"description": "透传 跳过按钮 的全部属性，{ content: '跳过', theme: 'default' }",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props",
"type": "ButtonProps"
},
{
"name": "steps",
"description": "用于定义每个步骤的内容，包括高亮的节点、相对位置和具体的文案内容等",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props",
"type": "Array<GuideStep>"
},
{
"name": "z-index",
"description": "提示框的层级",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props",
"type": "number",
"default": "999999"
}
],
"js": {
"events": [
{
"name": "back",
"description": "点击返回按钮时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-events"
},
{
"name": "change",
"description": "当前步骤发生变化时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-events"
},
{
"name": "finish",
"description": "点击完成按钮时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-events"
},
{
"name": "next-step-click",
"description": "点击下一步时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-events"
},
{
"name": "skip",
"description": "点击跳过按钮时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-events"
}
]
},
"slots": []
},
{
"name": "icon-font",
"source": {
"symbol": "IconFont"
},
"description": "IconFont\n\n图标（IconFont）",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/icon",
"props": [
{
"name": "load-default-icons",
"description": "是否加载组件库内置图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/icon?tab=api#iconfont-props",
"type": "boolean",
"default": "true"
},
{
"name": "name",
"description": "图标名称",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/icon?tab=api#iconfont-props",
"type": "string"
},
{
"name": "size",
"description": "图标尺寸，支持 'small', 'medium', 'large'，'35px', '3em' 等",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/icon?tab=api#iconfont-props",
"type": "string",
"default": "undefined"
},
{
"name": "style",
"description": "可用于设置图标颜色，如：style=\\\"color: red\\\"",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/icon?tab=api#iconfont-props",
"type": "string"
},
{
"name": "tag",
"description": "图标 DOM 元素，可选值：i/span/div/...",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/icon?tab=api#iconfont-props",
"type": "string",
"default": "i"
},
{
"name": "url",
"description": "图标地址，地址内容参考[组件内部默认加载图标](https://tdesign.gtimg.com/icon/web/index.css)。也可以在 index.html 中引入图标地址",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/icon?tab=api#iconfont-props",
"type": "string | Array<string>"
}
],
"js": {
"events": [
{
"name": "click",
"description": "点击时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/icon?tab=api#iconfont-events"
}
]
},
"slots": []
},
{
"name": "icon",
"source": {
"symbol": "IconSVG"
},
"description": "IconSVG\n\n图标（IconSVG）",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/icon",
"props": [
{
"name": "load-default-icons",
"description": "是否加载组件库内置图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/icon?tab=api#iconsvg-props",
"type": "boolean",
"default": "true"
},
{
"name": "name",
"description": "图标名称",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/icon?tab=api#iconsvg-props",
"type": "string"
},
{
"name": "size",
"description": "图标尺寸，支持 'small', 'medium', 'large'，'35px', '3em' 等",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/icon?tab=api#iconsvg-props",
"type": "string",
"default": "undefined"
},
{
"name": "style",
"description": "可用于设置图标颜色，如：style=\\\"color: red\\\"",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/icon?tab=api#iconsvg-props",
"type": "string"
},
{
"name": "url",
"description": "图标地址，地址内容参考[组件内部默认加载图标](https://tdesign.gtimg.com/icon/web/index.js)",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/icon?tab=api#iconsvg-props",
"type": "string | Array<string>"
}
],
"js": {
"events": [
{
"name": "click",
"description": "点击时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/icon?tab=api#iconsvg-events"
}
]
},
"slots": []
},
{
"name": "t-icon",
"source": {
"symbol": "IconSVG"
},
"description": "IconSVG\n\n图标（IconSVG）",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/icon",
"props": [
{
"name": "load-default-icons",
"description": "是否加载组件库内置图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/icon?tab=api#iconsvg-props",
"type": "boolean",
"default": "true"
},
{
"name": "name",
"description": "图标名称",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/icon?tab=api#iconsvg-props",
"type": "string"
},
{
"name": "size",
"description": "图标尺寸，支持 'small', 'medium', 'large'，'35px', '3em' 等",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/icon?tab=api#iconsvg-props",
"type": "string",
"default": "undefined"
},
{
"name": "style",
"description": "可用于设置图标颜色，如：style=\\\"color: red\\\"",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/icon?tab=api#iconsvg-props",
"type": "string"
},
{
"name": "url",
"description": "图标地址，地址内容参考[组件内部默认加载图标](https://tdesign.gtimg.com/icon/web/index.js)",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/icon?tab=api#iconsvg-props",
"type": "string | Array<string>"
}
],
"js": {
"events": [
{
"name": "click",
"description": "点击时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/icon?tab=api#iconsvg-events"
}
]
},
"slots": []
},
{
"name": "t-image",
"source": {
"symbol": "Image"
},
"description": "Image\n\n图片",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image",
"props": [
{
"name": "alt",
"description": "图片描述",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image?tab=api#image-props",
"type": "string"
},
{
"name": "error",
"description": "自定义图片加载失败状态下的显示内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image?tab=api#image-props",
"type": "string | TNode"
},
{
"name": "fallback",
"description": "display `fallback` image on `src` loading failed. you can also use `error` to define more complex error content\n\n图片加载失败时，显示当前链接设置的图片地址。如果要使用组件图标或完全自定义加载失败时显示的内容，请更为使用 `error`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image?tab=api#image-props",
"type": "string"
},
{
"name": "fit",
"description": "图片填充模式",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image?tab=api#image-props",
"type": "'contain' | 'cover' | 'fill' | 'none' | 'scale-down'",
"default": "fill",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "contain"
},
{
"name": "cover"
},
{
"name": "fill"
},
{
"name": "none"
},
{
"name": "scale-down"
}
]
},
{
"name": "lazy",
"description": "是否开启图片懒加载",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image?tab=api#image-props",
"type": "boolean",
"default": "false"
},
{
"name": "loading",
"description": "自定义加载中状态的图片内容，如：“加载中”",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image?tab=api#image-props",
"type": "string | TNode"
},
{
"name": "position",
"description": "等同于原生的 object-position 属性，可选值为 top right bottom left 或 string，可以自定义任何单位，px 或者 百分比",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image?tab=api#image-props",
"type": "string",
"default": "center"
},
{
"name": "referrerpolicy",
"description": "attribute of `<img>`, [MDN Definition](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy)\n\n`<img>` 标签的原生属性，[MDN 定义](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy)",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image?tab=api#image-props",
"type": "'no-referrer' | 'no-referrer-when-downgrade' | 'origin' | 'origin-when-cross-origin' | 'same-origin' | 'strict-origin' | 'strict-origin-when-cross-origin' | 'unsafe-url'",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "no-referrer"
},
{
"name": "no-referrer-when-downgrade"
},
{
"name": "origin"
},
{
"name": "origin-when-cross-origin"
},
{
"name": "same-origin"
},
{
"name": "strict-origin"
},
{
"name": "strict-origin-when-cross-origin"
},
{
"name": "unsafe-url"
}
]
},
{
"name": "shape",
"description": "图片圆角类型",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image?tab=api#image-props",
"type": "'circle' | 'round' | 'square'",
"default": "square",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "circle"
},
{
"name": "round"
},
{
"name": "square"
}
]
},
{
"name": "src",
"description": "图片链接",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image?tab=api#image-props",
"type": "string"
},
{
"name": "srcset",
"description": "for `.avif` and `.webp` image url, load `srcset` before `src`\n\n图片链接集合，用于支持特殊格式的图片，如 `.avif` 和 `.webp`。会优先加载 `srcset` 中的图片格式，浏览器不支持的情况下，加载 `src` 设置的图片地址",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image?tab=api#image-props",
"type": "ImageSrcset"
}
],
"js": {
"events": [
{
"name": "error",
"description": "trigger on image load failed\n\n图片加载失败时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image?tab=api#image-events"
},
{
"name": "load",
"description": "trigger on image loaded\n\n图片加载完成时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image?tab=api#image-events"
}
]
},
"slots": [
{
"name": "error",
"description": "自定义图片加载失败状态下的显示内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image?tab=api#image-props"
},
{
"name": "loading",
"description": "自定义加载中状态的图片内容，如：“加载中”",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image?tab=api#image-props"
}
]
},
{
"name": "t-image-viewer",
"source": {
"symbol": "ImageViewer"
},
"description": "ImageViewer\n\n图片预览",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image-viewer",
"props": [
{
"name": "close-btn",
"description": "是否展示关闭按钮，值为 `true` 显示默认关闭按钮；值为 `false` 则不显示关闭按钮；也可以完全自定义关闭按钮",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image-viewer?tab=api#imageviewer-props",
"type": "boolean | TNode",
"default": "true"
},
{
"name": "cover",
"description": "支持自定义覆盖在图片预览最上方的内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image-viewer?tab=api#imageviewer-props",
"type": "TNode"
},
{
"name": "delete-btn",
"description": "是否显示删除操作，前提需要开启页码",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image-viewer?tab=api#imageviewer-props",
"type": "boolean | TNode",
"default": "false"
},
{
"name": "image",
"description": "自定义图片内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image-viewer?tab=api#imageviewer-props",
"type": "TNode<ImageSlotParams>"
},
{
"name": "images",
"description": "图片数组",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image-viewer?tab=api#imageviewer-props",
"type": "Array<string | ImageInfo>",
"default": "[]"
},
{
"name": "index",
"description": "当前预览图片所在的下标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image-viewer?tab=api#imageviewer-props",
"type": "number"
},
{
"name": "max-zoom",
"description": "【开发中】最大放大比例",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image-viewer?tab=api#imageviewer-props",
"type": "number",
"default": "3"
},
{
"name": "show-index",
"description": "是否显示页码",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image-viewer?tab=api#imageviewer-props",
"type": "boolean",
"default": "false"
},
{
"name": "visible",
"description": "hide or show image viewer\n\n隐藏/显示预览",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image-viewer?tab=api#imageviewer-props",
"type": "boolean",
"default": "false"
}
],
"js": {
"events": [
{
"name": "close",
"description": "关闭时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image-viewer?tab=api#imageviewer-events"
},
{
"name": "delete",
"description": "点击删除操作按钮时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image-viewer?tab=api#imageviewer-events"
},
{
"name": "index-change",
"description": "预览图片切换时触发，`context.prev` 切换到上一张图片，`context.next` 切换到下一张图片",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image-viewer?tab=api#imageviewer-events"
}
]
},
"slots": [
{
"name": "closeBtn",
"description": "是否展示关闭按钮，值为 `true` 显示默认关闭按钮；值为 `false` 则不显示关闭按钮；也可以完全自定义关闭按钮",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image-viewer?tab=api#imageviewer-props"
},
{
"name": "close-btn",
"description": "是否展示关闭按钮，值为 `true` 显示默认关闭按钮；值为 `false` 则不显示关闭按钮；也可以完全自定义关闭按钮",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image-viewer?tab=api#imageviewer-props"
},
{
"name": "cover",
"description": "支持自定义覆盖在图片预览最上方的内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image-viewer?tab=api#imageviewer-props"
},
{
"name": "deleteBtn",
"description": "是否显示删除操作，前提需要开启页码",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image-viewer?tab=api#imageviewer-props"
},
{
"name": "delete-btn",
"description": "是否显示删除操作，前提需要开启页码",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image-viewer?tab=api#imageviewer-props"
},
{
"name": "image",
"description": "自定义图片内容类型和参数：TNode<ImageSlotParams>【interface ImageSlotParams {src: string; className?: string; style?: string; onLoad?: (e: Event) => void; onTransitionstart?: (e: TransitionEvent) => void; onTransitionend?: (e: TransitionEvent) => void;} 】",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image-viewer?tab=api#imageviewer-props"
}
]
},
{
"name": "t-indexes",
"source": {
"symbol": "Indexes"
},
"description": "Indexes\n\n索引",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/indexes",
"props": [
{
"name": "current",
"description": "索引列表的激活项，默认首项",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/indexes?tab=api#indexes-props",
"type": "string | number"
},
{
"name": "index-list",
"description": "索引字符列表。不传默认 `A-Z`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/indexes?tab=api#indexes-props",
"type": "Array<string | number>"
},
{
"name": "sticky",
"description": "索引是否吸顶，默认为true",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/indexes?tab=api#indexes-props",
"type": "Boolean",
"default": "true"
},
{
"name": "sticky-offset",
"description": "锚点吸顶时与顶部的距离\t",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/indexes?tab=api#indexes-props",
"type": "number",
"default": "0"
}
],
"js": {
"events": [
{
"name": "change",
"description": "索引发生变更时触发事件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/indexes?tab=api#indexes-events"
},
{
"name": "select",
"description": "点击侧边栏时触发事件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/indexes?tab=api#indexes-events"
}
]
},
"slots": []
},
{
"name": "t-indexes-anchor",
"source": {
"symbol": "IndexesAnchor"
},
"description": "IndexesAnchor\n\n索引锚点",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/indexes",
"props": [
{
"name": "index",
"description": "索引字符",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/indexes?tab=api#indexesanchor-props",
"type": "string | number"
}
],
"slots": []
},
{
"name": "t-input",
"source": {
"symbol": "Input"
},
"description": "Input\n\n输入框",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input",
"props": [
{
"name": "align",
"description": "text align type\n\n文本内容位置，居左/居中/居右",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "'left' | 'center' | 'right'",
"default": "left",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "left"
},
{
"name": "center"
},
{
"name": "right"
}
]
},
{
"name": "allow-input-over-max",
"description": "allow to continue input on value length is over `maxlength` or `maxcharacter`\n\n超出 `maxlength` 或 `maxcharacter` 之后是否允许继续输入",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "boolean",
"default": "false"
},
{
"name": "autocomplete",
"description": "attribute of input element, [see here](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete)\n\n是否开启自动填充功能，HTML5 原生属性，[点击查看详情](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete)",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "string",
"default": "undefined"
},
{
"name": "autofocus",
"description": "autofocus on first rendered\n\n自动聚焦",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "boolean",
"default": "false"
},
{
"name": "borderless",
"description": "input without border\n\n是否开启无边框模式",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "boolean",
"default": "false"
},
{
"name": "clear-trigger",
"description": "show clear icon, clicked to clear input value\n\n清空图标触发方式，仅在输入框有值时有效",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "'always' | 'focus'",
"default": "always",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "always "
},
{
"name": " focus"
}
]
},
{
"name": "clearable",
"description": "show clear icon, clicked to clear input value\n\n是否可清空",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "boolean",
"default": "false"
},
{
"name": "cursor-color",
"description": "光标颜色",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "string",
"default": "#0052d9"
},
{
"name": "disabled",
"description": "make input to be disabled\n\n是否禁用输入框",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "enterkeyhint",
"description": "attribute of input element, [see here](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/enterkeyhint)\n\n用于控制回车键样式，此 API 仅在部分浏览器支持，HTML5 原生属性，[点击查看详情](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/enterkeyhint)",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send'",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "enter"
},
{
"name": "done"
},
{
"name": "go"
},
{
"name": "next"
},
{
"name": "previous"
},
{
"name": "search"
},
{
"name": "send"
}
]
},
{
"name": "extra",
"description": "右侧额外内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "TNode"
},
{
"name": "format",
"description": "input value formatter, `type=number` does not work. if you need to format number, `InputNumber` Component might be better\n\n指定输入框展示值的格式",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "InputFormatType"
},
{
"name": "label",
"description": "text on the left of input\n\n左侧文本",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "string | TNode"
},
{
"name": "layout",
"description": "标题输入框布局方式",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "'vertical' | 'horizontal'",
"default": "horizontal",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "vertical"
},
{
"name": "horizontal"
}
]
},
{
"name": "maxcharacter",
"description": "用户最多可以输入的字符个数，一个中文汉字表示两个字符长度。`maxcharacter` 和 `maxlength` 二选一使用",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "number"
},
{
"name": "maxlength",
"description": "用户最多可以输入的文本长度，一个中文等于一个计数长度。默认为空，不限制输入长度。`maxcharacter` 和 `maxlength` 二选一使用",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "string | number"
},
{
"name": "name",
"description": "名称",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "string"
},
{
"name": "placeholder",
"description": "占位符",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "string",
"default": "undefined"
},
{
"name": "prefix-icon",
"description": "组件前置图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "TNode"
},
{
"name": "readonly",
"description": "只读状态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "size",
"description": "输入框尺寸",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "'medium' | 'small'",
"default": "small",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "small"
},
{
"name": "medium"
}
]
},
{
"name": "spell-check",
"description": "attribute of input element, [see here](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/spellcheck)\n\n是否开启拼写检查，HTML5 原生属性，[点击查看详情](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/spellcheck)",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "boolean",
"default": "false"
},
{
"name": "status",
"description": "输入框状态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "'default' | 'success' | 'warning' | 'error'",
"default": "default",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "default"
},
{
"name": "success"
},
{
"name": "warning"
},
{
"name": "error"
}
]
},
{
"name": "suffix",
"description": "suffix content before suffixIcon\n\n后置图标前的后置内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "string | TNode"
},
{
"name": "suffix-icon",
"description": "suffix icon of input\n\n组件后置图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "TNode"
},
{
"name": "tips",
"description": "tips on the bottom of input, different `status` can make tips to be different color\n\n输入框下方提示文本，会根据不同的 `status` 呈现不同的样式",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "string | TNode"
},
{
"name": "type",
"description": "type attribute of input element. if you are using `type=number`, `InputNumber` Component might be better\n\n输入框类型",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "'text' | 'number' | 'url' | 'tel' | 'password' | 'search' | 'submit' | 'hidden'",
"default": "text",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "text"
},
{
"name": "number"
},
{
"name": "url"
},
{
"name": "tel"
},
{
"name": "password"
},
{
"name": "search"
},
{
"name": "submit"
},
{
"name": "hidden"
}
]
},
{
"name": "value",
"description": "input value\n\n输入框的值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": "InputValue"
}
],
"js": {
"events": [
{
"name": "blur",
"description": "失去焦点时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-events"
},
{
"name": "change",
"description": "trigger on input value changed\n\n输入框值发生变化时触发。`trigger=initial` 表示传入的数据不符合预期，组件自动处理后触发 change 告知父组件。如：初始值长度超过 `maxlength` 限制",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-events"
},
{
"name": "clear",
"description": "清空按钮点击时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-events"
},
{
"name": "focus",
"description": "获得焦点时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-events"
},
{
"name": "validate",
"description": "trigger on text length being over max length or max character\n\n字数超出限制时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-events"
}
]
},
"slots": [
{
"name": "extra",
"description": "右侧额外内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props"
},
{
"name": "label",
"description": "text on the left of input\n\n左侧文本",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props"
},
{
"name": "prefixIcon",
"description": "组件前置图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props"
},
{
"name": "prefix-icon",
"description": "组件前置图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props"
},
{
"name": "suffix",
"description": "suffix content before suffixIcon\n\n后置图标前的后置内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props"
},
{
"name": "suffixIcon",
"description": "suffix icon of input\n\n组件后置图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props"
},
{
"name": "suffix-icon",
"description": "suffix icon of input\n\n组件后置图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props"
},
{
"name": "tips",
"description": "tips on the bottom of input, different `status` can make tips to be different color\n\n输入框下方提示文本，会根据不同的 `status` 呈现不同的样式",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props"
}
]
},
{
"name": "t-link",
"source": {
"symbol": "Link"
},
"description": "Link\n\n链接",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/link",
"props": [
{
"name": "content",
"description": "链接内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/link?tab=api#link-props",
"type": "string | TNode"
},
{
"name": "default",
"description": "链接内容，同 content",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/link?tab=api#link-props",
"type": "string | TNode"
},
{
"name": "disabled",
"description": "make link to be disabled\n\n禁用链接。优先级：Link.disabled > Form.disabled",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/link?tab=api#link-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "hover",
"description": "是否开启点击反馈",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/link?tab=api#link-props",
"type": "boolean"
},
{
"name": "href",
"description": "跳转链接",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/link?tab=api#link-props",
"type": "string"
},
{
"name": "prefix-icon",
"description": "前置图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/link?tab=api#link-props",
"type": "TNode"
},
{
"name": "size",
"description": "尺寸",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/link?tab=api#link-props",
"type": "SizeEnum",
"default": "medium",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "small"
},
{
"name": "medium"
},
{
"name": "large"
}
]
},
{
"name": "suffix-icon",
"description": "后置图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/link?tab=api#link-props",
"type": "TNode"
},
{
"name": "target",
"description": "target is an attribute of `<a>`\n\n跳转方式，如：当前页面打开、新页面打开等，同 HTML 属性 target 含义相同",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/link?tab=api#link-props",
"type": "string"
},
{
"name": "theme",
"description": "组件风格，依次为默认色、品牌色、危险色、警告色、成功色",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/link?tab=api#link-props",
"type": "'default' | 'primary' | 'danger' | 'warning' | 'success'",
"default": "default",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "default"
},
{
"name": "primary"
},
{
"name": "danger"
},
{
"name": "warning"
},
{
"name": "success"
}
]
},
{
"name": "underline",
"description": "普通状态是否显示链接下划线",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/link?tab=api#link-props",
"type": "boolean"
}
],
"js": {
"events": [
{
"name": "click",
"description": "click event, it won't trigger when it's disabled\n\n点击事件，禁用状态不会触发点击事件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/link?tab=api#link-events"
}
]
},
"slots": [
{
"name": "content",
"description": "链接内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/link?tab=api#link-props"
},
{
"name": "default",
"description": "链接内容，同 content",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/link?tab=api#link-props"
},
{
"name": "prefixIcon",
"description": "前置图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/link?tab=api#link-props"
},
{
"name": "prefix-icon",
"description": "前置图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/link?tab=api#link-props"
},
{
"name": "suffixIcon",
"description": "后置图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/link?tab=api#link-props"
},
{
"name": "suffix-icon",
"description": "后置图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/link?tab=api#link-props"
}
]
},
{
"name": "t-list",
"source": {
"symbol": "List"
},
"description": "List\n\n列表",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/list",
"props": [
{
"name": "async-loading",
"description": "自定义加载中。值为空不显示加载中，值为 'loading' 显示加载中状态，值为 'load-more' 显示加载更多状态。值类型为函数，则表示自定义加载状态呈现内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/list?tab=api#list-props",
"type": "string | TNode"
},
{
"name": "footer",
"description": "底部",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/list?tab=api#list-props",
"type": "string | TNode"
},
{
"name": "header",
"description": "头部",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/list?tab=api#list-props",
"type": "string | TNode"
}
],
"js": {
"events": [
{
"name": "load-more",
"description": "点击加载更多时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/list?tab=api#list-events"
},
{
"name": "scroll",
"description": "列表滚动时触发，bottomDistance 表示底部距离；scrollTop 表示顶部滚动距离",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/list?tab=api#list-events"
}
]
},
"slots": [
{
"name": "asyncLoading",
"description": "自定义加载中。值为空不显示加载中，值为 'loading' 显示加载中状态，值为 'load-more' 显示加载更多状态。值类型为函数，则表示自定义加载状态呈现内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/list?tab=api#list-props"
},
{
"name": "async-loading",
"description": "自定义加载中。值为空不显示加载中，值为 'loading' 显示加载中状态，值为 'load-more' 显示加载更多状态。值类型为函数，则表示自定义加载状态呈现内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/list?tab=api#list-props"
},
{
"name": "footer",
"description": "底部",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/list?tab=api#list-props"
},
{
"name": "header",
"description": "头部",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/list?tab=api#list-props"
}
]
},
{
"name": "t-loading",
"source": {
"symbol": "Loading"
},
"description": "Loading\n\n加载中",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/loading",
"props": [
{
"name": "attach",
"description": "挂载元素，默认挂载到组件本身所在的位置。数据类型为 String 时，会被当作选择器处理，进行节点查询。示例：'body' 或 () => document.body",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/loading?tab=api#loading-props",
"type": "AttachNode",
"default": "''"
},
{
"name": "content",
"description": "子元素",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/loading?tab=api#loading-props",
"type": "string | TNode"
},
{
"name": "default",
"description": "子元素，同 content",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/loading?tab=api#loading-props",
"type": "string | TNode"
},
{
"name": "delay",
"description": "延迟显示加载效果的时间，用于防止请求速度过快引起的加载闪烁，单位：毫秒",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/loading?tab=api#loading-props",
"type": "number",
"default": "0"
},
{
"name": "duration",
"description": "加载动画执行完成一次的时间，单位：毫秒",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/loading?tab=api#loading-props",
"type": "number",
"default": "800"
},
{
"name": "fullscreen",
"description": "是否显示为全屏加载",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/loading?tab=api#loading-props",
"type": "boolean",
"default": "false"
},
{
"name": "indicator",
"description": "加载指示符，值为 true 显示默认指示符，值为 false 则不显示，也可以自定义指示符",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/loading?tab=api#loading-props",
"type": "boolean | TNode",
"default": "true"
},
{
"name": "inherit-color",
"description": "是否继承父元素颜色",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/loading?tab=api#loading-props",
"type": "boolean",
"default": "false"
},
{
"name": "layout",
"description": "对齐方式",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/loading?tab=api#loading-props",
"type": "'horizontal' | 'vertical'",
"default": "horizontal",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "horizontal"
},
{
"name": "vertical"
}
]
},
{
"name": "loading",
"description": "是否处于加载状态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/loading?tab=api#loading-props",
"type": "boolean",
"default": "true"
},
{
"name": "pause",
"description": "是否暂停动画",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/loading?tab=api#loading-props",
"type": "boolean",
"default": "false"
},
{
"name": "reverse",
"description": "加载动画是否反向",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/loading?tab=api#loading-props",
"type": "boolean"
},
{
"name": "size",
"description": "尺寸，示例：20px",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/loading?tab=api#loading-props",
"type": "string",
"default": "'20px'"
},
{
"name": "text",
"description": "加载提示文案",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/loading?tab=api#loading-props",
"type": "string | TNode"
},
{
"name": "theme",
"description": "加载组件类型",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/loading?tab=api#loading-props",
"type": "'circular' | 'spinner' | 'dots'",
"default": "circular",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "circular"
},
{
"name": "spinner"
},
{
"name": "dots"
}
]
}
],
"slots": [
{
"name": "content",
"description": "子元素",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/loading?tab=api#loading-props"
},
{
"name": "default",
"description": "子元素，同 content",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/loading?tab=api#loading-props"
},
{
"name": "indicator",
"description": "加载指示符，值为 true 显示默认指示符，值为 false 则不显示，也可以自定义指示符",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/loading?tab=api#loading-props"
},
{
"name": "text",
"description": "加载提示文案",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/loading?tab=api#loading-props"
}
]
},
{
"name": "t-message",
"source": {
"symbol": "Message"
},
"description": "Message\n\n全局提醒",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/message",
"props": [
{
"name": "align",
"description": "文本对齐方式",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/message?tab=api#message-props",
"type": "MessageAlignType",
"default": "left",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "left"
},
{
"name": "center"
}
]
},
{
"name": "close-btn",
"description": "关闭按钮，可以自定义。值为 true 显示默认关闭按钮，值为 false 不显示关闭按钮。值类型为 string 则直接显示值，如：“关闭”。也可以完全自定义按钮",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/message?tab=api#message-props",
"type": "string | boolean | TNode",
"default": "undefined"
},
{
"name": "content",
"description": "用于自定义消息弹出内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/message?tab=api#message-props",
"type": "string | TNode"
},
{
"name": "duration",
"description": "消息内置计时器，计时到达时会触发 duration-end 事件。单位：毫秒。值为 0 则表示没有计时器",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/message?tab=api#message-props",
"type": "number",
"default": "3000"
},
{
"name": "gap",
"description": "两条 `message` 之间的间距",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/message?tab=api#message-props",
"type": "string | number | boolean",
"default": "12"
},
{
"name": "icon",
"description": "用于自定义消息前面的图标，优先级大于 theme 设定的图标。值为 false 则不显示图标，值为 true 显示 theme 设定图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/message?tab=api#message-props",
"type": "boolean | TNode",
"default": "true"
},
{
"name": "link",
"description": "链接名称。值为字符串表示链接名称，值为 `Object` 类型，表示透传至 `Link`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/message?tab=api#message-props",
"type": "string | object | TNode"
},
{
"name": "marquee",
"description": "跑马灯效果。speed 指速度控制；loop 指循环播放次数，值为 -1 表示循环播放，值为 0 表示不循环播放；delay 表示延迟多久开始播放",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/message?tab=api#message-props",
"type": "boolean | MessageMarquee",
"default": "false"
},
{
"name": "offset",
"description": "相对于 placement 的偏移量，示例：[-10, 20] 或 ['10px', '8px']",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/message?tab=api#message-props",
"type": "Array<string | number>"
},
{
"name": "single",
"description": "是否保持仅显示一条信息",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/message?tab=api#message-props",
"type": "boolean",
"default": "true"
},
{
"name": "theme",
"description": "消息组件风格",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/message?tab=api#message-props",
"type": "MessageThemeList",
"default": "info",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "info"
},
{
"name": "success"
},
{
"name": "warning"
},
{
"name": "error"
}
]
},
{
"name": "visible",
"description": "是否显示，隐藏时默认销毁组件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/message?tab=api#message-props",
"type": "boolean",
"default": "false"
},
{
"name": "z-index",
"description": "元素层级，样式默认为 5000",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/message?tab=api#message-props",
"type": "number"
}
],
"js": {
"events": [
{
"name": "close-btn-click",
"description": "当关闭按钮存在时，用户点击关闭按钮触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/message?tab=api#message-events"
},
{
"name": "duration-end",
"description": "计时结束后触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/message?tab=api#message-events"
},
{
"name": "link-click",
"description": "当`link`链接存在时，点击链接文本时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/message?tab=api#message-events"
}
]
},
"slots": [
{
"name": "closeBtn",
"description": "关闭按钮，可以自定义。值为 true 显示默认关闭按钮，值为 false 不显示关闭按钮。值类型为 string 则直接显示值，如：“关闭”。也可以完全自定义按钮",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/message?tab=api#message-props"
},
{
"name": "close-btn",
"description": "关闭按钮，可以自定义。值为 true 显示默认关闭按钮，值为 false 不显示关闭按钮。值类型为 string 则直接显示值，如：“关闭”。也可以完全自定义按钮",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/message?tab=api#message-props"
},
{
"name": "content",
"description": "用于自定义消息弹出内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/message?tab=api#message-props"
},
{
"name": "icon",
"description": "用于自定义消息前面的图标，优先级大于 theme 设定的图标。值为 false 则不显示图标，值为 true 显示 theme 设定图标类型和参数：boolean | TNode",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/message?tab=api#message-props"
},
{
"name": "link",
"description": "链接名称。值为字符串表示链接名称，值为 `Object` 类型，表示透传至 `Link`类型和参数：string | object | TNode",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/message?tab=api#message-props"
}
]
},
{
"name": "t-navbar",
"source": {
"symbol": "Navbar"
},
"description": "Navbar\n\n导航条",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/navbar",
"props": [
{
"name": "animation",
"description": "是否添加动画效果",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-props",
"type": "boolean",
"default": "true"
},
{
"name": "capsule",
"description": "左侧胶囊区域",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-props",
"type": "TNode"
},
{
"name": "fixed",
"description": "是否固定在顶部",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-props",
"type": "boolean",
"default": "true"
},
{
"name": "left",
"description": "左侧区域",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-props",
"type": "TNode"
},
{
"name": "left-arrow",
"description": "是否展示左侧箭头",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-props",
"type": "boolean",
"default": "false"
},
{
"name": "placeholder",
"description": "固定在顶部时是否开启占位",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-props",
"type": "boolean",
"default": "false"
},
{
"name": "right",
"description": "右侧区域",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-props",
"type": "TNode"
},
{
"name": "safe-area-inset-top",
"description": "是否开启顶部安全区适配",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-props",
"type": "boolean",
"default": "true"
},
{
"name": "title",
"description": "page title\n\n页面标题",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-props",
"type": "string | TNode"
},
{
"name": "title-max-length",
"description": "标题文字最大长度，超出的范围使用 `...` 表示",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-props",
"type": "number"
},
{
"name": "visible",
"description": "是否显示",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-props",
"type": "boolean",
"default": "true"
},
{
"name": "z-index",
"description": "导航条层级",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-props",
"type": "number",
"default": "1"
}
],
"js": {
"events": [
{
"name": "left-click",
"description": "点击左侧按钮时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-events"
},
{
"name": "right-click",
"description": "点击右侧图标时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-events"
}
]
},
"slots": [
{
"name": "capsule",
"description": "左侧胶囊区域",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-props"
},
{
"name": "left",
"description": "左侧区域",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-props"
},
{
"name": "right",
"description": "右侧区域",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-props"
},
{
"name": "title",
"description": "page title\n\n页面标题",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-props"
}
]
},
{
"name": "t-notice-bar",
"source": {
"symbol": "NoticeBar"
},
"description": "NoticeBar\n\n公告栏",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/notice-bar",
"props": [
{
"name": "content",
"description": "文本内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/notice-bar?tab=api#noticebar-props",
"type": "string | string[] | TNode"
},
{
"name": "direction",
"description": "滚动方向",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/notice-bar?tab=api#noticebar-props",
"type": "'horizontal' | 'vertical'",
"default": "horizontal",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "horizontal"
},
{
"name": "vertical"
}
]
},
{
"name": "interval",
"description": "间隔时间【仅在 direction='vertical' 有效】",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/notice-bar?tab=api#noticebar-props",
"type": "number",
"default": "2000"
},
{
"name": "marquee",
"description": "跑马灯效果。speed 指速度控制；loop 指循环播放次数，值为 -1 表示循环播放，值为 0 表示不循环播放；delay 表示延迟多久开始播放",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/notice-bar?tab=api#noticebar-props",
"type": "boolean | NoticeBarMarquee",
"default": "false"
},
{
"name": "operation",
"description": "右侧额外信息",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/notice-bar?tab=api#noticebar-props",
"type": "string | TNode"
},
{
"name": "prefix-icon",
"description": "用于自定义公告栏前面的图标，优先级大于 theme 设定的图标。值为 false 则不显示图标，值为 true 显示 theme 设定图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/notice-bar?tab=api#noticebar-props",
"type": "Boolean | TNode",
"default": "true"
},
{
"name": "suffix-icon",
"description": "后缀图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/notice-bar?tab=api#noticebar-props",
"type": "TNode"
},
{
"name": "theme",
"description": "内置主题",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/notice-bar?tab=api#noticebar-props",
"type": "'info' | 'success' | 'warning' | 'error'",
"default": "info",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "info"
},
{
"name": "success"
},
{
"name": "warning"
},
{
"name": "error"
}
]
},
{
"name": "visible",
"description": "显示/隐藏",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/notice-bar?tab=api#noticebar-props",
"type": "boolean",
"default": "false"
}
],
"js": {
"events": [
{
"name": "change",
"description": "当 `direction=\"vertical\"` 时轮播切换时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/notice-bar?tab=api#noticebar-events"
},
{
"name": "click",
"description": "点击事件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/notice-bar?tab=api#noticebar-events"
}
]
},
"slots": [
{
"name": "content",
"description": "文本内容类型和参数：string | string[] | TNode",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/notice-bar?tab=api#noticebar-props"
},
{
"name": "operation",
"description": "右侧额外信息",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/notice-bar?tab=api#noticebar-props"
},
{
"name": "prefixIcon",
"description": "用于自定义公告栏前面的图标，优先级大于 theme 设定的图标。值为 false 则不显示图标，值为 true 显示 theme 设定图标类型和参数：Boolean | TNode",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/notice-bar?tab=api#noticebar-props"
},
{
"name": "prefix-icon",
"description": "用于自定义公告栏前面的图标，优先级大于 theme 设定的图标。值为 false 则不显示图标，值为 true 显示 theme 设定图标类型和参数：Boolean | TNode",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/notice-bar?tab=api#noticebar-props"
},
{
"name": "suffixIcon",
"description": "后缀图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/notice-bar?tab=api#noticebar-props"
},
{
"name": "suffix-icon",
"description": "后缀图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/notice-bar?tab=api#noticebar-props"
}
]
},
{
"name": "t-overlay",
"source": {
"symbol": "Overlay"
},
"description": "Overlay\n\n遮罩层",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/overlay",
"props": [
{
"name": "background-color",
"description": "遮罩层的背景色",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/overlay?tab=api#overlay-props",
"type": "string"
},
{
"name": "custom-style",
"description": "遮罩层自定义样式。优先级低于其他属性",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/overlay?tab=api#overlay-props",
"type": "string"
},
{
"name": "duration",
"description": "背景色过渡时间，单位毫秒",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/overlay?tab=api#overlay-props",
"type": "number",
"default": "300"
},
{
"name": "prevent-scroll-through",
"description": "是否阻止背景滚动，阻止时蒙层里的内容也将无法滚动",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/overlay?tab=api#overlay-props",
"type": "boolean",
"default": "true"
},
{
"name": "visible",
"description": "是否展示",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/overlay?tab=api#overlay-props",
"type": "boolean",
"default": "false"
},
{
"name": "z-index",
"description": "遮罩的层级",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/overlay?tab=api#overlay-props",
"type": "number",
"default": "1000"
}
],
"js": {
"events": [
{
"name": "click",
"description": "遮罩层的点击事件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/overlay?tab=api#overlay-events"
},
{
"name": "close",
"description": "遮罩执行消失动画效果前触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/overlay?tab=api#overlay-events"
},
{
"name": "closed",
"description": "遮罩消失动画效果结束后触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/overlay?tab=api#overlay-events"
},
{
"name": "open",
"description": "遮罩执行弹出动画效果前触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/overlay?tab=api#overlay-events"
},
{
"name": "opened",
"description": "遮罩弹出动画效果结束后触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/overlay?tab=api#overlay-events"
}
]
},
"slots": []
},
{
"name": "t-picker",
"source": {
"symbol": "Picker"
},
"description": "Picker\n\n选择器",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/picker",
"props": [
{
"name": "cancel-btn",
"description": "取消按钮文字",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/picker?tab=api#picker-props",
"type": "boolean | string",
"default": "true"
},
{
"name": "columns",
"description": "配置每一列的选项",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/picker?tab=api#picker-props",
"type": "PickerColumn | Array<PickerColumn> | ((item: Array<PickerValue>) => Array<PickerColumn>)",
"default": "[]"
},
{
"name": "confirm-btn",
"description": "确定按钮文字",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/picker?tab=api#picker-props",
"type": "boolean | string",
"default": "true"
},
{
"name": "footer",
"description": "底部内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/picker?tab=api#picker-props",
"type": "TNode"
},
{
"name": "header",
"description": "自定义头部内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/picker?tab=api#picker-props",
"type": "TNode"
},
{
"name": "keys",
"description": "用来定义 value / label / disabled 在 `columns ` 中对应的字段别名",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/picker?tab=api#picker-props",
"type": "KeysType"
},
{
"name": "option",
"description": "自定义选项内容。参数为 `option: PickerColumnItem, index: number`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/picker?tab=api#picker-props",
"type": "(option: PickerColumnItem, index: number) => string | Record<string, string | boolean>"
},
{
"name": "render-label",
"description": "自定义label",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/picker?tab=api#picker-props",
"type": "(item: PickerColumnItem, index: number) => string"
},
{
"name": "swipe-duration",
"description": "The duration of inertial scrolling during fast swiping, in milliseconds (ms). When set to 0, it disables inertial scrolling.\n\n快速滑动时惯性滚动的时长，单位 ms，为 0 时表示取消惯性滚动",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/picker?tab=api#picker-props",
"type": "string | number",
"default": "300"
},
{
"name": "title",
"description": "标题",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/picker?tab=api#picker-props",
"type": "string",
"default": "''"
},
{
"name": "value",
"description": "选中值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/picker?tab=api#picker-props",
"type": "Array<PickerValue>"
}
],
"js": {
"events": [
{
"name": "cancel",
"description": "点击取消按钮时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/picker?tab=api#picker-events"
},
{
"name": "change",
"description": "选中变化时候触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/picker?tab=api#picker-events"
},
{
"name": "confirm",
"description": "点击确认按钮时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/picker?tab=api#picker-events"
},
{
"name": "pick",
"description": "任何一列选中都会触发，不同的列参数不同。`context.column` 表示第几列变化，`context.index` 表示变化那一列的选中项下标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/picker?tab=api#picker-events"
}
]
},
"slots": [
{
"name": "footer",
"description": "底部内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/picker?tab=api#picker-props"
},
{
"name": "header",
"description": "自定义头部内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/picker?tab=api#picker-props"
},
{
"name": "option",
"description": "自定义选项内容。参数为 `option: PickerColumnItem, index: number`类型和参数：(option: PickerColumnItem, index: number) => string | Record<string, string | boolean>",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/picker?tab=api#picker-props"
}
]
},
{
"name": "t-popover",
"source": {
"symbol": "Popover"
},
"description": "Popover\n\n气泡弹出框",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popover",
"props": [
{
"name": "close-on-click-outside",
"description": "是否在点击外部元素后关闭菜单 ",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popover?tab=api#popover-props",
"type": "boolean",
"default": "true"
},
{
"name": "content",
"description": "确认框内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popover?tab=api#popover-props",
"type": "string | TNode"
},
{
"name": "default",
"description": "触发元素，同 triggerElement",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popover?tab=api#popover-props",
"type": "string | TNode"
},
{
"name": "placement",
"description": "浮层出现位置",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popover?tab=api#popover-props",
"type": "'top' | 'left' | 'right' | 'bottom' | 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'left-top' | 'left-bottom' | 'right-top' | 'right-bottom'",
"default": "top",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "top"
},
{
"name": "left"
},
{
"name": "right"
},
{
"name": "bottom"
},
{
"name": "top-left"
},
{
"name": "top-right"
},
{
"name": "bottom-left"
},
{
"name": "bottom-right"
},
{
"name": "left-top"
},
{
"name": "left-bottom"
},
{
"name": "right-top"
},
{
"name": "right-bottom"
}
]
},
{
"name": "show-arrow",
"description": "是否显示浮层箭头",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popover?tab=api#popover-props",
"type": "boolean",
"default": "true"
},
{
"name": "theme",
"description": "弹出气泡主题",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popover?tab=api#popover-props",
"type": "'dark' | 'light' | 'brand' | 'success' | 'warning' | 'error'",
"default": "dark",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "brand"
},
{
"name": "success"
},
{
"name": "warning"
},
{
"name": "error"
}
]
},
{
"name": "trigger-element",
"description": "触发元素",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popover?tab=api#popover-props",
"type": "string | TNode"
},
{
"name": "visible",
"description": "是否显示气泡确认框",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popover?tab=api#popover-props",
"type": "boolean"
}
],
"js": {
"events": [
{
"name": "visible-change",
"description": "确认框显示或隐藏时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popover?tab=api#popover-events"
}
]
},
"slots": [
{
"name": "content",
"description": "确认框内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popover?tab=api#popover-props"
},
{
"name": "default",
"description": "触发元素，同 triggerElement",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popover?tab=api#popover-props"
},
{
"name": "triggerElement",
"description": "触发元素",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popover?tab=api#popover-props"
},
{
"name": "trigger-element",
"description": "触发元素",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popover?tab=api#popover-props"
}
]
},
{
"name": "t-popup",
"source": {
"symbol": "Popup"
},
"description": "Popup\n\n气泡框",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popup",
"props": [
{
"name": "attach",
"description": "指定挂载节点。数据类型为 String 时，会被当作选择器处理，进行节点查询。示例：'body' 或 () => document.body",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popup?tab=api#popup-props",
"type": "AttachNode",
"default": "'body'"
},
{
"name": "close-btn",
"description": "是否展示关闭按钮，值为 `true` 显示默认关闭按钮；值为 `false` 则不显示关闭按钮；也可以自定义关闭按钮",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popup?tab=api#popup-props",
"type": "boolean | TNode"
},
{
"name": "close-on-overlay-click",
"description": "点击遮罩层是否关闭",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popup?tab=api#popup-props",
"type": "boolean",
"default": "true"
},
{
"name": "destroy-on-close",
"description": "是否在关闭浮层时销毁浮层",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popup?tab=api#popup-props",
"type": "boolean",
"default": "false"
},
{
"name": "duration",
"description": "动画过渡时间",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popup?tab=api#popup-props",
"type": "number",
"default": "240"
},
{
"name": "overlay-props",
"description": "遮罩层的属性，透传至 overlay",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popup?tab=api#popup-props",
"type": "OverlayProps",
"default": "{}"
},
{
"name": "placement",
"description": "浮层出现位置",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popup?tab=api#popup-props",
"type": "'top' | 'left' | 'right' | 'bottom' | 'center'",
"default": "top",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "top"
},
{
"name": "left"
},
{
"name": "right"
},
{
"name": "bottom"
},
{
"name": "center"
}
]
},
{
"name": "prevent-scroll-through",
"description": "是否阻止背景滚动",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popup?tab=api#popup-props",
"type": "boolean",
"default": "true"
},
{
"name": "show-overlay",
"description": "是否显示遮罩层",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popup?tab=api#popup-props",
"type": "boolean",
"default": "true"
},
{
"name": "transition-name",
"description": "弹出层内容区的动画名，等价于transition组件的name属性",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popup?tab=api#popup-props",
"type": "string"
},
{
"name": "visible",
"description": "是否显示浮层",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popup?tab=api#popup-props",
"type": "boolean"
},
{
"name": "z-index",
"description": "组件层级，Web 侧样式默认为 5500，移动端和小程序样式默认为 1500",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popup?tab=api#popup-props",
"type": "number"
}
],
"js": {
"events": [
{
"name": "close",
"description": "组件准备关闭时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popup?tab=api#popup-events"
},
{
"name": "closed",
"description": "组件关闭且动画结束后执行",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popup?tab=api#popup-events"
},
{
"name": "open",
"description": "组件准备展示时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popup?tab=api#popup-events"
},
{
"name": "opened",
"description": "组件展示且动画结束后执行",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popup?tab=api#popup-events"
},
{
"name": "visible-change",
"description": "当浮层隐藏或显示时触发，trigger=document 表示点击弹出层元素触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popup?tab=api#popup-events"
}
]
},
"slots": [
{
"name": "closeBtn",
"description": "是否展示关闭按钮，值为 `true` 显示默认关闭按钮；值为 `false` 则不显示关闭按钮；也可以自定义关闭按钮",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popup?tab=api#popup-props"
},
{
"name": "close-btn",
"description": "是否展示关闭按钮，值为 `true` 显示默认关闭按钮；值为 `false` 则不显示关闭按钮；也可以自定义关闭按钮",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popup?tab=api#popup-props"
}
]
},
{
"name": "t-progress",
"source": {
"symbol": "Progress"
},
"description": "Progress\n\n进度条",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/progress",
"props": [
{
"name": "color",
"description": "进度条颜色。示例：'#ED7B2F' 或 'orange' 或 `['#f00', '#0ff', '#f0f']` 或 `{ '0%': '#f00', '100%': '#0ff' }` 或 `{ from: '#000', to: '#000' }` 等",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/progress?tab=api#progress-props",
"type": "string | Array<string> | Record<string, string>",
"default": "''"
},
{
"name": "label",
"description": "进度百分比，可自定义",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/progress?tab=api#progress-props",
"type": "string | boolean | TNode",
"default": "true"
},
{
"name": "percentage",
"description": "进度条百分比",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/progress?tab=api#progress-props",
"type": "number",
"default": "0"
},
{
"name": "size",
"description": "进度条尺寸，仅对环形进度条有效。可选值：default/micro。default 值为 112； micro 值为 24",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/progress?tab=api#progress-props",
"type": "string | number",
"default": "'default'"
},
{
"name": "status",
"description": "进度条状态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/progress?tab=api#progress-props",
"type": "ProgressStatus",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "success"
},
{
"name": "error"
},
{
"name": "warning"
},
{
"name": "active"
}
]
},
{
"name": "stroke-width",
"description": "进度条线宽。宽度数值不能超过 size 的一半，否则不能输出环形进度",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/progress?tab=api#progress-props",
"type": "string | number"
},
{
"name": "theme",
"description": "进度条风格。值为 line，标签（label）显示在进度条右侧；值为 plump，标签（label）显示在进度条里面；值为 circle，标签（label）显示在进度条正中间",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/progress?tab=api#progress-props",
"type": "ProgressTheme",
"default": "line",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "line"
},
{
"name": "plump"
},
{
"name": "circle"
}
]
},
{
"name": "track-color",
"description": "进度条未完成部分颜色",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/progress?tab=api#progress-props",
"type": "string",
"default": "''"
}
],
"slots": [
{
"name": "label",
"description": "进度百分比，可自定义",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/progress?tab=api#progress-props"
}
]
},
{
"name": "t-pull-down-refresh",
"source": {
"symbol": "PullDownRefresh"
},
"description": "PullDownRefresh\n\n下拉刷新",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/pull-down-refresh",
"props": [
{
"name": "disabled",
"description": "disabled pull down refresh\n\n是否禁用下拉刷新",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/pull-down-refresh?tab=api#pulldownrefresh-props",
"type": "boolean",
"default": "false"
},
{
"name": "loading-bar-height",
"description": "加载中下拉高度，如果值为数字则单位是：'px'",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/pull-down-refresh?tab=api#pulldownrefresh-props",
"type": "string | number",
"default": "50"
},
{
"name": "loading-props",
"description": "加载loading样式",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/pull-down-refresh?tab=api#pulldownrefresh-props",
"type": "LoadingProps"
},
{
"name": "loading-texts",
"description": "提示语，组件内部默认值为 ['下拉刷新', '松手刷新', '正在刷新', '刷新完成']",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/pull-down-refresh?tab=api#pulldownrefresh-props",
"type": "string[]",
"default": "[]"
},
{
"name": "max-bar-height",
"description": "最大下拉高度，如果值为数字则单位是：'px'",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/pull-down-refresh?tab=api#pulldownrefresh-props",
"type": "string | number",
"default": "80"
},
{
"name": "refresh-timeout",
"description": "刷新超时时间",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/pull-down-refresh?tab=api#pulldownrefresh-props",
"type": "number",
"default": "3000"
},
{
"name": "success-duration",
"description": "刷新成功提示展示时长，单位 'ms'",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/pull-down-refresh?tab=api#pulldownrefresh-props",
"type": "string | number",
"default": "500"
},
{
"name": "value",
"description": "组件状态，值为 `true` 表示下拉状态，值为 `false` 表示收起状态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/pull-down-refresh?tab=api#pulldownrefresh-props",
"type": "boolean",
"default": "false"
}
],
"js": {
"events": [
{
"name": "change",
"description": "下拉或收起时触发，用户手势往下滑动触发下拉状态，手势松开触发收起状态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/pull-down-refresh?tab=api#pulldownrefresh-events"
},
{
"name": "refresh",
"description": "结束下拉时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/pull-down-refresh?tab=api#pulldownrefresh-events"
},
{
"name": "scrolltolower",
"description": "滚动到页面底部时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/pull-down-refresh?tab=api#pulldownrefresh-events"
},
{
"name": "timeout",
"description": "刷新超时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/pull-down-refresh?tab=api#pulldownrefresh-events"
}
]
},
"slots": []
},
{
"name": "t-qrcode",
"source": {
"symbol": "QRCode"
},
"description": "QRCode\n\n二维码",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/qrcode",
"props": [
{
"name": "bg-color",
"description": "QR code background color\n\n二维码背景颜色",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/qrcode?tab=api#qrcode-props",
"type": "string"
},
{
"name": "borderless",
"description": "Is there a border\n\n是否有边框",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/qrcode?tab=api#qrcode-props",
"type": "boolean",
"default": "false"
},
{
"name": "color",
"description": "QR code color\n\n二维码颜色",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/qrcode?tab=api#qrcode-props",
"type": "string"
},
{
"name": "icon",
"description": "The address of the picture in the QR code\n\n二维码中图片的地址",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/qrcode?tab=api#qrcode-props",
"type": "string"
},
{
"name": "icon-size",
"description": "The size of the picture in the QR code\n\n二维码中图片的大小",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/qrcode?tab=api#qrcode-props",
"type": "number | { width: number; height: number }",
"default": "40"
},
{
"name": "level",
"description": "QR code error correction level\n\n二维码纠错等级",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/qrcode?tab=api#qrcode-props",
"type": "'L' | 'M' | 'Q' | 'H'",
"default": "M",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "L"
},
{
"name": "M"
},
{
"name": "Q"
},
{
"name": "H"
}
]
},
{
"name": "size",
"description": "QR code size\n\n二维码大小",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/qrcode?tab=api#qrcode-props",
"type": "number",
"default": "160"
},
{
"name": "status",
"description": "QR code status\n\n二维码状态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/qrcode?tab=api#qrcode-props",
"type": "QRStatus",
"default": "active",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "active"
},
{
"name": "expired"
},
{
"name": "loading"
},
{
"name": "scanned"
}
]
},
{
"name": "status-render",
"description": "Custom state renderer\n\n自定义状态渲染器",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/qrcode?tab=api#qrcode-props",
"type": "(info:StatusRenderInfo) => TNode"
},
{
"name": "type",
"description": "render type\n\n渲染类型",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/qrcode?tab=api#qrcode-props",
"type": "'canvas' | 'svg'",
"default": "canvas",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "canvas"
},
{
"name": "svg"
}
]
},
{
"name": "value",
"description": "scanned text\n\n扫描后的文本",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/qrcode?tab=api#qrcode-props",
"type": "string"
}
],
"js": {
"events": [
{
"name": "refresh",
"description": "Click the \"Click to refresh\" callback\n\n点击\"点击刷新\"的回调",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/qrcode?tab=api#qrcode-events"
}
]
},
"slots": [
{
"name": "statusRender",
"description": "Custom state renderer\n\n自定义状态渲染器类型和参数：(info:StatusRenderInfo) => TNode【type StatusRenderInfo = {status:QRStatus;onRefresh?: () => void;}】",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/qrcode?tab=api#qrcode-props"
},
{
"name": "status-render",
"description": "Custom state renderer\n\n自定义状态渲染器类型和参数：(info:StatusRenderInfo) => TNode【type StatusRenderInfo = {status:QRStatus;onRefresh?: () => void;}】",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/qrcode?tab=api#qrcode-props"
}
]
},
{
"name": "t-radio",
"source": {
"symbol": "Radio"
},
"description": "Radio\n\n单选框",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio",
"props": [
{
"name": "allow-uncheck",
"description": "是否允许取消选中",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radio-props",
"type": "boolean",
"default": "false"
},
{
"name": "block",
"description": "是否为块级元素",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radio-props",
"type": "boolean",
"default": "true"
},
{
"name": "borderless",
"description": "是否开启无边框模式",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radio-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "checked",
"description": "是否选中",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radio-props",
"type": "boolean",
"default": "false"
},
{
"name": "content",
"description": "单选内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radio-props",
"type": "string | TNode"
},
{
"name": "content-disabled",
"description": "是否禁用组件内容（content）触发选中",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radio-props",
"type": "boolean"
},
{
"name": "default",
"description": "单选按钮内容，同 label",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radio-props",
"type": "string | TNode"
},
{
"name": "disabled",
"description": "是否为禁用态。如果存在父组件 RadioGroup，默认值由 RadioGroup.disabled 控制。优先级：Radio.disabled > RadioGroup.disabled > Form.disabled",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radio-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "icon",
"description": "自定义选中图标和非选中图标。示例：[选中态图标地址，非选中态图标地址]。使用 String 时，值为 circle 表示填充型图标、值为 line 表示描边型图标、值为 dot 表示圆点图标、值为 'none' 则表示没有图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radio-props",
"type": "'circle' | 'line' | 'dot' | 'none' |Array<TNode>",
"default": "'circle'"
},
{
"name": "label",
"description": "主文案",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radio-props",
"type": "string | TNode"
},
{
"name": "max-content-row",
"description": "内容最大行数限制",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radio-props",
"type": "number",
"default": "5"
},
{
"name": "max-label-row",
"description": "主文案最大行数限制",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radio-props",
"type": "number",
"default": "3"
},
{
"name": "name",
"description": "HTML 元素原生属性",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radio-props",
"type": "string"
},
{
"name": "placement",
"description": "复选框和内容相对位置。优先级高于 RadioGroup.placement。Radio 单独存在时，默认值为 left。如果父组件存在 RadioGroup，默认值便由 RadioGroup.placement 决定",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radio-props",
"type": "'left' | 'right'",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "left"
},
{
"name": "right"
}
]
},
{
"name": "readonly",
"description": "只读状态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radio-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "value",
"description": "单选按钮的值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radio-props",
"type": "T",
"default": "undefined"
}
],
"js": {
"events": [
{
"name": "change",
"description": "选中状态变化时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radio-events"
}
]
},
"slots": [
{
"name": "content",
"description": "单选内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radio-props"
},
{
"name": "default",
"description": "单选按钮内容，同 label",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radio-props"
},
{
"name": "label",
"description": "主文案",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radio-props"
}
]
},
{
"name": "t-radio-group",
"source": {
"symbol": "RadioGroup"
},
"description": "RadioGroup\n\n单选框组",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio",
"props": [
{
"name": "allow-uncheck",
"description": "是否允许取消选中",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radiogroup-props",
"type": "boolean",
"default": "false"
},
{
"name": "borderless",
"description": "是否开启无边框模式；优先级低于 Radio",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radiogroup-props",
"type": "boolean",
"default": "false"
},
{
"name": "disabled",
"description": "是否禁用全部子单选框。优先级：Radio.disabled > RadioGroup.disabled > Form.disabled",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radiogroup-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "icon",
"description": "自定义选中图标和非选中图标。示例：[选中态图标地址，非选中态图标地址]。使用 String 时，值为 circle 表示填充型图标、值为 line 表示描边型图标、值为 dot 表示圆点图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radiogroup-props",
"type": "'circle' | 'line' | 'dot' | Array<TNode>",
"default": "'circle'"
},
{
"name": "keys",
"description": "用来定义 value / label / disabled 在 `options` 中对应的字段别名",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radiogroup-props",
"type": "KeysType"
},
{
"name": "name",
"description": "HTML 元素原生属性",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radiogroup-props",
"type": "string"
},
{
"name": "options",
"description": "单选组件按钮形式。RadioOption 数据类型为 string 或 number 时，表示 label 和 value 值相同",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radiogroup-props",
"type": "Array<RadioOption>"
},
{
"name": "placement",
"description": "复选框和内容相对位置。优先级低于 Radio.placement",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radiogroup-props",
"type": "'left' | 'right'",
"default": "left",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "left"
},
{
"name": "right"
}
]
},
{
"name": "readonly",
"description": "只读状态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radiogroup-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "value",
"description": "选中的值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radiogroup-props",
"type": "T"
}
],
"js": {
"events": [
{
"name": "change",
"description": "选中值发生变化时触发, `context.name` 指 RadioGroup 的 name 属性",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radiogroup-events"
}
]
},
"slots": []
},
{
"name": "t-rate",
"source": {
"symbol": "Rate"
},
"description": "Rate\n\n评分",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/rate",
"props": [
{
"name": "allow-half",
"description": "是否允许半选",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/rate?tab=api#rate-props",
"type": "boolean",
"default": "false"
},
{
"name": "color",
"description": "评分图标的颜色，样式中默认为 #ED7B2F。一个值表示设置选中高亮的五角星颜色，示例：[选中颜色]。数组则表示分别设置 选中高亮的五角星颜色 和 未选中暗灰的五角星颜色，[选中颜色，未选中颜色]。示例：['#ED7B2F', '#E3E6EB']",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/rate?tab=api#rate-props",
"type": "string | Array<string>",
"default": "'#ED7B2F'"
},
{
"name": "count",
"description": "评分的数量",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/rate?tab=api#rate-props",
"type": "number",
"default": "5"
},
{
"name": "disabled",
"description": "是否禁用评分",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/rate?tab=api#rate-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "gap",
"description": "评分图标的间距",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/rate?tab=api#rate-props",
"type": "string | number",
"default": "8"
},
{
"name": "icon",
"description": "自定义评分图标，[选中图标，未选中图标]",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/rate?tab=api#rate-props",
"type": "Array<TNode | Function>"
},
{
"name": "placement",
"description": "选择评分弹框的位置，值为空字符表示不显示评分弹框",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/rate?tab=api#rate-props",
"type": "'top' | 'bottom' | ''",
"default": "top",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "top "
},
{
"name": " bottom "
},
{
"name": " ''"
}
]
},
{
"name": "show-text",
"description": "是否显示对应的辅助文字",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/rate?tab=api#rate-props",
"type": "boolean",
"default": "false"
},
{
"name": "size",
"description": "评分图标的大小",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/rate?tab=api#rate-props",
"type": "string",
"default": "24px"
},
{
"name": "texts",
"description": "评分等级对应的辅助文字。组件内置默认值为：['极差', '失望', '一般', '满意', '惊喜']。自定义值示例：['1分', '2分', '3分', '4分', '5分']",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/rate?tab=api#rate-props",
"type": "Array<string>",
"default": "[]"
},
{
"name": "value",
"description": "选择评分的值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/rate?tab=api#rate-props",
"type": "number",
"default": "0"
}
],
"js": {
"events": [
{
"name": "change",
"description": "评分数改变时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/rate?tab=api#rate-events"
}
]
},
"slots": [
{
"name": "icon",
"description": "自定义评分图标，[选中图标，未选中图标]类型和参数：Array<TNode | Function>",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/rate?tab=api#rate-props"
}
]
},
{
"name": "t-result",
"source": {
"symbol": "Result"
},
"description": "Result\n\n结果",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/result",
"props": [
{
"name": "description",
"description": "描述文字",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/result?tab=api#result-props",
"type": "string | TNode"
},
{
"name": "icon",
"description": "图标名称",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/result?tab=api#result-props",
"type": "TNode"
},
{
"name": "image",
"description": "图片地址",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/result?tab=api#result-props",
"type": "string | TNode"
},
{
"name": "theme",
"description": "内置主题",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/result?tab=api#result-props",
"type": "'default' | 'success' | 'warning' | 'error'",
"default": "default",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "default"
},
{
"name": "success"
},
{
"name": "warning"
},
{
"name": "error"
}
]
},
{
"name": "title",
"description": "标题",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/result?tab=api#result-props",
"type": "string | TNode",
"default": "''"
}
],
"slots": [
{
"name": "description",
"description": "描述文字",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/result?tab=api#result-props"
},
{
"name": "icon",
"description": "图标名称",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/result?tab=api#result-props"
},
{
"name": "image",
"description": "图片地址",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/result?tab=api#result-props"
},
{
"name": "title",
"description": "标题",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/result?tab=api#result-props"
}
]
},
{
"name": "t-row",
"source": {
"symbol": "Row"
},
"description": "Row\n\n栅格-横向",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/row",
"props": [
{
"name": "gutter",
"description": "列之间的间距（默认单位px）",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/row?tab=api#row-props",
"type": "string | number"
}
],
"slots": []
},
{
"name": "t-search",
"source": {
"symbol": "Search"
},
"description": "Search\n\n搜索",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search",
"props": [
{
"name": "action",
"description": "自定义右侧操作按钮文字，如：“取消”",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search?tab=api#search-props",
"type": "string | TNode",
"default": "''"
},
{
"name": "autocomplete-options",
"description": "autocomplete words list\n\n【讨论中】联想词列表，如果不存在或长度为 0 则不显示联想框。可以使用函数 `label` 自定义联想词为任意内容；也可使用插槽 `option` 定义联想词内容，插槽参数为 `{ option: AutocompleteOption; index: number }`。如果 `group` 值为 `true` 则表示当前项为分组标题",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search?tab=api#search-props",
"type": "Array<AutocompleteOption>"
},
{
"name": "center",
"description": "是否居中",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search?tab=api#search-props",
"type": "boolean",
"default": "false"
},
{
"name": "clear-trigger",
"description": "show clear icon, clicked to clear input value\n\n清空图标触发方式，仅在输入框有值时有效",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search?tab=api#search-props",
"type": "'always' | 'focus'",
"default": "always",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "always "
},
{
"name": " focus"
}
]
},
{
"name": "clearable",
"description": "是否可清空",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search?tab=api#search-props",
"type": "boolean",
"default": "true"
},
{
"name": "disabled",
"description": "禁用状态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search?tab=api#search-props",
"type": "boolean"
},
{
"name": "focus",
"description": "是否聚焦",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search?tab=api#search-props",
"type": "boolean",
"default": "false"
},
{
"name": "left-icon",
"description": "左侧图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search?tab=api#search-props",
"type": "string | TNode",
"default": "'search'"
},
{
"name": "maxcharacter",
"description": "The maximum number of characters that the user can enter. One Chinese character represents two characters in length. Use either `maxcharacter` or `maxlength`\n\n用户最多可以输入的字符个数，一个中文汉字表示两个字符长度。`maxcharacter` 和 `maxlength` 二选一使用",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search?tab=api#search-props",
"type": "number"
},
{
"name": "maxlength",
"description": "The maximum length of text that the user can enter. One Chinese character is equal to one count length. By default, it is empty, and the input length is not limited. Use either `maxcharacter` or `maxlength`\n\n用户最多可以输入的文本长度，一个中文等于一个计数长度。默认为空，不限制输入长度。`maxcharacter` 和 `maxlength` 二选一使用",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search?tab=api#search-props",
"type": "string | number"
},
{
"name": "placeholder",
"description": "占位符",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search?tab=api#search-props",
"type": "string",
"default": "''"
},
{
"name": "readonly",
"description": "只读状态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search?tab=api#search-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "result-list",
"description": "预览结果列表",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search?tab=api#search-props",
"type": "Array<string>",
"default": "[]"
},
{
"name": "shape",
"description": "搜索框形状",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search?tab=api#search-props",
"type": "'square' | 'round'",
"default": "'square'",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "square"
},
{
"name": "round"
}
]
},
{
"name": "value",
"description": "值，搜索关键词",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search?tab=api#search-props",
"type": "string"
}
],
"js": {
"events": [
{
"name": "action-click",
"description": "点击搜索框右侧操作内容时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search?tab=api#search-events"
},
{
"name": "blur",
"description": "失去焦点时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search?tab=api#search-events"
},
{
"name": "change",
"description": "搜索关键词发生变化时触发，可能场景有：搜索框内容发生变化、点击联想词",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search?tab=api#search-events"
},
{
"name": "clear",
"description": "点击清除时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search?tab=api#search-events"
},
{
"name": "focus",
"description": "获得焦点时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search?tab=api#search-events"
},
{
"name": "search",
"description": "【讨论中】搜索触发，包含：手机键盘提交健、联想关键词点击、清空按钮点击等",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search?tab=api#search-events"
},
{
"name": "submit",
"description": "提交时触发，如：手机键盘提交按钮点击",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search?tab=api#search-events"
}
]
},
"slots": [
{
"name": "action",
"description": "自定义右侧操作按钮文字，如：“取消”",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search?tab=api#search-props"
},
{
"name": "leftIcon",
"description": "左侧图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search?tab=api#search-props"
},
{
"name": "left-icon",
"description": "左侧图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/search?tab=api#search-props"
}
]
},
{
"name": "t-side-bar",
"source": {
"symbol": "SideBar"
},
"description": "SideBar\n\n侧边导航",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/side-bar",
"props": [
{
"name": "value",
"description": "选项值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/side-bar?tab=api#sidebar-props",
"type": "string | number"
}
],
"js": {
"events": [
{
"name": "change",
"description": "选项值发生变化时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/side-bar?tab=api#sidebar-events"
},
{
"name": "click",
"description": "点击选项时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/side-bar?tab=api#sidebar-events"
}
]
},
"slots": []
},
{
"name": "t-side-bar-item",
"source": {
"symbol": "SideBarItem"
},
"description": "SideBarItem\n\n侧边导航项",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/side-bar",
"props": [
{
"name": "badge-props",
"description": "透传至 Badge 组件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/side-bar?tab=api#sidebaritem-props",
"type": "BadgeProps"
},
{
"name": "disabled",
"description": "是否禁用",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/side-bar?tab=api#sidebaritem-props",
"type": "boolean",
"default": "false"
},
{
"name": "icon",
"description": "图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/side-bar?tab=api#sidebaritem-props",
"type": "TNode"
},
{
"name": "label",
"description": "展示的标签",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/side-bar?tab=api#sidebaritem-props",
"type": "string"
},
{
"name": "value",
"description": "当前选项的值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/side-bar?tab=api#sidebaritem-props",
"type": "string | number"
}
],
"slots": [
{
"name": "icon",
"description": "图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/side-bar?tab=api#sidebaritem-props"
}
]
},
{
"name": "t-skeleton",
"source": {
"symbol": "Skeleton"
},
"description": "Skeleton\n\n骨架屏",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/skeleton",
"props": [
{
"name": "animation",
"description": "动画效果，有「渐变加载动画」和「闪烁加载动画」两种。值为 'none' 则表示没有动画",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/skeleton?tab=api#skeleton-props",
"type": "'gradient' | 'flashed' | 'none'",
"default": "none",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "gradient"
},
{
"name": "flashed"
},
{
"name": "none"
}
]
},
{
"name": "delay",
"description": "延迟显示加载效果的时间，用于防止请求速度过快引起的加载闪烁，单位：毫秒",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/skeleton?tab=api#skeleton-props",
"type": "number",
"default": "0"
},
{
"name": "loading",
"description": "是否为加载状态，如果是则显示骨架图，如果不是则显示加载完成的内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/skeleton?tab=api#skeleton-props",
"type": "boolean",
"default": "true"
},
{
"name": "row-col",
"description": "高级设置，用于自定义行列数量、宽度高度、间距等。【示例一】，`[1, 1, 2]` 表示输出三行骨架图，第一行一列，第二行一列，第三行两列。【示例二】，`[1, 1, { width: '100px' }]` 表示自定义第三行的宽度为 `100px`。【示例三】，`[1, 2, [{ width, height }, { width, height, marginLeft }]]` 表示第三行有两列，且自定义宽度、高度、尺寸（圆形或方形使用）、间距、内容等",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/skeleton?tab=api#skeleton-props",
"type": "SkeletonRowCol"
},
{
"name": "theme",
"description": "骨架图风格，有基础、头像组合等两大类",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/skeleton?tab=api#skeleton-props",
"type": "'avatar' | 'image' | 'text' | 'paragraph'",
"default": "text",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "avatar"
},
{
"name": "image"
},
{
"name": "text"
},
{
"name": "paragraph"
}
]
}
],
"slots": []
},
{
"name": "t-slider",
"source": {
"symbol": "Slider"
},
"description": "Slider\n\n滑块",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/slider",
"props": [
{
"name": "disabled",
"description": "是否禁用组件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/slider?tab=api#slider-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "label",
"description": "滑块当前值文本。<br />值为 true 显示默认文案；值为 false 不显示滑块当前值文本；<br />值为 `${value}%` 则表示组件会根据占位符渲染文案；<br />值类型为函数时，参数 `value` 标识滑块值，参数 `position=start` 表示范围滑块的起始值，参数 `position=end` 表示范围滑块的终点值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/slider?tab=api#slider-props",
"type": "string | boolean | TNode<{ value: SliderValue; position?: 'start' | 'end' }>",
"default": "false"
},
{
"name": "marks",
"description": "刻度标记，示例：[0, 10, 40, 200] 或者 `{ 10: (val) => val + '%', 50: (h) => <button>50</button> }`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/slider?tab=api#slider-props",
"type": "Array<number> | SliderMarks"
},
{
"name": "max",
"description": "滑块范围最大值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/slider?tab=api#slider-props",
"type": "number",
"default": "100"
},
{
"name": "min",
"description": "滑块范围最小值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/slider?tab=api#slider-props",
"type": "number",
"default": "0"
},
{
"name": "range",
"description": "双游标滑块",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/slider?tab=api#slider-props",
"type": "boolean",
"default": "false"
},
{
"name": "show-extreme-value",
"description": "是否边界值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/slider?tab=api#slider-props",
"type": "boolean",
"default": "false"
},
{
"name": "step",
"description": "步长",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/slider?tab=api#slider-props",
"type": "number",
"default": "1"
},
{
"name": "theme",
"description": "滑块风格",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/slider?tab=api#slider-props",
"type": "'default' | 'capsule'",
"default": "default",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "default"
},
{
"name": "capsule"
}
]
},
{
"name": "value",
"description": "滑块值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/slider?tab=api#slider-props",
"type": "SliderValue",
"default": "0"
},
{
"name": "vertical",
"description": "是否是垂直的滑块（渲染垂直滑块时，默认高度为200px，可通过修改`--td-slider-bar-height`来自定义高度）",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/slider?tab=api#slider-props",
"type": "boolean",
"default": "false"
}
],
"js": {
"events": [
{
"name": "change",
"description": "滑块值变化时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/slider?tab=api#slider-events"
},
{
"name": "dragend",
"description": "结束拖动时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/slider?tab=api#slider-events"
},
{
"name": "dragstart",
"description": "开始拖动时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/slider?tab=api#slider-events"
}
]
},
"slots": [
{
"name": "label",
"description": "滑块当前值文本。<br />值为 true 显示默认文案；值为 false 不显示滑块当前值文本；<br />值为 `${value}%` 则表示组件会根据占位符渲染文案；<br />值类型为函数时，参数 `value` 标识滑块值，参数 `position=start` 表示范围滑块的起始值，参数 `position=end` 表示范围滑块的终点值类型和参数：string | boolean | TNode<{ value: SliderValue; position?: 'start' | 'end' }>",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/slider?tab=api#slider-props"
}
]
},
{
"name": "t-step-item",
"source": {
"symbol": "StepItem"
},
"description": "StepItem\n\n步骤",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/steps",
"props": [
{
"name": "content",
"description": "步骤描述",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/steps?tab=api#stepitem-props",
"type": "string | TNode",
"default": "''"
},
{
"name": "extra",
"description": "步骤条自定义内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/steps?tab=api#stepitem-props",
"type": "string | TNode"
},
{
"name": "icon",
"description": "图标，默认显示内置图标，也可以自定义图标，值为 false 则不显示图标。优先级大于 `status` 定义的图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/steps?tab=api#stepitem-props",
"type": "boolean | TNode",
"default": "true"
},
{
"name": "status",
"description": "当前步骤的状态：默认状态（未开始）、进行中状态、完成状态、错误状态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/steps?tab=api#stepitem-props",
"type": "StepStatus",
"default": "default",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "default"
},
{
"name": "process"
},
{
"name": "finish"
},
{
"name": "error"
}
]
},
{
"name": "title",
"description": "标题",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/steps?tab=api#stepitem-props",
"type": "string | TNode",
"default": "''"
},
{
"name": "title-right",
"description": "标题右侧数据 仅支持 layout = 'vertical' 时",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/steps?tab=api#stepitem-props",
"type": "string | TNode",
"default": "''"
}
],
"slots": [
{
"name": "content",
"description": "步骤描述",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/steps?tab=api#stepitem-props"
},
{
"name": "extra",
"description": "步骤条自定义内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/steps?tab=api#stepitem-props"
},
{
"name": "icon",
"description": "图标，默认显示内置图标，也可以自定义图标，值为 false 则不显示图标。优先级大于 `status` 定义的图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/steps?tab=api#stepitem-props"
},
{
"name": "title",
"description": "标题",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/steps?tab=api#stepitem-props"
},
{
"name": "titleRight",
"description": "标题右侧数据 仅支持 layout = 'vertical' 时",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/steps?tab=api#stepitem-props"
},
{
"name": "title-right",
"description": "标题右侧数据 仅支持 layout = 'vertical' 时",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/steps?tab=api#stepitem-props"
}
]
},
{
"name": "t-stepper",
"source": {
"symbol": "Stepper"
},
"description": "Stepper\n\n步进器",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/stepper",
"props": [
{
"name": "disable-input",
"description": "禁用输入框",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/stepper?tab=api#stepper-props",
"type": "boolean",
"default": "false"
},
{
"name": "disabled",
"description": "禁用全部操作",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/stepper?tab=api#stepper-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "input-width",
"description": "输入框宽度",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/stepper?tab=api#stepper-props",
"type": "number"
},
{
"name": "integer",
"description": "是否整型",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/stepper?tab=api#stepper-props",
"type": "boolean",
"default": "true"
},
{
"name": "max",
"description": "最大值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/stepper?tab=api#stepper-props",
"type": "number",
"default": "100"
},
{
"name": "min",
"description": "最小值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/stepper?tab=api#stepper-props",
"type": "number",
"default": "0"
},
{
"name": "size",
"description": "组件尺寸",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/stepper?tab=api#stepper-props",
"type": "SizeEnum",
"default": "medium",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "small"
},
{
"name": "medium"
},
{
"name": "large"
}
]
},
{
"name": "step",
"description": "步长",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/stepper?tab=api#stepper-props",
"type": "number",
"default": "1"
},
{
"name": "theme",
"description": "stylish\n\n组件风格",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/stepper?tab=api#stepper-props",
"type": "'normal' | 'filled' | 'outline'",
"default": "normal",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "normal"
},
{
"name": "filled"
},
{
"name": "outline"
}
]
},
{
"name": "value",
"description": "值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/stepper?tab=api#stepper-props",
"type": "string | number",
"default": "0"
}
],
"js": {
"events": [
{
"name": "blur",
"description": "输入框失去焦点时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/stepper?tab=api#stepper-events"
},
{
"name": "change",
"description": "数值发生变更时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/stepper?tab=api#stepper-events"
},
{
"name": "focus",
"description": "输入框聚焦时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/stepper?tab=api#stepper-events"
},
{
"name": "overlimit",
"description": "数值超出限制时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/stepper?tab=api#stepper-events"
}
]
},
"slots": []
},
{
"name": "t-steps",
"source": {
"symbol": "Steps"
},
"description": "Steps\n\n步骤条",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/steps",
"props": [
{
"name": "current",
"description": "当前步骤，即整个步骤条进度。默认根据步骤下标判断步骤的完成状态，当前步骤为进行中，当前步骤之前的步骤为已完成，当前步骤之后的步骤为未开始。如果每个步骤没有设置 value，current 值为步骤长度则表示所有步骤已完成。如果每个步骤设置了自定义 value，则 current = 'FINISH' 表示所有状态完成",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/steps?tab=api#steps-props",
"type": "string | number"
},
{
"name": "current-status",
"description": "用于控制 current 指向的步骤条的状态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/steps?tab=api#steps-props",
"type": "'default' | 'process' | 'finish' | 'error'",
"default": "process",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "default"
},
{
"name": "process"
},
{
"name": "finish"
},
{
"name": "error"
}
]
},
{
"name": "layout",
"description": "步骤条方向，有两种：横向和纵向",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/steps?tab=api#steps-props",
"type": "'horizontal' | 'vertical'",
"default": "horizontal",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "horizontal"
},
{
"name": "vertical"
}
]
},
{
"name": "readonly",
"description": "只读状态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/steps?tab=api#steps-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "sequence",
"description": "步骤条顺序",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/steps?tab=api#steps-props",
"type": "'positive' | 'reverse'",
"default": "positive",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "positive"
},
{
"name": "reverse"
}
]
},
{
"name": "theme",
"description": "步骤条风格",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/steps?tab=api#steps-props",
"type": "'default' | 'dot'",
"default": "default",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "default"
},
{
"name": "dot"
}
]
}
],
"js": {
"events": [
{
"name": "change",
"description": "当前步骤发生变化时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/steps?tab=api#steps-events"
}
]
},
"slots": []
},
{
"name": "t-sticky",
"source": {
"symbol": "Sticky"
},
"description": "Sticky\n\n吸顶容器",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/sticky",
"props": [
{
"name": "container",
"description": "指定容器对应的NodesRef节点为组件的外部容器，滚动时组件会始终保持在容器范围内，当组件即将超出容器底部时，会返回原位置",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/sticky?tab=api#sticky-props",
"type": "Element"
},
{
"name": "disabled",
"description": "是否禁用组件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/sticky?tab=api#sticky-props",
"type": "boolean",
"default": "false"
},
{
"name": "offset-top",
"description": "吸顶时与顶部的距离，单位`px`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/sticky?tab=api#sticky-props",
"type": "string | number",
"default": "0"
},
{
"name": "z-index",
"description": "吸顶时的 z-index",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/sticky?tab=api#sticky-props",
"type": "number",
"default": "99"
}
],
"js": {
"events": [
{
"name": "scroll",
"description": "滚动时触发，scrollTop: 距离顶部位置，isFixed: 是否吸顶",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/sticky?tab=api#sticky-events"
}
]
},
"slots": []
},
{
"name": "t-swipe-cell",
"source": {
"symbol": "SwipeCell"
},
"description": "SwipeCell\n\n滑动操作",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swipe-cell",
"props": [
{
"name": "content",
"description": "操作项以外的内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swipe-cell?tab=api#swipecell-props",
"type": "string | TNode"
},
{
"name": "default",
"description": "操作项以外的内容，同 content",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swipe-cell?tab=api#swipecell-props",
"type": "string | TNode"
},
{
"name": "disabled",
"description": "是否禁用滑动",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swipe-cell?tab=api#swipecell-props",
"type": "boolean"
},
{
"name": "left",
"description": "左侧滑动操作项。所有行为同 `right`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swipe-cell?tab=api#swipecell-props",
"type": "Array<SwipeActionItem> | TNode"
},
{
"name": "opened",
"description": "操作项是否呈现为打开态，值为数组时表示分别控制左右滑动的展开和收起状态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swipe-cell?tab=api#swipecell-props",
"type": "boolean | Array<boolean>",
"default": "false"
},
{
"name": "right",
"description": "右侧滑动操作项。有两种定义方式，一种是使用数组，二种是使用插槽。`right.text` 表示操作文本，`right.className` 表示操作项类名，`right.style` 表示操作项样式，`right.onClick` 表示点击操作项后执行的回调函数。示例：`[{ text: '删除', style: 'background-color: red', onClick: () => {} }]`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swipe-cell?tab=api#swipecell-props",
"type": "Array<SwipeActionItem> | TNode"
}
],
"js": {
"events": [
{
"name": "change",
"description": "菜单展开或者收回后将菜单的状态传递给父组件，值为数组时表示分别控制左右滑动的展开和收起状态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swipe-cell?tab=api#swipecell-events"
},
{
"name": "click",
"description": "操作项点击时触发（插槽写法组件不触发，业务侧自定义内容和事件）",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swipe-cell?tab=api#swipecell-events"
},
{
"name": "dragend",
"description": "滑动结束事件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swipe-cell?tab=api#swipecell-events"
},
{
"name": "dragstart",
"description": "滑动开始事件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swipe-cell?tab=api#swipecell-events"
}
]
},
"slots": [
{
"name": "content",
"description": "操作项以外的内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swipe-cell?tab=api#swipecell-props"
},
{
"name": "default",
"description": "操作项以外的内容，同 content",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swipe-cell?tab=api#swipecell-props"
},
{
"name": "left",
"description": "左侧滑动操作项。所有行为同 `right`类型和参数：Array<SwipeActionItem> | TNode",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swipe-cell?tab=api#swipecell-props"
},
{
"name": "right",
"description": "右侧滑动操作项。有两种定义方式，一种是使用数组，二种是使用插槽。`right.text` 表示操作文本，`right.className` 表示操作项类名，`right.style` 表示操作项样式，`right.onClick` 表示点击操作项后执行的回调函数。示例：`[{ text: '删除', style: 'background-color: red', onClick: () => {} }]`类型和参数：Array<SwipeActionItem> | TNode【interface SwipeActionItem {text: string; className?: string; style?: Styles; sure?: Sure; onClick?: () => void; [key: string]: any }】【type Sure = string | TNode】",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swipe-cell?tab=api#swipecell-props"
}
]
},
{
"name": "t-swiper",
"source": {
"symbol": "Swiper"
},
"description": "Swiper\n\n轮播",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swiper",
"props": [
{
"name": "animation",
"description": "轮播切换动画效果类型",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swiper?tab=api#swiper-props",
"type": "'slide'",
"default": "slide",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "slide"
}
]
},
{
"name": "autoplay",
"description": "是否自动播放",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swiper?tab=api#swiper-props",
"type": "boolean",
"default": "true"
},
{
"name": "current",
"description": "当前轮播在哪一项（下标）",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swiper?tab=api#swiper-props",
"type": "number",
"default": "0"
},
{
"name": "direction",
"description": "轮播滑动方向，包括横向滑动和纵向滑动两个方向",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swiper?tab=api#swiper-props",
"type": "'horizontal' | 'vertical'",
"default": "horizontal",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "horizontal"
},
{
"name": "vertical"
}
]
},
{
"name": "duration",
"description": "滑动动画时长",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swiper?tab=api#swiper-props",
"type": "number",
"default": "300"
},
{
"name": "height",
"description": "轮播的高度",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swiper?tab=api#swiper-props",
"type": "string | number"
},
{
"name": "interval",
"description": "轮播间隔时间",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swiper?tab=api#swiper-props",
"type": "number",
"default": "5000"
},
{
"name": "loop",
"description": "是否循环播放",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swiper?tab=api#swiper-props",
"type": "boolean",
"default": "true"
},
{
"name": "navigation",
"description": "导航器全部配置",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swiper?tab=api#swiper-props",
"type": "SwiperNavigation | TNode"
},
{
"name": "next-margin",
"description": "【开发中】后边距，可用于露出后一项的一小部分。默认单位 `px`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swiper?tab=api#swiper-props",
"type": "string | number",
"default": "0"
},
{
"name": "previous-margin",
"description": "【开发中】前边距，可用于露出前一项的一小部分。默认单位 `px`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swiper?tab=api#swiper-props",
"type": "string | number",
"default": "0"
}
],
"js": {
"events": [
{
"name": "change",
"description": "轮播切换时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swiper?tab=api#swiper-events"
},
{
"name": "click",
"description": "点击轮播项时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swiper?tab=api#swiper-events"
}
]
},
"slots": [
{
"name": "navigation",
"description": "导航器全部配置类型和参数：SwiperNavigation | TNode",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swiper?tab=api#swiper-props"
}
]
},
{
"name": "t-switch",
"source": {
"symbol": "Switch"
},
"description": "Switch\n\n开关",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/switch",
"props": [
{
"name": "custom-value",
"description": "用于自定义开关的值，[打开时的值，关闭时的值]。默认为 [true, false]。示例：[1, 0]、['open', 'close']",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/switch?tab=api#switch-props",
"type": "Array<SwitchValue>"
},
{
"name": "disabled",
"description": "是否禁用组件。优先级：Switch.disabled > Form.disabled",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/switch?tab=api#switch-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "icon",
"description": "开关的图标；[打开时的图标，关闭时的图标]",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/switch?tab=api#switch-props",
"type": "TNode[]",
"default": "[]"
},
{
"name": "label",
"description": "开关内容，[开启时内容，关闭时内容]。示例：['开', '关'] 或 (value) => value ? '开' : '关'",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/switch?tab=api#switch-props",
"type": "Array<string | TNode> | TNode<{ value: SwitchValue }>",
"default": "[]"
},
{
"name": "loading",
"description": "是否处于加载中状态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/switch?tab=api#switch-props",
"type": "boolean",
"default": "false"
},
{
"name": "size",
"description": "开关尺寸",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/switch?tab=api#switch-props",
"type": "'small' | 'medium' | 'large'",
"default": "medium",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "small"
},
{
"name": "medium"
},
{
"name": "large"
}
]
},
{
"name": "value",
"description": "开关值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/switch?tab=api#switch-props",
"type": "T"
}
],
"js": {
"events": [
{
"name": "change",
"description": "数据发生变化时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/switch?tab=api#switch-events"
}
]
},
"slots": [
{
"name": "label",
"description": "开关内容，[开启时内容，关闭时内容]。示例：['开', '关'] 或 (value) => value ? '开' : '关'类型和参数：Array<string | TNode> | TNode<{ value: SwitchValue }>",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/switch?tab=api#switch-props"
}
]
},
{
"name": "t-tab-bar",
"source": {
"symbol": "TabBar"
},
"description": "TabBar\n\n标签栏",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tab-bar",
"props": [
{
"name": "bordered",
"description": "是否显示外边框",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tab-bar?tab=api#tabbar-props",
"type": "boolean",
"default": "true"
},
{
"name": "fixed",
"description": "是否固定在底部",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tab-bar?tab=api#tabbar-props",
"type": "boolean",
"default": "true"
},
{
"name": "placeholder",
"description": "固定在底部时是否开启占位",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tab-bar?tab=api#tabbar-props",
"type": "boolean",
"default": "false"
},
{
"name": "safe-area-inset-bottom",
"description": "是否开启底部安全区适配",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tab-bar?tab=api#tabbar-props",
"type": "boolean",
"default": "true"
},
{
"name": "shape",
"description": "标签栏的形状",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tab-bar?tab=api#tabbar-props",
"type": "'normal' | 'round'",
"default": "normal",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "normal"
},
{
"name": "round"
}
]
},
{
"name": "split",
"description": "是否需要分割线",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tab-bar?tab=api#tabbar-props",
"type": "boolean",
"default": "true"
},
{
"name": "theme",
"description": "选项风格",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tab-bar?tab=api#tabbar-props",
"type": "'normal' | 'tag'",
"default": "normal",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "normal"
},
{
"name": "tag"
}
]
},
{
"name": "value",
"description": "当前选中标签的索引",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tab-bar?tab=api#tabbar-props",
"type": "string | number | Array<string | number>"
},
{
"name": "z-index",
"description": "标签栏层级",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tab-bar?tab=api#tabbar-props",
"type": "number",
"default": "1"
}
],
"js": {
"events": [
{
"name": "change",
"description": "选中标签切换时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tab-bar?tab=api#tabbar-events"
}
]
},
"slots": []
},
{
"name": "t-tab-bar-item",
"source": {
"symbol": "TabBarItem"
},
"description": "TabBarItem\n\n标签栏选项",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tab-bar",
"props": [
{
"name": "badge-props",
"description": "图标右上角提示信息",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tab-bar?tab=api#tabbaritem-props",
"type": "BadgeProps"
},
{
"name": "icon",
"description": "图标名称",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tab-bar?tab=api#tabbaritem-props",
"type": "TNode"
},
{
"name": "sub-tab-bar",
"description": "二级菜单",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tab-bar?tab=api#tabbaritem-props",
"type": "SubTabBarItem[] "
},
{
"name": "value",
"description": "标识符",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tab-bar?tab=api#tabbaritem-props",
"type": "string | number"
}
],
"slots": [
{
"name": "icon",
"description": "图标名称",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tab-bar?tab=api#tabbaritem-props"
}
]
},
{
"name": "t-tab-panel",
"source": {
"symbol": "TabPanel"
},
"description": "TabPanel\n\n选项卡面板",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs",
"props": [
{
"name": "badge-props",
"description": "透传至 Badge 组件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabpanel-props",
"type": "object"
},
{
"name": "destroy-on-hide",
"description": "选项卡内容隐藏时是否销毁",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabpanel-props",
"type": "boolean",
"default": "true"
},
{
"name": "disabled",
"description": "是否禁用当前选项卡",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabpanel-props",
"type": "boolean",
"default": "false"
},
{
"name": "icon",
"description": "图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabpanel-props",
"type": "TNode"
},
{
"name": "label",
"description": "选项卡名称，可自定义选项卡导航内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabpanel-props",
"type": "string | TNode"
},
{
"name": "lazy",
"description": "Enable tab lazy loading\n\n是否启用选项卡懒加载",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabpanel-props",
"type": "boolean",
"default": "false"
},
{
"name": "panel",
"description": "用于自定义选项卡面板内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabpanel-props",
"type": "string | TNode"
},
{
"name": "value",
"description": "选项卡的值，唯一标识",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabpanel-props",
"type": "TabValue"
}
],
"slots": [
{
"name": "icon",
"description": "图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabpanel-props"
},
{
"name": "label",
"description": "选项卡名称，可自定义选项卡导航内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabpanel-props"
},
{
"name": "panel",
"description": "用于自定义选项卡面板内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabpanel-props"
}
]
},
{
"name": "t-tabs",
"source": {
"symbol": "Tabs"
},
"description": "Tabs\n\n选项卡",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs",
"props": [
{
"name": "animation",
"description": "动画效果设置。其中 duration 表示动画时长",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabs-props",
"type": "TabAnimation"
},
{
"name": "bottom-line-mode",
"description": "激活下划线的模式",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabs-props",
"type": "'fixed' | 'auto' | 'full'",
"default": "fixed",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "fixed"
},
{
"name": "auto"
},
{
"name": "full"
}
]
},
{
"name": "list",
"description": "选项卡列表",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabs-props",
"type": "Array<TdTabPanelProps>"
},
{
"name": "middle",
"description": "中间内容，介于头部和内容之间",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabs-props",
"type": "TNode"
},
{
"name": "show-bottom-line",
"description": "是否展示底部激活线条",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabs-props",
"type": "boolean",
"default": "true"
},
{
"name": "size",
"description": "组件尺寸",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabs-props",
"type": "'medium' | 'large'",
"default": "medium",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "medium"
},
{
"name": "large"
}
]
},
{
"name": "space-evenly",
"description": "选项卡头部空间是否均分",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabs-props",
"type": "boolean",
"default": "true"
},
{
"name": "split",
"description": "是否展示分割线",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabs-props",
"type": "boolean",
"default": "true"
},
{
"name": "sticky",
"description": "是否开启粘性布局",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabs-props",
"type": "boolean",
"default": "false"
},
{
"name": "sticky-props",
"description": "透传至 Sticky 组件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabs-props",
"type": "StickyProps"
},
{
"name": "swipeable",
"description": "是否可以滑动切换",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabs-props",
"type": "boolean",
"default": "true"
},
{
"name": "theme",
"description": "标签的样式",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabs-props",
"type": "'line' | 'tag' | 'card'",
"default": "line",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "line"
},
{
"name": "tag"
},
{
"name": "card"
}
]
},
{
"name": "value",
"description": "激活的选项卡值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabs-props",
"type": "TabValue"
}
],
"js": {
"events": [
{
"name": "change",
"description": "激活的选项卡发生变化时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabs-events"
},
{
"name": "click",
"description": "点击选项卡时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabs-events"
},
{
"name": "scroll",
"description": "页面滚动时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabs-events"
}
]
},
"slots": [
{
"name": "middle",
"description": "中间内容，介于头部和内容之间",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabs-props"
}
]
},
{
"name": "t-tag",
"source": {
"symbol": "Tag"
},
"description": "Tag\n\n标签",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag",
"props": [
{
"name": "closable",
"description": "标签是否可关闭",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#tag-props",
"type": "boolean",
"default": "false"
},
{
"name": "content",
"description": "组件子元素",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#tag-props",
"type": "string | TNode"
},
{
"name": "default",
"description": "组件子元素，同 `content`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#tag-props",
"type": "string | TNode"
},
{
"name": "disabled",
"description": "标签禁用态，失效标签不能触发事件。默认风格（theme=default）才有禁用态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#tag-props",
"type": "boolean",
"default": "false"
},
{
"name": "icon",
"description": "标签中的图标，可自定义图标呈现",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#tag-props",
"type": "TNode",
"default": "undefined"
},
{
"name": "max-width",
"description": "标签最大宽度，宽度超出后会出现省略号。示例：'50px' / 80",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#tag-props",
"type": "string | number"
},
{
"name": "shape",
"description": "标签类型，有三种：方形、圆角方形、标记型",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#tag-props",
"type": "'square' | 'round' | 'mark'",
"default": "square",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "square"
},
{
"name": "round"
},
{
"name": "mark"
}
]
},
{
"name": "size",
"description": "标签尺寸",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#tag-props",
"type": "'small' | 'medium' | 'large' | 'extra-large'",
"default": "medium",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "small"
},
{
"name": "medium"
},
{
"name": "large"
},
{
"name": "extra-large"
}
]
},
{
"name": "theme",
"description": "组件风格，用于描述组件不同的应用场景",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#tag-props",
"type": "'default' | 'primary' | 'warning' | 'danger' | 'success'",
"default": "default",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "default"
},
{
"name": "primary"
},
{
"name": "warning"
},
{
"name": "danger"
},
{
"name": "success"
}
]
},
{
"name": "variant",
"description": "标签风格变体",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#tag-props",
"type": "'dark' | 'light' | 'outline' | 'light-outline'",
"default": "dark",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "outline"
},
{
"name": "light-outline"
}
]
}
],
"js": {
"events": [
{
"name": "click",
"description": "点击时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#tag-events"
},
{
"name": "close",
"description": "如果关闭按钮存在，点击关闭按钮时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#tag-events"
}
]
},
"slots": [
{
"name": "content",
"description": "组件子元素",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#tag-props"
},
{
"name": "default",
"description": "组件子元素，同 `content`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#tag-props"
},
{
"name": "icon",
"description": "标签中的图标，可自定义图标呈现",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tag?tab=api#tag-props"
}
]
},
{
"name": "t-textarea",
"source": {
"symbol": "Textarea"
},
"description": "Textarea\n\n文本输入框",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/textarea",
"props": [
{
"name": "allow-input-over-max",
"description": "Allow input after exceeding `maxlength` or `maxcharacter`\n\n超出 `maxlength` 或 `maxcharacter` 之后是否还允许输入",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/textarea?tab=api#textarea-props",
"type": "boolean",
"default": "false"
},
{
"name": "autofocus",
"description": "自动聚焦，拉起键盘",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/textarea?tab=api#textarea-props",
"type": "boolean",
"default": "false"
},
{
"name": "autosize",
"description": "高度自动撑开。 autosize = true 表示组件高度自动撑开，同时，依旧允许手动拖高度。如果设置了 autosize.maxRows 或者 autosize.minRows 则不允许手动调整高度",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/textarea?tab=api#textarea-props",
"type": "boolean | { minRows?: number; maxRows?: number }",
"default": "false"
},
{
"name": "bordered",
"description": "是否显示外边框",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/textarea?tab=api#textarea-props",
"type": "boolean",
"default": "false"
},
{
"name": "cursor-color",
"description": "光标颜色",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/textarea?tab=api#textarea-props",
"type": "string",
"default": "#0052d9"
},
{
"name": "disabled",
"description": "是否禁用文本框",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/textarea?tab=api#textarea-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "indicator",
"description": "显示文本计数器，如 0/140。当 `maxlength < 0 && maxcharacter < 0` 成立时， indicator无效",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/textarea?tab=api#textarea-props",
"type": "boolean",
"default": "false"
},
{
"name": "label",
"description": "左侧文本",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/textarea?tab=api#textarea-props",
"type": "string | TNode"
},
{
"name": "layout",
"description": "标题输入框布局方式",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/textarea?tab=api#textarea-props",
"type": "'vertical' | 'horizontal'",
"default": "horizontal",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "vertical"
},
{
"name": "horizontal"
}
]
},
{
"name": "maxcharacter",
"description": "用户最多可以输入的字符个数，一个中文汉字表示两个字符长度",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/textarea?tab=api#textarea-props",
"type": "number"
},
{
"name": "maxlength",
"description": "用户最多可以输入的字符个数",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/textarea?tab=api#textarea-props",
"type": "string | number"
},
{
"name": "name",
"description": "名称，HTML 元素原生属性",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/textarea?tab=api#textarea-props",
"type": "string"
},
{
"name": "placeholder",
"description": "占位符",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/textarea?tab=api#textarea-props",
"type": "string",
"default": "undefined"
},
{
"name": "readonly",
"description": "只读状态",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/textarea?tab=api#textarea-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "value",
"description": "文本框值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/textarea?tab=api#textarea-props",
"type": "TextareaValue"
}
],
"js": {
"events": [
{
"name": "blur",
"description": "失去焦点时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/textarea?tab=api#textarea-events"
},
{
"name": "change",
"description": "输入内容变化时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/textarea?tab=api#textarea-events"
},
{
"name": "focus",
"description": "获得焦点时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/textarea?tab=api#textarea-events"
}
]
},
"slots": [
{
"name": "label",
"description": "左侧文本",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/textarea?tab=api#textarea-props"
}
]
},
{
"name": "t-toast",
"source": {
"symbol": "Toast"
},
"description": "Toast\n\n轻提示",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/toast",
"props": [
{
"name": "direction",
"description": "图标排列方式",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/toast?tab=api#toast-props",
"type": "'row' | 'column'",
"default": "row",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "row"
},
{
"name": "column"
}
]
},
{
"name": "duration",
"description": "弹窗显示毫秒数",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/toast?tab=api#toast-props",
"type": "number",
"default": "2000"
},
{
"name": "icon",
"description": "自定义图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/toast?tab=api#toast-props",
"type": "TNode"
},
{
"name": "message",
"description": "弹窗显示文字",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/toast?tab=api#toast-props",
"type": "string | TNode"
},
{
"name": "overlay-props",
"description": "遮罩层属性，透传至 Overlay",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/toast?tab=api#toast-props",
"type": "OverlayProps "
},
{
"name": "placement",
"description": "弹窗展示位置",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/toast?tab=api#toast-props",
"type": "'top' | 'middle' | 'bottom'",
"default": "middle",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": " top"
},
{
"name": "middle"
},
{
"name": "bottom"
}
]
},
{
"name": "prevent-scroll-through",
"description": "防止滚动穿透，即不允许点击和滚动",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/toast?tab=api#toast-props",
"type": "boolean",
"default": "false"
},
{
"name": "show-overlay",
"description": "是否显示遮罩层",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/toast?tab=api#toast-props",
"type": "boolean",
"default": "false"
},
{
"name": "theme",
"description": "提示类型",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/toast?tab=api#toast-props",
"type": "'loading' | 'success' | 'warning' | 'error'",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "loading"
},
{
"name": "success"
},
{
"name": "warning"
},
{
"name": "error"
}
]
}
],
"js": {
"events": [
{
"name": "close",
"description": "轻提示隐藏的时候触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/toast?tab=api#toast-events"
},
{
"name": "destroy",
"description": "轻提示销毁的时候触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/toast?tab=api#toast-events"
}
]
},
"slots": [
{
"name": "icon",
"description": "自定义图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/toast?tab=api#toast-props"
},
{
"name": "message",
"description": "弹窗显示文字",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/toast?tab=api#toast-props"
}
]
},
{
"name": "t-tree-select",
"source": {
"symbol": "TreeSelect"
},
"description": "TreeSelect\n\n树选择",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tree-select",
"props": [
{
"name": "custom-value",
"description": "自定义选中值，优先级高于 `value`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tree-select?tab=api#treeselect-props",
"type": "TreeSelectValue"
},
{
"name": "height",
"description": "高度，默认单位为 px",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tree-select?tab=api#treeselect-props",
"type": "string | number",
"default": "336"
},
{
"name": "keys",
"description": "alias filed name in options\n\n用来定义 `value / label / disabled / children` 在 `options` 数据中对应的字段别名，示例：`{ value: 'key', label: 'name', children: 'list' }`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tree-select?tab=api#treeselect-props",
"type": "TreeKeysType"
},
{
"name": "multiple",
"description": "是否允许多选",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tree-select?tab=api#treeselect-props",
"type": "boolean",
"default": "false"
},
{
"name": "options",
"description": "选项",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tree-select?tab=api#treeselect-props",
"type": "Array<DataOption>",
"default": "[]"
},
{
"name": "value",
"description": "选中值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tree-select?tab=api#treeselect-props",
"type": "TreeSelectValue"
}
],
"js": {
"events": [
{
"name": "change",
"description": "点击任何节点均会触发；level 代表当前点击的层级，0 代表最左侧，依次递进",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tree-select?tab=api#treeselect-events"
}
]
},
"slots": []
},
{
"name": "t-upload",
"source": {
"symbol": "Upload"
},
"description": "Upload\n\n上传",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload",
"props": [
{
"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/mobile-vue/components/upload?tab=api#upload-props",
"type": "string"
},
{
"name": "action",
"description": "Uploading URL\n\n上传接口。设接口响应数据为字段 `response`，那么 `response.error` 存在时会判断此次上传失败，并显示错误文本信息；`response.url` 会作为文件上传成功后的地址，并使用该地址显示图片或文件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": "string"
},
{
"name": "add-btn",
"description": "添加按钮",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": "boolean",
"default": "true"
},
{
"name": "add-content",
"description": "添加按钮内容。值为空，使用默认图标渲染；值为 slot 则表示使用插槽渲染；其他值无效",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": "string | TNode"
},
{
"name": "allow-upload-duplicate-file",
"description": "allow to upload duplicate name files\n\n是否允许重复上传相同文件名的文件。在 `capture = ''` + 拍照上传场景中，`allowUploadDuplicateFile` 应取 `true`，避免拍照上传的文件被同名文件校验过滤",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": "boolean",
"default": "false"
},
{
"name": "auto-upload",
"description": "post upload request automatically after files being selected\n\n是否在选择文件后自动发起请求上传文件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": "boolean",
"default": "true"
},
{
"name": "before-upload",
"description": "stop one of files to upload\n\n如果是自动上传模式 `autoUpload=true`，表示单个文件上传之前的钩子函数，若函数返回值为 `false` 则表示不上传当前文件。<br/>如果是非自动上传模式 `autoUpload=false`，函数返回值为 `false` 时表示从上传文件中剔除当前文件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": "(file: UploadFile) => boolean | Promise<boolean>"
},
{
"name": "capture",
"description": "图片选取模式，可选值为 camera (直接调起摄像头)",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": "string"
},
{
"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/mobile-vue/components/upload?tab=api#upload-props",
"type": "Record<string, any> | ((files: UploadFile[]) => Record<string, any>)"
},
{
"name": "disabled",
"description": "make upload to be disabled\n\n是否禁用组件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": "boolean",
"default": "undefined"
},
{
"name": "files",
"description": "已上传文件列表，同 `value`。TS 类型：`UploadFile`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": "Array<T>",
"default": "[]"
},
{
"name": "format",
"description": "to redefine `UploadFile` data structure\n\n转换文件 `UploadFile` 的数据结构，可新增或修改 `UploadFile` 的属性，注意不能删除 `UploadFile` 属性。`action` 存在时有效",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": "(file: File) => UploadFile"
},
{
"name": "format-request",
"description": "redefine request data\n\n用于新增或修改文件上传请求 参数。`action` 存在时有效。一个请求上传一个文件时，默认请求字段有 `file`。<br/>一个请求上传多个文件时，默认字段有 `file[0]/file[1]/file[2]/.../length`，其中 `length` 表示本次上传的文件数量。<br/>⚠️非常注意，此处的 `file[0]/file[1]` 仅仅是一个字段名，并非表示 `file` 是一个数组，接口获取字段时注意区分。<br/>可以使用 `name` 定义 `file` 字段的别名。<br/>也可以使用 `formatRequest` 自定义任意字段，如添加一个字段 `fileList` ，存储文件数组",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": "(requestData: { [key: string]: any }) => { [key: string]: any }"
},
{
"name": "format-response",
"description": "redefine response data structure\n\n用于格式化文件上传后的接口响应数据，`response` 便是接口响应的原始数据。`action` 存在时有效。<br/> 此函数的返回值 `error` 或 `response.error` 会作为错误文本提醒，如果存在会判定为本次上传失败。<br/> 此函数的返回值 `url` 或 `response.url` 会作为上传成功后的链接",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": "(response: any, context: FormatResponseContext) => ResponseType"
},
{
"name": "headers",
"description": "HTTP Request Header\n\n设置上传的请求头部，`action` 存在时有效",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": "{[key: string]: string}"
},
{
"name": "image-props",
"description": "透传 Image 组件全部属性",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": "ImageProps"
},
{
"name": "max",
"description": "max count of files limit\n\n用于控制文件上传数量，值为 0 则不限制",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": "number",
"default": "0"
},
{
"name": "method",
"description": "HTTP request method\n\nHTTP 请求类型",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": "'POST' | 'GET' | 'PUT' | 'OPTIONS' | 'PATCH' | 'post' | 'get' | 'put' | 'options' | 'patch'",
"default": "POST",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "POST"
},
{
"name": "GET"
},
{
"name": "PUT"
},
{
"name": "OPTIONS"
},
{
"name": "PATCH"
},
{
"name": "post"
},
{
"name": "get"
},
{
"name": "put"
},
{
"name": "options"
},
{
"name": "patch"
}
]
},
{
"name": "multiple",
"description": "multiple files uploading\n\n支持多文件上传",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": "boolean",
"default": "false"
},
{
"name": "preview",
"description": "是否支持图片预览，文件没有预览",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": "boolean",
"default": "true"
},
{
"name": "remove-btn",
"description": "移除按钮",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": "boolean",
"default": "true"
},
{
"name": "request-method",
"description": "custom upload request method\n\n自定义上传方法。返回值 `status` 表示上传成功或失败；`error` 或 `response.error` 表示上传失败的原因；<br/>`response` 表示请求上传成功后的返回数据，`response.url` 表示上传成功后的图片/文件地址，`response.files` 表示一个请求上传多个文件/图片后的返回值。<br/>示例一：`{ status: 'fail', error: '上传失败', response }`。<br/>示例二：`{ status: 'success', response: { url: 'https://tdesign.gtimg.com/site/avatar.jpg' } }`。<br/> 示例三：`{ status: 'success', files: [{ url: 'https://xxx.png', name: 'xxx.png' }]}`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": "(files: UploadFile | UploadFile[]) => Promise<RequestMethodResponse>"
},
{
"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/mobile-vue/components/upload?tab=api#upload-props",
"type": "number | SizeLimitObj"
},
{
"name": "use-mock-progress",
"description": "use mock progress, instead of real progress\n\n是否在请求时间超过 300ms 后显示模拟进度。上传进度有模拟进度和真实进度两种。一般大小的文件上传，真实的上传进度只有 0 和 100，不利于交互呈现，因此组件内置模拟上传进度。真实上传进度一般用于大文件上传",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": "boolean",
"default": "true"
},
{
"name": "value",
"description": "file list\n\n已上传文件列表，同 `files`。TS 类型：`UploadFile`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": "Array<T>",
"default": "[]"
},
{
"name": "with-credentials",
"description": "uploading request with cookie\n\n上传请求时是否携带 cookie",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": "boolean",
"default": "false"
}
],
"js": {
"events": [
{
"name": "change",
"description": "trigger on uploaded files change\n\n已上传文件列表发生变化时触发，`trigger` 表示触发本次的来源",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-events"
},
{
"name": "click-upload",
"description": "点击上传区域时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-events"
},
{
"name": "fail",
"description": "`response.error` used for error tips, `formatResponse` can format `response`\n\n上传失败后触发。`response` 指接口响应结果，`response.error` 会作为错误文本提醒。如果希望判定为上传失败，但接口响应数据不包含 `error` 字段，可以使用 `formatResponse` 格式化 `response` 数据结构。如果是多文件多请求上传场景，请到事件 `onOneFileFail` 中查看 `response`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-events"
},
{
"name": "preview",
"description": "trigger on preview elements click\n\n点击图片预览时触发，文件没有预览",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-events"
},
{
"name": "progress",
"description": "uploading request progress event\n\n上传进度变化时触发，真实进度和模拟进度都会触发。<br/>⚠️ 原始上传请求，小文件的上传进度只有 0 和 100，故而不会触发 `progress` 事件；只有大文件才有真实的中间进度。如果你希望很小的文件也显示上传进度，保证 `useMockProgress=true` 的情况下，设置 `mockProgressDuration` 为更小的值。<br/>参数 `options.type=real` 表示真实上传进度，`options.type=mock` 表示模拟上传进度",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-events"
},
{
"name": "remove",
"description": "trigger on file removed\n\n移除文件时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-events"
},
{
"name": "select-change",
"description": "trigger after file choose and before upload\n\n选择文件或图片之后，上传之前，触发该事件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-events"
},
{
"name": "success",
"description": "trigger on all files uploaded successfully\n\n上传成功后触发。<br/>`context.currentFiles` 表示当次请求上传的文件（无论成功或失败），`context.fileList` 表示上传成功后的文件，`context.response` 表示上传请求的返回数据。<br/>`context.results` 表示单次选择全部文件上传成功后的响应结果，可以在这个字段存在时提醒用户上传成功或失败。<br />",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-events"
},
{
"name": "validate",
"description": "trigger on length over limit, or trigger on file size over limit\n\n文件上传校验结束事件，文件数量超出、文件大小超出限制、文件同名、`beforeAllFilesUpload` 返回值为假、`beforeUpload` 返回值为假等场景会触发。<br/>注意：如果设置允许上传同名文件，即 `allowUploadDuplicateFile=true`，则不会因为文件重名触发该事件。<br/>结合 `status` 和 `tips` 可以在组件中呈现不同类型的错误（或告警）提示",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-events"
}
]
},
"slots": [
{
"name": "addContent",
"description": "添加按钮内容。值为空，使用默认图标渲染；值为 slot 则表示使用插槽渲染；其他值无效",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props"
},
{
"name": "add-content",
"description": "添加按钮内容。值为空，使用默认图标渲染；值为 slot 则表示使用插槽渲染；其他值无效",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props"
}
]
},
{
"name": "t-watermark",
"source": {
"symbol": "Watermark"
},
"description": "Watermark\n\n水印",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/watermark",
"props": [
{
"name": "alpha",
"description": "水印整体透明度，取值范围 [0-1]",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/watermark?tab=api#watermark-props",
"type": "number",
"default": "1"
},
{
"name": "content",
"description": "水印所覆盖的内容节点",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/watermark?tab=api#watermark-props",
"type": "string | TNode"
},
{
"name": "default",
"description": "水印所覆盖的内容节点，同 `content`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/watermark?tab=api#watermark-props",
"type": "string | TNode"
},
{
"name": "height",
"description": "水印高度",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/watermark?tab=api#watermark-props",
"type": "number"
},
{
"name": "is-repeat",
"description": "水印是否重复出现",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/watermark?tab=api#watermark-props",
"type": "boolean",
"default": "true"
},
{
"name": "layout",
"description": "水印的布局方式，rectangular：矩形，即横平竖直的水印；hexagonal：六边形，即错位的水印",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/watermark?tab=api#watermark-props",
"type": "'rectangular' | 'hexagonal'",
"default": "rectangular",
"attribute-value": {
"type": "enum"
},
"values": [
{
"name": "rectangular"
},
{
"name": "hexagonal"
}
]
},
{
"name": "line-space",
"description": "行间距，只作用在多行（`content` 配置为数组）情况下",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/watermark?tab=api#watermark-props",
"type": "number",
"default": "16"
},
{
"name": "movable",
"description": "水印是否可移动",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/watermark?tab=api#watermark-props",
"type": "boolean",
"default": "false"
},
{
"name": "move-interval",
"description": "水印发生运动位移的间隙，单位：毫秒",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/watermark?tab=api#watermark-props",
"type": "number",
"default": "3000"
},
{
"name": "offset",
"description": "水印在画布上绘制的水平和垂直偏移量，正常情况下水印绘制在中间位置，即 `offset = [gapX / 2, gapY / 2]`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/watermark?tab=api#watermark-props",
"type": "Array<number>"
},
{
"name": "removable",
"description": "水印是否可被删除",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/watermark?tab=api#watermark-props",
"type": "boolean",
"default": "true"
},
{
"name": "rotate",
"description": "水印旋转的角度，单位 °",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/watermark?tab=api#watermark-props",
"type": "number",
"default": "-22"
},
{
"name": "watermark-content",
"description": "水印内容，需要显示多行情况下可配置为数组",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/watermark?tab=api#watermark-props",
"type": "WatermarkText|WatermarkImage|Array<WatermarkText|WatermarkImage>"
},
{
"name": "width",
"description": "水印宽度",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/watermark?tab=api#watermark-props",
"type": "number"
},
{
"name": "x",
"description": "水印之间的水平间距",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/watermark?tab=api#watermark-props",
"type": "number"
},
{
"name": "y",
"description": "水印之间的垂直间距",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/watermark?tab=api#watermark-props",
"type": "number"
},
{
"name": "z-index",
"description": "水印元素的 `z-index`，默认值写在 CSS 中",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/watermark?tab=api#watermark-props",
"type": "number"
}
],
"slots": [
{
"name": "content",
"description": "水印所覆盖的内容节点",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/watermark?tab=api#watermark-props"
},
{
"name": "default",
"description": "水印所覆盖的内容节点，同 `content`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/watermark?tab=api#watermark-props"
}
]
}
]
}
}
}