Skip to content

Commit ca86b6e

Browse files
liweijie0812liweijie0812
committed
chore: generate doc
1 parent 4dc39f0 commit ca86b6e

File tree

20 files changed

+1143
-11
lines changed

20 files changed

+1143
-11
lines changed

‎db/TDesign.db‎

0 Bytes
Binary file not shown.

‎packages/products/tdesign-react/packages/components/chat/chat.en-US.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,8 +134,9 @@ name | type | default | description | required
134134
className | String | - | className of component | N
135135
style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N
136136
collapsePanelProps | Object | { destroyOnCollapse: false } | Typescript：`CollapsePanelProps`，[Collapse API Documents](./collapse?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/chat/type.ts) | N
137+
expand | Boolean | - | \- | N
137138
expandIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N
138139
expandIconPlacement | String | right | options: left/right | N
139140
header | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N
140141
headerRightContent | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N
141-
onExpandChange | Function | | Typescript：`(value: CollapseValue) => void`<br/>Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/chat/type.ts)。<br/>`import { CollapseValue } from '@Collapse'`<br/> | N
142+
onExpandChange | Function | | Typescript：`(value: boolean) => void`<br/>Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N

‎packages/products/tdesign-react/packages/components/chat/chat.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,8 +134,9 @@ onStop | Function | | TS 类型：`(value:string, context: { e: MouseEvent }) =
134134
className | String | - | 类名 | N
135135
style | Object | - | 样式，TS 类型：`React.CSSProperties` | N
136136
collapsePanelProps | Object | { destroyOnCollapse: false } | 透传给 CollapsePanel 组件的全部属性。TS 类型：`CollapsePanelProps`，[Collapse API Documents](./collapse?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/chat/type.ts) | N
137+
expand | Boolean | - | \- | N
137138
expandIcon | TElement | - | 当前折叠面板展开图标。优先级低于collapsePanelProps.expandIcon。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N
138139
expandIconPlacement | String | right | 展开图标位置，可选项：left/right。可选项：left/right | N
139140
header | TElement | - | 折叠面板头内容。优先级低于collapsePanelProps.header。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N
140141
headerRightContent | TElement | - | 折叠面板尾内容。优先级低于collapsePanelProps.headerRightContent。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N
141-
onExpandChange | Function | | TS 类型：`(value: CollapseValue) => void`<br/>展开图标点击事件。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/chat/type.ts)。<br/>`import { CollapseValue } from '@Collapse'`<br/> | N
142+
onExpandChange | Function | | TS 类型：`(value: boolean) => void`<br/>展开图标点击事件。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N

‎packages/products/tdesign-react/packages/components/chat/type.ts‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
import { AvatarProps } from '../avatar';
88
import { TextareaProps } from '../textarea';
99
import { CollapsePanelProps } from '../collapse';
10-
import { CollapseValue } from '../collapse';
1110
import { TNode, TElement } from '../common';
1211
import { MouseEvent, KeyboardEvent, FocusEvent, FormEvent } from 'react';
1312

@@ -326,6 +325,14 @@ export interface TdChatReasoningProps {
326325
* @default { destroyOnCollapse: false }
327326
*/
328327
collapsePanelProps?: CollapsePanelProps;
328+
/**
329+
* null
330+
*/
331+
expand?: boolean;
332+
/**
333+
* null，非受控属性
334+
*/
335+
defaultExpand?: boolean;
329336
/**
330337
* 当前折叠面板展开图标。优先级低于collapsePanelProps.expandIcon
331338
*/
@@ -346,7 +353,7 @@ export interface TdChatReasoningProps {
346353
/**
347354
* 展开图标点击事件
348355
*/
349-
onExpandChange?: (value: CollapseValue) => void;
356+
onExpandChange?: (value: boolean) => void;
350357
}
351358

352359
export interface TdChatItemMeta {

‎packages/products/tdesign-vue-next/packages/components/chat/chat-reasoning-props.ts‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,17 @@ export default {
1313
type: Object as PropType<TdChatReasoningProps['collapsePanelProps']>,
1414
default: { destroyOnCollapse: false },
1515
},
16+
/** null */
17+
expand: {
18+
type: Boolean,
19+
default: undefined,
20+
},
21+
modelValue: {
22+
type: Boolean,
23+
default: undefined,
24+
},
25+
/** null，非受控属性 */
26+
defaultExpand: Boolean,
1627
/** 当前折叠面板展开图标。优先级低于collapsePanelProps.expandIcon */
1728
expandIcon: {
1829
type: Function as PropType<TdChatReasoningProps['expandIcon']>,

‎packages/products/tdesign-vue-next/packages/components/chat/chat.en-US.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,14 +149,15 @@ stop | `(value:string, context: { e: MouseEvent })` | \-
149149
name | type | default | description | required
150150
-- | -- | -- | -- | --
151151
collapsePanelProps | Object | { destroyOnCollapse: false } | Typescript：`CollapsePanelProps`，[Collapse API Documents](./collapse?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/chat/type.ts) | N
152+
expand | Boolean | - | `v-model` and `v-model:expand` is supported | N
152153
expandIcon | Slot / Function | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N
153154
expandIconPlacement | String | right | options: left/right | N
154155
header | Slot / Function | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N
155156
headerRightContent | Slot / Function | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N
156-
onExpandChange | Function | | Typescript：`(value: CollapseValue) => void`<br/>Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/chat/type.ts)。<br/>`import { CollapseValue } from '@Collapse'`<br/> | N
157+
onExpandChange | Function | | Typescript：`(value: boolean) => void`<br/>Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N
157158

158159
### ChatReasoning Events
159160

160161
name | params | description
161162
-- | -- | --
162-
expand-change | `(value: CollapseValue)` | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/chat/type.ts)。<br/>`import { CollapseValue } from '@Collapse'`<br/>
163+
expand-change | `(value: boolean)` | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)

‎packages/products/tdesign-vue-next/packages/components/chat/chat.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,14 +149,15 @@ stop | `(value:string, context: { e: MouseEvent })` | 点击消息终止的回
149149
名称 | 类型 | 默认值 | 描述 | 必传
150150
-- | -- | -- | -- | --
151151
collapsePanelProps | Object | { destroyOnCollapse: false } | 透传给 CollapsePanel 组件的全部属性。TS 类型：`CollapsePanelProps`，[Collapse API Documents](./collapse?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/chat/type.ts) | N
152+
expand | Boolean | - | 支持语法糖 `v-model` 或 `v-model:expand` | N
152153
expandIcon | Slot / Function | - | 当前折叠面板展开图标。优先级低于collapsePanelProps.expandIcon。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N
153154
expandIconPlacement | String | right | 展开图标位置，可选项：left/right。可选项：left/right | N
154155
header | Slot / Function | - | 折叠面板头内容。优先级低于collapsePanelProps.header。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N
155156
headerRightContent | Slot / Function | - | 折叠面板尾内容。优先级低于collapsePanelProps.headerRightContent。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N
156-
onExpandChange | Function | | TS 类型：`(value: CollapseValue) => void`<br/>展开图标点击事件。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/chat/type.ts)。<br/>`import { CollapseValue } from '@Collapse'`<br/> | N
157+
onExpandChange | Function | | TS 类型：`(value: boolean) => void`<br/>展开图标点击事件。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N
157158

158159
### ChatReasoning Events
159160

160161
名称 | 参数 | 描述
161162
-- | -- | --
162-
expand-change | `(value: CollapseValue)` | 展开图标点击事件。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/chat/type.ts)。<br/>`import { CollapseValue } from '@Collapse'`<br/>
163+
expand-change | `(value: boolean)` | 展开图标点击事件。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)

‎packages/products/tdesign-vue-next/packages/components/chat/type.ts‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
import { AvatarProps } from '../avatar';
88
import { TextareaProps } from '../textarea';
99
import { CollapsePanelProps } from '../collapse';
10-
import { CollapseValue } from '../collapse';
1110
import { TNode } from '../common';
1211

1312
export interface TdChatProps {
@@ -329,6 +328,18 @@ export interface TdChatReasoningProps {
329328
* @default { destroyOnCollapse: false }
330329
*/
331330
collapsePanelProps?: CollapsePanelProps;
331+
/**
332+
* null
333+
*/
334+
expand?: boolean;
335+
/**
336+
* null，非受控属性
337+
*/
338+
defaultExpand?: boolean;
339+
/**
340+
* null
341+
*/
342+
modelValue?: boolean;
332343
/**
333344
* 当前折叠面板展开图标。优先级低于collapsePanelProps.expandIcon
334345
*/
@@ -349,7 +360,7 @@ export interface TdChatReasoningProps {
349360
/**
350361
* 展开图标点击事件
351362
*/
352-
onExpandChange?: (value: CollapseValue) => void;
363+
onExpandChange?: (value: boolean) => void;
353364
}
354365

355366
export interface TdChatItemMeta {

‎packages/products/tdesign-vue/src/chat/chat-action-props.ts‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
/* eslint-disable */
2+
3+
/**
4+
* 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
5+
* */
6+
7+
import { TdChatActionProps } from '../chat/type';
8+
import { PropType } from 'vue';
9+
10+
export default {
11+
/** 被复制的内容 */
12+
content: {
13+
type: String,
14+
default: '',
15+
},
16+
/** 操作按钮是否可点击 */
17+
disabled: Boolean,
18+
/** 是否点踩 */
19+
isBad: Boolean,
20+
/** 是否点赞 */
21+
isGood: Boolean,
22+
/** 操作按钮配置项，可配置操作按钮选项和顺序 */
23+
operationBtn: {
24+
type: Array as PropType<TdChatActionProps['operationBtn']>,
25+
default: (): TdChatActionProps['operationBtn'] => ["replay", "copy", "good", "bad"],
26+
},
27+
/** 点击点赞，点踩，复制，重新生成按钮时触发 */
28+
onOperation: Function as PropType<TdChatActionProps['onOperation']>,
29+
};

‎packages/products/tdesign-vue/src/chat/chat-content-props.ts‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/* eslint-disable */
2+
3+
/**
4+
* 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
5+
* */
6+
7+
import { TdChatContentProps } from '../chat/type';
8+
import { PropType } from 'vue';
9+
10+
export default {
11+
/** 聊天内容，支持 markdown 格式 */
12+
content: {
13+
type: String,
14+
default: '',
15+
},
16+
/** 角色，不同选项配置不同的样式，支持类型包括用户、助手、错误、模型切换、系统消息 */
17+
role: {
18+
type: String as PropType<TdChatContentProps['role']>,
19+
validator(val: TdChatContentProps['role']): boolean {
20+
if (!val) return true;
21+
return ['user', 'assistant', 'error', 'model-change', 'system'].includes(val);
22+
},
23+
},
24+
};

0 commit comments

Comments
 (0)