Skip to content

Commit ceb674c

Browse files
Wesley-0808Wesley-0808
committed
fix
1 parent 8dd1aad commit ceb674c

File tree

9 files changed

+634
-6
lines changed

9 files changed

+634
-6
lines changed

‎packages/products/tdesign-mobile-vue/src/dialog/dialog.en-US.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
:: BASE_DOC ::
22

33
## API
4-
54
### Dialog Props
65

76
name | type | default | description | required
@@ -21,6 +20,8 @@ title | String / Slot / Function | - | Typescript：`string \| TNode`。[see mor
2120
visible | Boolean | - | \- | N
2221
width | String / Number | - | \- | N
2322
zIndex | Number | - | \- | N
23+
onBeforeClose | Function | | Typescript：`() => void`<br/> | N
24+
onBeforeOpen | Function | | Typescript：`() => void`<br/> | N
2425
onCancel | Function | | Typescript：`(context: { e: MouseEvent }) => void`<br/> | N
2526
onClose | Function | | Typescript：`(context: DialogCloseContext) => void`<br/>[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/dialog/type.ts)。<br/>`type DialogEventSource = 'cancel' \| 'overlay'`<br/><br/>`interface DialogCloseContext { trigger: DialogEventSource; e: MouseEvent }`<br/> | N
2627
onClosed | Function | | Typescript：`() => void`<br/> | N
@@ -31,6 +32,8 @@ onOverlayClick | Function | | Typescript：`(context: { e: MouseEvent }) => voi
3132

3233
name | params | description
3334
-- | -- | --
35+
before-close | \- | \-
36+
before-open | \- | \-
3437
cancel | `(context: { e: MouseEvent })` | \-
3538
close | `(context: DialogCloseContext)` | [see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/dialog/type.ts)。<br/>`type DialogEventSource = 'cancel' \| 'overlay'`<br/><br/>`interface DialogCloseContext { trigger: DialogEventSource; e: MouseEvent }`<br/>
3639
closed | \- | \-

‎packages/products/tdesign-mobile-vue/src/dialog/dialog.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
:: BASE_DOC ::
22

33
## API
4-
54
### Dialog Props
65

76
名称 | 类型 | 默认值 | 描述 | 必传
@@ -21,6 +20,8 @@ title | String / Slot / Function | - | 标题。TS 类型：`string \| TNode`。
2120
visible | Boolean | - | 控制对话框是否显示 | N
2221
width | String / Number | - | 对话框宽度，示例：320, '500px', '80%' | N
2322
zIndex | Number | - | 对话框层级，Web 侧样式默认为 2500，移动端和小程序样式默认为 1500 | N
23+
onBeforeClose | Function | | TS 类型：`() => void`<br/>对话框执行消失动画效果前触发 | N
24+
onBeforeOpen | Function | | TS 类型：`() => void`<br/>对话框执行弹出动画效果前触发 | N
2425
onCancel | Function | | TS 类型：`(context: { e: MouseEvent }) => void`<br/>如果“取消”按钮存在，则点击“取消”按钮时触发，同时触发关闭事件 | N
2526
onClose | Function | | TS 类型：`(context: DialogCloseContext) => void`<br/>关闭事件，点击 取消按钮 或 点击蒙层 时触发。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/dialog/type.ts)。<br/>`type DialogEventSource = 'cancel' \| 'overlay'`<br/><br/>`interface DialogCloseContext { trigger: DialogEventSource; e: MouseEvent }`<br/> | N
2627
onClosed | Function | | TS 类型：`() => void`<br/>对话框消失动画效果结束后触发 | N
@@ -31,6 +32,8 @@ onOverlayClick | Function | | TS 类型：`(context: { e: MouseEvent }) => void
3132

3233
名称 | 参数 | 描述
3334
-- | -- | --
35+
before-close | \- | 对话框执行消失动画效果前触发
36+
before-open | \- | 对话框执行弹出动画效果前触发
3437
cancel | `(context: { e: MouseEvent })` | 如果“取消”按钮存在，则点击“取消”按钮时触发，同时触发关闭事件
3538
close | `(context: DialogCloseContext)` | 关闭事件，点击 取消按钮 或 点击蒙层 时触发。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/dialog/type.ts)。<br/>`type DialogEventSource = 'cancel' \| 'overlay'`<br/><br/>`interface DialogCloseContext { trigger: DialogEventSource; e: MouseEvent }`<br/>
3639
closed | \- | 对话框消失动画效果结束后触发

