Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(Drawer): update api #482

Merged
merged 2 commits into from
Dec 2, 2024
Merged

feat(Drawer): update api #482

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a694a59
feat: update api
liweijie0812 Nov 29, 2024
6900d10
feat: update api
liweijie0812 Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified db/TDesign.db
View file
Open in desktop
Binary file not shown.
6 changes: 3 additions & 3 deletions packages/products/tdesign-miniprogram/src/drawer/README.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ 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
close-on-overlay-click | Boolean | true | \- | N
close-on-overlay-click | Boolean | undefined | \- | N
destroy-on-close | Boolean | false | \- | N
footer | Slot | - | `0.29.0`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/src/common/common.ts) | N
items | Array | - | Typescript：`DrawerItem[] ` `interface DrawerItem { title: string; icon: string; }。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/drawer/type.ts)`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/drawer/type.ts) | N
items | Array | - | Typescript：`DrawerItem[]` `interface DrawerItem { title: string; icon: string; }`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/drawer/type.ts) | N
placement | String | right | options: left/right | N
show-overlay | Boolean | true | \- | N
title | String / Slot | - | `0.29.0`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/src/common/common.ts) | N
Expand All @@ -23,6 +23,6 @@ z-index | Number | 11500 | \- | N

name | params | description
-- | -- | --
close | `(trigger: TriggerSource)` | \-
close | `(trigger: DrawerTriggerSource)` | [see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/drawer/type.ts)。<br/>`type DrawerTriggerSource = 'overlay'`<br/>
item-click | `(index: number; item: DrawerItem)` | \-
overlay-click | \- | \-
6 changes: 3 additions & 3 deletions packages/products/tdesign-miniprogram/src/drawer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@
-- | -- | -- | -- | --
style | Object | - | 样式 | N
custom-style | Object | - | 样式，一般用于开启虚拟化组件节点场景 | N
close-on-overlay-click | Boolean | true | 点击蒙层时是否触发抽屉关闭事件 | N
close-on-overlay-click | Boolean | undefined | 点击蒙层时是否触发抽屉关闭事件 | N
destroy-on-close | Boolean | false | 抽屉关闭时是否销毁节点 | N
footer | Slot | - | `0.29.0`。抽屉的底部。[通用类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/src/common/common.ts) | N
items | Array | - | 抽屉里的列表项。TS 类型：`DrawerItem[] ` `interface DrawerItem { title: string; icon: string; }。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/drawer/type.ts)`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/drawer/type.ts) | N
items | Array | - | 抽屉里的列表项。TS 类型：`DrawerItem[]` `interface DrawerItem { title: string; icon: string; }`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/drawer/type.ts) | N
placement | String | right | 抽屉方向。可选项：left/right | N
show-overlay | Boolean | true | 是否显示遮罩层 | N
title | String / Slot | - | `0.29.0`。抽屉的标题。[通用类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/src/common/common.ts) | N
Expand All @@ -23,6 +23,6 @@ z-index | Number | 11500 | 抽屉层级，样式默认为 11500 | N

