docs(Drawer): add overlayProps attr (#724)

anlyyao · web-flow · commit 03dee497355b · 2025-10-09T17:49:34.000+08:00
diff --git a/db/TDesign.db b/db/TDesign.db
diff --git a/packages/products/tdesign-miniprogram/packages/components/drawer/README.en-US.md b/packages/products/tdesign-miniprogram/packages/components/drawer/README.en-US.md
@@ -10,15 +10,23 @@ 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
 destroy-on-close | Boolean | false | \- | N
-footer | Slot | - | `0.29.0`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/common/common.ts) | N
+
 items | Array | - | Typescript：`DrawerItem[]` `interface DrawerItem { title: string; icon: string; }`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/drawer/type.ts) | N
+overlay-props | Object | {} | Typescript：`OverlayProps`，[Overlay API Documents](./overlay?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/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/packages/components/common/common.ts) | N
+title | String | - | `0.29.0` | N
 using-custom-navbar | Boolean | false | \- | N
 visible | Boolean | false | \- | N
 z-index | Number | 11500 | \- | N
 
+### Drawer Slots
+
+name | Description
+-- | --
+footer | `0.29.0`
+title | `0.29.0`
+
 ### Drawer Events
 
 name | params | description
diff --git a/packages/products/tdesign-miniprogram/packages/components/drawer/README.md b/packages/products/tdesign-miniprogram/packages/components/drawer/README.md
@@ -10,15 +10,23 @@ style | Object | - | 样式 | N
 custom-style | Object | - | 样式，一般用于开启虚拟化组件节点场景 | N
 close-on-overlay-click | Boolean | true | 点击蒙层时是否触发抽屉关闭事件 | N
 destroy-on-close | Boolean | false | 抽屉关闭时是否销毁节点 | N
-footer | Slot | - | `0.29.0`。抽屉的底部。[通用类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/common/common.ts) | N
+
 items | Array | - | 抽屉里的列表项。TS 类型：`DrawerItem[]` `interface DrawerItem { title: string; icon: string; }`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/drawer/type.ts) | N
+overlay-props | Object | {} | 遮罩层的属性，透传至 overlay。TS 类型：`OverlayProps`，[Overlay API Documents](./overlay?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/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/packages/components/common/common.ts) | N
+title | String | - | `0.29.0`。抽屉的标题 | N
 using-custom-navbar | Boolean | false | 是否使用了自定义导航栏 | N
 visible | Boolean | false | 组件是否可见 | N
 z-index | Number | 11500 | 抽屉层级，样式默认为 11500 | N
 
+### Drawer Slots
+
+名称 | 描述
+-- | --
+footer | `0.29.0`。抽屉的底部
+title | `0.29.0`。抽屉的标题
+
 ### Drawer Events
 
 名称 | 参数 | 描述