‎packages/products/tdesign-mobile-vue/src/dialog/props.ts

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
/* eslint-disable */
2+
3+
/**
4+
* 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
5+
* */
6+
7+
import { TdDialogProps } from './type';
8+
import { PropType } from 'vue';
9+
10+
export default {
11+
/** 操作栏 */
12+
actions: {
13+
type: [Array, Function] as PropType<TdDialogProps['actions']>,
14+
},
15+
/** 多按钮排列方式 */
16+
buttonLayout: {
17+
type: String as PropType<TdDialogProps['buttonLayout']>,
18+
default: 'horizontal' as TdDialogProps['buttonLayout'],
19+
validator(val: TdDialogProps['buttonLayout']): boolean {
20+
if (!val) return true;
21+
return ['horizontal', 'vertical'].includes(val);
22+
},
23+
},
24+
/** 取消按钮，可自定义。值为 null 则不显示取消按钮。值类型为字符串，则表示自定义按钮文本，值类型为 Object 则表示透传 Button 组件属性。使用 TNode 自定义按钮时，需自行控制取消事件 */
25+
cancelBtn: {
26+
type: [String, Object, Function] as PropType<TdDialogProps['cancelBtn']>,
27+
},
28+
/** 多按钮排列方式。可选项：true/false */
29+
closeBtn: Boolean,
30+
/** 点击蒙层时是否触发关闭事件 */
31+
closeOnOverlayClick: Boolean,
32+
/** 确认按钮。值为 null 则不显示确认按钮。值类型为字符串，则表示自定义按钮文本，值类型为 Object 则表示透传 Button 组件属性。使用 TNode 自定义按钮时，需自行控制确认事件 */
33+
confirmBtn: {
34+
type: [String, Object, Function] as PropType<TdDialogProps['confirmBtn']>,
35+
},
36+
/** 内容 */
37+
content: {
38+
type: [String, Function] as PropType<TdDialogProps['content']>,
39+
},
40+
/** 是否在关闭弹框的时候销毁子元素 */
41+
destroyOnClose: Boolean,
42+
/** 透传至 Overlay 组件 */
43+
overlayProps: {
44+
type: Object as PropType<TdDialogProps['overlayProps']>,
45+
default: () => ({}),
46+
},
47+
/** 防止滚动穿透 */
48+
preventScrollThrough: {
49+
type: Boolean,
50+
default: true,
51+
},
52+
/** 是否显示遮罩层 */
53+
showOverlay: {
54+
type: Boolean,
55+
default: true,
56+
},
57+
/** 标题 */
58+
title: {
59+
type: [String, Function] as PropType<TdDialogProps['title']>,
60+
},
61+
/** 控制对话框是否显示 */
62+
visible: Boolean,
63+
/** 对话框宽度，示例：320, '500px', '80%' */
64+
width: {
65+
type: [String, Number] as PropType<TdDialogProps['width']>,
66+
},
67+
/** 对话框层级，Web 侧样式默认为 2500，移动端和小程序样式默认为 1500 */
68+
zIndex: {
69+
type: Number,
70+
},
71+
/** 对话框执行消失动画效果前触发 */
72+
onBeforeClose: Function as PropType<TdDialogProps['onBeforeClose']>,
73+
/** 对话框执行弹出动画效果前触发 */
74+
onBeforeOpen: Function as PropType<TdDialogProps['onBeforeOpen']>,
75+
/** 如果“取消”按钮存在，则点击“取消”按钮时触发，同时触发关闭事件 */
76+
onCancel: Function as PropType<TdDialogProps['onCancel']>,
77+
/** 关闭事件，点击 取消按钮 或 点击蒙层 时触发 */
78+
onClose: Function as PropType<TdDialogProps['onClose']>,
79+
/** 对话框消失动画效果结束后触发 */
80+
onClosed: Function as PropType<TdDialogProps['onClosed']>,
81+
/** 如果“确认”按钮存在，则点击“确认”按钮时触发 */
82+
onConfirm: Function as PropType<TdDialogProps['onConfirm']>,
83+
/** 如果蒙层存在，点击蒙层时触发 */
84+
onOverlayClick: Function as PropType<TdDialogProps['onOverlayClick']>,
85+
};