名称 | 参数 | 描述
-- | -- | --
close | `(trigger: TriggerSource)` | 关闭时触发。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/drawer/type.ts)。<br/>`type TriggerSource = 'overlay'`<br/>
close | `(trigger: DrawerTriggerSource)` | 关闭时触发。。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/drawer/type.ts)。<br/>`type DrawerTriggerSource = 'overlay'`<br/>
item-click | `(index: number; item: DrawerItem)` | 点击抽屉里的列表项
overlay-click | \- | 如果蒙层存在，点击蒙层时触发
4 changes: 2 additions & 2 deletions packages/products/tdesign-miniprogram/src/drawer/props.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ import { TdDrawerProps } from './type';
const props: TdDrawerProps = {
/** 点击蒙层时是否触发抽屉关闭事件 */
closeOnOverlayClick: {
type: Boolean,
value: true,
type: null,
value: undefined,
},
/** 抽屉关闭时是否销毁节点 */
destroyOnClose: {
Expand Down
77 changes: 76 additions & 1 deletion packages/products/tdesign-miniprogram/src/drawer/type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,79 @@
* 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
* */

[object Object]
export interface TdDrawerProps {
/**
* 点击蒙层时是否触发抽屉关闭事件
*/
closeOnOverlayClick?: {
type: BooleanConstructor;
value?: boolean;
};
/**
* 抽屉关闭时是否销毁节点
* @default false
*/
destroyOnClose?: {
type: BooleanConstructor;
value?: boolean;
};
/**
* 抽屉里的列表项
*/
items?: {
type: ArrayConstructor;
value?: DrawerItem[];
};
/**
* 抽屉方向
* @default right
*/
placement?: {
type: StringConstructor;
value?: 'left' | 'right';
};
/**
* 是否显示遮罩层
* @default true
*/
showOverlay?: {
type: BooleanConstructor;
value?: boolean;
};
/**
* 抽屉的标题
*/
title?: {
type: StringConstructor;
value?: string;
};
/**
* 是否使用了自定义导航栏
* @default false
*/
usingCustomNavbar?: {
type: BooleanConstructor;
value?: boolean;
};
/**
* 组件是否可见
* @default false
*/
visible?: {
type: BooleanConstructor;
value?: boolean;
};
/**
* 抽屉层级，样式默认为 11500
* @default 11500
*/
zIndex?: {
type: NumberConstructor;
value?: number;
};
}

export interface DrawerItem {
title: string;
icon: string;
}
2 changes: 1 addition & 1 deletion packages/products/tdesign-mobile-react/src/drawer/defaultProps.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import { TdDrawerProps } from './type';

export const drawerDefaultProps: TdDrawerProps = {
closeOnOverlayClick: true,
closeOnOverlayClick: undefined,
destroyOnClose: false,
placement: 'right',
showOverlay: true,
Expand Down
7 changes: 4 additions & 3 deletions packages/products/tdesign-mobile-react/src/drawer/drawer.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,26 @@
:: BASE_DOC ::

## API

### Drawer Props

name | type | default | description | required
-- | -- | -- | -- | --
className | String | - | className of component | N
style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N
attach | String / Function | - | Typescript：`AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N
closeOnOverlayClick | Boolean | true | \- | N
closeOnOverlayClick | Boolean | undefined | \- | N
destroyOnClose | Boolean | false | \- | N
footer | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N
items | Array | - | Typescript：`DrawerItem[] ` `interface DrawerItem { title: string; icon: TNode; }`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/drawer/type.ts) | N
items | Array | - | Typescript：`DrawerItem[] ` `interface DrawerItem { title: string; icon?: TNode; }`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/drawer/type.ts) | N
placement | String | right | options: left/right | N
showOverlay | Boolean | true | \- | N
title | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N
visible | Boolean | false | \- | N
zIndex | Number | - | \- | N
onBeforeClose | Function | | Typescript：`() => void`<br/> | N
onBeforeOpen | Function | | Typescript：`() => void`<br/> | N
onClose | Function | | Typescript：`(trigger: TriggerSource) => void`<br/> | N
onClose | Function | | Typescript：`(trigger: DrawerTriggerSource) => void`<br/>[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/drawer/type.ts)。<br/>`type DrawerTriggerSource = 'overlay'`<br/> | N
onItemClick | Function | | Typescript：`( index: number, item: DrawerItem, context: { e: MouseEvent }) => void`<br/> | N
onOverlayClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`<br/> | N

Expand Down
7 changes: 4 additions & 3 deletions packages/products/tdesign-mobile-react/src/drawer/drawer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,26 @@
:: BASE_DOC ::

## API

### Drawer Props

名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
className | String | - | 类名 | N
style | Object | - | 样式，TS 类型：`React.CSSProperties` | N
attach | String / Function | - | 抽屉挂载的节点，默认挂在组件本身的位置。数据类型为 String 时，会被当作选择器处理，进行节点查询。示例：'body' 或 () => document.body。TS 类型：`AttachNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N
closeOnOverlayClick | Boolean | true | 点击蒙层时是否触发抽屉关闭事件 | N
closeOnOverlayClick | Boolean | undefined | 点击蒙层时是否触发抽屉关闭事件 | N
destroyOnClose | Boolean | false | 抽屉关闭时是否销毁节点 | N
footer | TElement | - | 抽屉的底部。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N
items | Array | - | 抽屉里的列表项。TS 类型：`DrawerItem[] ` `interface DrawerItem { title: string; icon: TNode; }`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts)。[详细类型定义](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/drawer/type.ts) | N
items | Array | - | 抽屉里的列表项。TS 类型：`DrawerItem[] ` `interface DrawerItem { title: string; icon?: TNode; }`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts)。[详细类型定义](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/drawer/type.ts) | N
placement | String | right | 抽屉方向。可选项：left/right | N
showOverlay | Boolean | true | 是否显示遮罩层 | N
title | TNode | - | 抽屉的标题。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N
visible | Boolean | false | 组件是否可见 | N
zIndex | Number | - | 抽屉层级，样式默认为 1500 | N
onBeforeClose | Function | | TS 类型：`() => void`<br/>抽屉执行关闭动画效果前触发 | N
onBeforeOpen | Function | | TS 类型：`() => void`<br/>抽屉执行打开动画效果前触发 | N
onClose | Function | | TS 类型：`(trigger: TriggerSource) => void`<br/>关闭时触发。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/drawer/type.ts)。<br/>`type TriggerSource = 'overlay'`<br/> | N
onClose | Function | | TS 类型：`(trigger: DrawerTriggerSource) => void`<br/>关闭时触发。。[详细类型定义](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/drawer/type.ts)。<br/>`type DrawerTriggerSource = 'overlay'`<br/> | N
onItemClick | Function | | TS 类型：`( index: number, item: DrawerItem, context: { e: MouseEvent }) => void`<br/>点击抽屉里的列表项 | N
onOverlayClick | Function | | TS 类型：`(context: { e: MouseEvent }) => void`<br/>如果蒙层存在，点击蒙层时触发 | N

Expand Down
9 changes: 5 additions & 4 deletions packages/products/tdesign-mobile-react/src/drawer/type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ export interface TdDrawerProps {
attach?: AttachNode;
/**
* 点击蒙层时是否触发抽屉关闭事件
* @default true
*/
closeOnOverlayClick?: boolean;
/**
Expand Down Expand Up @@ -62,9 +61,9 @@ export interface TdDrawerProps {
*/
onBeforeOpen?: () => void;
/**
* 关闭时触发。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/drawer/type.ts)。<br/>`type TriggerSource = 'overlay'`<br/>
* 关闭时触发。
*/
onClose?: (trigger: TriggerSource) => void;
onClose?: (trigger: DrawerTriggerSource) => void;
/**
* 点击抽屉里的列表项
*/
Expand Down Expand Up @@ -108,7 +107,9 @@ export interface DrawerInstance {

export interface DrawerItem {
title: string;
icon: TNode;
icon?: TNode;
}

export type DrawerTriggerSource = 'overlay';

export type DrawerMethod = (options?: DrawerOptions) => void;
7 changes: 4 additions & 3 deletions packages/products/tdesign-mobile-vue/src/drawer/drawer.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
:: BASE_DOC ::

## API

### Drawer Props

name | type | default | description | required
Expand All @@ -9,15 +10,15 @@ attach | String / Function | - | Typescript：`AttachNode`。[see more ts defini
closeOnOverlayClick | Boolean | undefined | \- | N
destroyOnClose | Boolean | false | \- | N
footer | Slot / Function | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
items | Array | - | Typescript：`DrawerItem[] ` `interface DrawerItem { title: string; icon: TNode; }`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/drawer/type.ts) | N
items | Array | - | Typescript：`DrawerItem[] ` `interface DrawerItem { title: string; icon?: TNode; }`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/drawer/type.ts) | N
placement | String | right | options: left/right | N
showOverlay | Boolean | true | \- | N
title | String / Slot / Function | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
visible | Boolean | false | \- | N
zIndex | Number | - | \- | N
onBeforeClose | Function | | Typescript：`() => void`<br/> | N
onBeforeOpen | Function | | Typescript：`() => void`<br/> | N
onClose | Function | | Typescript：`(trigger: TriggerSource) => void`<br/> | N
onClose | Function | | Typescript：`(trigger: DrawerTriggerSource) => void`<br/>[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/drawer/type.ts)。<br/>`type DrawerTriggerSource = 'overlay'`<br/> | N
onItemClick | Function | | Typescript：`( index: number, item: DrawerItem, context: { e: MouseEvent }) => void`<br/> | N
onOverlayClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`<br/> | N

Expand All @@ -27,7 +28,7 @@ name | params | description
-- | -- | --
before-close | \- | \-
before-open | \- | \-
close | `(trigger: TriggerSource)` | \-
close | `(trigger: DrawerTriggerSource)` | [see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/drawer/type.ts)。<br/>`type DrawerTriggerSource = 'overlay'`<br/>
item-click | `( index: number, item: DrawerItem, context: { e: MouseEvent })` | \-
overlay-click | `(context: { e: MouseEvent })` | \-

Expand Down
7 changes: 4 additions & 3 deletions packages/products/tdesign-mobile-vue/src/drawer/drawer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
:: BASE_DOC ::

## API

### Drawer Props

名称 | 类型 | 默认值 | 描述 | 必传
Expand All @@ -9,15 +10,15 @@ attach | String / Function | - | 抽屉挂载的节点，默认挂在组件本
closeOnOverlayClick | Boolean | undefined | 点击蒙层时是否触发抽屉关闭事件 | N
destroyOnClose | Boolean | false | 抽屉关闭时是否销毁节点 | N
footer | Slot / Function | - | 抽屉的底部。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
items | Array | - | 抽屉里的列表项。TS 类型：`DrawerItem[] ` `interface DrawerItem { title: string; icon: TNode; }`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts)。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/drawer/type.ts) | N
items | Array | - | 抽屉里的列表项。TS 类型：`DrawerItem[] ` `interface DrawerItem { title: string; icon?: TNode; }`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts)。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/drawer/type.ts) | N
placement | String | right | 抽屉方向。可选项：left/right | N
showOverlay | Boolean | true | 是否显示遮罩层 | N
title | String / Slot / Function | - | 抽屉的标题。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
visible | Boolean | false | 组件是否可见 | N
zIndex | Number | - | 抽屉层级，样式默认为 1500 | N
onBeforeClose | Function | | TS 类型：`() => void`<br/>抽屉执行关闭动画效果前触发 | N
onBeforeOpen | Function | | TS 类型：`() => void`<br/>抽屉执行打开动画效果前触发 | N
onClose | Function | | TS 类型：`(trigger: TriggerSource) => void`<br/>关闭时触发。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/drawer/type.ts)。<br/>`type TriggerSource = 'overlay'`<br/> | N
onClose | Function | | TS 类型：`(trigger: DrawerTriggerSource) => void`<br/>关闭时触发。。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/drawer/type.ts)。<br/>`type DrawerTriggerSource = 'overlay'`<br/> | N
onItemClick | Function | | TS 类型：`( index: number, item: DrawerItem, context: { e: MouseEvent }) => void`<br/>点击抽屉里的列表项 | N
onOverlayClick | Function | | TS 类型：`(context: { e: MouseEvent }) => void`<br/>如果蒙层存在，点击蒙层时触发 | N

