From c9dbdedc4f5d72335d4e1c7f08dddd303db1fb43 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=BB=8E=E4=BC=9F=E6=9D=B0?= <674416404@qq.com> Date: Fri, 24 Jan 2025 10:56:42 +0800 Subject: [PATCH] docs(Descriptions): update labelStyle api desc --- db/TDesign.db | Bin 1007616 -> 1007616 bytes .../src/descriptions/descriptions.en-US.md | 2 +- .../src/descriptions/descriptions.md | 2 +- .../tdesign-react/src/descriptions/type.ts | 2 +- .../src/descriptions/descriptions.en-US.md | 2 +- .../src/descriptions/descriptions.md | 2 +- .../src/descriptions/props.ts | 2 +- .../tdesign-vue-next/src/descriptions/type.ts | 2 +- .../src/descriptions/descriptions.en-US.md | 2 +- .../src/descriptions/descriptions.md | 2 +- .../tdesign-vue/src/descriptions/props.ts | 2 +- .../tdesign-vue/src/descriptions/type.ts | 2 +- packages/scripts/api.json | 4 ++-- 13 files changed, 13 insertions(+), 13 deletions(-) diff --git a/db/TDesign.db b/db/TDesign.db index 780d471d9290abbc5a6d797013b70cbdd447e540..ce70b16aaddf090622aadf50d21bceb82d511771 100644 GIT binary patch delta 268 zcmZoTVB2uOc7ilx+(a2?);I>evW~`-))dCp6sFb`=GGLJ))dy(6t>nB_SO`R))dax z6t313?$#8Zttq^V`0Y)Yx#PH+`K)<2@%-i~XJ5`>!f40&np2X)i}4Y=1)DlcBGUyX z9|kCBVw-Lx&BCb4smRF7+i2gYIQ_FEueZhfJv}eyG`v{W__DS4>4Xl2gp$OhoK&C0 z%KXxj1cfI%b}1wzmX_ovC_L-zecHeN$?m1kr_6sgwPU)S6tASAjzW1xW^#r?Nn&&SrFeC>FA(5$_i!7)>sC;vaZII))dCp6sFb`=GGLJ))dy(6t>nB_SO`R))dax z6t313?$#8Zttq^V_|@h!bH{Nt^I7w5;`z-}&d$O4gke6X4@VXIYDQ` | N -labelStyle | Object | - | style of description item。Typescript：`Styles`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N +labelStyle | Object | - | style of description item, which takes effect when `tableLayout` is `auto`。Typescript：`Styles`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N layout | String | horizontal | layout direction。options: horizontal/vertical | N size | String | medium | a descriptions has three size。options: small/medium/large。Typescript：`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N tableLayout | String | fixed | Sets the algorithm used to layout `table` cells, rows, and columns, exactly the same as the native table-layout css property. `fixed`: uses fixed layout algorithm; `auto`: uses automatic layout algorithm. For more details, see [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout)。options: fixed/auto | N diff --git a/packages/products/tdesign-react/src/descriptions/descriptions.md b/packages/products/tdesign-react/src/descriptions/descriptions.md index 16614b683..2aa3a8431 100644 --- a/packages/products/tdesign-react/src/descriptions/descriptions.md +++ b/packages/products/tdesign-react/src/descriptions/descriptions.md @@ -14,7 +14,7 @@ column | Number | 2 | 一行 `DescriptionItem` 的数量 | N contentStyle | Object | - | 自定义描述项内容的样式。TS 类型：`Styles`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N itemLayout | String | horizontal | 描述项的排列方向。可选项：horizontal/vertical | N items | Array | - | 描述项的列表。TS 类型：`Array` | N -labelStyle | Object | - | 自定义描述项标签的样式。TS 类型：`Styles`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N +labelStyle | Object | - | 自定义描述项标签的样式，需要配合 `tableLayout` 为 `auto` 才可以生效。TS 类型：`Styles`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N layout | String | horizontal | 排列方向。可选项：horizontal/vertical | N size | String | medium | 组件尺寸。可选项：small/medium/large。TS 类型：`SizeEnum`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N tableLayout | String | fixed | 用于设置底层 `table` 单元格、行和列的布局算法，与原生 table-layout css 属性完全一致。`fixed`：采用固定布局算法；`auto`：采用自动布局算法。详情可参考 [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout)。可选项：fixed/auto | N diff --git a/packages/products/tdesign-react/src/descriptions/type.ts b/packages/products/tdesign-react/src/descriptions/type.ts index 02848a3a5..6cd40eeb3 100644 --- a/packages/products/tdesign-react/src/descriptions/type.ts +++ b/packages/products/tdesign-react/src/descriptions/type.ts @@ -35,7 +35,7 @@ export interface TdDescriptionsProps { */ items?: Array; /** - * 自定义描述项标签的样式 + * 自定义描述项标签的样式，需要配合 `tableLayout` 为 `auto` 才可以生效 */ labelStyle?: Styles; /** diff --git a/packages/products/tdesign-vue-next/src/descriptions/descriptions.en-US.md b/packages/products/tdesign-vue-next/src/descriptions/descriptions.en-US.md index 7176b12cd..e495dd5d8 100644 --- a/packages/products/tdesign-vue-next/src/descriptions/descriptions.en-US.md +++ b/packages/products/tdesign-vue-next/src/descriptions/descriptions.en-US.md @@ -13,7 +13,7 @@ column | Number | 2 | count of DescriptionItem in one row | N contentStyle | Object | - | style of description content。Typescript：`Styles`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N itemLayout | String | horizontal | layout direction of description item。options: horizontal/vertical | N items | Array | - | list of descriptions items。Typescript：`Array` | N -labelStyle | Object | - | style of description item。Typescript：`Styles`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N +labelStyle | Object | - | style of description item, which takes effect when `tableLayout` is `auto`。Typescript：`Styles`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N layout | String | horizontal | layout direction。options: horizontal/vertical | N size | String | medium | a descriptions has three size。options: small/medium/large。Typescript：`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N tableLayout | String | fixed | Sets the algorithm used to layout `table` cells, rows, and columns, exactly the same as the native table-layout css property. `fixed`: uses fixed layout algorithm; `auto`: uses automatic layout algorithm. For more details, see [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout)。options: fixed/auto | N diff --git a/packages/products/tdesign-vue-next/src/descriptions/descriptions.md b/packages/products/tdesign-vue-next/src/descriptions/descriptions.md index ca64f9e69..696cf5265 100644 --- a/packages/products/tdesign-vue-next/src/descriptions/descriptions.md +++ b/packages/products/tdesign-vue-next/src/descriptions/descriptions.md @@ -13,7 +13,7 @@ column | Number | 2 | 一行 `DescriptionItem` 的数量 | N contentStyle | Object | - | 自定义描述项内容的样式。TS 类型：`Styles`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N itemLayout | String | horizontal | 描述项的排列方向。可选项：horizontal/vertical | N items | Array | - | 描述项的列表。TS 类型：`Array` | N -labelStyle | Object | - | 自定义描述项标签的样式。TS 类型：`Styles`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N +labelStyle | Object | - | 自定义描述项标签的样式，需要配合 `tableLayout` 为 `auto` 才可以生效。TS 类型：`Styles`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N layout | String | horizontal | 排列方向。可选项：horizontal/vertical | N size | String | medium | 组件尺寸。可选项：small/medium/large。TS 类型：`SizeEnum`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N tableLayout | String | fixed | 用于设置底层 `table` 单元格、行和列的布局算法，与原生 table-layout css 属性完全一致。`fixed`：采用固定布局算法；`auto`：采用自动布局算法。详情可参考 [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout)。可选项：fixed/auto | N diff --git a/packages/products/tdesign-vue-next/src/descriptions/props.ts b/packages/products/tdesign-vue-next/src/descriptions/props.ts index 54d03f612..95d5b5f78 100644 --- a/packages/products/tdesign-vue-next/src/descriptions/props.ts +++ b/packages/products/tdesign-vue-next/src/descriptions/props.ts @@ -42,7 +42,7 @@ export default { items: { type: Array as PropType, }, - /** 自定义描述项标签的样式 */ + /** 自定义描述项标签的样式，需要配合 `tableLayout` 为 `auto` 才可以生效 */ labelStyle: { type: Object as PropType, }, diff --git a/packages/products/tdesign-vue-next/src/descriptions/type.ts b/packages/products/tdesign-vue-next/src/descriptions/type.ts index 209d27e72..2d261fc40 100644 --- a/packages/products/tdesign-vue-next/src/descriptions/type.ts +++ b/packages/products/tdesign-vue-next/src/descriptions/type.ts @@ -39,7 +39,7 @@ export interface TdDescriptionsProps { */ items?: Array; /** - * 自定义描述项标签的样式 + * 自定义描述项标签的样式，需要配合 `tableLayout` 为 `auto` 才可以生效 */ labelStyle?: Styles; /** diff --git a/packages/products/tdesign-vue/src/descriptions/descriptions.en-US.md b/packages/products/tdesign-vue/src/descriptions/descriptions.en-US.md index 93fca4b6b..d43cdc219 100644 --- a/packages/products/tdesign-vue/src/descriptions/descriptions.en-US.md +++ b/packages/products/tdesign-vue/src/descriptions/descriptions.en-US.md @@ -13,7 +13,7 @@ column | Number | 2 | count of DescriptionItem in one row | N contentStyle | Object | - | style of description content。Typescript：`Styles`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N itemLayout | String | horizontal | layout direction of description item。options: horizontal/vertical | N items | Array | - | list of descriptions items。Typescript：`Array` | N -labelStyle | Object | - | style of description item。Typescript：`Styles`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N +labelStyle | Object | - | style of description item, which takes effect when `tableLayout` is `auto`。Typescript：`Styles`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N layout | String | horizontal | layout direction。options: horizontal/vertical | N size | String | medium | a descriptions has three size。options: small/medium/large。Typescript：`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N tableLayout | String | fixed | Sets the algorithm used to layout `table` cells, rows, and columns, exactly the same as the native table-layout css property. `fixed`: uses fixed layout algorithm; `auto`: uses automatic layout algorithm. For more details, see [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout)。options: fixed/auto | N diff --git a/packages/products/tdesign-vue/src/descriptions/descriptions.md b/packages/products/tdesign-vue/src/descriptions/descriptions.md index 9ac099563..015855e0a 100644 --- a/packages/products/tdesign-vue/src/descriptions/descriptions.md +++ b/packages/products/tdesign-vue/src/descriptions/descriptions.md @@ -13,7 +13,7 @@ column | Number | 2 | 一行 `DescriptionItem` 的数量 | N contentStyle | Object | - | 自定义描述项内容的样式。TS 类型：`Styles`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N itemLayout | String | horizontal | 描述项的排列方向。可选项：horizontal/vertical | N items | Array | - | 描述项的列表。TS 类型：`Array` | N -labelStyle | Object | - | 自定义描述项标签的样式。TS 类型：`Styles`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N +labelStyle | Object | - | 自定义描述项标签的样式，需要配合 `tableLayout` 为 `auto` 才可以生效。TS 类型：`Styles`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N layout | String | horizontal | 排列方向。可选项：horizontal/vertical | N size | String | medium | 组件尺寸。可选项：small/medium/large。TS 类型：`SizeEnum`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N tableLayout | String | fixed | 用于设置底层 `table` 单元格、行和列的布局算法，与原生 table-layout css 属性完全一致。`fixed`：采用固定布局算法；`auto`：采用自动布局算法。详情可参考 [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout)。可选项：fixed/auto | N diff --git a/packages/products/tdesign-vue/src/descriptions/props.ts b/packages/products/tdesign-vue/src/descriptions/props.ts index 54d03f612..95d5b5f78 100644 --- a/packages/products/tdesign-vue/src/descriptions/props.ts +++ b/packages/products/tdesign-vue/src/descriptions/props.ts @@ -42,7 +42,7 @@ export default { items: { type: Array as PropType, }, - /** 自定义描述项标签的样式 */ + /** 自定义描述项标签的样式，需要配合 `tableLayout` 为 `auto` 才可以生效 */ labelStyle: { type: Object as PropType, }, diff --git a/packages/products/tdesign-vue/src/descriptions/type.ts b/packages/products/tdesign-vue/src/descriptions/type.ts index 209d27e72..2d261fc40 100644 --- a/packages/products/tdesign-vue/src/descriptions/type.ts +++ b/packages/products/tdesign-vue/src/descriptions/type.ts @@ -39,7 +39,7 @@ export interface TdDescriptionsProps { */ items?: Array; /** - * 自定义描述项标签的样式 + * 自定义描述项标签的样式，需要配合 `tableLayout` 为 `auto` 才可以生效 */ labelStyle?: Styles; /** diff --git a/packages/scripts/api.json b/packages/scripts/api.json index ccafc3400..25e3d54ee 100644 --- a/packages/scripts/api.json +++ b/packages/scripts/api.json @@ -38026,8 +38026,8 @@ ], "field_default_value": "", "field_enum": "", - "field_desc_zh": "自定义描述项标签的样式", - "field_desc_en": "style of description item", + "field_desc_zh": "自定义描述项标签的样式，需要配合 `tableLayout` 为 `auto` 才可以生效", + "field_desc_en": "style of description item, which takes effect when `tableLayout` is `auto`", "field_required": 0, "event_input": "", "create_time": "2023-12-28 08:40:20",