‎packages/products/tdesign-mobile-vue/src/dialog/type.ts

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
/* eslint-disable */
2+
3+
/**
4+
* 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
5+
* */
6+
7+
import { ButtonProps } from '../button';
8+
import { OverlayProps } from '../overlay';
9+
import { TNode } from '../common';
10+
11+
export interface TdDialogProps {
12+
/**
13+
* 操作栏
14+
*/
15+
actions?: Array<ButtonProps>;
16+
/**
17+
* 多按钮排列方式
18+
* @default horizontal
19+
*/
20+
buttonLayout?: 'horizontal' | 'vertical';
21+
/**
22+
* 取消按钮，可自定义。值为 null 则不显示取消按钮。值类型为字符串，则表示自定义按钮文本，值类型为 Object 则表示透传 Button 组件属性。使用 TNode 自定义按钮时，需自行控制取消事件
23+
*/
24+
cancelBtn?: string | ButtonProps | TNode | null;
25+
/**
26+
* 多按钮排列方式。可选项：true/false
27+
* @default false
28+
*/
29+
closeBtn?: boolean;
30+
/**
31+
* 点击蒙层时是否触发关闭事件
32+
* @default false
33+
*/
34+
closeOnOverlayClick?: boolean;
35+
/**
36+
* 确认按钮。值为 null 则不显示确认按钮。值类型为字符串，则表示自定义按钮文本，值类型为 Object 则表示透传 Button 组件属性。使用 TNode 自定义按钮时，需自行控制确认事件
37+
*/
38+
confirmBtn?: string | ButtonProps | TNode | null;
39+
/**
40+
* 内容
41+
*/
42+
content?: string | TNode;
43+
/**
44+
* 是否在关闭弹框的时候销毁子元素
45+
* @default false
46+
*/
47+
destroyOnClose?: boolean;
48+
/**
49+
* 透传至 Overlay 组件
50+
* @default {}
51+
*/
52+
overlayProps?: OverlayProps;
53+
/**
54+
* 防止滚动穿透
55+
* @default true
56+
*/
57+
preventScrollThrough?: boolean;
58+
/**
59+
* 是否显示遮罩层
60+
* @default true
61+
*/
62+
showOverlay?: boolean;
63+
/**
64+
* 标题
65+
*/
66+
title?: string | TNode;
67+
/**
68+
* 控制对话框是否显示
69+
*/
70+
visible?: boolean;
71+
/**
72+
* 对话框宽度，示例：320, '500px', '80%'
73+
*/
74+
width?: string | number;
75+
/**
76+
* 对话框层级，Web 侧样式默认为 2500，移动端和小程序样式默认为 1500
77+
*/
78+
zIndex?: number;
79+
/**
80+
* 对话框执行消失动画效果前触发
81+
*/
82+
onBeforeClose?: () => void;
83+
/**
84+
* 对话框执行弹出动画效果前触发
85+
*/
86+
onBeforeOpen?: () => void;
87+
/**
88+
* 如果“取消”按钮存在，则点击“取消”按钮时触发，同时触发关闭事件
89+
*/
90+
onCancel?: (context: { e: MouseEvent }) => void;
91+
/**
92+
* 关闭事件，点击 取消按钮 或 点击蒙层 时触发
93+
*/
94+
onClose?: (context: DialogCloseContext) => void;
95+
/**
96+
* 对话框消失动画效果结束后触发
97+
*/
98+
onClosed?: () => void;
99+
/**
100+
* 如果“确认”按钮存在，则点击“确认”按钮时触发
101+
*/
102+
onConfirm?: (context: { e: MouseEvent }) => void;
103+
/**
104+
* 如果蒙层存在，点击蒙层时触发
105+
*/
106+
onOverlayClick?: (context: { e: MouseEvent }) => void;
107+
}
108+
109+
export interface DialogOptions extends Omit<TdDialogProps, 'attach'> {
110+
/**
111+
* 弹框类名，示例：'t-class-dialog-first t-class-dialog-second'
112+
* @default ''
113+
*/
114+
className?: string;
115+
}
116+
117+
export interface DialogInstance {
118+
/**
119+
* 销毁弹框
120+
*/
121+
destroy: () => void;
122+
/**
123+
* 隐藏弹框
124+
*/
125+
hide: () => void;
126+
/**
127+
* 显示弹框
128+
*/
129+
show: () => void;
130+
/**
131+
* 更新弹框内容
132+
*/
133+
update: (props: DialogOptions) => void;
134+
}
135+
136+
export type DialogEventSource = 'cancel' | 'overlay';
137+
138+
export interface DialogCloseContext {
139+
trigger: DialogEventSource;
140+
e: MouseEvent;
141+
}
142+
143+
export type DialogMethod = (options?: DialogOptions) => DialogInstance;
144+
145+
export type DialogConfirmMethod = (options?: DialogOptions) => DialogInstance;
146+
147+
export type DialogAlertMethod = (options?: Omit<DialogOptions, 'cancelBtn'>) => DialogInstance;

