docs: update api docs

anlyyao · anlyyao · commit 958458b8e910 · 2025-11-12T21:05:55.000+08:00
diff --git a/packages/pro-components/chat/attachments/README.en-US.md b/packages/pro-components/chat/attachments/README.en-US.md
@@ -10,7 +10,7 @@ style | Object | - | CSS(Cascading Style Sheets) | N
 custom-style | Object | - | CSS(Cascading Style Sheets)，used to set style on virtual component | N
 addable | Boolean | true | \- | N
 image-viewer | Boolean | true | \- | N
-items | Array | [] | Typescript: `FileItem[]` `interface FileItem { fileType: 'image'\|'video'\|'audio'\|'pdf'\|'doc'\|'ppt'\|'txt'; name: string; url: string; size: number; status?: 'success'\|'fail'\|'pending'\|'error'; progress?: number; errorMessage?: string; fileIcon?: string; width?: number; height?: number; mode?: 'aspectFit' \| 'aspectFill' \| 'widthFix' \| 'heightFix' \| 'scaleToFill'}`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/pro-components/chat/attachments/type.ts) | N
+items | Array | [] | required。Typescript: `FileItem[]` `interface FileItem { fileType: 'image'\|'video'\|'audio'\|'pdf'\|'doc'\|'ppt'\|'txt'; name: string; url: string; size: number; status?: 'success'\|'fail'\|'pending'\|'error'; progress?: number; errorMessage?: string; fileIcon?: string; width?: number; height?: number; mode?: 'aspectFit' \| 'aspectFill' \| 'widthFix' \| 'heightFix' \| 'scaleToFill'}`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/pro-components/chat/attachments/type.ts) | Y
 removable | Boolean | true | \- | N
 
 ### Attachments Events
diff --git a/packages/pro-components/chat/attachments/README.md b/packages/pro-components/chat/attachments/README.md
@@ -54,7 +54,7 @@ style | Object | - | 样式 | N
 custom-style | Object | - | 样式，一般用于开启虚拟化组件节点场景 | N
 addable | Boolean | true | 【讨论中】是否显示添加按钮 | N
 image-viewer | Boolean | true | 是否启用图片预览功能 | N
-items | Array | [] | 【实验】附件列表。TS 类型：`FileItem[]` `interface FileItem { fileType: 'image'\|'video'\|'audio'\|'pdf'\|'doc'\|'ppt'\|'txt'; name: string; url: string; size: number; status?: 'success'\|'fail'\|'pending'\|'error'; progress?: number; errorMessage?: string; fileIcon?: string; width?: number; height?: number; mode?: 'aspectFit' \| 'aspectFill' \| 'widthFix' \| 'heightFix' \| 'scaleToFill'}`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/pro-components/chat/attachments/type.ts) | N
+items | Array | [] | 必需。附件列表。TS 类型：`FileItem[]` `interface FileItem { fileType: 'image'\|'video'\|'audio'\|'pdf'\|'doc'\|'ppt'\|'txt'; name: string; url: string; size: number; status?: 'success'\|'fail'\|'pending'\|'error'; progress?: number; errorMessage?: string; fileIcon?: string; width?: number; height?: number; mode?: 'aspectFit' \| 'aspectFill' \| 'widthFix' \| 'heightFix' \| 'scaleToFill'}`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/pro-components/chat/attachments/type.ts) | Y
 removable | Boolean | true | 是否显示删除按钮 | N
 
 ### Attachments Events
diff --git a/packages/pro-components/chat/attachments/props.ts b/packages/pro-components/chat/attachments/props.ts
@@ -16,10 +16,11 @@ const props: TdAttachmentsProps = {
     type: Boolean,
     value: true,
   },
