From e6d3b43c1303858d034d75c386d60438d5fa8bc1 Mon Sep 17 00:00:00 2001 From: liweijie0812 <674416404@qq.com> Date: Tue, 10 Sep 2024 12:56:47 +0800 Subject: [PATCH] fix(Avatar): update shape desc (#417) --- db/TDesign.db | Bin 1003520 -> 1003520 bytes .../src/avatar-group/type.ts | 2 ++ .../src/avatar/README.en-US.md | 4 ++-- .../tdesign-miniprogram/src/avatar/README.md | 4 ++-- .../tdesign-miniprogram/src/avatar/props.ts | 2 +- .../tdesign-miniprogram/src/avatar/type.ts | 3 ++- .../src/avatar/avatar.en-US.md | 4 ++-- .../tdesign-mobile-react/src/avatar/avatar.md | 4 ++-- .../tdesign-mobile-react/src/avatar/type.ts | 4 ++-- .../src/avatar/avatar.en-US.md | 4 ++-- .../tdesign-mobile-vue/src/avatar/avatar.md | 4 ++-- .../tdesign-mobile-vue/src/avatar/props.ts | 2 +- .../tdesign-mobile-vue/src/avatar/type.ts | 4 ++-- .../tdesign-react/src/avatar/avatar.en-US.md | 4 ++-- .../tdesign-react/src/avatar/avatar.md | 4 ++-- .../products/tdesign-react/src/avatar/type.ts | 4 ++-- .../src/avatar/avatar.en-US.md | 4 ++-- .../tdesign-vue-next/src/avatar/avatar.md | 4 ++-- .../tdesign-vue-next/src/avatar/props.ts | 2 +- .../tdesign-vue-next/src/avatar/type.ts | 4 ++-- .../tdesign-vue/src/avatar/avatar.en-US.md | 4 ++-- .../products/tdesign-vue/src/avatar/avatar.md | 4 ++-- .../products/tdesign-vue/src/avatar/props.ts | 2 +- .../products/tdesign-vue/src/avatar/type.ts | 4 ++-- packages/scripts/api.json | 4 ++-- 25 files changed, 44 insertions(+), 41 deletions(-) diff --git a/db/TDesign.db b/db/TDesign.db index 55e3223fc6c0fef35931e599a86850ff44884896..68c05456ea7f272e4e77368e65032ceb7865dfb3 100644 GIT binary patch delta 138 zcmZozVB4_3c7imc{X`jOM*GHu)&$1Z1g6#m=GFw3)&$np1h&=$_N@sVJKr;Y*)H{g z!<>t8+4Q^=X1VDFzc^ZCn}j<2q?i~bImJ17RhtsUIe3kY8RQu_Ie0l3c&Fd^#j%s6 kI3uxO`n2C1Htk%0IDnWFh`E568;E&;n0GtZAHHwF04LEdUH||9 delta 132 zcmZozVB4_3c7imc-9#B@M!Uv@)&$1Z1g6#m=GFw3)&$np1h&=$_N@sVJKrsTcY0n5v)uH8UmPvdb$@frWlhd3O3s;n?l*_c^oLJ5B_>~3!Z-cRUk)yg%#zgH fTBX|BcCJ4hK+FlmTtLhX#5_REyPfL~-?v}@-J diff --git a/packages/products/tdesign-miniprogram/src/avatar-group/type.ts b/packages/products/tdesign-miniprogram/src/avatar-group/type.ts index cc775f48..442610a8 100644 --- a/packages/products/tdesign-miniprogram/src/avatar-group/type.ts +++ b/packages/products/tdesign-miniprogram/src/avatar-group/type.ts @@ -4,6 +4,8 @@ * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC * */ +import { ShapeEnum } from '../common/common'; + export interface TdAvatarGroupProps { /** * 图片之间的层叠关系，可选值：左侧图片在上和右侧图片在上 diff --git a/packages/products/tdesign-miniprogram/src/avatar/README.en-US.md b/packages/products/tdesign-miniprogram/src/avatar/README.en-US.md index 0d0514fa..a4e284b6 100644 --- a/packages/products/tdesign-miniprogram/src/avatar/README.en-US.md +++ b/packages/products/tdesign-miniprogram/src/avatar/README.en-US.md @@ -15,7 +15,7 @@ hide-on-load-failed | Boolean | false | hide image when loading image failed | N icon | String / Object | - | \- | N image | String | - | images url | N image-props | Object | - | Typescript：`ImageProps`，[Image API Documents](./image?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/avatar/type.ts) | N -shape | String | - | shape。options: circle/round。Typescript：`ShapeEnum` | N +shape | String | - | shape。options: circle/round。Typescript：`ShapeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/src/common/common.ts) | N size | String | - | size | N ### Avatar Events @@ -44,7 +44,7 @@ custom-style | Object | - | CSS(Cascading Style Sheets)，used to set style on v cascading | String | 'left-up' | multiple images cascading。options: left-up/right-up。Typescript：`CascadingValue` `type CascadingValue = 'left-up' \| 'right-up'`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/avatar-group/type.ts) | N collapse-avatar | String / Slot | - | [see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/src/common/common.ts) | N max | Number | - | \- | N -shape | String | - | shape。options: circle/round。Typescript：`ShapeEnum` | N +shape | String | - | shape。options: circle/round。Typescript：`ShapeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/src/common/common.ts) | N size | String | - | size | N ### AvatarGroup Events diff --git a/packages/products/tdesign-miniprogram/src/avatar/README.md b/packages/products/tdesign-miniprogram/src/avatar/README.md index 5f6a7bbf..5658d898 100644 --- a/packages/products/tdesign-miniprogram/src/avatar/README.md +++ b/packages/products/tdesign-miniprogram/src/avatar/README.md @@ -15,7 +15,7 @@ hide-on-load-failed | Boolean | false | 加载失败时隐藏图片 | N icon | String / Object | - | 图标。值为字符串表示图标名称，值为 `Object` 类型，表示透传至 `icon`。 | N image | String | - | 图片地址 | N image-props | Object | - | 透传至 Image 组件。TS 类型：`ImageProps`，[Image API Documents](./image?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/avatar/type.ts) | N -shape | String | - | 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.circle 决定。可选项：circle/round。TS 类型：`ShapeEnum` | N +shape | String | - | 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.shape 决定。可选项：circle/round。TS 类型：`ShapeEnum`。[通用类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/src/common/common.ts) | N size | String | - | 尺寸，示例值：small/medium/large/24px/38px 等。优先级高于 AvatarGroup.size 。Avatar 单独存在时，默认值为 medium。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.size 决定 | N ### Avatar Events @@ -44,7 +44,7 @@ custom-style | Object | - | 样式，一般用于开启虚拟化组件节点场 cascading | String | 'left-up' | 图片之间的层叠关系，可选值：左侧图片在上和右侧图片在上。可选项：left-up/right-up。TS 类型：`CascadingValue` `type CascadingValue = 'left-up' \| 'right-up'`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/avatar-group/type.ts) | N collapse-avatar | String / Slot | - | 头像数量超出时，会出现一个头像折叠元素。该元素内容可自定义。默认为 `+N`。示例：`+5`，`...`, `更多`。[通用类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/src/common/common.ts) | N max | Number | - | 能够同时显示的最多头像数量 | N -shape | String | - | 形状。优先级低于 Avatar.shape。可选项：circle/round。TS 类型：`ShapeEnum` | N +shape | String | - | 形状。优先级低于 Avatar.shape。可选项：circle/round。TS 类型：`ShapeEnum`。[通用类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/src/common/common.ts) | N size | String | - | 尺寸，示例值：small/medium/large/24px/38px 等。优先级低于 Avatar.size | N ### AvatarGroup Events diff --git a/packages/products/tdesign-miniprogram/src/avatar/props.ts b/packages/products/tdesign-miniprogram/src/avatar/props.ts index 9bf28230..4b69177f 100644 --- a/packages/products/tdesign-miniprogram/src/avatar/props.ts +++ b/packages/products/tdesign-miniprogram/src/avatar/props.ts @@ -38,7 +38,7 @@ const props: TdAvatarProps = { imageProps: { type: Object, }, - /** 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.circle 决定 */ + /** 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.shape 决定 */ shape: { type: String, }, diff --git a/packages/products/tdesign-miniprogram/src/avatar/type.ts b/packages/products/tdesign-miniprogram/src/avatar/type.ts index aa45cb1d..e59bf924 100644 --- a/packages/products/tdesign-miniprogram/src/avatar/type.ts +++ b/packages/products/tdesign-miniprogram/src/avatar/type.ts @@ -6,6 +6,7 @@ import { BadgeProps } from '../badge/index'; import { ImageProps } from '../image/index'; +import { ShapeEnum } from '../common/common'; export interface TdAvatarProps { /** @@ -62,7 +63,7 @@ export interface TdAvatarProps { value?: ImageProps; }; /** - * 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.circle 决定 + * 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.shape 决定 */ shape?: { type: StringConstructor; diff --git a/packages/products/tdesign-mobile-react/src/avatar/avatar.en-US.md b/packages/products/tdesign-mobile-react/src/avatar/avatar.en-US.md index 6c5624fb..3b388d26 100644 --- a/packages/products/tdesign-mobile-react/src/avatar/avatar.en-US.md +++ b/packages/products/tdesign-mobile-react/src/avatar/avatar.en-US.md @@ -15,7 +15,7 @@ hideOnLoadFailed | Boolean | false | hide image when loading image failed | N icon | TElement | - | use icon to fill。Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N image | String | - | images url | N imageProps | Object | - | Typescript：`ImageProps`，[Image API Documents](./image?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/avatar/type.ts) | N -shape | String | - | shape。options: circle/round。Typescript：`ShapeEnum` | N +shape | String | - | shape。options: circle/round。Typescript：`ShapeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N size | String | - | size | N onError | Function | | Typescript：`(context: { e: Event }) => void`
trigger on image load failed | N @@ -29,6 +29,6 @@ style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProper cascading | String | 'right-up' | multiple images cascading。options: left-up/right-up。Typescript：`CascadingValue` `type CascadingValue = 'left-up' \| 'right-up'`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/avatar/type.ts) | N collapseAvatar | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N max | Number | - | \- | N -shape | String | - | shape。options: circle/round。Typescript：`ShapeEnum` | N +shape | String | - | shape。options: circle/round。Typescript：`ShapeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N size | String | - | size | N onCollapsedItemClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N diff --git a/packages/products/tdesign-mobile-react/src/avatar/avatar.md b/packages/products/tdesign-mobile-react/src/avatar/avatar.md index 027817bf..f9eb5a7e 100644 --- a/packages/products/tdesign-mobile-react/src/avatar/avatar.md +++ b/packages/products/tdesign-mobile-react/src/avatar/avatar.md @@ -15,7 +15,7 @@ hideOnLoadFailed | Boolean | false | 加载失败时隐藏图片 | N icon | TElement | - | 图标。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N image | String | - | 图片地址 | N imageProps | Object | - | 透传至 Image 组件。TS 类型：`ImageProps`，[Image API Documents](./image?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/avatar/type.ts) | N -shape | String | - | 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.circle 决定。可选项：circle/round。TS 类型：`ShapeEnum` | N +shape | String | - | 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.shape 决定。可选项：circle/round。TS 类型：`ShapeEnum`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N size | String | - | 尺寸，示例值：small/medium/large/24px/38px 等。优先级高于 AvatarGroup.size 。Avatar 单独存在时，默认值为 medium。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.size 决定 | N onError | Function | | TS 类型：`(context: { e: Event }) => void`
图片加载失败时触发 | N @@ -29,6 +29,6 @@ style | Object | - | 样式，TS 类型：`React.CSSProperties` | N cascading | String | 'right-up' | 图片之间的层叠关系，可选值：左侧图片在上和右侧图片在上。可选项：left-up/right-up。TS 类型：`CascadingValue` `type CascadingValue = 'left-up' \| 'right-up'`。[详细类型定义](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/avatar/type.ts) | N collapseAvatar | TNode | - | 头像数量超出时，会出现一个头像折叠元素。该元素内容可自定义。默认为 `+N`。示例：`+5`，`...`, `更多`。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N max | Number | - | 能够同时显示的最多头像数量 | N -shape | String | - | 形状。优先级低于 Avatar.shape。可选项：circle/round。TS 类型：`ShapeEnum` | N +shape | String | - | 形状。优先级低于 Avatar.shape。可选项：circle/round。TS 类型：`ShapeEnum`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N size | String | - | 尺寸，示例值：small/medium/large/24px/38px 等。优先级低于 Avatar.size | N onCollapsedItemClick | Function | | TS 类型：`(context: { e: MouseEvent }) => void`
点击头像折叠元素触发 | N diff --git a/packages/products/tdesign-mobile-react/src/avatar/type.ts b/packages/products/tdesign-mobile-react/src/avatar/type.ts index 3242d82f..2dd79047 100644 --- a/packages/products/tdesign-mobile-react/src/avatar/type.ts +++ b/packages/products/tdesign-mobile-react/src/avatar/type.ts @@ -6,7 +6,7 @@ import { BadgeProps } from '../badge'; import { ImageProps } from '../image'; -import { TNode, TElement } from '../common'; +import { TNode, TElement, ShapeEnum } from '../common'; import { MouseEvent } from 'react'; export interface TdAvatarProps { @@ -42,7 +42,7 @@ export interface TdAvatarProps { */ imageProps?: ImageProps; /** - * 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.circle 决定 + * 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.shape 决定 */ shape?: ShapeEnum; /** diff --git a/packages/products/tdesign-mobile-vue/src/avatar/avatar.en-US.md b/packages/products/tdesign-mobile-vue/src/avatar/avatar.en-US.md index e62fe4b9..59718a86 100644 --- a/packages/products/tdesign-mobile-vue/src/avatar/avatar.en-US.md +++ b/packages/products/tdesign-mobile-vue/src/avatar/avatar.en-US.md @@ -12,7 +12,7 @@ hideOnLoadFailed | Boolean | false | hide image when loading image failed | N icon | Slot / Function | - | use icon to fill。Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N image | String | - | images url | N imageProps | Object | - | Typescript：`ImageProps`，[Image API Documents](./image?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/avatar/type.ts) | N -shape | String | - | shape。options: circle/round。Typescript：`ShapeEnum` | N +shape | String | - | shape。options: circle/round。Typescript：`ShapeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N size | String | - | size | N onError | Function | | Typescript：`(context: { e: Event }) => void`
trigger on image load failed | N @@ -30,7 +30,7 @@ name | type | default | description | required cascading | String | 'right-up' | multiple images cascading。options: left-up/right-up。Typescript：`CascadingValue` `type CascadingValue = 'left-up' \| 'right-up'`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/avatar/type.ts) | N collapseAvatar | String / Slot / Function | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N max | Number | - | \- | N -shape | String | - | shape。options: circle/round。Typescript：`ShapeEnum` | N +shape | String | - | shape。options: circle/round。Typescript：`ShapeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N size | String | - | size | N onCollapsedItemClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N diff --git a/packages/products/tdesign-mobile-vue/src/avatar/avatar.md b/packages/products/tdesign-mobile-vue/src/avatar/avatar.md index a317506a..47af566e 100644 --- a/packages/products/tdesign-mobile-vue/src/avatar/avatar.md +++ b/packages/products/tdesign-mobile-vue/src/avatar/avatar.md @@ -12,7 +12,7 @@ hideOnLoadFailed | Boolean | false | 加载失败时隐藏图片 | N icon | Slot / Function | - | 图标。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N image | String | - | 图片地址 | N imageProps | Object | - | 透传至 Image 组件。TS 类型：`ImageProps`，[Image API Documents](./image?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/avatar/type.ts) | N -shape | String | - | 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.circle 决定。可选项：circle/round。TS 类型：`ShapeEnum` | N +shape | String | - | 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.shape 决定。可选项：circle/round。TS 类型：`ShapeEnum`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N size | String | - | 尺寸，示例值：small/medium/large/24px/38px 等。优先级高于 AvatarGroup.size 。Avatar 单独存在时，默认值为 medium。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.size 决定 | N onError | Function | | TS 类型：`(context: { e: Event }) => void`
图片加载失败时触发 | N @@ -30,7 +30,7 @@ error | `(context: { e: Event })` | 图片加载失败时触发 cascading | String | 'right-up' | 图片之间的层叠关系，可选值：左侧图片在上和右侧图片在上。可选项：left-up/right-up。TS 类型：`CascadingValue` `type CascadingValue = 'left-up' \| 'right-up'`。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/avatar/type.ts) | N collapseAvatar | String / Slot / Function | - | 头像数量超出时，会出现一个头像折叠元素。该元素内容可自定义。默认为 `+N`。示例：`+5`，`...`, `更多`。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N max | Number | - | 能够同时显示的最多头像数量 | N -shape | String | - | 形状。优先级低于 Avatar.shape。可选项：circle/round。TS 类型：`ShapeEnum` | N +shape | String | - | 形状。优先级低于 Avatar.shape。可选项：circle/round。TS 类型：`ShapeEnum`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N size | String | - | 尺寸，示例值：small/medium/large/24px/38px 等。优先级低于 Avatar.size | N onCollapsedItemClick | Function | | TS 类型：`(context: { e: MouseEvent }) => void`
点击头像折叠元素触发 | N diff --git a/packages/products/tdesign-mobile-vue/src/avatar/props.ts b/packages/products/tdesign-mobile-vue/src/avatar/props.ts index 8d63efdb..a3fcc99f 100644 --- a/packages/products/tdesign-mobile-vue/src/avatar/props.ts +++ b/packages/products/tdesign-mobile-vue/src/avatar/props.ts @@ -32,7 +32,7 @@ export default { imageProps: { type: Object as PropType, }, - /** 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.circle 决定 */ + /** 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.shape 决定 */ shape: { type: String as PropType, validator(val: TdAvatarProps['shape']): boolean { diff --git a/packages/products/tdesign-mobile-vue/src/avatar/type.ts b/packages/products/tdesign-mobile-vue/src/avatar/type.ts index 30d21fc5..335e0f30 100644 --- a/packages/products/tdesign-mobile-vue/src/avatar/type.ts +++ b/packages/products/tdesign-mobile-vue/src/avatar/type.ts @@ -6,7 +6,7 @@ import { BadgeProps } from '../badge'; import { ImageProps } from '../image'; -import { TNode } from '../common'; +import { TNode, ShapeEnum } from '../common'; export interface TdAvatarProps { /** @@ -37,7 +37,7 @@ export interface TdAvatarProps { */ imageProps?: ImageProps; /** - * 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.circle 决定 + * 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.shape 决定 */ shape?: ShapeEnum; /** diff --git a/packages/products/tdesign-react/src/avatar/avatar.en-US.md b/packages/products/tdesign-react/src/avatar/avatar.en-US.md index b5f33d80..4a907063 100644 --- a/packages/products/tdesign-react/src/avatar/avatar.en-US.md +++ b/packages/products/tdesign-react/src/avatar/avatar.en-US.md @@ -15,7 +15,7 @@ hideOnLoadFailed | Boolean | false | hide image when loading image failed | N icon | TElement | - | use icon to fill。Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N image | String | - | images url | N imageProps | Object | - | Typescript：`ImageProps`，[Image API Documents](./image?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/avatar/type.ts) | N -shape | String | - | shape。options: circle/round。Typescript：`ShapeEnum` | N +shape | String | - | shape。options: circle/round。Typescript：`ShapeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N size | String | - | size | N onClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
trigger on click | N onContextmenu | Function | | Typescript：`(context: { e: MouseEvent }) => void`
trigger on context menu | N @@ -33,6 +33,6 @@ cascading | String | 'right-up' | multiple images cascading。options: left-up/r collapseAvatar | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N max | Number | - | \- | N popupProps | Object | - | Typescript：`PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/avatar/type.ts) | N -shape | String | - | shape。options: circle/round。Typescript：`ShapeEnum` | N +shape | String | - | shape。options: circle/round。Typescript：`ShapeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N size | String | - | size | N onCollapsedItemClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N diff --git a/packages/products/tdesign-react/src/avatar/avatar.md b/packages/products/tdesign-react/src/avatar/avatar.md index 09134616..e0c042fc 100644 --- a/packages/products/tdesign-react/src/avatar/avatar.md +++ b/packages/products/tdesign-react/src/avatar/avatar.md @@ -15,7 +15,7 @@ hideOnLoadFailed | Boolean | false | 加载失败时隐藏图片 | N icon | TElement | - | 图标。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N image | String | - | 图片地址 | N imageProps | Object | - | 透传至 Image 组件。TS 类型：`ImageProps`，[Image API Documents](./image?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/src/avatar/type.ts) | N -shape | String | - | 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.circle 决定。可选项：circle/round。TS 类型：`ShapeEnum` | N +shape | String | - | 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.shape 决定。可选项：circle/round。TS 类型：`ShapeEnum`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N size | String | - | 尺寸，示例值：small/medium/large/24px/38px 等。优先级高于 AvatarGroup.size 。Avatar 单独存在时，默认值为 medium。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.size 决定 | N onClick | Function | | TS 类型：`(context: { e: MouseEvent }) => void`
点击时触发 | N onContextmenu | Function | | TS 类型：`(context: { e: MouseEvent }) => void`
右键点击时触发 | N @@ -33,6 +33,6 @@ cascading | String | 'right-up' | 图片之间的层叠关系，可选值：左 collapseAvatar | TNode | - | 头像数量超出时，会出现一个头像折叠元素。该元素内容可自定义。默认为 `+N`。示例：`+5`，`...`, `更多`。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N max | Number | - | 能够同时显示的最多头像数量 | N popupProps | Object | - | 头像右上角提示信息。TS 类型：`PopupProps`，[Popup API Documents](./popup?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/src/avatar/type.ts) | N -shape | String | - | 形状。优先级低于 Avatar.shape。可选项：circle/round。TS 类型：`ShapeEnum` | N +shape | String | - | 形状。优先级低于 Avatar.shape。可选项：circle/round。TS 类型：`ShapeEnum`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N size | String | - | 尺寸，示例值：small/medium/large/24px/38px 等。优先级低于 Avatar.size | N onCollapsedItemClick | Function | | TS 类型：`(context: { e: MouseEvent }) => void`
点击头像折叠元素触发 | N diff --git a/packages/products/tdesign-react/src/avatar/type.ts b/packages/products/tdesign-react/src/avatar/type.ts index 65f9e2d3..c2c6b1dd 100644 --- a/packages/products/tdesign-react/src/avatar/type.ts +++ b/packages/products/tdesign-react/src/avatar/type.ts @@ -6,7 +6,7 @@ import { ImageProps } from '../image'; import { PopupProps } from '../popup'; -import { TNode, TElement } from '../common'; +import { TNode, TElement, ShapeEnum } from '../common'; import { MouseEvent } from 'react'; export interface TdAvatarProps { @@ -42,7 +42,7 @@ export interface TdAvatarProps { */ imageProps?: ImageProps; /** - * 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.circle 决定 + * 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.shape 决定 */ shape?: ShapeEnum; /** diff --git a/packages/products/tdesign-vue-next/src/avatar/avatar.en-US.md b/packages/products/tdesign-vue-next/src/avatar/avatar.en-US.md index ea5bf3fd..151346df 100644 --- a/packages/products/tdesign-vue-next/src/avatar/avatar.en-US.md +++ b/packages/products/tdesign-vue-next/src/avatar/avatar.en-US.md @@ -13,7 +13,7 @@ hideOnLoadFailed | Boolean | false | hide image when loading image failed | N icon | Slot / Function | - | use icon to fill。Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N image | String | - | images url | N imageProps | Object | - | Typescript：`ImageProps`，[Image API Documents](./image?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/avatar/type.ts) | N -shape | String | - | shape。options: circle/round。Typescript：`ShapeEnum` | N +shape | String | - | shape。options: circle/round。Typescript：`ShapeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N size | String | - | size | N onClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
trigger on click | N onContextmenu | Function | | Typescript：`(context: { e: MouseEvent }) => void`
trigger on context menu | N @@ -38,7 +38,7 @@ cascading | String | 'right-up' | multiple images cascading。options: left-up/r collapseAvatar | String / Slot / Function | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N max | Number | - | \- | N popupProps | Object | - | Typescript：`PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/avatar/type.ts) | N -shape | String | - | shape。options: circle/round。Typescript：`ShapeEnum` | N +shape | String | - | shape。options: circle/round。Typescript：`ShapeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N size | String | - | size | N onCollapsedItemClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N diff --git a/packages/products/tdesign-vue-next/src/avatar/avatar.md b/packages/products/tdesign-vue-next/src/avatar/avatar.md index a4f505cc..4cf5fb04 100644 --- a/packages/products/tdesign-vue-next/src/avatar/avatar.md +++ b/packages/products/tdesign-vue-next/src/avatar/avatar.md @@ -13,7 +13,7 @@ hideOnLoadFailed | Boolean | false | 加载失败时隐藏图片 | N icon | Slot / Function | - | 图标。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N image | String | - | 图片地址 | N imageProps | Object | - | 透传至 Image 组件。TS 类型：`ImageProps`，[Image API Documents](./image?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/avatar/type.ts) | N -shape | String | - | 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.circle 决定。可选项：circle/round。TS 类型：`ShapeEnum` | N +shape | String | - | 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.shape 决定。可选项：circle/round。TS 类型：`ShapeEnum`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N size | String | - | 尺寸，示例值：small/medium/large/24px/38px 等。优先级高于 AvatarGroup.size 。Avatar 单独存在时，默认值为 medium。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.size 决定 | N onClick | Function | | TS 类型：`(context: { e: MouseEvent }) => void`
点击时触发 | N onContextmenu | Function | | TS 类型：`(context: { e: MouseEvent }) => void`
右键点击时触发 | N @@ -38,7 +38,7 @@ cascading | String | 'right-up' | 图片之间的层叠关系，可选值：左 collapseAvatar | String / Slot / Function | - | 头像数量超出时，会出现一个头像折叠元素。该元素内容可自定义。默认为 `+N`。示例：`+5`，`...`, `更多`。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N max | Number | - | 能够同时显示的最多头像数量 | N popupProps | Object | - | 头像右上角提示信息。TS 类型：`PopupProps`，[Popup API Documents](./popup?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/avatar/type.ts) | N -shape | String | - | 形状。优先级低于 Avatar.shape。可选项：circle/round。TS 类型：`ShapeEnum` | N +shape | String | - | 形状。优先级低于 Avatar.shape。可选项：circle/round。TS 类型：`ShapeEnum`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N size | String | - | 尺寸，示例值：small/medium/large/24px/38px 等。优先级低于 Avatar.size | N onCollapsedItemClick | Function | | TS 类型：`(context: { e: MouseEvent }) => void`
点击头像折叠元素触发 | N diff --git a/packages/products/tdesign-vue-next/src/avatar/props.ts b/packages/products/tdesign-vue-next/src/avatar/props.ts index 23b8282f..4871b0ea 100644 --- a/packages/products/tdesign-vue-next/src/avatar/props.ts +++ b/packages/products/tdesign-vue-next/src/avatar/props.ts @@ -36,7 +36,7 @@ export default { imageProps: { type: Object as PropType, }, - /** 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.circle 决定 */ + /** 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.shape 决定 */ shape: { type: String as PropType, validator(val: TdAvatarProps['shape']): boolean { diff --git a/packages/products/tdesign-vue-next/src/avatar/type.ts b/packages/products/tdesign-vue-next/src/avatar/type.ts index fbdd8964..4109bca2 100644 --- a/packages/products/tdesign-vue-next/src/avatar/type.ts +++ b/packages/products/tdesign-vue-next/src/avatar/type.ts @@ -6,7 +6,7 @@ import { ImageProps } from '../image'; import { PopupProps } from '../popup'; -import { TNode } from '../common'; +import { TNode, ShapeEnum } from '../common'; export interface TdAvatarProps { /** @@ -41,7 +41,7 @@ export interface TdAvatarProps { */ imageProps?: ImageProps; /** - * 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.circle 决定 + * 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.shape 决定 */ shape?: ShapeEnum; /** diff --git a/packages/products/tdesign-vue/src/avatar/avatar.en-US.md b/packages/products/tdesign-vue/src/avatar/avatar.en-US.md index c62f69dc..0dada989 100644 --- a/packages/products/tdesign-vue/src/avatar/avatar.en-US.md +++ b/packages/products/tdesign-vue/src/avatar/avatar.en-US.md @@ -13,7 +13,7 @@ hideOnLoadFailed | Boolean | false | hide image when loading image failed | N icon | Slot / Function | - | use icon to fill。Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N image | String | - | images url | N imageProps | Object | - | Typescript：`ImageProps`，[Image API Documents](./image?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/avatar/type.ts) | N -shape | String | - | shape。options: circle/round。Typescript：`ShapeEnum` | N +shape | String | - | shape。options: circle/round。Typescript：`ShapeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N size | String | - | size | N onClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
trigger on click | N onContextmenu | Function | | Typescript：`(context: { e: MouseEvent }) => void`
trigger on context menu | N @@ -38,7 +38,7 @@ cascading | String | 'right-up' | multiple images cascading。options: left-up/r collapseAvatar | String / Slot / Function | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N max | Number | - | \- | N popupProps | Object | - | Typescript：`PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/avatar/type.ts) | N -shape | String | - | shape。options: circle/round。Typescript：`ShapeEnum` | N +shape | String | - | shape。options: circle/round。Typescript：`ShapeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N size | String | - | size | N onCollapsedItemClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N diff --git a/packages/products/tdesign-vue/src/avatar/avatar.md b/packages/products/tdesign-vue/src/avatar/avatar.md index 838e17e5..85a0d023 100644 --- a/packages/products/tdesign-vue/src/avatar/avatar.md +++ b/packages/products/tdesign-vue/src/avatar/avatar.md @@ -13,7 +13,7 @@ hideOnLoadFailed | Boolean | false | 加载失败时隐藏图片 | N icon | Slot / Function | - | 图标。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N image | String | - | 图片地址 | N imageProps | Object | - | 透传至 Image 组件。TS 类型：`ImageProps`，[Image API Documents](./image?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/avatar/type.ts) | N -shape | String | - | 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.circle 决定。可选项：circle/round。TS 类型：`ShapeEnum` | N +shape | String | - | 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.shape 决定。可选项：circle/round。TS 类型：`ShapeEnum`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N size | String | - | 尺寸，示例值：small/medium/large/24px/38px 等。优先级高于 AvatarGroup.size 。Avatar 单独存在时，默认值为 medium。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.size 决定 | N onClick | Function | | TS 类型：`(context: { e: MouseEvent }) => void`
点击时触发 | N onContextmenu | Function | | TS 类型：`(context: { e: MouseEvent }) => void`
右键点击时触发 | N @@ -38,7 +38,7 @@ cascading | String | 'right-up' | 图片之间的层叠关系，可选值：左 collapseAvatar | String / Slot / Function | - | 头像数量超出时，会出现一个头像折叠元素。该元素内容可自定义。默认为 `+N`。示例：`+5`，`...`, `更多`。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N max | Number | - | 能够同时显示的最多头像数量 | N popupProps | Object | - | 头像右上角提示信息。TS 类型：`PopupProps`，[Popup API Documents](./popup?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/avatar/type.ts) | N -shape | String | - | 形状。优先级低于 Avatar.shape。可选项：circle/round。TS 类型：`ShapeEnum` | N +shape | String | - | 形状。优先级低于 Avatar.shape。可选项：circle/round。TS 类型：`ShapeEnum`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N size | String | - | 尺寸，示例值：small/medium/large/24px/38px 等。优先级低于 Avatar.size | N onCollapsedItemClick | Function | | TS 类型：`(context: { e: MouseEvent }) => void`
点击头像折叠元素触发 | N diff --git a/packages/products/tdesign-vue/src/avatar/props.ts b/packages/products/tdesign-vue/src/avatar/props.ts index 23b8282f..4871b0ea 100644 --- a/packages/products/tdesign-vue/src/avatar/props.ts +++ b/packages/products/tdesign-vue/src/avatar/props.ts @@ -36,7 +36,7 @@ export default { imageProps: { type: Object as PropType, }, - /** 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.circle 决定 */ + /** 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.shape 决定 */ shape: { type: String as PropType, validator(val: TdAvatarProps['shape']): boolean { diff --git a/packages/products/tdesign-vue/src/avatar/type.ts b/packages/products/tdesign-vue/src/avatar/type.ts index fbdd8964..4109bca2 100644 --- a/packages/products/tdesign-vue/src/avatar/type.ts +++ b/packages/products/tdesign-vue/src/avatar/type.ts @@ -6,7 +6,7 @@ import { ImageProps } from '../image'; import { PopupProps } from '../popup'; -import { TNode } from '../common'; +import { TNode, ShapeEnum } from '../common'; export interface TdAvatarProps { /** @@ -41,7 +41,7 @@ export interface TdAvatarProps { */ imageProps?: ImageProps; /** - * 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.circle 决定 + * 形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.shape 决定 */ shape?: ShapeEnum; /** diff --git a/packages/scripts/api.json b/packages/scripts/api.json index a55a9379..6df2dc5f 100644 --- a/packages/scripts/api.json +++ b/packages/scripts/api.json @@ -6281,7 +6281,7 @@ ], "field_default_value": "", "field_enum": "circle/round", - "field_desc_zh": "形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.circle 决定", + "field_desc_zh": "形状。优先级高于 AvatarGroup.shape 。Avatar 单独存在时，默认值为 circle。如果父组件 AvatarGroup 存在，默认值便由 AvatarGroup.shape 决定", "field_desc_en": "shape", "field_required": 0, "event_input": "", @@ -6295,7 +6295,7 @@ "trigger_elements": "", "deprecated": 0, "version": null, - "test_description": "{\"PC\":{\"snapshot\":true,\"className\":\"t-avatar--${item}\"}}", + "test_description": "", "support_default_value": 0, "field_category_text": "Props", "platform_framework_text": [