Skip to content

Commit 21c961f

Browse files
authored
chore: docs update (#726)
1 parent cf3e8c3 commit 21c961f

File tree

4 files changed

+19
-0
lines changed

4 files changed

+19
-0
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ placement | String | top | options: top/center | N
5454
preventScrollThrough | Boolean | true | \- | N
5555
showInAttachedElement | Boolean | false | \- | N
5656
showOverlay | Boolean | true | \- | N
57+
sizeDraggable | Boolean / Object | false | allow resizing drawer width/height, set max or min to limit size.。Typescript:`boolean \| SizeDragLimit` `interface SizeDragLimit { maxWidth: number\|undefined, minWidth: number\|undefined, maxHeight: number\|undefined, minHeight: number\|undefined }`[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/dialog/type.ts) | N
5758
theme | String | default | options: default/info/warning/danger/success | N
5859
top | String / Number | - | \- | N
5960
visible | Boolean | - | \- | N

packages/products/tdesign-vue-next/packages/components/dialog/dialog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ placement | String | top | 对话框位置,内置两种:垂直水平居中
5454
preventScrollThrough | Boolean | true | 防止滚动穿透 | N
5555
showInAttachedElement | Boolean | false | 仅在挂载元素中显示抽屉,默认在浏览器可视区域显示。父元素需要有定位属性,如:position: relative | N
5656
showOverlay | Boolean | true | 是否显示遮罩层 | N
57+
sizeDraggable | Boolean / Object | false | 弹窗大小可拖拽调整。`sizeDraggable.maxWidth``sizeDraggable.minWidth``sizeDraggable.maxHeight``sizeDraggable.minHeight` 用于控制拖拽尺寸大小限制。。TS 类型:`boolean \| SizeDragLimit` `interface SizeDragLimit { maxWidth: number\|undefined, minWidth: number\|undefined, maxHeight: number\|undefined, minHeight: number\|undefined }`[详细类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/dialog/type.ts) | N
5758
theme | String | default | 对话框风格。可选项:default/info/warning/danger/success | N
5859
top | String / Number | - | 用于弹框具体窗口顶部的距离,优先级大于 placement | N
5960
visible | Boolean | - | 控制对话框是否显示 | N

packages/products/tdesign-vue-next/packages/components/dialog/props.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,11 @@ export default {
105105
type: Boolean,
106106
default: true,
107107
},
108+
/** 弹窗大小可拖拽调整。`sizeDraggable.maxWidth`、`sizeDraggable.minWidth`、`sizeDraggable.maxHeight`、`sizeDraggable.minHeight` 用于控制拖拽尺寸大小限制。 */
109+
sizeDraggable: {
110+
type: [Boolean, Object] as PropType<TdDialogProps['sizeDraggable']>,
111+
default: false as TdDialogProps['sizeDraggable'],
112+
},
108113
/** 对话框风格 */
109114
theme: {
110115
type: String as PropType<TdDialogProps['theme']>,

packages/products/tdesign-vue-next/packages/components/dialog/type.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,11 @@ export interface TdDialogProps {
108108
* @default true
109109
*/
110110
showOverlay?: boolean;
111+
/**
112+
* 弹窗大小可拖拽调整。`sizeDraggable.maxWidth`、`sizeDraggable.minWidth`、`sizeDraggable.maxHeight`、`sizeDraggable.minHeight` 用于控制拖拽尺寸大小限制。
113+
* @default false
114+
*/
115+
sizeDraggable?: boolean | SizeDragLimit;
111116
/**
112117
* 对话框风格
113118
* @default default
@@ -277,6 +282,13 @@ export interface DialogInstance {
277282
update: (props: DialogOptions) => void;
278283
}
279284

285+
export interface SizeDragLimit {
286+
maxWidth: number | undefined;
287+
minWidth: number | undefined;
288+
maxHeight: number | undefined;
289+
minHeight: number | undefined;
290+
}
291+
280292
export type DialogEventSource = 'esc' | 'close-btn' | 'cancel' | 'overlay';
281293

282294
export interface DialogCloseContext {

0 commit comments

Comments
 (0)