From b591eaa85641d64066667b2eaa482c94f5f66660 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E9=BB=8E=E4=BC=9F=E6=9D=B0?= <674416404@qq.com>
Date: Sat, 3 Feb 2024 10:57:34 +0800
Subject: [PATCH 1/4] =?UTF-8?q?chore:=20=E7=BC=96=E8=BE=91=E5=99=A8?=
=?UTF-8?q?=E6=8F=90=E7=A4=BA=E6=9B=B4=E6=96=B0=EF=BC=8C=E5=A2=9E=E5=8A=A0?=
=?UTF-8?q?volar=E6=8F=90=E7=A4=BA?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
global.d.ts | 109 ++++
helper/attributes.json | 380 ++++++++++--
helper/tags.json | 87 ++-
helper/web-types.json | 934 ++++++++++++++++++++++++++---
site/docs/getting-started.en-US.md | 5 +
site/docs/getting-started.md | 5 +
6 files changed, 1386 insertions(+), 134 deletions(-)
create mode 100644 global.d.ts
diff --git a/global.d.ts b/global.d.ts
new file mode 100644
index 000000000..fcf1a1237
--- /dev/null
+++ b/global.d.ts
@@ -0,0 +1,109 @@
+/**
+ * 该文件为脚本自动生成文件,请勿随意修改。如需修改请联系 PMC
+ * https://github.com/TDesignOteam/tdesign-api
+ * eslint-disable
+ * */
+declare module '@vue/runtime-core' {
+ export interface GlobalComponents {
+ TActionSheet: typeof import('tdesign-mobile-vue')['ActionSheet'];
+ TAvatar: typeof import('tdesign-mobile-vue')['Avatar'];
+ TAvatarGroup: typeof import('tdesign-mobile-vue')['AvatarGroup'];
+ TBackTop: typeof import('tdesign-mobile-vue')['BackTop'];
+ TBadge: typeof import('tdesign-mobile-vue')['Badge'];
+ TBaseTable: typeof import('tdesign-mobile-vue')['BaseTable'];
+ TButton: typeof import('tdesign-mobile-vue')['Button'];
+ TCalendar: typeof import('tdesign-mobile-vue')['Calendar'];
+ TCascader: typeof import('tdesign-mobile-vue')['Cascader'];
+ TCell: typeof import('tdesign-mobile-vue')['Cell'];
+ TCellGroup: typeof import('tdesign-mobile-vue')['CellGroup'];
+ TCheckTag: typeof import('tdesign-mobile-vue')['CheckTag'];
+ TCheckTagGroup: typeof import('tdesign-mobile-vue')['CheckTagGroup'];
+ TCheckbox: typeof import('tdesign-mobile-vue')['Checkbox'];
+ TCheckboxGroup: typeof import('tdesign-mobile-vue')['CheckboxGroup'];
+ TCol: typeof import('tdesign-mobile-vue')['Col'];
+ TCollapse: typeof import('tdesign-mobile-vue')['Collapse'];
+ TCollapsePanel: typeof import('tdesign-mobile-vue')['CollapsePanel'];
+ TColorPicker: typeof import('tdesign-mobile-vue')['ColorPicker'];
+ TComment: typeof import('tdesign-mobile-vue')['Comment'];
+ TCountDown: typeof import('tdesign-mobile-vue')['CountDown'];
+ TDateRangePicker: typeof import('tdesign-mobile-vue')['DateRangePicker'];
+ TDateTimePicker: typeof import('tdesign-mobile-vue')['DateTimePicker'];
+ TDialog: typeof import('tdesign-mobile-vue')['Dialog'];
+ TDivider: typeof import('tdesign-mobile-vue')['Divider'];
+ TDrawer: typeof import('tdesign-mobile-vue')['Drawer'];
+ TDropdownItem: typeof import('tdesign-mobile-vue')['DropdownItem'];
+ TDropdownMenu: typeof import('tdesign-mobile-vue')['DropdownMenu'];
+ TEmpty: typeof import('tdesign-mobile-vue')['Empty'];
+ TFab: typeof import('tdesign-mobile-vue')['Fab'];
+ TFooter: typeof import('tdesign-mobile-vue')['Footer'];
+ TForm: typeof import('tdesign-mobile-vue')['Form'];
+ TFormItem: typeof import('tdesign-mobile-vue')['FormItem'];
+ TGrid: typeof import('tdesign-mobile-vue')['Grid'];
+ TGridItem: typeof import('tdesign-mobile-vue')['GridItem'];
+ TIconSVG: typeof import('tdesign-mobile-vue')['IconSVG'];
+ TIconfont: typeof import('tdesign-mobile-vue')['Iconfont'];
+ TImage: typeof import('tdesign-mobile-vue')['Image'];
+ TImageViewer: typeof import('tdesign-mobile-vue')['ImageViewer'];
+ TIndexes: typeof import('tdesign-mobile-vue')['Indexes'];
+ TIndexesAnchor: typeof import('tdesign-mobile-vue')['IndexesAnchor'];
+ TInput: typeof import('tdesign-mobile-vue')['Input'];
+ TInputAdornment: typeof import('tdesign-mobile-vue')['InputAdornment'];
+ TLink: typeof import('tdesign-mobile-vue')['Link'];
+ TList: typeof import('tdesign-mobile-vue')['List'];
+ TLoading: typeof import('tdesign-mobile-vue')['Loading'];
+ TMessage: typeof import('tdesign-mobile-vue')['Message'];
+ TNavbar: typeof import('tdesign-mobile-vue')['Navbar'];
+ TNoticeBar: typeof import('tdesign-mobile-vue')['NoticeBar'];
+ TOverlay: typeof import('tdesign-mobile-vue')['Overlay'];
+ TPagination: typeof import('tdesign-mobile-vue')['Pagination'];
+ TPicker: typeof import('tdesign-mobile-vue')['Picker'];
+ TPickerItem: typeof import('tdesign-mobile-vue')['PickerItem'];
+ TPopconfirm: typeof import('tdesign-mobile-vue')['Popconfirm'];
+ TPopover: typeof import('tdesign-mobile-vue')['Popover'];
+ TPopup: typeof import('tdesign-mobile-vue')['Popup'];
+ TPrimaryTable: typeof import('tdesign-mobile-vue')['PrimaryTable'];
+ TProgress: typeof import('tdesign-mobile-vue')['Progress'];
+ TPullDownRefresh: typeof import('tdesign-mobile-vue')['PullDownRefresh'];
+ TRadio: typeof import('tdesign-mobile-vue')['Radio'];
+ TRadioGroup: typeof import('tdesign-mobile-vue')['RadioGroup'];
+ TRangeInput: typeof import('tdesign-mobile-vue')['RangeInput'];
+ TRangeInputPopup: typeof import('tdesign-mobile-vue')['RangeInputPopup'];
+ TRate: typeof import('tdesign-mobile-vue')['Rate'];
+ TResult: typeof import('tdesign-mobile-vue')['Result'];
+ TRow: typeof import('tdesign-mobile-vue')['Row'];
+ TSearch: typeof import('tdesign-mobile-vue')['Search'];
+ TSegmentedControl: typeof import('tdesign-mobile-vue')['SegmentedControl'];
+ TSelect: typeof import('tdesign-mobile-vue')['Select'];
+ TSideBar: typeof import('tdesign-mobile-vue')['SideBar'];
+ TSideBarItem: typeof import('tdesign-mobile-vue')['SideBarItem'];
+ TSkeleton: typeof import('tdesign-mobile-vue')['Skeleton'];
+ TSlider: typeof import('tdesign-mobile-vue')['Slider'];
+ TSpace: typeof import('tdesign-mobile-vue')['Space'];
+ TStatistic: typeof import('tdesign-mobile-vue')['Statistic'];
+ TStepItem: typeof import('tdesign-mobile-vue')['StepItem'];
+ TStepper: typeof import('tdesign-mobile-vue')['Stepper'];
+ TSteps: typeof import('tdesign-mobile-vue')['Steps'];
+ TSticky: typeof import('tdesign-mobile-vue')['Sticky'];
+ TStickyTool: typeof import('tdesign-mobile-vue')['StickyTool'];
+ TSwipeCell: typeof import('tdesign-mobile-vue')['SwipeCell'];
+ TSwiper: typeof import('tdesign-mobile-vue')['Swiper'];
+ TSwiperNav: typeof import('tdesign-mobile-vue')['SwiperNav'];
+ TSwitch: typeof import('tdesign-mobile-vue')['Switch'];
+ TTabBar: typeof import('tdesign-mobile-vue')['TabBar'];
+ TTabBarItem: typeof import('tdesign-mobile-vue')['TabBarItem'];
+ TTabPanel: typeof import('tdesign-mobile-vue')['TabPanel'];
+ TTabs: typeof import('tdesign-mobile-vue')['Tabs'];
+ TTag: typeof import('tdesign-mobile-vue')['Tag'];
+ TTextarea: typeof import('tdesign-mobile-vue')['Textarea'];
+ TTimeRangePicker: typeof import('tdesign-mobile-vue')['TimeRangePicker'];
+ TTimeline: typeof import('tdesign-mobile-vue')['Timeline'];
+ TTimelineItem: typeof import('tdesign-mobile-vue')['TimelineItem'];
+ TToast: typeof import('tdesign-mobile-vue')['Toast'];
+ TTooltip: typeof import('tdesign-mobile-vue')['Tooltip'];
+ TTreeSelect: typeof import('tdesign-mobile-vue')['TreeSelect'];
+ TUpload: typeof import('tdesign-mobile-vue')['Upload'];
+ TWatermark: typeof import('tdesign-mobile-vue')['Watermark'];
+ }
+}
+
+export {};
diff --git a/helper/attributes.json b/helper/attributes.json
index b3d8bd7f8..26ca66510 100644
--- a/helper/attributes.json
+++ b/helper/attributes.json
@@ -187,6 +187,168 @@
],
"description": "尺寸\n\ndefault: medium\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/badge?tab=api#badge-props)"
},
+ "t-base-table/bordered": {
+ "type": "Boolean",
+ "description": "show table bordered\n\n是否显示表格边框\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-table/bordered": {
+ "type": "Boolean",
+ "description": "show table bordered\n\n是否显示表格边框\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-base-table/cell-empty-content": {
+ "type": "String|TNode",
+ "description": "单元格数据为空时呈现的内容\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-table/cell-empty-content": {
+ "type": "String|TNode",
+ "description": "单元格数据为空时呈现的内容\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-base-table/columns": {
+ "type": "Array",
+ "description": "table column configs\n\n列配置,泛型 T 指表格数据类型\n\ndefault: []\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-table/columns": {
+ "type": "Array",
+ "description": "table column configs\n\n列配置,泛型 T 指表格数据类型\n\ndefault: []\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-base-table/data": {
+ "type": "Array",
+ "description": "table data\n\n数据源,泛型 T 指表格数据类型\n\ndefault: []\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-table/data": {
+ "type": "Array",
+ "description": "table data\n\n数据源,泛型 T 指表格数据类型\n\ndefault: []\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-base-table/empty": {
+ "type": "String|TNode",
+ "description": "empty text or empty element\n\n空表格呈现样式,支持全局配置 `GlobalConfigProvider`\n\ndefault: ''\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-table/empty": {
+ "type": "String|TNode",
+ "description": "empty text or empty element\n\n空表格呈现样式,支持全局配置 `GlobalConfigProvider`\n\ndefault: ''\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-base-table/fixed-rows": {
+ "type": "Array",
+ "description": "固定行(冻结行),示例:[M, N],表示冻结表头 M 行和表尾 N 行。M 和 N 值为 0 时,表示不冻结行\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-table/fixed-rows": {
+ "type": "Array",
+ "description": "固定行(冻结行),示例:[M, N],表示冻结表头 M 行和表尾 N 行。M 和 N 值为 0 时,表示不冻结行\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-base-table/height": {
+ "type": "String|Number",
+ "description": "table height\n\n表格高度,超出后会出现滚动条。示例:100, '30%', '300'。值为数字类型,会自动加上单位 px。如果不是绝对固定表格高度,建议使用 `maxHeight`\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-table/height": {
+ "type": "String|Number",
+ "description": "table height\n\n表格高度,超出后会出现滚动条。示例:100, '30%', '300'。值为数字类型,会自动加上单位 px。如果不是绝对固定表格高度,建议使用 `maxHeight`\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-base-table/loading": {
+ "type": "Boolean|TNode",
+ "description": "loading state table\n\n加载中状态。值为 `true` 会显示默认加载中样式,可以通过 Function 和 插槽 自定义加载状态呈现内容和样式。值为 `false` 则会取消加载状态\n\ndefault: undefined\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-table/loading": {
+ "type": "Boolean|TNode",
+ "description": "loading state table\n\n加载中状态。值为 `true` 会显示默认加载中样式,可以通过 Function 和 插槽 自定义加载状态呈现内容和样式。值为 `false` 则会取消加载状态\n\ndefault: undefined\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-base-table/max-height": {
+ "type": "String|Number",
+ "description": "table max height\n\n表格最大高度,超出后会出现滚动条。示例:100, '30%', '300'。值为数字类型,会自动加上单位 px\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-table/max-height": {
+ "type": "String|Number",
+ "description": "table max height\n\n表格最大高度,超出后会出现滚动条。示例:100, '30%', '300'。值为数字类型,会自动加上单位 px\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-base-table/row-key": {
+ "type": "String",
+ "description": "unique key for each row data\n\n唯一标识一行数据的字段名,来源于 `data` 中的字段。如果是字段嵌套多层,可以设置形如 `item.a.id` 的方法\n\ndefault: 'id'\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-table/row-key": {
+ "type": "String",
+ "description": "unique key for each row data\n\n唯一标识一行数据的字段名,来源于 `data` 中的字段。如果是字段嵌套多层,可以设置形如 `item.a.id` 的方法\n\ndefault: 'id'\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-base-table/show-header": {
+ "type": "Boolean",
+ "description": "show table header\n\n是否显示表头\n\ndefault: true\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-table/show-header": {
+ "type": "Boolean",
+ "description": "show table header\n\n是否显示表头\n\ndefault: true\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-base-table/stripe": {
+ "type": "Boolean",
+ "description": "show stripe style\n\n是否显示斑马纹\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-table/stripe": {
+ "type": "Boolean",
+ "description": "show stripe style\n\n是否显示斑马纹\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-base-table/table-content-width": {
+ "type": "String",
+ "description": "表格内容的总宽度,注意不是表格可见宽度。主要应用于 `table-layout: auto` 模式下的固定列显示。`tableContentWidth` 内容宽度的值必须大于表格可见宽度\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-table/table-content-width": {
+ "type": "String",
+ "description": "表格内容的总宽度,注意不是表格可见宽度。主要应用于 `table-layout: auto` 模式下的固定列显示。`tableContentWidth` 内容宽度的值必须大于表格可见宽度\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-base-table/table-layout": {
+ "type": "String",
+ "options": [
+ "auto",
+ "fixed"
+ ],
+ "description": "table-layout css properties, [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout). set value to be `fixed` on `resizable=true` please\n\n表格布局方式,`
` 元素原生属性。[MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout)。注意,在列宽调整下场景只能使用 `fixed` 模式\n\ndefault: fixed\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-table/table-layout": {
+ "type": "String",
+ "options": [
+ "auto",
+ "fixed"
+ ],
+ "description": "table-layout css properties, [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout). set value to be `fixed` on `resizable=true` please\n\n表格布局方式,`` 元素原生属性。[MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout)。注意,在列宽调整下场景只能使用 `fixed` 模式\n\ndefault: fixed\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-base-table/vertical-align": {
+ "type": "String",
+ "options": [
+ "top",
+ "middle",
+ "bottom"
+ ],
+ "description": "vertical align\n\n行内容上下方向对齐\n\ndefault: middle\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-table/vertical-align": {
+ "type": "String",
+ "options": [
+ "top",
+ "middle",
+ "bottom"
+ ],
+ "description": "vertical align\n\n行内容上下方向对齐\n\ndefault: middle\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props)"
+ },
+ "t-base-table/cell-click": {
+ "type": "event",
+ "description": "trigger on cell clicked\n\n单元格点击时触发\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-events)"
+ },
+ "t-table/cell-click": {
+ "type": "event",
+ "description": "trigger on cell clicked\n\n单元格点击时触发\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-events)"
+ },
+ "t-base-table/row-click": {
+ "type": "event",
+ "description": "trigger on row click\n\n行点击时触发,泛型 T 指表格数据类型\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-events)"
+ },
+ "t-table/row-click": {
+ "type": "event",
+ "description": "trigger on row click\n\n行点击时触发,泛型 T 指表格数据类型\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-events)"
+ },
+ "t-base-table/scroll": {
+ "type": "event",
+ "description": "trigger on table content scroll\n\n表格内容滚动时触发\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-events)"
+ },
+ "t-table/scroll": {
+ "type": "event",
+ "description": "trigger on table content scroll\n\n表格内容滚动时触发\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-events)"
+ },
"t-button/block": {
"type": "Boolean",
"description": "make button to be a block-level element\n\n是否为块级元素\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/button?tab=api#button-props)"
@@ -344,6 +506,14 @@
"type": "Object",
"description": "用来定义 value / label 在 `options` 中对应的字段别名\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props)"
},
+ "t-cascader/lazy": {
+ "type": "Boolean",
+ "description": "是否异步加载\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props)"
+ },
+ "t-cascader/load-completed": {
+ "type": "Boolean",
+ "description": "是否完成异步加载\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props)"
+ },
"t-cascader/options": {
"type": "Array",
"description": "可选项数据源\n\ndefault: []\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props)"
@@ -457,6 +627,10 @@
"type": "Boolean",
"description": "标签选中的状态,默认风格(theme=default)才有选中态\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/check-tag?tab=api#checktag-props)"
},
+ "t-check-tag/checked-props": {
+ "type": "Object",
+ "description": "used to set checked tag props\n\n透传标签选中态属性\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/check-tag?tab=api#checktag-props)"
+ },
"t-check-tag/closable": {
"type": "Boolean",
"description": "标签是否可关闭\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/check-tag?tab=api#checktag-props)"
@@ -495,6 +669,10 @@
],
"description": "标签尺寸\n\ndefault: medium\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/check-tag?tab=api#checktag-props)"
},
+ "t-check-tag/unchecked-props": {
+ "type": "Object",
+ "description": "used to set unchecked tag props\n\n透传标签未选态属性\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/check-tag?tab=api#checktag-props)"
+ },
"t-check-tag/variant": {
"type": "String",
"options": [
@@ -513,6 +691,14 @@
"type": "event",
"description": "点击标签时触发\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/check-tag?tab=api#checktag-events)"
},
+ "t-check-tag-group/checked-props": {
+ "type": "Object",
+ "description": "used to set checked tag props\n\n透传标签选中态属性\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/check-tag-group?tab=api#checktaggroup-props)"
+ },
+ "t-check-tag-group/unchecked-props": {
+ "type": "Object",
+ "description": "used to set unchecked tag props\n\n透传标签未选态属性\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/check-tag-group?tab=api#checktaggroup-props)"
+ },
"t-checkbox/block": {
"type": "Boolean",
"description": "是否为块级元素\n\ndefault: true\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-props)"
@@ -681,6 +867,10 @@
"type": "String|TNode",
"description": "面板头内容\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/collapse-panel?tab=api#collapsepanel-props)"
},
+ "t-collapse-panel/header-left-icon": {
+ "type": "String|TNode",
+ "description": "面板头左侧图标\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/collapse-panel?tab=api#collapsepanel-props)"
+ },
"t-collapse-panel/header-right-content": {
"type": "String|TNode",
"description": "面板头的右侧区域,一般用于呈现面板操作\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/collapse-panel?tab=api#collapsepanel-props)"
@@ -889,6 +1079,10 @@
"type": "String|Object|TNode",
"description": "确认按钮。值为 null 则不显示确认按钮。值类型为字符串,则表示自定义按钮文本,值类型为 Object 则表示透传 Button 组件属性。使用 TNode 自定义按钮时,需自行控制确认事件\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props)"
},
+ "t-dialog/confirm-loading": {
+ "type": "Boolean",
+ "description": "confirm button loading status\n\n确认按钮加载状态\n\ndefault: undefined\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props)"
+ },
"t-dialog/content": {
"type": "String|TNode",
"description": "内容\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props)"
@@ -1055,9 +1249,13 @@
"description": "选项排列;不再支持 tree 布局,可与 treeSelect 配合使用\n\ndefault: columns\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/dropdown-item?tab=api#dropdownitem-props)"
},
"t-dropdown-item/value": {
- "type": "String|Number",
+ "type": "String|Number|Array",
"description": "选中值\n\ndefault: undefined\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/dropdown-item?tab=api#dropdownitem-props)"
},
+ "t-dropdown-item/visible": {
+ "type": "Boolean",
+ "description": "是否展示\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/dropdown-item?tab=api#dropdownitem-props)"
+ },
"t-dropdown-item/change": {
"type": "event",
"description": "值改变时触发\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/dropdown-item?tab=api#dropdownitem-events)"
@@ -1088,15 +1286,15 @@
},
"t-empty/action": {
"type": "TNode",
- "description": "操作按钮\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/empty?tab=api#empty-props)"
+ "description": "action block\n\n操作区域\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/empty?tab=api#empty-props)"
},
"t-empty/description": {
"type": "String|TNode",
- "description": "描述文字\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/empty?tab=api#empty-props)"
+ "description": "empty component description\n\n描述文字\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/empty?tab=api#empty-props)"
},
"t-empty/image": {
"type": "String|TNode",
- "description": "图片地址\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/empty?tab=api#empty-props)"
+ "description": "image url, or Image component props, or custom any node you need.\n\n组件图片,可以完全自定义内容。值类型为字符串时,表示图片地址;值类型为对象时,则表示透传全部属性到图片组件,示例:``\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/empty?tab=api#empty-props)"
},
"t-fab/button-props": {
"type": "Object",
@@ -1250,7 +1448,7 @@
"description": "可以整体设置标签宽度,优先级高于 Form.labelWidth\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/form-item?tab=api#formitem-props)"
},
"t-form-item/name": {
- "type": "String|Number",
+ "type": "String",
"description": "表单字段名称\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/form-item?tab=api#formitem-props)"
},
"t-form-item/required-mark": {
@@ -1432,7 +1630,7 @@
"strict-origin-when-cross-origin",
"unsafe-url"
],
- "description": "attribute of ``, [MDN Definition](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy)\n\n`` 标签的原生属性,[MDN 定义](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy)\n\ndefault: strict-origin-when-cross-origin\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/image?tab=api#image-props)"
+ "description": "attribute of ``, [MDN Definition](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy)\n\n`` 标签的原生属性,[MDN 定义](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy)\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/image?tab=api#image-props)"
},
"t-image/shape": {
"type": "String",
@@ -1469,7 +1667,7 @@
},
"t-image-viewer/index": {
"type": "Number",
- "description": "当前预览图片所在的下标\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/image-viewer?tab=api#imageviewer-props)"
+ "description": "当前预览图片所在的下标\n\ndefault: 0\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/image-viewer?tab=api#imageviewer-props)"
},
"t-image-viewer/max-zoom": {
"type": "Number",
@@ -1481,7 +1679,7 @@
},
"t-image-viewer/visible": {
"type": "Boolean",
- "description": "隐藏/显示预览\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/image-viewer?tab=api#imageviewer-props)"
+ "description": "hide or show image viewer\n\n隐藏/显示预览\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/image-viewer?tab=api#imageviewer-props)"
},
"t-image-viewer/close": {
"type": "event",
@@ -1530,27 +1728,31 @@
"center",
"right"
],
- "description": "文本内容位置,居左/居中/居右\n\ndefault: left\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
+ "description": "text align type\n\n文本内容位置,居左/居中/居右\n\ndefault: left\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
},
"t-input/allow-input-over-max": {
"type": "Boolean",
- "description": "超出 `maxlength` 或 `maxcharacter` 之后是否允许继续输入\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
+ "description": "allow to continue input on value length is over `maxlength` or `maxcharacter`\n\n超出 `maxlength` 或 `maxcharacter` 之后是否允许继续输入\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
},
"t-input/autocomplete": {
"type": "String",
- "description": "是否开启自动填充功能,HTML5 原生属性,[点击查看详情](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete)\n\ndefault: undefined\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
+ "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)\n\ndefault: undefined\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
},
"t-input/autofocus": {
"type": "Boolean",
- "description": "自动聚焦\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
+ "description": "autofocus on first rendered\n\n自动聚焦\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
+ },
+ "t-input/borderless": {
+ "type": "Boolean",
+ "description": "input without border\n\n【开发中】无边框模式\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
},
"t-input/clearable": {
"type": "Boolean",
- "description": "是否可清空\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
+ "description": "show clear icon, clicked to clear input value\n\n是否可清空\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
},
"t-input/disabled": {
"type": "Boolean",
- "description": "是否禁用输入框\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
+ "description": "make input to be disabled\n\n是否禁用输入框\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
},
"t-input/error-message": {
"type": "String",
@@ -1558,18 +1760,18 @@
},
"t-input/format": {
"type": "Function",
- "description": "指定输入框展示值的格式\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
+ "description": "input value formatter, `type=number` does not work. if you need to format number, `InputNumber` Component might be better\n\n指定输入框展示值的格式。注意 `type=number` 时请勿使用,此功能建议更为使用 `InputNumber` 组件\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
},
"t-input/label": {
"type": "String|TNode",
- "description": "左侧文本\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
+ "description": "text on the left of input\n\n左侧文本\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
},
"t-input/maxcharacter": {
"type": "Number",
"description": "用户最多可以输入的字符个数,一个中文汉字表示两个字符长度。`maxcharacter` 和 `maxlength` 二选一使用\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
},
"t-input/maxlength": {
- "type": "Number",
+ "type": "String|Number",
"description": "用户最多可以输入的文本长度,一个中文等于一个计数长度。值为空,则表示不限制输入长度。`maxcharacter` 和 `maxlength` 二选一使用\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
},
"t-input/name": {
@@ -1608,15 +1810,15 @@
},
"t-input/suffix": {
"type": "String|TNode",
- "description": "后置图标前的后置内容\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
+ "description": "suffix content before suffixIcon\n\n后置图标前的后置内容\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
},
"t-input/suffix-icon": {
"type": "TNode",
- "description": "组件后置图标\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
+ "description": "suffix icon of input\n\n组件后置图标\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
},
"t-input/tips": {
"type": "String|TNode",
- "description": "输入框下方提示文本,会根据不同的 `status` 呈现不同的样式\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
+ "description": "tips on the bottom of input, different `status` can make tips to be different color\n\n输入框下方提示文本,会根据不同的 `status` 呈现不同的样式\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
},
"t-input/type": {
"type": "String",
@@ -1630,11 +1832,11 @@
"submit",
"hidden"
],
- "description": "输入框类型\n\ndefault: text\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
+ "description": "type attribute of input element. if you are using `type=number`, `InputNumber` Component might be better\n\n输入框类型。`type=number` 仅支持最基础的数字输入功能,更多功能建议使用 `InputNumber` 组件\n\ndefault: text\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
},
"t-input/value": {
- "type": "String",
- "description": "输入框的值\n\ndefault: ''\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
+ "type": "String|Number",
+ "description": "input value\n\n输入框的值\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props)"
},
"t-input/blur": {
"type": "event",
@@ -1642,7 +1844,7 @@
},
"t-input/change": {
"type": "event",
- "description": "输入框值发生变化时触发。`trigger=initial` 表示传入的数据不符合预期,组件自动处理后触发 change 告知父组件。如:初始值长度超过 `maxlength` 限制\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-events)"
+ "description": "trigger on input value changed\n\n输入框值发生变化时触发。参数 `trigger=initial` 表示传入的数据不符合预期,组件自动处理后触发 change 告知父组件。如:初始值长度超过 `maxlength` 限制\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-events)"
},
"t-input/clear": {
"type": "event",
@@ -1784,10 +1986,6 @@
"type": "Boolean",
"description": "是否暂停动画\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/loading?tab=api#loading-props)"
},
- "t-loading/progress": {
- "type": "Number",
- "description": "加载进度\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/loading?tab=api#loading-props)"
- },
"t-loading/reverse": {
"type": "Boolean",
"description": "加载动画是否反向\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/loading?tab=api#loading-props)"
@@ -1903,6 +2101,10 @@
"type": "String",
"description": "background\n\n已废弃。背景\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-props)"
},
+ "t-navbar/capsule": {
+ "type": "TNode",
+ "description": "左侧胶囊区域\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-props)"
+ },
"t-navbar/fixed": {
"type": "Boolean",
"description": "是否固定在顶部\n\ndefault: true\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-props)"
@@ -1913,7 +2115,7 @@
},
"t-navbar/left-arrow": {
"type": "Boolean",
- "description": "是否显示左侧箭头\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-props)"
+ "description": "是否展示左侧箭头\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-props)"
},
"t-navbar/right": {
"type": "String|TNode",
@@ -2212,7 +2414,7 @@
},
"t-popup/close": {
"type": "event",
- "description": "组件准备关闭时触发\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/popup?tab=api#popup-events)"
+ "description": "组件开始关闭时触发\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/popup?tab=api#popup-events)"
},
"t-popup/closed": {
"type": "event",
@@ -2230,6 +2432,30 @@
"type": "event",
"description": "当浮层隐藏或显示时触发\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/popup?tab=api#popup-events)"
},
+ "t-primary-table/row-selection-allow-uncheck": {
+ "type": "Boolean",
+ "description": "allow to uncheck selection in table with single row selection\n\n行选中单选场景,是否允许取消选中\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/primary-table?tab=api#primarytable-props)"
+ },
+ "t-table/row-selection-allow-uncheck": {
+ "type": "Boolean",
+ "description": "allow to uncheck selection in table with single row selection\n\n行选中单选场景,是否允许取消选中\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/primary-table?tab=api#primarytable-props)"
+ },
+ "t-primary-table/row-selection-type": {
+ "type": "String",
+ "options": [
+ "single",
+ "multiple"
+ ],
+ "description": "single row selection, or multiple row selection\n\n行选中类型,单选或多选。效果和 `columns` 中配置的 `{ colKey: 'row-select', type: 'single' }` 一样\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/primary-table?tab=api#primarytable-props)"
+ },
+ "t-table/row-selection-type": {
+ "type": "String",
+ "options": [
+ "single",
+ "multiple"
+ ],
+ "description": "single row selection, or multiple row selection\n\n行选中类型,单选或多选。效果和 `columns` 中配置的 `{ colKey: 'row-select', type: 'single' }` 一样\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/primary-table?tab=api#primarytable-props)"
+ },
"t-progress/color": {
"type": "String|Object|Array",
"description": "进度条颜色。示例:'#ED7B2F' 或 'orange' 或 `['#f00', '#0ff', '#f0f']` 或 `{ '0%': '#f00', '100%': '#0ff' }` 或 `{ from: '#000', to: '#000' }` 等\n\ndefault: ''\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/progress?tab=api#progress-props)"
@@ -2301,6 +2527,10 @@
"type": "event",
"description": "结束下拉时触发\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/pull-down-refresh?tab=api#pulldownrefresh-events)"
},
+ "t-pull-down-refresh/scrolltolower": {
+ "type": "event",
+ "description": "滚动到页面底部时触发\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/pull-down-refresh?tab=api#pulldownrefresh-events)"
+ },
"t-pull-down-refresh/timeout": {
"type": "event",
"description": "刷新超时触发\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/pull-down-refresh?tab=api#pulldownrefresh-events)"
@@ -2431,7 +2661,7 @@
"left",
"right"
],
- "description": "复选框和内容相对位置\n\ndefault: left\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radio-props)"
+ "description": "复选框和内容相对位置\n\ndefault: undefined\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radio-props)"
},
"t-radio-button/placement": {
"type": "String",
@@ -2439,7 +2669,7 @@
"left",
"right"
],
- "description": "复选框和内容相对位置\n\ndefault: left\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radio-props)"
+ "description": "复选框和内容相对位置\n\ndefault: undefined\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/radio?tab=api#radio-props)"
},
"t-radio/value": {
"type": "String|Number|Boolean",
@@ -2469,6 +2699,10 @@
"type": "Boolean",
"description": "是否禁用全部子单选框。默认为 false。RadioGroup.disabled 优先级低于 Radio.disabled\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/radio-group?tab=api#radiogroup-props)"
},
+ "t-radio-group/icon": {
+ "type": "String|Array",
+ "description": "自定义选中图标和非选中图标。示例:[选中态图标地址,非选中态图标地址]。使用 String 时,值为 circle 表示填充型图标、值为 line 表示描边型图标、值为 dot 表示圆点图标\n\ndefault: 'circle'\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/radio-group?tab=api#radiogroup-props)"
+ },
"t-radio-group/keys": {
"type": "Object",
"description": "用来定义 value / label 在 `options` 中对应的字段别名\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/radio-group?tab=api#radiogroup-props)"
@@ -2783,6 +3017,38 @@
"type": "Object",
"description": "透传 Tag 标签组件全部属性\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/select?tab=api#select-props)"
},
+ "t-side-bar/value": {
+ "type": "String|Number",
+ "description": "选项值\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/side-bar?tab=api#sidebar-props)"
+ },
+ "t-side-bar/change": {
+ "type": "event",
+ "description": "选项值发生变化时触发\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/side-bar?tab=api#sidebar-events)"
+ },
+ "t-side-bar/click": {
+ "type": "event",
+ "description": "点击选项时触发\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/side-bar?tab=api#sidebar-events)"
+ },
+ "t-side-bar-item/badge-props": {
+ "type": "Object",
+ "description": "透传至 Badge 组件\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/side-bar-item?tab=api#sidebaritem-props)"
+ },
+ "t-side-bar-item/disabled": {
+ "type": "Boolean",
+ "description": "是否禁用\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/side-bar-item?tab=api#sidebaritem-props)"
+ },
+ "t-side-bar-item/icon": {
+ "type": "TNode",
+ "description": "图标\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/side-bar-item?tab=api#sidebaritem-props)"
+ },
+ "t-side-bar-item/label": {
+ "type": "String",
+ "description": "展示的标签\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/side-bar-item?tab=api#sidebaritem-props)"
+ },
+ "t-side-bar-item/value": {
+ "type": "String|Number",
+ "description": "当前选项的值\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/side-bar-item?tab=api#sidebaritem-props)"
+ },
"t-skeleton/animation": {
"type": "String",
"options": [
@@ -2914,6 +3180,10 @@
],
"description": "当前步骤的状态:默认状态(未开始)、进行中状态、完成状态、错误状态\n\ndefault: default\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/step-item?tab=api#stepitem-props)"
},
+ "t-step-item/sub-step-items": {
+ "type": "Array",
+ "description": "子步骤条,仅支持 layout = 'vertical' 时\n\ndefault: []\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/step-item?tab=api#stepitem-props)"
+ },
"t-step-item/title": {
"type": "String|TNode",
"description": "标题\n\ndefault: ''\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/step-item?tab=api#stepitem-props)"
@@ -2980,6 +3250,16 @@
"type": "String|Number",
"description": "当前步骤,即整个步骤条进度。默认根据步骤下标判断步骤的完成状态,当前步骤为进行中,当前步骤之前的步骤为已完成,当前步骤之后的步骤为未开始。如果每个步骤没有设置 value,current 值为步骤长度则表示所有步骤已完成。如果每个步骤设置了自定义 value,则 current = 'FINISH' 表示所有状态完成\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/steps?tab=api#steps-props)"
},
+ "t-steps/current-status": {
+ "type": "String",
+ "options": [
+ "default",
+ "process",
+ "finish",
+ "error"
+ ],
+ "description": "用于控制 current 指向的步骤条的状态\n\ndefault: process\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/steps?tab=api#steps-props)"
+ },
"t-steps/layout": {
"type": "String",
"options": [
@@ -3067,20 +3347,12 @@
},
"t-swipe-cell/default": {
"type": "String|TNode",
- "description": "子内容,同 content\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/swipe-cell?tab=api#swipecell-props)"
+ "description": "操作项以外的内容,同 content\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/swipe-cell?tab=api#swipecell-props)"
},
"t-swipe-cell/disabled": {
"type": "Boolean",
"description": "是否禁用滑动\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/swipe-cell?tab=api#swipecell-props)"
},
- "t-swipe-cell/expanded": {
- "type": "String",
- "options": [
- "left",
- "right"
- ],
- "description": "操作项是否呈现为打开态\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/swipe-cell?tab=api#swipecell-props)"
- },
"t-swipe-cell/left": {
"type": "Array|TNode",
"description": "左侧滑动操作项。所有行为同 `right`\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/swipe-cell?tab=api#swipecell-props)"
@@ -3345,10 +3617,6 @@
],
"description": "组件尺寸\n\ndefault: medium\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabs-props)"
},
- "t-tabs/space-evenly": {
- "type": "Boolean",
- "description": "选项卡头部空间是否均分\n\ndefault: true\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabs-props)"
- },
"t-tabs/sticky": {
"type": "Boolean",
"description": "是否开启粘性布局\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabs-props)"
@@ -3491,7 +3759,7 @@
"description": "用户最多可以输入的字符个数,一个中文汉字表示两个字符长度\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/textarea?tab=api#textarea-props)"
},
"t-textarea/maxlength": {
- "type": "Number",
+ "type": "String|Number",
"description": "用户最多可以输入的字符个数\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/textarea?tab=api#textarea-props)"
},
"t-textarea/name": {
@@ -3587,6 +3855,10 @@
],
"description": "标签信息相对于时间轴的位置,在 `mode='alternate'` 时生效,优先级高于 `Timeline.labelAlign`\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/timeline-item?tab=api#timelineitem-props)"
},
+ "t-timeline-item/click": {
+ "type": "event",
+ "description": "trigger on click\n\n点击时触发\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/timeline-item?tab=api#timelineitem-events)"
+ },
"t-toast/direction": {
"type": "String",
"options": [
@@ -3663,7 +3935,7 @@
},
"t-tree-select/keys": {
"type": "Object",
- "description": "用来定义 `value / label / children` 在 `data` 数据中对应的字段别名,示例:`{ value: 'key', label 'name', children: 'list' }`\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/tree-select?tab=api#treeselect-props)"
+ "description": "alias filed name in data\n\n用来定义 `value / label / disabled / children` 在 `data` 数据中对应的字段别名,示例:`{ value: 'key', label: 'name', children: 'list' }`\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/tree-select?tab=api#treeselect-props)"
},
"t-tree-select/multiple": {
"type": "Boolean",
@@ -3710,6 +3982,10 @@
"type": "String",
"description": "Uploading URL\n\n上传接口。设接口响应数据为字段 `response`,那么 `response.error` 存在时会判断此次上传失败,并显示错误文本信息;`response.url` 会作为文件上传成功后的地址,并使用该地址显示图片或文件\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props)"
},
+ "t-upload/add-content": {
+ "type": "String|TNode",
+ "description": "添加按钮内容。值为空,使用默认图标渲染;值为 slot 则表示使用插槽渲染;其他值无效。\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props)"
+ },
"t-upload/allow-upload-duplicate-file": {
"type": "Boolean",
"description": "allow to upload duplicate name files\n\n是否允许重复上传相同文件名的文件\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props)"
@@ -3744,11 +4020,11 @@
},
"t-upload/format-request": {
"type": "Function",
- "description": "redefine request data\n\n用于新增或修改文件上传请求参数。`action` 存在时有效。一个请求上传一个文件时,默认请求字段有 `file`;
一个请求上传多个文件时,默认字段有 `file[0]/file[1]/file[2]/.../length`,其中 `length` 表示本次上传的文件数量。
⚠️非常注意,此处的 `file[0]/file[1]` 仅仅是一个字段名,并非表示 `file` 是一个数组,接口获取字段时注意区分。
可以使用 `name` 定义 `file` 字段的别名,也可以使用 `formatRequest` 自定义任意字段\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props)"
+ "description": "redefine request data\n\n用于新增或修改文件上传请求 参数。`action` 存在时有效。一个请求上传一个文件时,默认请求字段有 `file`。
一个请求上传多个文件时,默认字段有 `file[0]/file[1]/file[2]/.../length`,其中 `length` 表示本次上传的文件数量。
⚠️非常注意,此处的 `file[0]/file[1]` 仅仅是一个字段名,并非表示 `file` 是一个数组,接口获取字段时注意区分。
可以使用 `name` 定义 `file` 字段的别名。
也可以使用 `formatRequest` 自定义任意字段,如添加一个字段 `fileList` ,存储文件数组\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props)"
},
"t-upload/format-response": {
"type": "Function",
- "description": "redefine response data structure\n\n用于格式化文件上传后的接口响应数据,`response` 便是接口响应的原始数据。`action` 存在时有效。
此函数的返回值 `error` 或 `response.error` 会作为错误文本提醒,如果存在会判定为本次上传失败。
此函数的返回值 `url` 或 `response.url` 会作为上传成功后的链接\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props)"
+ "description": "redefine response data structure\n\n用于格式化文件上传后的接口响应数据,`response` 便是接口响应的原始数据。`action` 存在时有效。
示例返回值:`{ error, url, status, files }`
此函数的返回值 `error` 会作为错误文本提醒,表示上传失败的原因,如果存在会判定为本次上传失败。
此函数的返回值 `url` 会作为单个文件上传成功后的链接。
`files` 表示一个请求同时上传多个文件后的文件列表\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props)"
},
"t-upload/headers": {
"type": "Object",
@@ -3760,7 +4036,7 @@
},
"t-upload/max": {
"type": "Number",
- "description": "max count of files limit\n\n用于控制文件上传数量,值为 0 则不限制\n\ndefault: 0\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props)"
+ "description": "max count of files limit\n\n用于控制文件上传数量,值为 0 则不限制。注意,单文件上传场景,请勿设置 `max` 属性\n\ndefault: 0\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props)"
},
"t-upload/method": {
"type": "String",
@@ -3794,6 +4070,10 @@
"type": "Boolean",
"description": "use mock progress, instead of real progress\n\n是否在请求时间超过 300ms 后显示模拟进度。上传进度有模拟进度和真实进度两种。一般大小的文件上传,真实的上传进度只有 0 和 100,不利于交互呈现,因此组件内置模拟上传进度。真实上传进度一般用于大文件上传。\n\ndefault: true\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props)"
},
+ "t-upload/value": {
+ "type": "Array",
+ "description": "file list\n\n已上传文件列表,同 `files`。TS 类型:`UploadFile`\n\ndefault: []\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props)"
+ },
"t-upload/with-credentials": {
"type": "Boolean",
"description": "uploading request with cookie\n\n上传请求时是否携带 cookie\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props)"
diff --git a/helper/tags.json b/helper/tags.json
index ac2e22842..bb4136308 100644
--- a/helper/tags.json
+++ b/helper/tags.json
@@ -65,6 +65,36 @@
],
"description": "Badge\n\n徽标数\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/badge)"
},
+ "t-base-table": {
+ "attributes": [
+ "bordered",
+ "cell-empty-content",
+ "columns",
+ "data",
+ "empty",
+ "fixed-rows",
+ "height",
+ "loading",
+ "max-height",
+ "row-key",
+ "show-header",
+ "stripe",
+ "table-content-width",
+ "table-layout",
+ "vertical-align",
+ "cell-click",
+ "row-click",
+ "scroll"
+ ],
+ "description": "BaseTable\n\n基础表格\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/base-table)"
+ },
+ "t-table": {
+ "attributes": [
+ "row-selection-allow-uncheck",
+ "row-selection-type"
+ ],
+ "description": "PrimaryTable\n\n主表格\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/primary-table)"
+ },
"t-button": {
"attributes": [
"block",
@@ -108,6 +138,8 @@
"attributes": [
"close-btn",
"keys",
+ "lazy",
+ "load-completed",
"options",
"sub-titles",
"theme",
@@ -148,6 +180,7 @@
"t-check-tag": {
"attributes": [
"checked",
+ "checked-props",
"closable",
"content",
"default",
@@ -155,12 +188,20 @@
"icon",
"shape",
"size",
+ "unchecked-props",
"variant",
"change",
"click"
],
"description": "CheckTag\n\n可选标签\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/check-tag)"
},
+ "t-check-tag-group": {
+ "attributes": [
+ "checked-props",
+ "unchecked-props"
+ ],
+ "description": "CheckTagGroup\n\n可选标签组\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/check-tag-group)"
+ },
"t-checkbox": {
"attributes": [
"block",
@@ -223,6 +264,7 @@
"disabled",
"expand-icon",
"header",
+ "header-left-icon",
"header-right-content",
"placement",
"value"
@@ -299,6 +341,7 @@
"cancel-btn",
"close-on-overlay-click",
"confirm-btn",
+ "confirm-loading",
"content",
"destroy-on-close",
"overlay-props",
@@ -353,6 +396,7 @@
"options-columns",
"options-layout",
"value",
+ "visible",
"change",
"confirm",
"reset"
@@ -535,6 +579,7 @@
"allow-input-over-max",
"autocomplete",
"autofocus",
+ "borderless",
"clearable",
"disabled",
"error-message",
@@ -606,7 +651,6 @@
"layout",
"loading",
"pause",
- "progress",
"reverse",
"size",
"text",
@@ -642,6 +686,7 @@
"attributes": [
"animation",
"background",
+ "capsule",
"fixed",
"left",
"left-arrow",
@@ -757,6 +802,13 @@
],
"description": "Popup\n\n气泡框\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/popup)"
},
+ "t-primary-table": {
+ "attributes": [
+ "row-selection-allow-uncheck",
+ "row-selection-type"
+ ],
+ "description": "PrimaryTable\n\n主表格\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/primary-table)"
+ },
"t-progress": {
"attributes": [
"color",
@@ -779,6 +831,7 @@
"value",
"change",
"refresh",
+ "scrolltolower",
"timeout"
],
"description": "PullDownRefresh\n\n下拉刷新\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/pull-down-refresh)"
@@ -832,6 +885,7 @@
"allow-uncheck",
"borderless",
"disabled",
+ "icon",
"keys",
"name",
"options",
@@ -947,6 +1001,24 @@
],
"description": "Select\n\n选择器\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/select)"
},
+ "t-side-bar": {
+ "attributes": [
+ "value",
+ "change",
+ "click"
+ ],
+ "description": "SideBar\n\n侧边导航\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/side-bar)"
+ },
+ "t-side-bar-item": {
+ "attributes": [
+ "badge-props",
+ "disabled",
+ "icon",
+ "label",
+ "value"
+ ],
+ "description": "SideBarItem\n\n侧边导航项\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/side-bar-item)"
+ },
"t-skeleton": {
"attributes": [
"animation",
@@ -984,11 +1056,16 @@
],
"description": "Space\n\n间距\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/space)"
},
+ "t-statistic": {
+ "attributes": [],
+ "description": "Statistic\n\n统计数值\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/statistic)"
+ },
"t-step-item": {
"attributes": [
"content",
"icon",
"status",
+ "sub-step-items",
"title"
],
"description": "StepItem\n\n步骤\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/step-item)"
@@ -1013,6 +1090,7 @@
"t-steps": {
"attributes": [
"current",
+ "current-status",
"layout",
"options",
"readonly",
@@ -1045,7 +1123,6 @@
"content",
"default",
"disabled",
- "expanded",
"left",
"opened",
"right",
@@ -1138,7 +1215,6 @@
"list",
"show-bottom-line",
"size",
- "space-evenly",
"sticky",
"sticky-props",
"swipeable",
@@ -1209,7 +1285,8 @@
"dot",
"dot-color",
"label",
- "label-align"
+ "label-align",
+ "click"
],
"description": "TimelineItem\n\n时间轴\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/timeline-item)"
},
@@ -1256,6 +1333,7 @@
"attributes": [
"accept",
"action",
+ "add-content",
"allow-upload-duplicate-file",
"auto-upload",
"before-upload",
@@ -1274,6 +1352,7 @@
"request-method",
"size-limit",
"use-mock-progress",
+ "value",
"with-credentials",
"change",
"fail",
diff --git a/helper/web-types.json b/helper/web-types.json
index 1018c0e5d..866af214d 100644
--- a/helper/web-types.json
+++ b/helper/web-types.json
@@ -528,6 +528,428 @@
}
]
},
+ {
+ "name": "t-base-table",
+ "source": {
+ "symbol": "BaseTable"
+ },
+ "description": "BaseTable\n\n基础表格",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/base-table",
+ "props": [
+ {
+ "name": "bordered",
+ "description": "show table bordered\n\n是否显示表格边框",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props",
+ "type": [
+ "Boolean"
+ ],
+ "default": "false"
+ },
+ {
+ "name": "cell-empty-content",
+ "description": "单元格数据为空时呈现的内容",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props",
+ "type": [
+ "String",
+ "TNode"
+ ]
+ },
+ {
+ "name": "columns",
+ "description": "table column configs\n\n列配置,泛型 T 指表格数据类型",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props",
+ "type": [
+ "Array"
+ ],
+ "default": "[]"
+ },
+ {
+ "name": "data",
+ "description": "table data\n\n数据源,泛型 T 指表格数据类型",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props",
+ "type": [
+ "Array"
+ ],
+ "default": "[]"
+ },
+ {
+ "name": "empty",
+ "description": "empty text or empty element\n\n空表格呈现样式,支持全局配置 `GlobalConfigProvider`",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/base-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/base-table?tab=api#basetable-props",
+ "type": [
+ "Array"
+ ]
+ },
+ {
+ "name": "height",
+ "description": "table height\n\n表格高度,超出后会出现滚动条。示例:100, '30%', '300'。值为数字类型,会自动加上单位 px。如果不是绝对固定表格高度,建议使用 `maxHeight`",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/base-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/base-table?tab=api#basetable-props",
+ "type": [
+ "Boolean",
+ "TNode"
+ ],
+ "default": "undefined"
+ },
+ {
+ "name": "max-height",
+ "description": "table max height\n\n表格最大高度,超出后会出现滚动条。示例:100, '30%', '300'。值为数字类型,会自动加上单位 px",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props",
+ "type": [
+ "String",
+ "Number"
+ ]
+ },
+ {
+ "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/base-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/base-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/base-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/base-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表格布局方式,`` 元素原生属性。[MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout)。注意,在列宽调整下场景只能使用 `fixed` 模式",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props",
+ "type": [
+ "String"
+ ],
+ "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/base-table?tab=api#basetable-props",
+ "type": [
+ "String"
+ ],
+ "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/base-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/base-table?tab=api#basetable-events"
+ },
+ {
+ "name": "scroll",
+ "description": "trigger on table content scroll\n\n表格内容滚动时触发",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-events"
+ }
+ ]
+ },
+ "slots": [
+ {
+ "name": "cellEmptyContent",
+ "description": "单元格数据为空时呈现的内容类型和参数:string | TNode>",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props"
+ },
+ {
+ "name": "cell-empty-content",
+ "description": "单元格数据为空时呈现的内容类型和参数:string | TNode>",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/base-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/base-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/base-table?tab=api#basetable-props"
+ }
+ ]
+ },
+ {
+ "name": "t-table",
+ "source": {
+ "symbol": "BaseTable"
+ },
+ "description": "BaseTable\n\n基础表格",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/base-table",
+ "props": [
+ {
+ "name": "bordered",
+ "description": "show table bordered\n\n是否显示表格边框",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props",
+ "type": [
+ "Boolean"
+ ],
+ "default": "false"
+ },
+ {
+ "name": "cell-empty-content",
+ "description": "单元格数据为空时呈现的内容",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props",
+ "type": [
+ "String",
+ "TNode"
+ ]
+ },
+ {
+ "name": "columns",
+ "description": "table column configs\n\n列配置,泛型 T 指表格数据类型",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props",
+ "type": [
+ "Array"
+ ],
+ "default": "[]"
+ },
+ {
+ "name": "data",
+ "description": "table data\n\n数据源,泛型 T 指表格数据类型",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props",
+ "type": [
+ "Array"
+ ],
+ "default": "[]"
+ },
+ {
+ "name": "empty",
+ "description": "empty text or empty element\n\n空表格呈现样式,支持全局配置 `GlobalConfigProvider`",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/base-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/base-table?tab=api#basetable-props",
+ "type": [
+ "Array"
+ ]
+ },
+ {
+ "name": "height",
+ "description": "table height\n\n表格高度,超出后会出现滚动条。示例:100, '30%', '300'。值为数字类型,会自动加上单位 px。如果不是绝对固定表格高度,建议使用 `maxHeight`",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/base-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/base-table?tab=api#basetable-props",
+ "type": [
+ "Boolean",
+ "TNode"
+ ],
+ "default": "undefined"
+ },
+ {
+ "name": "max-height",
+ "description": "table max height\n\n表格最大高度,超出后会出现滚动条。示例:100, '30%', '300'。值为数字类型,会自动加上单位 px",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props",
+ "type": [
+ "String",
+ "Number"
+ ]
+ },
+ {
+ "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/base-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/base-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/base-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/base-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表格布局方式,`` 元素原生属性。[MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout)。注意,在列宽调整下场景只能使用 `fixed` 模式",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props",
+ "type": [
+ "String"
+ ],
+ "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/base-table?tab=api#basetable-props",
+ "type": [
+ "String"
+ ],
+ "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/base-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/base-table?tab=api#basetable-events"
+ },
+ {
+ "name": "scroll",
+ "description": "trigger on table content scroll\n\n表格内容滚动时触发",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-events"
+ }
+ ]
+ },
+ "slots": [
+ {
+ "name": "cellEmptyContent",
+ "description": "单元格数据为空时呈现的内容类型和参数:string | TNode>",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/base-table?tab=api#basetable-props"
+ },
+ {
+ "name": "cell-empty-content",
+ "description": "单元格数据为空时呈现的内容类型和参数:string | TNode>",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/base-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/base-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/base-table?tab=api#basetable-props"
+ }
+ ]
+ },
{
"name": "t-button",
"source": {
@@ -949,6 +1371,24 @@
"Object"
]
},
+ {
+ "name": "lazy",
+ "description": "是否异步加载",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props",
+ "type": [
+ "Boolean"
+ ],
+ "default": "false"
+ },
+ {
+ "name": "load-completed",
+ "description": "是否完成异步加载",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/cascader?tab=api#cascader-props",
+ "type": [
+ "Boolean"
+ ],
+ "default": "false"
+ },
{
"name": "options",
"description": "可选项数据源",
@@ -1286,6 +1726,14 @@
"Boolean"
]
},
+ {
+ "name": "checked-props",
+ "description": "used to set checked tag props\n\n透传标签选中态属性",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/check-tag?tab=api#checktag-props",
+ "type": [
+ "Object"
+ ]
+ },
{
"name": "closable",
"description": "标签是否可关闭",
@@ -1378,6 +1826,14 @@
}
]
},
+ {
+ "name": "unchecked-props",
+ "description": "used to set unchecked tag props\n\n透传标签未选态属性",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/check-tag?tab=api#checktag-props",
+ "type": [
+ "Object"
+ ]
+ },
{
"name": "variant",
"description": "标签风格变体",
@@ -1437,6 +1893,33 @@
}
]
},
+ {
+ "name": "t-check-tag-group",
+ "source": {
+ "symbol": "CheckTagGroup"
+ },
+ "description": "CheckTagGroup\n\n可选标签组",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/check-tag-group",
+ "props": [
+ {
+ "name": "checked-props",
+ "description": "used to set checked tag props\n\n透传标签选中态属性",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/check-tag-group?tab=api#checktaggroup-props",
+ "type": [
+ "Object"
+ ]
+ },
+ {
+ "name": "unchecked-props",
+ "description": "used to set unchecked tag props\n\n透传标签未选态属性",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/check-tag-group?tab=api#checktaggroup-props",
+ "type": [
+ "Object"
+ ]
+ }
+ ],
+ "slots": []
+ },
{
"name": "t-checkbox",
"source": {
@@ -1897,6 +2380,15 @@
"TNode"
]
},
+ {
+ "name": "header-left-icon",
+ "description": "面板头左侧图标",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse-panel?tab=api#collapsepanel-props",
+ "type": [
+ "String",
+ "TNode"
+ ]
+ },
{
"name": "header-right-content",
"description": "面板头的右侧区域,一般用于呈现面板操作",
@@ -1962,6 +2454,16 @@
"description": "面板头内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse-panel?tab=api#collapsepanel-props"
},
+ {
+ "name": "headerLeftIcon",
+ "description": "面板头左侧图标",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse-panel?tab=api#collapsepanel-props"
+ },
+ {
+ "name": "header-left-icon",
+ "description": "面板头左侧图标",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/collapse-panel?tab=api#collapsepanel-props"
+ },
{
"name": "headerRightContent",
"description": "面板头的右侧区域,一般用于呈现面板操作",
@@ -2508,6 +3010,15 @@
"TNode"
]
},
+ {
+ "name": "confirm-loading",
+ "description": "confirm button loading status\n\n确认按钮加载状态",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/dialog?tab=api#dialog-props",
+ "type": [
+ "Boolean"
+ ],
+ "default": "undefined"
+ },
{
"name": "content",
"description": "内容",
@@ -2957,9 +3468,19 @@
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/dropdown-item?tab=api#dropdownitem-props",
"type": [
"String",
- "Number"
+ "Number",
+ "Array"
],
"default": "undefined"
+ },
+ {
+ "name": "visible",
+ "description": "是否展示",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/dropdown-item?tab=api#dropdownitem-props",
+ "type": [
+ "Boolean"
+ ],
+ "default": "false"
}
],
"js": {
@@ -3041,7 +3562,7 @@
"props": [
{
"name": "action",
- "description": "操作按钮",
+ "description": "action block\n\n操作区域",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/empty?tab=api#empty-props",
"type": [
"TNode"
@@ -3049,7 +3570,7 @@
},
{
"name": "description",
- "description": "描述文字",
+ "description": "empty component description\n\n描述文字",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/empty?tab=api#empty-props",
"type": [
"String",
@@ -3058,7 +3579,7 @@
},
{
"name": "image",
- "description": "图片地址",
+ "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",
@@ -3069,17 +3590,17 @@
"slots": [
{
"name": "action",
- "description": "操作按钮",
+ "description": "action block\n\n操作区域",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/empty?tab=api#empty-props"
},
{
"name": "description",
- "description": "描述文字",
+ "description": "empty component description\n\n描述文字",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/empty?tab=api#empty-props"
},
{
"name": "image",
- "description": "图片地址",
+ "description": "image url, or Image component props, or custom any node you need.\n\n组件图片,可以完全自定义内容。值类型为字符串时,表示图片地址;值类型为对象时,则表示透传全部属性到图片组件,示例:``类型和参数:string | ImageProps | TNode 【import { ImageProps } from '@Image'】",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/empty?tab=api#empty-props"
}
]
@@ -3484,8 +4005,7 @@
"description": "表单字段名称",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/form-item?tab=api#formitem-props",
"type": [
- "String",
- "Number"
+ "String"
]
},
{
@@ -3971,7 +4491,6 @@
"type": [
"String"
],
- "default": "strict-origin-when-cross-origin",
"attribute-value": {
"type": "enum"
},
@@ -4113,7 +4632,8 @@
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/image-viewer?tab=api#imageviewer-props",
"type": [
"Number"
- ]
+ ],
+ "default": "0"
},
{
"name": "max-zoom",
@@ -4135,7 +4655,7 @@
},
{
"name": "visible",
- "description": "隐藏/显示预览",
+ "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"
@@ -4275,7 +4795,7 @@
"props": [
{
"name": "align",
- "description": "文本内容位置,居左/居中/居右",
+ "description": "text align type\n\n文本内容位置,居左/居中/居右",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": [
"String"
@@ -4298,7 +4818,7 @@
},
{
"name": "allow-input-over-max",
- "description": "超出 `maxlength` 或 `maxcharacter` 之后是否允许继续输入",
+ "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"
@@ -4307,7 +4827,7 @@
},
{
"name": "autocomplete",
- "description": "是否开启自动填充功能,HTML5 原生属性,[点击查看详情](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/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"
@@ -4316,7 +4836,16 @@
},
{
"name": "autofocus",
- "description": "自动聚焦",
+ "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"
@@ -4325,7 +4854,7 @@
},
{
"name": "clearable",
- "description": "是否可清空",
+ "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"
@@ -4334,7 +4863,7 @@
},
{
"name": "disabled",
- "description": "是否禁用输入框",
+ "description": "make input to be disabled\n\n是否禁用输入框",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": [
"Boolean"
@@ -4350,7 +4879,7 @@
},
{
"name": "format",
- "description": "指定输入框展示值的格式",
+ "description": "input value formatter, `type=number` does not work. if you need to format number, `InputNumber` Component might be better\n\n指定输入框展示值的格式。注意 `type=number` 时请勿使用,此功能建议更为使用 `InputNumber` 组件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": [
"Function"
@@ -4358,7 +4887,7 @@
},
{
"name": "label",
- "description": "左侧文本",
+ "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",
@@ -4378,6 +4907,7 @@
"description": "用户最多可以输入的文本长度,一个中文等于一个计数长度。值为空,则表示不限制输入长度。`maxcharacter` 和 `maxlength` 二选一使用",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": [
+ "String",
"Number"
]
},
@@ -4463,7 +4993,7 @@
},
{
"name": "suffix",
- "description": "后置图标前的后置内容",
+ "description": "suffix content before suffixIcon\n\n后置图标前的后置内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": [
"String",
@@ -4472,7 +5002,7 @@
},
{
"name": "suffix-icon",
- "description": "组件后置图标",
+ "description": "suffix icon of input\n\n组件后置图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": [
"TNode"
@@ -4480,7 +5010,7 @@
},
{
"name": "tips",
- "description": "输入框下方提示文本,会根据不同的 `status` 呈现不同的样式",
+ "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",
@@ -4489,7 +5019,7 @@
},
{
"name": "type",
- "description": "输入框类型",
+ "description": "type attribute of input element. if you are using `type=number`, `InputNumber` Component might be better\n\n输入框类型。`type=number` 仅支持最基础的数字输入功能,更多功能建议使用 `InputNumber` 组件",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": [
"String"
@@ -4527,12 +5057,12 @@
},
{
"name": "value",
- "description": "输入框的值",
+ "description": "input value\n\n输入框的值",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props",
"type": [
- "String"
- ],
- "default": "''"
+ "String",
+ "Number"
+ ]
}
],
"js": {
@@ -4544,7 +5074,7 @@
},
{
"name": "change",
- "description": "输入框值发生变化时触发。`trigger=initial` 表示传入的数据不符合预期,组件自动处理后触发 change 告知父组件。如:初始值长度超过 `maxlength` 限制",
+ "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"
},
{
@@ -4567,7 +5097,7 @@
"slots": [
{
"name": "label",
- "description": "左侧文本",
+ "description": "text on the left of input\n\n左侧文本",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props"
},
{
@@ -4582,22 +5112,22 @@
},
{
"name": "suffix",
- "description": "后置图标前的后置内容",
+ "description": "suffix content before suffixIcon\n\n后置图标前的后置内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props"
},
{
"name": "suffixIcon",
- "description": "组件后置图标",
+ "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": "组件后置图标",
+ "description": "suffix icon of input\n\n组件后置图标",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/input?tab=api#input-props"
},
{
"name": "tips",
- "description": "输入框下方提示文本,会根据不同的 `status` 呈现不同的样式",
+ "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"
}
]
@@ -4993,14 +5523,6 @@
],
"default": "false"
},
- {
- "name": "progress",
- "description": "加载进度",
- "doc-url": "https://tdesign.tencent.com/mobile-vue/components/loading?tab=api#loading-props",
- "type": [
- "Number"
- ]
- },
{
"name": "reverse",
"description": "加载动画是否反向",
@@ -5310,6 +5832,14 @@
"String"
]
},
+ {
+ "name": "capsule",
+ "description": "左侧胶囊区域",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-props",
+ "type": [
+ "TNode"
+ ]
+ },
{
"name": "fixed",
"description": "是否固定在顶部",
@@ -5330,7 +5860,7 @@
},
{
"name": "left-arrow",
- "description": "是否显示左侧箭头",
+ "description": "是否展示左侧箭头",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-props",
"type": [
"Boolean"
@@ -5388,6 +5918,11 @@
]
},
"slots": [
+ {
+ "name": "capsule",
+ "description": "左侧胶囊区域",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/navbar?tab=api#navbar-props"
+ },
{
"name": "left",
"description": "左侧区域。值为 `string` 表示文本,为其他表示自定义内容",
@@ -6191,7 +6726,7 @@
"events": [
{
"name": "close",
- "description": "组件准备关闭时触发",
+ "description": "组件开始关闭时触发",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/popup?tab=api#popup-events"
},
{
@@ -6229,6 +6764,82 @@
}
]
},
+ {
+ "name": "t-primary-table",
+ "source": {
+ "symbol": "PrimaryTable"
+ },
+ "description": "PrimaryTable\n\n主表格",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/primary-table",
+ "props": [
+ {
+ "name": "row-selection-allow-uncheck",
+ "description": "allow to uncheck selection in table with single row selection\n\n行选中单选场景,是否允许取消选中",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/primary-table?tab=api#primarytable-props",
+ "type": [
+ "Boolean"
+ ]
+ },
+ {
+ "name": "row-selection-type",
+ "description": "single row selection, or multiple row selection\n\n行选中类型,单选或多选。效果和 `columns` 中配置的 `{ colKey: 'row-select', type: 'single' }` 一样",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/primary-table?tab=api#primarytable-props",
+ "type": [
+ "String"
+ ],
+ "attribute-value": {
+ "type": "enum"
+ },
+ "values": [
+ {
+ "name": "single"
+ },
+ {
+ "name": "multiple"
+ }
+ ]
+ }
+ ],
+ "slots": []
+ },
+ {
+ "name": "t-table",
+ "source": {
+ "symbol": "PrimaryTable"
+ },
+ "description": "PrimaryTable\n\n主表格",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/primary-table",
+ "props": [
+ {
+ "name": "row-selection-allow-uncheck",
+ "description": "allow to uncheck selection in table with single row selection\n\n行选中单选场景,是否允许取消选中",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/primary-table?tab=api#primarytable-props",
+ "type": [
+ "Boolean"
+ ]
+ },
+ {
+ "name": "row-selection-type",
+ "description": "single row selection, or multiple row selection\n\n行选中类型,单选或多选。效果和 `columns` 中配置的 `{ colKey: 'row-select', type: 'single' }` 一样",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/primary-table?tab=api#primarytable-props",
+ "type": [
+ "String"
+ ],
+ "attribute-value": {
+ "type": "enum"
+ },
+ "values": [
+ {
+ "name": "single"
+ },
+ {
+ "name": "multiple"
+ }
+ ]
+ }
+ ],
+ "slots": []
+ },
{
"name": "t-progress",
"source": {
@@ -6419,6 +7030,11 @@
"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": "刷新超时触发",
@@ -6579,7 +7195,7 @@
"type": [
"String"
],
- "default": "left",
+ "default": "undefined",
"attribute-value": {
"type": "enum"
},
@@ -6782,7 +7398,7 @@
"type": [
"String"
],
- "default": "left",
+ "default": "undefined",
"attribute-value": {
"type": "enum"
},
@@ -6868,6 +7484,16 @@
"Boolean"
]
},
+ {
+ "name": "icon",
+ "description": "自定义选中图标和非选中图标。示例:[选中态图标地址,非选中态图标地址]。使用 String 时,值为 circle 表示填充型图标、值为 line 表示描边型图标、值为 dot 表示圆点图标",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/radio-group?tab=api#radiogroup-props",
+ "type": [
+ "String",
+ "Array"
+ ],
+ "default": "'circle'"
+ },
{
"name": "keys",
"description": "用来定义 value / label 在 `options` 中对应的字段别名",
@@ -7728,6 +8354,99 @@
],
"slots": []
},
+ {
+ "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-item",
+ "props": [
+ {
+ "name": "badge-props",
+ "description": "透传至 Badge 组件",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/side-bar-item?tab=api#sidebaritem-props",
+ "type": [
+ "Object"
+ ]
+ },
+ {
+ "name": "disabled",
+ "description": "是否禁用",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/side-bar-item?tab=api#sidebaritem-props",
+ "type": [
+ "Boolean"
+ ],
+ "default": "false"
+ },
+ {
+ "name": "icon",
+ "description": "图标",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/side-bar-item?tab=api#sidebaritem-props",
+ "type": [
+ "TNode"
+ ]
+ },
+ {
+ "name": "label",
+ "description": "展示的标签",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/side-bar-item?tab=api#sidebaritem-props",
+ "type": [
+ "String"
+ ]
+ },
+ {
+ "name": "value",
+ "description": "当前选项的值",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/side-bar-item?tab=api#sidebaritem-props",
+ "type": [
+ "String",
+ "Number"
+ ]
+ }
+ ],
+ "slots": [
+ {
+ "name": "icon",
+ "description": "图标",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/side-bar-item?tab=api#sidebaritem-props"
+ }
+ ]
+ },
{
"name": "t-skeleton",
"source": {
@@ -8037,6 +8756,16 @@
}
]
},
+ {
+ "name": "t-statistic",
+ "source": {
+ "symbol": "Statistic"
+ },
+ "description": "Statistic\n\n统计数值",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/statistic",
+ "props": [],
+ "slots": []
+ },
{
"name": "t-step-item",
"source": {
@@ -8091,6 +8820,15 @@
}
]
},
+ {
+ "name": "sub-step-items",
+ "description": "子步骤条,仅支持 layout = 'vertical' 时",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/step-item?tab=api#stepitem-props",
+ "type": [
+ "Array"
+ ],
+ "default": "[]"
+ },
{
"name": "title",
"description": "标题",
@@ -8276,6 +9014,32 @@
"Number"
]
},
+ {
+ "name": "current-status",
+ "description": "用于控制 current 指向的步骤条的状态",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/steps?tab=api#steps-props",
+ "type": [
+ "String"
+ ],
+ "default": "process",
+ "attribute-value": {
+ "type": "enum"
+ },
+ "values": [
+ {
+ "name": "default"
+ },
+ {
+ "name": "process"
+ },
+ {
+ "name": "finish"
+ },
+ {
+ "name": "error"
+ }
+ ]
+ },
{
"name": "layout",
"description": "步骤条方向,有两种:横向和纵向",
@@ -8516,7 +9280,7 @@
},
{
"name": "default",
- "description": "子内容,同 content",
+ "description": "操作项以外的内容,同 content",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swipe-cell?tab=api#swipecell-props",
"type": [
"String",
@@ -8531,25 +9295,6 @@
"Boolean"
]
},
- {
- "name": "expanded",
- "description": "操作项是否呈现为打开态",
- "doc-url": "https://tdesign.tencent.com/mobile-vue/components/swipe-cell?tab=api#swipecell-props",
- "type": [
- "String"
- ],
- "attribute-value": {
- "type": "enum"
- },
- "values": [
- {
- "name": "left"
- },
- {
- "name": "right"
- }
- ]
- },
{
"name": "left",
"description": "左侧滑动操作项。所有行为同 `right`",
@@ -8601,7 +9346,7 @@
},
{
"name": "default",
- "description": "子内容,同 content",
+ "description": "操作项以外的内容,同 content",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/swipe-cell?tab=api#swipecell-props"
},
{
@@ -9272,15 +10017,6 @@
}
]
},
- {
- "name": "space-evenly",
- "description": "选项卡头部空间是否均分",
- "doc-url": "https://tdesign.tencent.com/mobile-vue/components/tabs?tab=api#tabs-props",
- "type": [
- "Boolean"
- ],
- "default": "true"
- },
{
"name": "sticky",
"description": "是否开启粘性布局",
@@ -9644,6 +10380,7 @@
"description": "用户最多可以输入的字符个数",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/textarea?tab=api#textarea-props",
"type": [
+ "String",
"Number"
]
},
@@ -9898,6 +10635,15 @@
]
}
],
+ "js": {
+ "events": [
+ {
+ "name": "click",
+ "description": "trigger on click\n\n点击时触发",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/timeline-item?tab=api#timelineitem-events"
+ }
+ ]
+ },
"slots": [
{
"name": "content",
@@ -10127,7 +10873,7 @@
},
{
"name": "keys",
- "description": "用来定义 `value / label / children` 在 `data` 数据中对应的字段别名,示例:`{ value: 'key', label 'name', children: 'list' }`",
+ "description": "alias filed name in data\n\n用来定义 `value / label / disabled / children` 在 `data` 数据中对应的字段别名,示例:`{ value: 'key', label: 'name', children: 'list' }`",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/tree-select?tab=api#treeselect-props",
"type": [
"Object"
@@ -10255,6 +11001,15 @@
"String"
]
},
+ {
+ "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是否允许重复上传相同文件名的文件",
@@ -10324,7 +11079,7 @@
},
{
"name": "format-request",
- "description": "redefine request data\n\n用于新增或修改文件上传请求参数。`action` 存在时有效。一个请求上传一个文件时,默认请求字段有 `file`;
一个请求上传多个文件时,默认字段有 `file[0]/file[1]/file[2]/.../length`,其中 `length` 表示本次上传的文件数量。
⚠️非常注意,此处的 `file[0]/file[1]` 仅仅是一个字段名,并非表示 `file` 是一个数组,接口获取字段时注意区分。
可以使用 `name` 定义 `file` 字段的别名,也可以使用 `formatRequest` 自定义任意字段",
+ "description": "redefine request data\n\n用于新增或修改文件上传请求 参数。`action` 存在时有效。一个请求上传一个文件时,默认请求字段有 `file`。
一个请求上传多个文件时,默认字段有 `file[0]/file[1]/file[2]/.../length`,其中 `length` 表示本次上传的文件数量。
⚠️非常注意,此处的 `file[0]/file[1]` 仅仅是一个字段名,并非表示 `file` 是一个数组,接口获取字段时注意区分。
可以使用 `name` 定义 `file` 字段的别名。
也可以使用 `formatRequest` 自定义任意字段,如添加一个字段 `fileList` ,存储文件数组",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": [
"Function"
@@ -10332,7 +11087,7 @@
},
{
"name": "format-response",
- "description": "redefine response data structure\n\n用于格式化文件上传后的接口响应数据,`response` 便是接口响应的原始数据。`action` 存在时有效。
此函数的返回值 `error` 或 `response.error` 会作为错误文本提醒,如果存在会判定为本次上传失败。
此函数的返回值 `url` 或 `response.url` 会作为上传成功后的链接",
+ "description": "redefine response data structure\n\n用于格式化文件上传后的接口响应数据,`response` 便是接口响应的原始数据。`action` 存在时有效。
示例返回值:`{ error, url, status, files }`
此函数的返回值 `error` 会作为错误文本提醒,表示上传失败的原因,如果存在会判定为本次上传失败。
此函数的返回值 `url` 会作为单个文件上传成功后的链接。
`files` 表示一个请求同时上传多个文件后的文件列表",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": [
"Function"
@@ -10356,7 +11111,7 @@
},
{
"name": "max",
- "description": "max count of files limit\n\n用于控制文件上传数量,值为 0 则不限制",
+ "description": "max count of files limit\n\n用于控制文件上传数量,值为 0 则不限制。注意,单文件上传场景,请勿设置 `max` 属性",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/upload?tab=api#upload-props",
"type": [
"Number"
@@ -10442,6 +11197,15 @@
],
"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"
+ ],
+ "default": "[]"
+ },
{
"name": "with-credentials",
"description": "uploading request with cookie\n\n上传请求时是否携带 cookie",
@@ -10497,6 +11261,16 @@
]
},
"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": "fileListDisplay",
"description": "used to render file list UI\n\n用于完全自定义文件列表界面内容(UI),单文件和多文件均有效类型和参数:TNode<{ files: UploadFile[]; dragEvents?: UploadDisplayDragEvents }>",
diff --git a/site/docs/getting-started.en-US.md b/site/docs/getting-started.en-US.md
index 5516940ea..28778b691 100644
--- a/site/docs/getting-started.en-US.md
+++ b/site/docs/getting-started.en-US.md
@@ -146,6 +146,11 @@ module.exports = {
> You can click on this [link](https://github.com/antfu/unplugin-vue-components/blob/main/src/core/resolvers/tdesign.ts#L4) for the configuration supported by `TDesignResolver`.
+## Editor Prompts
+
+After installing and registering TDesign, it can be used with plugins in editors such as VSCode to achieve the effect of prompting component names and APIs during development.
+
+Plugin `volar` is recommended, after installing `volar`, please add `node_modules/tdesign-mobile-vue/global.d.ts` to the `includes` property in the project's `tsconfig.json file`.
## Browser Support
diff --git a/site/docs/getting-started.md b/site/docs/getting-started.md
index 11cb2342c..a047d187e 100644
--- a/site/docs/getting-started.md
+++ b/site/docs/getting-started.md
@@ -146,6 +146,11 @@ module.exports = {
> `TDesignResolver` 支持的配置,可以点击此[链接](https://github.com/antfu/unplugin-vue-components/blob/main/src/core/resolvers/tdesign.ts#L4)。
+## 编辑器提示
+
+安装注册 TDesign 之后,在开发项目时,可以配合插件在VSCode等主流编辑器中达到提示组件名及API的效果。
+
+推荐安装 `volar`,并在项目的 tsconfig.json 的 `includes` 属性中增加`node_modules/tdesign-mobile-vue/global.d.ts`,即可实现该效果。
## 浏览器兼容性
From 06adc3cd96974f2b9cba7bf7b40c117e70cad104 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E9=BB=8E=E4=BC=9F=E6=9D=B0?= <674416404@qq.com>
Date: Thu, 28 Mar 2024 13:15:05 +0800
Subject: [PATCH 2/4] =?UTF-8?q?chore:=20=E7=BC=96=E8=BE=91=E5=99=A8?=
=?UTF-8?q?=E6=8F=90=E7=A4=BA=E6=9B=B4=E6=96=B0=EF=BC=8C=E5=A2=9E=E5=8A=A0?=
=?UTF-8?q?volar=E6=8F=90=E7=A4=BA?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
global.d.ts | 3 +-
helper/attributes.json | 82 ++++++++++++++++++-
helper/tags.json | 24 ++++++
helper/web-types.json | 176 ++++++++++++++++++++++++++++++++++++++++-
4 files changed, 282 insertions(+), 3 deletions(-)
diff --git a/global.d.ts b/global.d.ts
index fcf1a1237..d9db28e50 100644
--- a/global.d.ts
+++ b/global.d.ts
@@ -3,7 +3,7 @@
* https://github.com/TDesignOteam/tdesign-api
* eslint-disable
* */
-declare module '@vue/runtime-core' {
+declare module 'vue' {
export interface GlobalComponents {
TActionSheet: typeof import('tdesign-mobile-vue')['ActionSheet'];
TAvatar: typeof import('tdesign-mobile-vue')['Avatar'];
@@ -40,6 +40,7 @@ declare module '@vue/runtime-core' {
TFormItem: typeof import('tdesign-mobile-vue')['FormItem'];
TGrid: typeof import('tdesign-mobile-vue')['Grid'];
TGridItem: typeof import('tdesign-mobile-vue')['GridItem'];
+ TGuide: typeof import('tdesign-mobile-vue')['Guide'];
TIconSVG: typeof import('tdesign-mobile-vue')['IconSVG'];
TIconfont: typeof import('tdesign-mobile-vue')['Iconfont'];
TImage: typeof import('tdesign-mobile-vue')['Image'];
diff --git a/helper/attributes.json b/helper/attributes.json
index 26ca66510..58f489c33 100644
--- a/helper/attributes.json
+++ b/helper/attributes.json
@@ -767,6 +767,10 @@
"type": "Boolean",
"description": "只读状态\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-props)"
},
+ "t-checkbox/title": {
+ "type": "String",
+ "description": "html attribute\n\nHTML 原生属性\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-props)"
+ },
"t-checkbox/value": {
"type": "String|Number|Boolean",
"description": "value of checkbox\n\n多选框的值\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-props)"
@@ -996,7 +1000,7 @@
"description": "选择器的最大可选时间,默认为当前时间+10年\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/date-time-picker?tab=api#datetimepicker-props)"
},
"t-date-time-picker/footer": {
- "type": "Boolean|TNode",
+ "type": "TNode",
"description": "底部内容\n\ndefault: true\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/date-time-picker?tab=api#datetimepicker-props)"
},
"t-date-time-picker/format": {
@@ -1531,6 +1535,82 @@
"type": "String|TNode",
"description": "文本,可以通过 Props 传入文本,也可以自定义标题节点\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/grid-item?tab=api#griditem-props)"
},
+ "t-guide/back-button-props": {
+ "type": "Object",
+ "description": "透传 返回 的全部属性,示例:`{ content: '返回', theme: 'default' }`\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props)"
+ },
+ "t-guide/counter": {
+ "type": "TNode",
+ "description": "用于自定义渲染计数部分\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props)"
+ },
+ "t-guide/current": {
+ "type": "Number",
+ "description": "当前步骤,即整个引导的进度。-1 则不展示,用于需要中断展示的场景\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props)"
+ },
+ "t-guide/finish-button-props": {
+ "type": "Object",
+ "description": "透传 完成 的全部属性,示例:`{ content: '完成', theme: 'primary' }`\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props)"
+ },
+ "t-guide/hide-counter": {
+ "type": "Boolean",
+ "description": "是否隐藏计数\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props)"
+ },
+ "t-guide/hide-skip": {
+ "type": "Boolean",
+ "description": "是否隐藏跳过按钮\n\ndefault: false\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props)"
+ },
+ "t-guide/highlight-padding": {
+ "type": "Number",
+ "description": "高亮框的内边距\n\ndefault: 8\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props)"
+ },
+ "t-guide/mode": {
+ "type": "String",
+ "options": [
+ "popover",
+ "dialog"
+ ],
+ "description": "引导框的类型\n\ndefault: popover\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props)"
+ },
+ "t-guide/next-button-props": {
+ "type": "Object",
+ "description": "透传 下一步按钮 的全部属性,示例:{ content: '下一步', theme: 'primary' }\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props)"
+ },
+ "t-guide/show-overlay": {
+ "type": "Boolean",
+ "description": "是否出现遮罩层\n\ndefault: true\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props)"
+ },
+ "t-guide/skip-button-props": {
+ "type": "Object",
+ "description": "透传 跳过按钮 的全部属性,{ content: '跳过', theme: 'default' }\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props)"
+ },
+ "t-guide/steps": {
+ "type": "Array",
+ "description": "用于定义每个步骤的内容,包括高亮的节点、相对位置和具体的文案内容等。\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props)"
+ },
+ "t-guide/z-index": {
+ "type": "Number",
+ "description": "提示框的层级\n\ndefault: 999999\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props)"
+ },
+ "t-guide/back": {
+ "type": "event",
+ "description": "点击返回按钮时触发\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-events)"
+ },
+ "t-guide/change": {
+ "type": "event",
+ "description": "当前步骤发生变化时触发\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-events)"
+ },
+ "t-guide/finish": {
+ "type": "event",
+ "description": "点击完成按钮时触发\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-events)"
+ },
+ "t-guide/next-step-click": {
+ "type": "event",
+ "description": "点击下一步时触发\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-events)"
+ },
+ "t-guide/skip": {
+ "type": "event",
+ "description": "点击跳过按钮时触发\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-events)"
+ },
"t-icon-svg/load-default-icons": {
"type": "Boolean",
"description": "是否加载组件库内置图标\n\ndefault: true\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/icon-svg?tab=api#iconsvg-props)"
diff --git a/helper/tags.json b/helper/tags.json
index bb4136308..16a50396c 100644
--- a/helper/tags.json
+++ b/helper/tags.json
@@ -220,6 +220,7 @@
"name",
"placement",
"readonly",
+ "title",
"value",
"change"
],
@@ -500,6 +501,29 @@
],
"description": "GridItem\n\n宫格子项\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/grid-item)"
},
+ "t-guide": {
+ "attributes": [
+ "back-button-props",
+ "counter",
+ "current",
+ "finish-button-props",
+ "hide-counter",
+ "hide-skip",
+ "highlight-padding",
+ "mode",
+ "next-button-props",
+ "show-overlay",
+ "skip-button-props",
+ "steps",
+ "z-index",
+ "back",
+ "change",
+ "finish",
+ "next-step-click",
+ "skip"
+ ],
+ "description": "Guide\n\n引导\n\n[docs](https://tdesign.tencent.com/mobile-vue/components/guide)"
+ },
"t-icon-svg": {
"attributes": [
"load-default-icons",
diff --git a/helper/web-types.json b/helper/web-types.json
index 866af214d..a6b92011e 100644
--- a/helper/web-types.json
+++ b/helper/web-types.json
@@ -2083,6 +2083,14 @@
],
"default": "false"
},
+ {
+ "name": "title",
+ "description": "html attribute\n\nHTML 原生属性",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/checkbox?tab=api#checkbox-props",
+ "type": [
+ "String"
+ ]
+ },
{
"name": "value",
"description": "value of checkbox\n\n多选框的值",
@@ -2816,7 +2824,6 @@
"description": "底部内容",
"doc-url": "https://tdesign.tencent.com/mobile-vue/components/date-time-picker?tab=api#datetimepicker-props",
"type": [
- "Boolean",
"TNode"
],
"default": "true"
@@ -4260,6 +4267,173 @@
}
]
},
+ {
+ "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": [
+ "Object"
+ ]
+ },
+ {
+ "name": "counter",
+ "description": "用于自定义渲染计数部分",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props",
+ "type": [
+ "TNode"
+ ]
+ },
+ {
+ "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": [
+ "Object"
+ ]
+ },
+ {
+ "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": [
+ "String"
+ ],
+ "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": [
+ "Object"
+ ]
+ },
+ {
+ "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": [
+ "Object"
+ ]
+ },
+ {
+ "name": "steps",
+ "description": "用于定义每个步骤的内容,包括高亮的节点、相对位置和具体的文案内容等。",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props",
+ "type": [
+ "Array"
+ ]
+ },
+ {
+ "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": "counter",
+ "description": "用于自定义渲染计数部分类型和参数:TNode<{ current: number; total: number }>",
+ "doc-url": "https://tdesign.tencent.com/mobile-vue/components/guide?tab=api#guide-props"
+ }
+ ]
+ },
{
"name": "t-icon-svg",
"source": {
From 20720d5717d59ca88508e42d36ded58f7a7661d9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E9=BB=8E=E4=BC=9F=E6=9D=B0?= <674416404@qq.com>
Date: Thu, 28 Mar 2024 21:52:28 +0800
Subject: [PATCH 3/4] chore(tsconfig): exclude global.d.ts
---
tsconfig.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/tsconfig.json b/tsconfig.json
index 1ed2c9b4b..5c289df14 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -38,6 +38,6 @@
"src/style/index.js",
"scripts/rollup.config.js"
],
- "exclude": ["node_modules", "src/_common", "dist", "es", "esm", "lib", "site"],
+ "exclude": ["node_modules", "src/_common", "dist", "es", "esm", "lib", "site", "global.d.ts"],
"compileOnSave": false
}
From 9dc2ff8284ff750fa324ca54838d867980090dd5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E9=BB=8E=E4=BC=9F=E6=9D=B0?= <674416404@qq.com>
Date: Sun, 7 Apr 2024 21:10:07 +0800
Subject: [PATCH 4/4] chore: global.d.ts
---
package.json | 3 ++-
tsconfig.json | 2 +-
2 files changed, 3 insertions(+), 2 deletions(-)
diff --git a/package.json b/package.json
index 3ee54a0c9..9ae39149a 100644
--- a/package.json
+++ b/package.json
@@ -73,7 +73,8 @@
"typings",
"LICENSE",
"README.md",
- "CHANGELOG.md"
+ "CHANGELOG.md",
+ "global.d.ts"
],
"sideEffects": [
"dist/*",
diff --git a/tsconfig.json b/tsconfig.json
index 5c289df14..1ed2c9b4b 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -38,6 +38,6 @@
"src/style/index.js",
"scripts/rollup.config.js"
],
- "exclude": ["node_modules", "src/_common", "dist", "es", "esm", "lib", "site", "global.d.ts"],
+ "exclude": ["node_modules", "src/_common", "dist", "es", "esm", "lib", "site"],
"compileOnSave": false
}