Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(Descriptions): update labelStyle api desc #535

Merged
merged 2 commits into from
Jan 24, 2025
Merged

docs(Descriptions): update labelStyle api desc #535

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c9dbded
docs(Descriptions): update labelStyle api desc
liweijie0812 Jan 24, 2025
76cb632
chore: resolve conflict
github-actions[bot] Jan 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified db/TDesign.db
View file
Open in desktop
Binary file not shown.
2 changes: 1 addition & 1 deletion packages/products/tdesign-react/src/descriptions/descriptions.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,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-react/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<TdDescriptionItemProps>` | 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
Expand Down
2 changes: 1 addition & 1 deletion packages/products/tdesign-react/src/descriptions/descriptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<TdDescriptionItemProps>` | 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
Expand Down
2 changes: 1 addition & 1 deletion packages/products/tdesign-react/src/descriptions/type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export interface TdDescriptionsProps {
*/
items?: Array<TdDescriptionItemProps>;
/**
* 自定义描述项标签的样式
* 自定义描述项标签的样式，需要配合 `tableLayout` 为 `auto` 才可以生效
*/
labelStyle?: Styles;
/**
Expand Down
2 changes: 1 addition & 1 deletion packages/products/tdesign-vue-next/src/descriptions/descriptions.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<TdDescriptionItemProps>` | 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
Expand Down
2 changes: 1 addition & 1 deletion packages/products/tdesign-vue-next/src/descriptions/descriptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<TdDescriptionItemProps>` | 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
Expand Down
2 changes: 1 addition & 1 deletion packages/products/tdesign-vue-next/src/descriptions/props.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export default {
items: {
type: Array as PropType<TdDescriptionsProps['items']>,
},
/** 自定义描述项标签的样式 */
/** 自定义描述项标签的样式，需要配合 `tableLayout` 为 `auto` 才可以生效 */
labelStyle: {
type: Object as PropType<TdDescriptionsProps['labelStyle']>,
},
Expand Down
2 changes: 1 addition & 1 deletion packages/products/tdesign-vue-next/src/descriptions/type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export interface TdDescriptionsProps {
*/
items?: Array<TdDescriptionItemProps>;
/**
* 自定义描述项标签的样式
* 自定义描述项标签的样式，需要配合 `tableLayout` 为 `auto` 才可以生效
*/
labelStyle?: Styles;
/**
Expand Down
2 changes: 1 addition & 1 deletion packages/products/tdesign-vue/src/descriptions/descriptions.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<TdDescriptionItemProps>` | 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
Expand Down
2 changes: 1 addition & 1 deletion packages/products/tdesign-vue/src/descriptions/descriptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<TdDescriptionItemProps>` | 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
Expand Down
2 changes: 1 addition & 1 deletion packages/products/tdesign-vue/src/descriptions/props.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export default {
items: {
type: Array as PropType<TdDescriptionsProps['items']>,
},
/** 自定义描述项标签的样式 */
/** 自定义描述项标签的样式，需要配合 `tableLayout` 为 `auto` 才可以生效 */
labelStyle: {
type: Object as PropType<TdDescriptionsProps['labelStyle']>,
},
Expand Down
2 changes: 1 addition & 1 deletion packages/products/tdesign-vue/src/descriptions/type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export interface TdDescriptionsProps {
*/
items?: Array<TdDescriptionItemProps>;
/**
* 自定义描述项标签的样式
* 自定义描述项标签的样式，需要配合 `tableLayout` 为 `auto` 才可以生效
*/
labelStyle?: Styles;
/**
Expand Down
4 changes: 2 additions & 2 deletions packages/scripts/api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Loading