diff --git a/packages/products/tdesign-miniprogram/packages/components/drawer/props.ts b/packages/products/tdesign-miniprogram/packages/components/drawer/props.ts
@@ -20,6 +20,11 @@ const props: TdDrawerProps = {
   items: {
     type: Array,
   },
+  /** 遮罩层的属性，透传至 overlay */
+  overlayProps: {
+    type: Object,
+    value: {},
+  },
   /** 抽屉方向 */
   placement: {
     type: String,
diff --git a/packages/products/tdesign-miniprogram/packages/components/drawer/type.ts b/packages/products/tdesign-miniprogram/packages/components/drawer/type.ts
@@ -4,6 +4,8 @@
  * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
  * */
 
+import { OverlayProps } from '../overlay/index';
+
 export interface TdDrawerProps {
   /**
    * 点击蒙层时是否触发抽屉关闭事件
@@ -28,6 +30,14 @@ export interface TdDrawerProps {
     type: ArrayConstructor;
     value?: DrawerItem[];
   };
+  /**
+   * 遮罩层的属性，透传至 overlay
+   * @default {}
+   */
+  overlayProps?: {
+    type: ObjectConstructor;
+    value?: OverlayProps;
+  };
   /**
    * 抽屉方向
    * @default right
diff --git a/packages/products/tdesign-mobile-react/src/drawer/defaultProps.ts b/packages/products/tdesign-mobile-react/src/drawer/defaultProps.ts
@@ -7,6 +7,7 @@ import { TdDrawerProps } from './type';
 export const drawerDefaultProps: TdDrawerProps = {
   closeOnOverlayClick: true,
   destroyOnClose: false,
+  overlayProps: {},
   placement: 'right',
   showOverlay: true,
   visible: false,
diff --git a/packages/products/tdesign-mobile-react/src/drawer/drawer.en-US.md b/packages/products/tdesign-mobile-react/src/drawer/drawer.en-US.md
@@ -13,6 +13,7 @@ closeOnOverlayClick | Boolean | true | \- | 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
+overlayProps | Object | {} | Typescript：`OverlayProps`，[Overlay API Documents](./overlay?tab=api)。[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
diff --git a/packages/products/tdesign-mobile-react/src/drawer/drawer.md b/packages/products/tdesign-mobile-react/src/drawer/drawer.md
@@ -13,6 +13,7 @@ closeOnOverlayClick | Boolean | true | 点击蒙层时是否触发抽屉关闭
 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
+overlayProps | Object | {} | 遮罩层的属性，透传至 overlay。TS 类型：`OverlayProps`，[Overlay API Documents](./overlay?tab=api)。[详细类型定义](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
diff --git a/packages/products/tdesign-mobile-react/src/drawer/type.ts b/packages/products/tdesign-mobile-react/src/drawer/type.ts
@@ -4,6 +4,7 @@
  * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
  * */
 
+import { OverlayProps } from '../overlay';
 import { TNode, TElement, Styles, AttachNode } from '../common';
 import { MouseEvent } from 'react';
 
@@ -30,6 +31,11 @@ export interface TdDrawerProps {
    * 抽屉里的列表项
    */
   items?: DrawerItem[];
+  /**
+   * 遮罩层的属性，透传至 overlay
+   * @default {}
+   */
+  overlayProps?: OverlayProps;
   /**
    * 抽屉方向
    * @default right
diff --git a/packages/products/tdesign-mobile-vue/src/drawer/drawer.en-US.md b/packages/products/tdesign-mobile-vue/src/drawer/drawer.en-US.md
@@ -11,6 +11,7 @@ closeOnOverlayClick | Boolean | true | \- | 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
+overlayProps | Object | {} | Typescript：`OverlayProps`，[Overlay API Documents](./overlay?tab=api)。[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
diff --git a/packages/products/tdesign-mobile-vue/src/drawer/drawer.md b/packages/products/tdesign-mobile-vue/src/drawer/drawer.md
@@ -11,20 +11,21 @@ closeOnOverlayClick | Boolean | true | 点击蒙层时是否触发抽屉关闭
 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
+overlayProps | Object | {} | 遮罩层的属性，透传至 overlay。TS 类型：`OverlayProps`，[Overlay API Documents](./overlay?tab=api)。[详细类型定义](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
-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
+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
 
 ### Drawer Events
 
 名称 | 参数 | 描述
 -- | -- | --
-close | `(trigger: DrawerTriggerSource)` | 关闭时触发。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/drawer/type.ts)。<br/>`type DrawerTriggerSource = '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 })` | 如果蒙层存在，点击蒙层时触发
 
diff --git a/packages/products/tdesign-mobile-vue/src/drawer/props.ts b/packages/products/tdesign-mobile-vue/src/drawer/props.ts
@@ -27,6 +27,11 @@ export default {
   items: {
     type: Array as PropType<TdDrawerProps['items']>,
   },
+  /** 遮罩层的属性，透传至 overlay */
+  overlayProps: {
+    type: Object as PropType<TdDrawerProps['overlayProps']>,
+    default: () => ({}),
+  },
   /** 抽屉方向 */
   placement: {
     type: String as PropType<TdDrawerProps['placement']>,
diff --git a/packages/products/tdesign-mobile-vue/src/drawer/type.ts b/packages/products/tdesign-mobile-vue/src/drawer/type.ts
@@ -4,6 +4,7 @@
  * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
  * */
 
+import { OverlayProps } from '../overlay';
 import { TNode, Styles, AttachNode } from '../common';
 
 export interface TdDrawerProps {
@@ -29,6 +30,11 @@ export interface TdDrawerProps {
    * 抽屉里的列表项
    */
   items?: DrawerItem[];
+  /**
+   * 遮罩层的属性，透传至 overlay
+   * @default {}
+   */
+  overlayProps?: OverlayProps;
   /**
    * 抽屉方向
    * @default right
diff --git a/packages/scripts/api.json b/packages/scripts/api.json
@@ -48952,6 +48952,47 @@
         "String"
       ]
     },
+    {
+      "id": 1759993379,
+      "platform_framework": [
+        "8",
+        "16",
+        "64"
+      ],
+      "component": "Drawer",
+      "field_category": 1,
+      "field_name": "overlayProps",
+      "field_type": [
+        "8"
+      ],
+      "field_default_value": "{}",
+      "field_enum": "",
+      "field_desc_zh": "遮罩层的属性，透传至 overlay",
+      "field_desc_en": null,
+      "field_required": 0,
+      "event_input": "",
+      "create_time": "2025-10-09 07:02:59",
+      "update_time": "2025-10-09 07:02:59",
+      "event_output": null,
+      "custom_field_type": "OverlayProps【import { OverlayProps } from '@Overlay'】",
+      "syntactic_sugar": null,
+      "readonly": 1,
+      "html_attribute": 0,
+      "trigger_elements": "",
+      "deprecated": 0,
+      "version": "{\n  \"miniprogram\": \"1.11.0\"\n}",
+      "test_description": null,
+      "support_default_value": 0,
+      "field_category_text": "Props",
+      "platform_framework_text": [
+        "Vue(Mobile)",
+        "React(Mobile)",
+        "Miniprogram"
+      ],
+      "field_type_text": [
+        "Object"
+      ]
+    },
     {
       "id": 689,
       "platform_framework": [
