docs(Chat): update api docs

Author: anlyyao

packages/components/common/common.ts

@@ -6,9 +6,6 @@ export interface Styles {
 
 export type ImageEvent = any;
 
-/**
- * 通用全局类型
- * */
 export type PlainObject = { [key: string]: any };
 
 export type OptionData = {
@@ -28,6 +25,9 @@ export type TreeOptionData<T = string | number> = {
   content?: string;
 } & PlainObject;
 
+/**
+ * 通用全局类型
+ * */
 export type SizeEnum = 'small' | 'medium' | 'large';
 
 export type ShapeEnum = 'circle' | 'round';

packages/pro-components/chat/attachments/README.en-US.md

@@ -0,0 +1,23 @@
+:: BASE_DOC ::
+
+## API
+
+### Attachments Props
+
+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
+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/components/attachments/type.ts) | N
+overflow | String | wrap | options: wrap/scrollX/scrollY | N
+removable | Boolean | true | \- | N
+
+### Attachments Events
+
+name | params | description
+-- | -- | --
+add | \- | \-
+file-click | `(item: FileItem)` | \-
+remove | `(item: FileItem, index: number)` | \-

packages/pro-components/chat/attachments/README.md

@@ -49,35 +49,18 @@ isComponent: true
 
 名称 | 类型 | 默认值 | 描述 | 必传
 -- | -- | -- | -- | --
-items | Array | [] | 附件列表。TS类型：FileItem[] | Y
-removable | Boolean | true | 是否显示删除按钮 | N
-imageViewer | Boolean | true | 是否启用图片预览功能 | N
+style | Object | - | 样式 | N
+custom-style | Object | - | 样式，一般用于开启虚拟化组件节点场景 | N
 addable | Boolean | true | 是否显示添加按钮 | N
-
-
-
-
-### FileItem 类型定义
-```typescript
-interface FileItem {
-  fileType: 'image'|'video'|'audio'|'pdf'|'doc'|'ppt'|'txt'  // 文件类型
-  name: string  // 文件名
-  url: string  // 文件URL
-  size: number  // 文件大小(KB)
-  status?: 'success'|'fail'|'pending'|'error'  // 上传状态
-  progress?: number  // 上传进度(0-100)
-  errorMessage?: string  // 错误信息
-  fileIcon?: string  // 自定义文件图标URL
-  width?: number  // 图片宽度(px)
-  height?: number  // 图片高度(px)
-  mode?: 'aspectFit' | 'aspectFill' | 'widthFix' | 'heightFix' | 'scaleToFill'  // 图片模式
-}
+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/components/attachments/type.ts) | N
+overflow | String | wrap | 文件列表超出时样式。可选项：wrap/scrollX/scrollY | N
+removable | Boolean | true | 是否显示删除按钮 | N
 
 ### Attachments Events
 
 名称 | 参数 | 描述
 -- | -- | --
-fileClick | `(item: FileItem)` | 点击文件时触发
+add | \- | 点击添加按钮时触发
+file-click | `(item: FileItem)` | 点击文件时触发
 remove | `(item: FileItem, index: number)` | 点击删除按钮时触发
-add | - | 点击添加按钮时触发
-

packages/pro-components/chat/attachments/attachments.ts

@@ -1,9 +1,12 @@
 import { SuperComponent, wxComponent, ComponentsOptionsType } from '../../../components/common/src/index';
 import config from '../../../components/common/config';
+import { TdAttachmentsProps } from './type';
 
 const { prefix } = config;
 const name = `${prefix}-attachments`;
 
+export interface AttachmentsProps extends TdAttachmentsProps {}
+
 @wxComponent()
 export default class Attachments extends SuperComponent {
   options: ComponentsOptionsType = {

packages/pro-components/chat/attachments/index.ts

@@ -0,0 +1,3 @@
+export * from './props';
+export * from './type';
+export * from './attachments';

packages/pro-components/chat/attachments/props.ts

@@ -4,15 +4,10 @@
  * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
  * */
 
-import { TdChatAttachmentsProps } from './type';
-const props: TdChatAttachmentsProps = {
-  /** 文件列表数据，每个元素需包含fileType/name/url/size等属性 */
-  items: {
-    type: Array,
-    value: [],
-  },
-  /** 是否显示删除按钮 */
-  removable: {
+import { TdAttachmentsProps } from './type';
+const props: TdAttachmentsProps = {
+  /** 是否显示添加按钮 */
+  addable: {
     type: Boolean,
     value: true,
   },
@@ -21,11 +16,21 @@ const props: TdChatAttachmentsProps = {
     type: Boolean,
     value: true,
   },
-  /** 是否显示添加按钮 */
-  addable: {
+  /** 【实验】附件列表 */
+  items: {
+    type: Array,
+    value: [],
+  },
+  /** 文件列表超出时样式 */
+  overflow: {
+    type: String,
+    value: 'wrap',
+  },
+  /** 是否显示删除按钮 */
+  removable: {
     type: Boolean,
     value: true,
-  }
+  },
 };
 
 export default props;

packages/pro-components/chat/attachments/type.ts

@@ -4,66 +4,12 @@
  * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
  * */
 
-export interface FileItem {
-  /**
-   * 文件类型
-   */
-  fileType: 'image' | 'pdf' | 'doc' | 'ppt' | 'txt';
-  /**
-   * 文件名
-   */
-  name: string;
-  /**
-   * 文件URL
-   */
-  url: string;
-  /**
-   * 文件大小(KB)
-   */
-  size: number;
-  /**
-   * 上传状态
-   */
-  status?: 'success' | 'fail' | 'pending' | 'error';
-  /**
-   * 上传进度(0-100)
-   */
-  progress?: number;
-  /**
-   * 错误信息
-   */
-  errorMessage?: string;
-  /**
-   * 自定义文件图标URL
-   */
-  fileIcon?: string;
-  /**
-   * 图片宽度
-   */
-  width?: number;
-  /**
-   * 图片高度
-   */
-  height?: number;
-  /**
-   * 图片缩放模式
-   */
-  mode?: 'aspectFit' | 'aspectFill' | 'widthFix' | 'heightFix' | 'scaleToFill';
-}
-export interface TdChatAttachmentsProps {
-  /**
-   * 文件列表数据，每个元素需包含fileType/name/url/size等属性
-   * @default []
-   */
-  items?: {
-    type: ArrayConstructor;
-    value?: FileItem[];
-  };
+export interface TdAttachmentsProps {
   /**
-   * 是否显示删除按钮
+   * 是否显示添加按钮
    * @default true
    */
-  removable?: {
+  addable?: {
     type: BooleanConstructor;
     value?: boolean;
   };
@@ -76,11 +22,41 @@ export interface TdChatAttachmentsProps {
     value?: boolean;
   };
   /**
-   * 是否显示添加按钮
+   * 【实验】附件列表
+   * @default []
+   */
+  items?: {
+    type: ArrayConstructor;
+    value?: FileItem[];
+  };
+  /**
+   * 文件列表超出时样式
+   * @default wrap
+   */
+  overflow?: {
+    type: StringConstructor;
+    value?: 'wrap' | 'scrollX' | 'scrollY';
+  };
+  /**
+   * 是否显示删除按钮
    * @default true
    */
-  addable?: {
+  removable?: {
     type: BooleanConstructor;
     value?: boolean;
   };
 }
+
+export 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';
+}

packages/pro-components/chat/chat-actionbar/README.en-US.md

@@ -0,0 +1,23 @@
+:: BASE_DOC ::
+
+## API
+
+### ChatActionbar Props
+
+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
+action-bar | Array | ['refresh', 'copy', 'good', 'bad', 'share'] | Typescript: `Array<string>` | N
+chat-id | String | - | \- | N
+comment | String | - | \- | N
+content | String | - | \- | N
+copy-mode | String | markdown | options: markdown/text | N
+disabled | Boolean | false | \- | N
+placement | String | start | options: start/end/space-around/space-between | N
+
+### ChatActionbar Events
+
+name | params | description
+-- | -- | --
+actions | `(name: ChatActionsName, active: boolean)` | \-

packages/pro-components/chat/chat-actionbar/README.md

@@ -37,19 +37,23 @@ isComponent: true
 
 
 ## API
-### ChatAction Props
+
+### ChatActionbar Props
 
 名称 | 类型 | 默认值 | 描述 | 必传
 -- | -- | -- | -- | --
-chatId | String | '' | 聊天消息的唯一标识，一般用于分享一段问答 | N
-content | String | - | 被复制的内容 | N
-copyMode | String | markdown | 复制内容的模式，可选 'markdown'（复制markdown原文）或 'text'（复制纯文本） | N
-comment | String | - | 评价类型， 可选值： `'good(点赞)'/'bad(点踩)`， 默认为空| N
-actionBar | Array | ["refresh", "copy", "good", "bad", "share"] | 操作按钮配置项，可配置操作按钮选项和顺序。TS 类型：`Array<'refresh'\|'copy'\|'good'\|'bad'\|'share'>` | N
-placement | String | start | 操作栏位置。可选项：start/end/space-around/space-between | N
-
-### ChatAction Events
+style | Object | - | 样式 | N
+custom-style | Object | - | 样式，一般用于开启虚拟化组件节点场景 | N
+action-bar | Array | ['refresh', 'copy', 'good', 'bad', 'share'] | 操作栏配置。TS 类型：`Array<string>` | N
+chat-id | String | - | 【实验】聊天消息的唯一标识 | N
+comment | String | - | 评价内容 | N
+content | String | - | 复制内容文本 | N
+copy-mode | String | markdown | 【实验】复制内容的模式，可选 'markdown'（复制markdown原文）或 'text'（复制纯文本）。可选项：markdown/text | N
+disabled | Boolean | false | 【讨论中】操作按钮是否可点击 | N
+placement | String | start | 【实验】操作栏位置。可选项：start/end/space-around/space-between | N
+
+### ChatActionbar Events
 
 名称 | 参数 | 描述
 -- | -- | --
-actions | `(name: ChatActionsName, context: { e: MouseEvent, active: boolean })`  点击点赞，点踩，复制，分享，重新生成按钮时触发发
+actions | `(name: ChatActionsName, active: boolean)` | 点击点赞，点踩，复制，分享，重新生成按钮时触发发

packages/pro-components/chat/chat-actionbar/props.ts

@@ -0,0 +1,46 @@
+/* eslint-disable */
+
+/**
+ * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
+ * */
+
+import { TdChatActionbarProps } from './type';
+const props: TdChatActionbarProps = {
+  /** 操作栏配置 */
+  actionBar: {
+    type: Array,
+    value: ['refresh', 'copy', 'good', 'bad', 'share'],
+  },
+  /** 【实验】聊天消息的唯一标识 */
+  chatId: {
+    type: String,
+    value: '',
+  },
+  /** 评价内容 */
+  comment: {
+    type: String,
+    value: '',
+  },
+  /** 复制内容文本 */
+  content: {
+    type: String,
+    value: '',
+  },
+  /** 【实验】复制内容的模式，可选 'markdown'（复制markdown原文）或 'text'（复制纯文本） */
+  copyMode: {
+    type: String,
+    value: 'markdown',
+  },
+  /** 【讨论中】操作按钮是否可点击 */
+  disabled: {
+    type: Boolean,
+    value: false,
+  },
+  /** 【实验】操作栏位置 */
+  placement: {
+    type: String,
+    value: 'start',
+  },
+};
+
+export default props;