Skip to content

Commit 7752f96

Browse files
RylanBotRylanBot
authored
feat(MessagePlugin): first parameter supports TNode (#740)
* feat(MessagePlugin): first parameter supports `TNode` * chore: update type * docs: update `String` to `string`
1 parent 1f13724 commit 7752f96

File tree

11 files changed

+104
-71
lines changed

11 files changed

+104
-71
lines changed

‎db/TDesign.db‎

0 Bytes
Binary file not shown.

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,49 +34,49 @@ zIndex | Number | 5000 | \- | N
3434
name | params | default | description
3535
-- | -- | -- | --
3636
theme | String | - | required。Typescript：`MessageThemeList`
37-
message | String / Object | - | required。Typescript：`string \| MessageOptions`
37+
message | String / Object | - | required。Typescript：`string \| TNode \| MessageOptions`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)
3838
duration | Number | 3000 | \-
3939

4040
### message.info 或 MessagePlugin.info
4141

4242
name | params | default | description
4343
-- | -- | -- | --
44-
message | String / Object | - | required。Typescript：`string \| MessageInfoOptions` `type MessageInfoOptions = Omit<MessageOptions, 'theme'>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/message/type.ts)
44+
message | String / Object | - | required。Typescript：`string \| TNode \| MessageInfoOptions` `type MessageInfoOptions = Omit<MessageOptions, 'theme'>`。[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/message/type.ts)
4545
duration | Number | 3000 | \-
4646

4747
### message.error 或 MessagePlugin.error
4848

4949
name | params | default | description
5050
-- | -- | -- | --
51-
message | String / Object | - | required。Typescript：`string \| MessageInfoOptions`
51+
message | String / Object | - | required。Typescript：`string \| TNode \| MessageInfoOptions`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)
5252
duration | Number | 3000 | \-
5353

5454
### message.warning 或 MessagePlugin.warning
5555

5656
name | params | default | description
5757
-- | -- | -- | --
58-
message | String / Object | - | required。Typescript：`string \| MessageInfoOptions`
58+
message | String / Object | - | required。Typescript：`string \| TNode \| MessageInfoOptions`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)
5959
duration | Number | 3000 | \-
6060

6161
### message.success 或 MessagePlugin.success
6262

6363
name | params | default | description
6464
-- | -- | -- | --
65-
message | String / Object | - | required。Typescript：`string \| MessageInfoOptions`
65+
message | String / Object | - | required。Typescript：`string \| TNode \| MessageInfoOptions`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)
6666
duration | Number | 3000 | \-
6767

6868
### message.loading 或 MessagePlugin.loading
6969

7070
name | params | default | description
7171
-- | -- | -- | --
72-
message | String / Object | - | required。Typescript：`string \| MessageInfoOptions`
72+
message | String / Object | - | required。Typescript：`string \| TNode \| MessageInfoOptions`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)
7373
duration | Number | 3000 | \-
7474

7575
### message.question 或 MessagePlugin.question
7676

7777
name | params | default | description
7878
-- | -- | -- | --
79-
message | String / Object | - | required。Typescript：`string \| MessageInfoOptions`
79+
message | String / Object | - | required。Typescript：`string \| TNode \| MessageInfoOptions`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)
8080
duration | Number | 3000 | \-
8181

8282
### message.closeAll 或 MessagePlugin.closeAll

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,49 +34,49 @@ zIndex | Number | 5000 | 消息层级 | N
3434
参数名称 | 参数类型 | 参数默认值 | 参数描述
3535
-- | -- | -- | --
3636
theme | String | - | 必需。消息类型。TS 类型：`MessageThemeList`
37-
message | String / Object | - | 必需。消息内容。TS 类型：`string \| MessageOptions`
37+
message | String / Object | - | 必需。消息内容。TS 类型：`string \| TNode \| MessageOptions`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)
3838
duration | Number | 3000 | 消息显示时长，单位：毫秒。值为 0 表示永久显示
3939

4040
### message.info 或 MessagePlugin.info
4141

4242
参数名称 | 参数类型 | 参数默认值 | 参数描述
4343
-- | -- | -- | --
44-
message | String / Object | - | 必需。消息内容。TS 类型：`string \| MessageInfoOptions` `type MessageInfoOptions = Omit<MessageOptions, 'theme'>`。[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/message/type.ts)
44+
message | String / Object | - | 必需。消息内容。TS 类型：`string \| TNode \| MessageInfoOptions` `type MessageInfoOptions = Omit<MessageOptions, 'theme'>`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/message/type.ts)
4545
duration | Number | 3000 | 消息显示时长，单位：毫秒。值为 0 表示永久显示
4646

4747
### message.error 或 MessagePlugin.error
4848

4949
参数名称 | 参数类型 | 参数默认值 | 参数描述
5050
-- | -- | -- | --
51-
message | String / Object | - | 必需。消息内容。TS 类型：`string \| MessageInfoOptions`
51+
message | String / Object | - | 必需。消息内容。TS 类型：`string \| TNode \| MessageInfoOptions`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)
5252
duration | Number | 3000 | 消息显示时长，单位：毫秒。值为 0 表示永久显示
5353

5454
### message.warning 或 MessagePlugin.warning
5555

5656
参数名称 | 参数类型 | 参数默认值 | 参数描述
5757
-- | -- | -- | --
58-
message | String / Object | - | 必需。消息内容。TS 类型：`string \| MessageInfoOptions`
58+
message | String / Object | - | 必需。消息内容。TS 类型：`string \| TNode \| MessageInfoOptions`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)
5959
duration | Number | 3000 | 消息显示时长，单位：毫秒。值为 0 表示永久显示
6060

6161
### message.success 或 MessagePlugin.success
6262

6363
参数名称 | 参数类型 | 参数默认值 | 参数描述
6464
-- | -- | -- | --
65-
message | String / Object | - | 必需。消息内容。TS 类型：`string \| MessageInfoOptions`
65+
message | String / Object | - | 必需。消息内容。TS 类型：`string \| TNode \| MessageInfoOptions`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)
6666
duration | Number | 3000 | 消息显示时长，单位：毫秒。值为 0 表示永久显示
6767

6868
### message.loading 或 MessagePlugin.loading
6969

7070
参数名称 | 参数类型 | 参数默认值 | 参数描述
7171
-- | -- | -- | --
72-
message | String / Object | - | 必需。消息提醒内容。TS 类型：`string \| MessageInfoOptions`
72+
message | String / Object | - | 必需。消息提醒内容。TS 类型：`string \| TNode \| MessageInfoOptions`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)
7373
duration | Number | 3000 | 消息显示时长，单位：毫秒。值为 0 表示永久显示
7474

7575
### message.question 或 MessagePlugin.question
7676

7777
参数名称 | 参数类型 | 参数默认值 | 参数描述
7878
-- | -- | -- | --
79-
message | String / Object | - | 必需。消息内容。TS 类型：`string \| MessageInfoOptions`
79+
message | String / Object | - | 必需。消息内容。TS 类型：`string \| TNode \| MessageInfoOptions`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)
8080
duration | Number | 3000 | 消息显示时长，单位：毫秒。值为 0 表示永久显示
8181

8282
### message.closeAll 或 MessagePlugin.closeAll

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

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -95,33 +95,39 @@ export interface MessageInstance {
9595

9696
export type MessageMethod = (
9797
theme: MessageThemeList,
98-
message: string | MessageOptions,
98+
message: string | TNode | MessageOptions,
9999
duration?: number,
100100
) => Promise<MessageInstance>;
101101

102102
export type MessageInfoOptions = Omit<MessageOptions, 'theme'>;
103103

104-
export type MessageInfoMethod = (message: string | MessageInfoOptions, duration?: number) => Promise<MessageInstance>;
104+
export type MessageInfoMethod = (
105+
message: string | TNode | MessageInfoOptions,
106+
duration?: number,
107+
) => Promise<MessageInstance>;
105108

106-
export type MessageErrorMethod = (message: string | MessageInfoOptions, duration?: number) => Promise<MessageInstance>;
109+
export type MessageErrorMethod = (
110+
message: string | TNode | MessageInfoOptions,
111+
duration?: number,
112+
) => Promise<MessageInstance>;
107113

108114
export type MessageWarningMethod = (
109-
message: string | MessageInfoOptions,
115+
message: string | TNode | MessageInfoOptions,
110116
duration?: number,
111117
) => Promise<MessageInstance>;
112118

113119
export type MessageSuccessMethod = (
114-
message: string | MessageInfoOptions,
120+
message: string | TNode | MessageInfoOptions,
115121
duration?: number,
116122
) => Promise<MessageInstance>;
117123

118124
export type MessageLoadingMethod = (
119-
message: string | MessageInfoOptions,
125+
message: string | TNode | MessageInfoOptions,
120126
duration?: number,
121127
) => Promise<MessageInstance>;
122128

123129
export type MessageQuestionMethod = (
124-
message: string | MessageInfoOptions,
130+
message: string | TNode | MessageInfoOptions,
125131
duration?: number,
126132
) => Promise<MessageInstance>;
127133

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ zIndex | Number | 5000 | \- | N
4242
name | params | default | description
4343
-- | -- | -- | --
4444
theme | String | - | required。Typescript：`MessageThemeList`
45-
message | String / Object | - | required。Typescript：`string \| MessageOptions`
45+
message | String / Object | - | required。Typescript：`string \| TNode \| MessageOptions`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
4646
duration | Number | 3000 | \-
4747
context | \- | - | Typescript：`AppContext`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
4848

@@ -52,7 +52,7 @@ context | \- | - | Typescript：`AppContext`。[see more ts definition](https://
5252

5353
name | params | default | description
5454
-- | -- | -- | --
55-
message | String / Object | - | required。Typescript：`string \| MessageInfoOptions` `type MessageInfoOptions = Omit<MessageOptions, 'theme'>`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/message/type.ts)
55+
message | String / Object | - | required。Typescript：`string \| TNode \| MessageInfoOptions` `type MessageInfoOptions = Omit<MessageOptions, 'theme'>`。[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/message/type.ts)
5656
duration | Number | 3000 | \-
5757
context | \- | - | Typescript：`AppContext`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
5858

@@ -62,7 +62,7 @@ context | \- | - | Typescript：`AppContext`。[see more ts definition](https://
6262

6363
name | params | default | description
6464
-- | -- | -- | --
65-
message | String / Object | - | required。Typescript：`string \| MessageInfoOptions`
65+
message | String / Object | - | required。Typescript：`string \| TNode \| MessageInfoOptions`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
6666
duration | Number | 3000 | \-
6767
context | \- | - | Typescript：`AppContext`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
6868

@@ -72,7 +72,7 @@ context | \- | - | Typescript：`AppContext`。[see more ts definition](https://
7272

7373
name | params | default | description
7474
-- | -- | -- | --
75-
message | String / Object | - | required。Typescript：`string \| MessageInfoOptions`
75+
message | String / Object | - | required。Typescript：`string \| TNode \| MessageInfoOptions`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
7676
duration | Number | 3000 | \-
7777
context | \- | - | Typescript：`AppContext`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
7878

@@ -82,7 +82,7 @@ context | \- | - | Typescript：`AppContext`。[see more ts definition](https://
8282

8383
name | params | default | description
8484
-- | -- | -- | --
85-
message | String / Object | - | required。Typescript：`string \| MessageInfoOptions`
85+
message | String / Object | - | required。Typescript：`string \| TNode \| MessageInfoOptions`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
8686
duration | Number | 3000 | \-
8787
context | \- | - | Typescript：`AppContext`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
8888

@@ -92,7 +92,7 @@ context | \- | - | Typescript：`AppContext`。[see more ts definition](https://
9292

9393
name | params | default | description
9494
-- | -- | -- | --
95-
message | String / Object | - | required。Typescript：`string \| MessageInfoOptions`
95+
message | String / Object | - | required。Typescript：`string \| TNode \| MessageInfoOptions`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
9696
duration | Number | 3000 | \-
9797
context | \- | - | Typescript：`AppContext`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
9898

@@ -102,7 +102,7 @@ context | \- | - | Typescript：`AppContext`。[see more ts definition](https://
102102

103103
name | params | default | description
104104
-- | -- | -- | --
105-
message | String / Object | - | required。Typescript：`string \| MessageInfoOptions`
105+
message | String / Object | - | required。Typescript：`string \| TNode \| MessageInfoOptions`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
106106
duration | Number | 3000 | \-
107107
context | \- | - | Typescript：`AppContext`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
108108

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ zIndex | Number | 5000 | 消息层级 | N
4242
参数名称 | 参数类型 | 参数默认值 | 参数描述
4343
-- | -- | -- | --
4444
theme | String | - | 必需。消息类型。TS 类型：`MessageThemeList`
45-
message | String / Object | - | 必需。消息内容。TS 类型：`string \| MessageOptions`
45+
message | String / Object | - | 必需。消息内容。TS 类型：`string \| TNode \| MessageOptions`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
4646
duration | Number | 3000 | 消息显示时长，单位：毫秒。值为 0 表示永久显示
4747
context | \- | - | 要继承的应用的上下文。。TS 类型：`AppContext`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
4848

@@ -52,7 +52,7 @@ context | \- | - | 要继承的应用的上下文。。TS 类型：`AppContext`
5252

5353
参数名称 | 参数类型 | 参数默认值 | 参数描述
5454
-- | -- | -- | --
55-
message | String / Object | - | 必需。消息内容。TS 类型：`string \| MessageInfoOptions` `type MessageInfoOptions = Omit<MessageOptions, 'theme'>`。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/message/type.ts)
55+
message | String / Object | - | 必需。消息内容。TS 类型：`string \| TNode \| MessageInfoOptions` `type MessageInfoOptions = Omit<MessageOptions, 'theme'>`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/message/type.ts)
5656
duration | Number | 3000 | 消息显示时长，单位：毫秒。值为 0 表示永久显示
5757
context | \- | - | 要继承的应用的上下文。。TS 类型：`AppContext`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
5858

@@ -62,7 +62,7 @@ context | \- | - | 要继承的应用的上下文。。TS 类型：`AppContext`
6262

6363
参数名称 | 参数类型 | 参数默认值 | 参数描述
6464
-- | -- | -- | --
65-
message | String / Object | - | 必需。消息内容。TS 类型：`string \| MessageInfoOptions`
65+
message | String / Object | - | 必需。消息内容。TS 类型：`string \| TNode \| MessageInfoOptions`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
6666
duration | Number | 3000 | 消息显示时长，单位：毫秒。值为 0 表示永久显示
6767
context | \- | - | 要继承的应用的上下文。。TS 类型：`AppContext`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
6868

@@ -72,7 +72,7 @@ context | \- | - | 要继承的应用的上下文。。TS 类型：`AppContext`
7272

7373
参数名称 | 参数类型 | 参数默认值 | 参数描述
7474
-- | -- | -- | --
75-
message | String / Object | - | 必需。消息内容。TS 类型：`string \| MessageInfoOptions`
75+
message | String / Object | - | 必需。消息内容。TS 类型：`string \| TNode \| MessageInfoOptions`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
7676
duration | Number | 3000 | 消息显示时长，单位：毫秒。值为 0 表示永久显示
7777
context | \- | - | 要继承的应用的上下文。。TS 类型：`AppContext`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
7878

@@ -82,7 +82,7 @@ context | \- | - | 要继承的应用的上下文。。TS 类型：`AppContext`
8282

8383
参数名称 | 参数类型 | 参数默认值 | 参数描述
8484
-- | -- | -- | --
85-
message | String / Object | - | 必需。消息内容。TS 类型：`string \| MessageInfoOptions`
85+
message | String / Object | - | 必需。消息内容。TS 类型：`string \| TNode \| MessageInfoOptions`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
8686
duration | Number | 3000 | 消息显示时长，单位：毫秒。值为 0 表示永久显示
8787
context | \- | - | 要继承的应用的上下文。。TS 类型：`AppContext`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
8888

@@ -92,7 +92,7 @@ context | \- | - | 要继承的应用的上下文。。TS 类型：`AppContext`
9292

9393
参数名称 | 参数类型 | 参数默认值 | 参数描述
9494
-- | -- | -- | --
95-
message | String / Object | - | 必需。消息提醒内容。TS 类型：`string \| MessageInfoOptions`
95+
message | String / Object | - | 必需。消息提醒内容。TS 类型：`string \| TNode \| MessageInfoOptions`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
9696
duration | Number | 3000 | 消息显示时长，单位：毫秒。值为 0 表示永久显示
9797
context | \- | - | 要继承的应用的上下文。。TS 类型：`AppContext`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
9898

@@ -102,7 +102,7 @@ context | \- | - | 要继承的应用的上下文。。TS 类型：`AppContext`
102102

103103
参数名称 | 参数类型 | 参数默认值 | 参数描述
104104
-- | -- | -- | --
105-
message | String / Object | - | 必需。消息内容。TS 类型：`string \| MessageInfoOptions`
105+
message | String / Object | - | 必需。消息内容。TS 类型：`string \| TNode \| MessageInfoOptions`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
106106
duration | Number | 3000 | 消息显示时长，单位：毫秒。值为 0 表示永久显示
107107
context | \- | - | 要继承的应用的上下文。。TS 类型：`AppContext`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts)
108108

0 commit comments

Comments
 (0)