‎packages/products/tdesign-vue-next/src/dialog/dialog-card-props.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
/* eslint-disable */
2+
3+
/**
4+
* 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
5+
* */
6+
7+
export default {
8+
};

‎packages/products/tdesign-vue-next/src/dialog/dialog.en-US.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
:: BASE_DOC ::
22

33
## API
4-
54
### DialogCard Props
65

76
name | type | default | description | required
@@ -39,6 +38,8 @@ top | String / Number | - | \- | N
3938
visible | Boolean | - | \- | N
4039
width | String / Number | - | \- | N
4140
zIndex | Number | - | \- | N
41+
onBeforeClose | Function | | Typescript：`() => void`<br/> | N
42+
onBeforeOpen | Function | | Typescript：`() => void`<br/> | N
4243
onCancel | Function | | Typescript：`(context: { e: MouseEvent }) => void`<br/> | N
4344
onClose | Function | | Typescript：`(context: DialogCloseContext) => void`<br/>[see more ts definition](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/dialog/type.ts)。<br/>`type DialogEventSource = 'esc' \| 'close-btn' \| 'cancel' \| 'overlay'`<br/><br/>`interface DialogCloseContext { trigger: DialogEventSource; e: MouseEvent \| KeyboardEvent }`<br/> | N
4445
onCloseBtnClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`<br/> | N
@@ -52,6 +53,8 @@ onOverlayClick | Function | | Typescript：`(context: { e: MouseEvent }) => voi
5253