Expand All @@ -27,7 +28,7 @@ onOverlayClick | Function | | TS 类型：`(context: { e: MouseEvent }) => void
-- | -- | --
before-close | \- | 抽屉执行关闭动画效果前触发
before-open | \- | 抽屉执行打开动画效果前触发
close | `(trigger: TriggerSource)` | 关闭时触发。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/drawer/type.ts)。<br/>`type TriggerSource = 'overlay'`<br/>
close | `(trigger: DrawerTriggerSource)` | 关闭时触发。。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/drawer/type.ts)。<br/>`type DrawerTriggerSource = 'overlay'`<br/>
item-click | `( index: number, item: DrawerItem, context: { e: MouseEvent })` | 点击抽屉里的列表项
overlay-click | `(context: { e: MouseEvent })` | 如果蒙层存在，点击蒙层时触发

Expand Down
2 changes: 1 addition & 1 deletion packages/products/tdesign-mobile-vue/src/drawer/props.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ export default {
onBeforeClose: Function as PropType<TdDrawerProps['onBeforeClose']>,
/** 抽屉执行打开动画效果前触发 */
onBeforeOpen: Function as PropType<TdDrawerProps['onBeforeOpen']>,
/** 关闭时触发。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/drawer/type.ts)。<br/>`type TriggerSource = 'overlay'`<br/> */
/** 关闭时触发。 */
onClose: Function as PropType<TdDrawerProps['onClose']>,
/** 点击抽屉里的列表项 */
onItemClick: Function as PropType<TdDrawerProps['onItemClick']>,
Expand Down
8 changes: 5 additions & 3 deletions packages/products/tdesign-mobile-vue/src/drawer/type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ export interface TdDrawerProps {
*/
onBeforeOpen?: () => void;
/**
* 关闭时触发。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/drawer/type.ts)。<br/>`type TriggerSource = 'overlay'`<br/>
* 关闭时触发。
*/
onClose?: (trigger: TriggerSource) => void;
onClose?: (trigger: DrawerTriggerSource) => void;
/**
* 点击抽屉里的列表项
*/
Expand Down Expand Up @@ -106,7 +106,9 @@ export interface DrawerInstance {

export interface DrawerItem {
title: string;
icon: TNode;
icon?: TNode;
}

export type DrawerTriggerSource = 'overlay';

export type DrawerMethod = (options?: DrawerOptions) => void;
2 changes: 1 addition & 1 deletion packages/products/tdesign-react/src/drawer/defaultProps.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { TdDrawerProps } from './type';

export const drawerDefaultProps: TdDrawerProps = {
closeOnEscKeydown: undefined,
closeOnOverlayClick: true,
closeOnOverlayClick: undefined,
destroyOnClose: false,
footer: true,
forceRender: false,
Expand Down
1 change: 1 addition & 0 deletions packages/products/tdesign-react/src/drawer/drawer.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
:: BASE_DOC ::

## API

### Drawer Props

name | type | default | description | required
Expand Down
1 change: 1 addition & 0 deletions packages/products/tdesign-react/src/drawer/drawer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
:: BASE_DOC ::

## API

### Drawer Props

名称 | 类型 | 默认值 | 描述 | 必传
Expand Down
1 change: 0 additions & 1 deletion packages/products/tdesign-react/src/drawer/type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ export interface TdDrawerProps {
closeOnEscKeydown?: boolean;
/**
* 点击蒙层时是否触发抽屉关闭事件
* @default true
*/
closeOnOverlayClick?: boolean;
/**
Expand Down
Loading