-  /** 【实验】附件列表 */
+  /** 附件列表 */
   items: {
     type: Array,
     value: [],
+    required: true,
   },
   /** 是否显示删除按钮 */
   removable: {
diff --git a/packages/pro-components/chat/attachments/type.ts b/packages/pro-components/chat/attachments/type.ts
@@ -22,12 +22,13 @@ export interface TdAttachmentsProps {
     value?: boolean;
   };
   /**
-   * 【实验】附件列表
+   * 附件列表
    * @default []
    */
-  items?: {
+  items: {
     type: ArrayConstructor;
     value?: FileItem[];
+    required?: boolean;
   };
   /**
    * 是否显示删除按钮
diff --git a/packages/pro-components/chat/chat-list/README.en-US.md b/packages/pro-components/chat/chat-list/README.en-US.md
@@ -8,8 +8,8 @@ name | type | default | description | required
 -- | -- | -- | -- | --
 style | Object | - | CSS(Cascading Style Sheets) | N
 custom-style | Object | - | CSS(Cascading Style Sheets)，used to set style on virtual component | N
-animation | String | skeleton | options: skeleton/moving/gradient | N
-data | Array | - | Typescript: `Array<TdChatItemMeta>` ` interface TdChatItemMeta { avatar?: string; name?:string; role?:string; datetime?: string; content?: string; reasoning?: string }`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/pro-components/chat/chat-list/type.ts) | N
+animation | String | skeleton | options: skeleton/moving/gradient/dot | N
+data | Array | - | Typescript: `Array<TdChatItemMeta>` ` interface TdChatItemMeta { avatar?: string; name?:string; role?:string; datetime?: string; content?: string; status?: string }`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/pro-components/chat/chat-list/type.ts) | N
 layout | String | both | options: both/single | N
 reverse | Boolean | true | \- | N
 
diff --git a/packages/pro-components/chat/chat-list/README.md b/packages/pro-components/chat/chat-list/README.md
@@ -61,9 +61,9 @@ isComponent: true
 -- | -- | -- | -- | --
 style | Object | - | 样式 | N
 custom-style | Object | - | 样式，一般用于开启虚拟化组件节点场景 | N
-animation | String | skeleton | 动画效果，支持「渐变加载动画」,「闪烁加载动画」, 「骨架屏」三种。可选项：skeleton/moving/gradient | N
-data | Array | - | 对话列表的数据。TS 类型：`Array<TdChatItemMeta>` ` interface TdChatItemMeta { avatar?: string; name?:string; role?:string; datetime?: string; content?: string; reasoning?: string }`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/pro-components/chat/chat-list/type.ts) | N
-layout | String | both | 对话布局形式，支持两侧对齐与左对齐。使用插槽自定义对话内容时不生效，得用`t-chat-message`的`placement`属性。。可选项：both/single | N
+animation | String | skeleton | 动画效果，支持「渐变加载动画」,「闪烁加载动画」, 「骨架屏」三种。可选项：skeleton/moving/gradient/dot | N
+data | Array | - | 对话列表的数据。TS 类型：`Array<TdChatItemMeta>` ` interface TdChatItemMeta { avatar?: string; name?:string; role?:string; datetime?: string; content?: string; status?: string }`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/pro-components/chat/chat-list/type.ts) | N
+layout | String | both | 对话布局形式，支持两侧对齐与左对齐。使用插槽自定义对话内容时不生效，得用`t-chat-message`的`placement`属性。可选项：both/single | N
 reverse | Boolean | true | 是否表现为倒序 | N
 
 ### ChatList Events
diff --git a/packages/pro-components/chat/chat-list/props.ts b/packages/pro-components/chat/chat-list/props.ts
@@ -15,7 +15,7 @@ const props: TdChatListProps = {
   data: {
     type: Array,
   },
-  /** 对话布局形式，支持两侧对齐与左对齐。使用插槽自定义对话内容时不生效，得用`t-chat-message`的`placement`属性。 */
+  /** 对话布局形式，支持两侧对齐与左对齐。使用插槽自定义对话内容时不生效，得用`t-chat-message`的`placement`属性 */
   layout: {
     type: String,
     value: 'both',
diff --git a/packages/pro-components/chat/chat-list/type.ts b/packages/pro-components/chat/chat-list/type.ts
@@ -11,7 +11,7 @@ export interface TdChatListProps {
    */
   animation?: {
     type: StringConstructor;
-    value?: 'skeleton' | 'moving' | 'gradient';
+    value?: 'skeleton' | 'moving' | 'gradient' | 'dot';
   };
   /**
    * 对话列表的数据
@@ -21,7 +21,7 @@ export interface TdChatListProps {
     value?: Array<TdChatItemMeta>;
   };
   /**
-   * 对话布局形式，支持两侧对齐与左对齐。使用插槽自定义对话内容时不生效，得用`t-chat-message`的`placement`属性。
+   * 对话布局形式，支持两侧对齐与左对齐。使用插槽自定义对话内容时不生效，得用`t-chat-message`的`placement`属性
    * @default both
    */
   layout?: {
@@ -44,5 +44,5 @@ export interface TdChatItemMeta {
   role?: string;
   datetime?: string;
   content?: string;
-  reasoning?: string;
+  status?: string;
 }
diff --git a/packages/pro-components/chat/chat-message/README.en-US.md b/packages/pro-components/chat/chat-message/README.en-US.md
@@ -7,7 +7,6 @@ name | type | default | description | required
 -- | -- | -- | -- | --
 style | Object | - | CSS(Cascading Style Sheets) | N
 custom-style | Object | - | CSS(Cascading Style Sheets)，used to set style on virtual component | N
-allow-content-segment-custom | Boolean | false | \- | N
 animation | String | skeleton | options: skeleton/moving/gradient/dots | N
 avatar | String | - | \- | N
 chat-content-props | Object | - | Typescript: `ChatContentProps`，[ChatContent API Documents](./chat-content?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/pro-components/chat/chat-message/type.ts) | N
diff --git a/packages/pro-components/chat/chat-message/README.md b/packages/pro-components/chat/chat-message/README.md
@@ -63,7 +63,6 @@ isComponent: true
 -- | -- | -- | -- | --
 style | Object | - | 样式 | N
 custom-style | Object | - | 样式，一般用于开启虚拟化组件节点场景 | N
-allow-content-segment-custom | Boolean | false | 【实验】 是否允许自定义局部消息内容，其他消息内容实用默认样式 | N
 animation | String | skeleton | 动画效果。可选项：skeleton/moving/gradient/dots | N
 avatar | String | - | 自定义的头像配置 | N
 chat-content-props | Object | - | 聊天内容组件的属性。TS 类型：`ChatContentProps`，[ChatContent API Documents](./chat-content?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/pro-components/chat/chat-message/type.ts) | N
diff --git a/packages/pro-components/chat/chat-message/props.ts b/packages/pro-components/chat/chat-message/props.ts
@@ -6,11 +6,6 @@
 
 import { TdChatMessageProps } from './type';
 const props: TdChatMessageProps = {
-  /** 【实验】 是否允许自定义局部消息内容，其他消息内容实用默认样式 */
-  allowContentSegmentCustom: {
-    type: Boolean,
-    value: false,
-  },
   /** 动画效果 */
   animation: {
     type: String,
diff --git a/packages/pro-components/chat/chat-message/type.ts b/packages/pro-components/chat/chat-message/type.ts
@@ -8,14 +8,6 @@ import { ChatContentProps } from '../chat-content/index';
 import { FileItem } from '../attachments/index';
 
 export interface TdChatMessageProps {
-  /**
-   * 【实验】 是否允许自定义局部消息内容，其他消息内容实用默认样式
-   * @default false
-   */
-  allowContentSegmentCustom?: {
-    type: BooleanConstructor;
-    value?: boolean;
-  };
   /**
    * 动画效果
    * @default skeleton
diff --git a/packages/pro-components/chat/chat-sender/README.en-US.md b/packages/pro-components/chat/chat-sender/README.en-US.md
@@ -18,7 +18,6 @@ placeholder | String | 请输入消息... | \- | N
 render-presets | Array | [{name: 'upload', presets: ['uploadCamera', 'uploadImage', 'uploadAttachment'], status: ''},{ name: 'send', type: 'icon'}] | Typescript: `ChatActionButtons` `type ChatActionButtons = Array<ChatActionButton>` `type ChatActionButton = UploadButton \| SendButton` `interface UploadButton { name: 'upload'; presets: string[]; status?: string; }` `interface SendButton { name: 'send'; type: 'icon' \| 'text';}`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/pro-components/chat/chat-sender/type.ts) | N
 textarea-props | Boolean / Object | { autosize: { maxHeight: 264, minHeight: 48 } } | \- | N
 value | String | - | input value | N
-default-value | String | undefined | input value。uncontrolled property | N
 visible | Boolean | false | \- | N
 
 ### ChatSender Events
diff --git a/packages/pro-components/chat/chat-sender/README.md b/packages/pro-components/chat/chat-sender/README.md
@@ -65,7 +65,6 @@ placeholder | String | 请输入消息... | 输入框默认文案 | N
 render-presets | Array | [{name: 'upload', presets: ['uploadCamera', 'uploadImage', 'uploadAttachment'], status: ''},{ name: 'send', type: 'icon'}] | 预设发送区渲染配置，用于灵活配置发送区的上传入口和发送按钮，支持自定义类型、顺序、样式。TS 类型：`ChatActionButtons` `type ChatActionButtons = Array<ChatActionButton>` `type ChatActionButton = UploadButton \| SendButton` `interface UploadButton { name: 'upload'; presets: string[]; status?: string; }` `interface SendButton { name: 'send'; type: 'icon' \| 'text';}`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/pro-components/chat/chat-sender/type.ts) | N
 textarea-props | Boolean / Object | { autosize: { maxHeight: 264, minHeight: 48 } } | 透传给 Textarea 组件的属性，autosize数值单位为 rpx | N
 value | String | - | 输入框的值 | N
-default-value | String | undefined | 输入框的值。非受控属性 | N
 visible | Boolean | false | 上传面板是否可见 | N
 
 ### ChatSender Events
diff --git a/packages/pro-components/chat/chat-thinking/README.en-US.md b/packages/pro-components/chat/chat-thinking/README.en-US.md
@@ -8,7 +8,7 @@ name | type | default | description | required
 -- | -- | -- | -- | --
 style | Object | - | CSS(Cascading Style Sheets) | N
 custom-style | Object | - | CSS(Cascading Style Sheets)，used to set style on virtual component | N
-animation | String | moving | options: circle/moving/gradient | N
+animation | String | moving | options: skeleton/moving/gradient/dot | N
 collapsed | Boolean | false | \- | N
 content | Object | - | required。Typescript: `{ text?: string; title?: string }` | Y
 layout | String | block | options: block/border | N
diff --git a/packages/pro-components/chat/chat-thinking/README.md b/packages/pro-components/chat/chat-thinking/README.md
@@ -55,7 +55,7 @@ isComponent: true
 -- | -- | -- | -- | --
 style | Object | - | 样式 | N
 custom-style | Object | - | 样式，一般用于开启虚拟化组件节点场景 | N
-animation | String | moving | 内容区域最大高度，超出会自动滚动。可选项：circle/moving/gradient | N
+animation | String | moving | 内容区域最大高度，超出会自动滚动。可选项：skeleton/moving/gradient/dot | N
 collapsed | Boolean | false | 是否折叠 | N
 content | Object | - | 必需。思考内容对象。TS 类型：`{ text?: string; title?: string }` | Y
 layout | String | block | 布局方式。可选项：block/border | N
diff --git a/packages/pro-components/chat/chat-thinking/type.ts b/packages/pro-components/chat/chat-thinking/type.ts
@@ -11,7 +11,7 @@ export interface TdChatThinkingProps {
    */
   animation?: {
     type: StringConstructor;
-    value?: 'circle' | 'moving' | 'gradient';
+    value?: 'skeleton' | 'moving' | 'gradient' | 'dot';
   };
   /**
    * 是否折叠