5354
name | params | description
5455
-- | -- | --
56+
before-close | \- | \-
57+
before-open | \- | \-
5558
cancel | `(context: { e: MouseEvent })` | \-
5659
close | `(context: DialogCloseContext)` | [see more ts definition](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/dialog/type.ts)。<br/>`type DialogEventSource = 'esc' \| 'close-btn' \| 'cancel' \| 'overlay'`<br/><br/>`interface DialogCloseContext { trigger: DialogEventSource; e: MouseEvent \| KeyboardEvent }`<br/>
5760
close-btn-click | `(context: { e: MouseEvent })` | \-
@@ -67,7 +70,6 @@ name | type | default | description | required
6770
-- | -- | -- | -- | --
6871
attach | String / Function | 'body' | Typescript：`AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N
6972
className | String | - | \- | N
70-
style | String / Object | - | Typescript：`string \| Styles`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N
7173
`Omit<DialogProps, 'attach'>` | \- | - | extends `Omit<DialogProps, 'attach'>` | N
7274

7375
### DialogInstance

‎packages/products/tdesign-vue-next/src/dialog/dialog.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
:: BASE_DOC ::
22

33
## API
4-
54
### DialogCard Props
65

76
名称 | 类型 | 默认值 | 描述 | 必传
@@ -39,6 +38,8 @@ top | String / Number | - | 用于弹框具体窗口顶部的距离，优先级
3938
visible | Boolean | - | 控制对话框是否显示 | N
4039
width | String / Number | - | 对话框宽度，示例：320, '500px', '80%' | N
4140
zIndex | Number | - | 对话框层级，Web 侧样式默认为 2500，移动端和小程序样式默认为 1500 | N
41+
onBeforeClose | Function | | TS 类型：`() => void`<br/>对话框执行消失动画效果前触发 | N
42+
onBeforeOpen | Function | | TS 类型：`() => void`<br/>对话框执行弹出动画效果前触发 | N
4243
onCancel | Function | | TS 类型：`(context: { e: MouseEvent }) => void`<br/>如果“取消”按钮存在，则点击“取消”按钮时触发，同时触发关闭事件 | N
4344
onClose | Function | | TS 类型：`(context: DialogCloseContext) => void`<br/>关闭事件，点击取消按钮、点击关闭按钮、点击蒙层、按下 ESC 等场景下触发。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/dialog/type.ts)。<br/>`type DialogEventSource = 'esc' \| 'close-btn' \| 'cancel' \| 'overlay'`<br/><br/>`interface DialogCloseContext { trigger: DialogEventSource; e: MouseEvent \| KeyboardEvent }`<br/> | N
4445
onCloseBtnClick | Function | | TS 类型：`(context: { e: MouseEvent }) => void`<br/>点击右上角关闭按钮时触发 | N
@@ -52,6 +53,8 @@ onOverlayClick | Function | | TS 类型：`(context: { e: MouseEvent }) => void
5253

5354
名称 | 参数 | 描述
5455
-- | -- | --
56+
before-close | \- | 对话框执行消失动画效果前触发
57+
before-open | \- | 对话框执行弹出动画效果前触发
5558
cancel | `(context: { e: MouseEvent })` | 如果“取消”按钮存在，则点击“取消”按钮时触发，同时触发关闭事件
5659
close | `(context: DialogCloseContext)` | 关闭事件，点击取消按钮、点击关闭按钮、点击蒙层、按下 ESC 等场景下触发。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/dialog/type.ts)。<br/>`type DialogEventSource = 'esc' \| 'close-btn' \| 'cancel' \| 'overlay'`<br/><br/>`interface DialogCloseContext { trigger: DialogEventSource; e: MouseEvent \| KeyboardEvent }`<br/>
5760
close-btn-click | `(context: { e: MouseEvent })` | 点击右上角关闭按钮时触发
@@ -67,7 +70,6 @@ overlay-click | `(context: { e: MouseEvent })` | 如果蒙层存在，点击蒙
6770
-- | -- | -- | -- | --
6871
attach | String / Function | 'body' | 对话框挂载的节点。数据类型为 String 时，会被当作选择器处理，进行节点查询。示例：'body' 或 () => document.body。TS 类型：`AttachNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N
6972
className | String | - | 弹框类名，示例：'t-class-dialog-first t-class-dialog-second' | N
70-
style | String / Object | - | 弹框 style 属性，输入 [CSSStyleDeclaration.cssText](https://developer.mozilla.org/en-US/docs/Web/API/CSSStyleDeclaration/cssText)。TS 类型：`string \| Styles`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N
7173
`Omit<DialogProps, 'attach'>` | \- | - | 继承 `Omit<DialogProps, 'attach'>` 中的全部属性 | N
7274

7375
### DialogInstance

0 commit comments

Comments
 (0)