Drawer 抽屉
基础用法
带图标抽屉
带标题抽屉
带底部插槽抽屉
命令行调用
Drawer Props
| 名称 | 类型 | 默认值 | 描述 | 必传 |
|---|---|---|---|---|
| attach | String / Function | - | 抽屉挂载的节点，默认挂在组件本身的位置。数据类型为 String 时，会被当作选择器处理，进行节点查询。示例：'body' 或 () => document.body。TS 类型：AttachNode。通用类型定义 | N |
| closeOnOverlayClick | Boolean | true | 点击蒙层时是否触发抽屉关闭事件 | N |
| destroyOnClose | Boolean | false | 抽屉关闭时是否销毁节点 | N |
| footer | Slot / Function | - | 抽屉的底部。TS 类型：TNode。通用类型定义 | N |
| items | Array | - | 抽屉里的列表项。TS 类型：DrawerItem[] interface DrawerItem { title: string; icon?: TNode; }。通用类型定义。详细类型定义 | N |
| placement | String | right | 抽屉方向。可选项：left/right | N |
| showOverlay | Boolean | true | 是否显示遮罩层 | N |
| title | String / Slot / Function | - | 抽屉的标题。TS 类型：string \| TNode。通用类型定义 | N |
| visible | Boolean | false | 组件是否可见 | N |
| zIndex | Number | - | 抽屉层级，样式默认为 1500 | N |
| onClose | Function | TS 类型：(trigger: DrawerTriggerSource) => void关闭时触发。。详细类型定义。 type DrawerTriggerSource = 'overlay' | N | |
| onItemClick | Function | TS 类型：( index: number, item: DrawerItem, context: { e: MouseEvent }) => void点击抽屉里的列表项 | N | |
| onOverlayClick | Function | TS 类型：(context: { e: MouseEvent }) => void如果蒙层存在，点击蒙层时触发 | N |
Drawer Events
| 名称 | 参数 | 描述 |
|---|---|---|
| close | (trigger: DrawerTriggerSource) | 关闭时触发。。详细类型定义。type DrawerTriggerSource = 'overlay' |
| item-click | ( index: number, item: DrawerItem, context: { e: MouseEvent }) | 点击抽屉里的列表项 |
| overlay-click | (context: { e: MouseEvent }) | 如果蒙层存在，点击蒙层时触发 |
DrawerOptions
| 名称 | 类型 | 默认值 | 描述 | 必传 |
|---|---|---|---|---|
| className | String | - | 抽屉类名，示例：'t-class-drawer-first t-class-drawer-second' | N |
| style | String / Object | - | 弹框 style 属性，输入 CSSStyleDeclaration.cssText。TS 类型：string \| Styles。通用类型定义 | N |
Omit<DrawerProps, 'attach'> | - | - | 继承 Omit<DrawerProps, 'attach'> 中的全部属性 | N |
DrawerInstance
| 名称 | 参数 | 返回值 | 描述 |
|---|---|---|---|
| destroy | - | - | 销毁抽屉 |
| hide | - | - | 隐藏抽屉 |
| show | - | - | 显示抽屉 |
| update | (props: DrawerOptions) | - | 更新抽屉内容 |
DrawerPlugin
同时也支持 this.$drawer。
| 参数名称 | 参数类型 | 参数默认值 | 参数描述 |
|---|---|---|---|
| options | - | - | TS 类型：DrawerOptions |
CSS Variables
组件提供了下列 CSS 变量，可用于自定义样式。
| 名称 | 默认值 | 描述 |
|---|---|---|
| --td-drawer-bg-color | @bg-color-container | - |
| --td-drawer-border-color | @border-color | - |
| --td-drawer-footer-padding-bottom | 20px | - |
| --td-drawer-hover-color | @bg-color-secondarycontainer | - |
| --td-drawer-item-height | 24px | - |
| --td-drawer-item-icon-size | 24px | - |
| --td-drawer-item-padding | 16px | - |
| --td-drawer-sidebar-height | 70vh | - |
| --td-drawer-title-color | @drawer-title-color | - |
| --td-drawer-title-color | @font-gray-1 | - |
| --td-drawer-title-font-size | 18px | - |
| --td-drawer-title-padding | 24px 16px 8px | - |
| --td-drawer-width | 280px | - |
何时使用
需要收折展示一组数量较多的菜单时使用
组件搭配使用
抽屉与按钮组合使用，通过按钮点击唤起抽屉。
常见用法
在网站场景，通常用来收折展示整个网站的菜单导航。
在应用场景，通常用来承载某类相关性较强的或较为低频的，如个人中心、设置等场景。
推荐/慎用示例
若抽屉内的菜单项较多，且菜单项之间的关联性存在差异时，建议对菜单项进行分组。
相似组件
| 组件名 | 何时使用 |
|---|---|
| 动作面板 | 需要提供一组与当前场景操作相关的关联操作时使用。 |
| 对话框 | 需要用户做一些决定，或这提供完成某个任务是需要的一些额外信息时使用。 |
| 下拉菜单 | 当内容较多时，需要通过筛选快速定位某一类内容时使用。 |
| 选择器 | 当需要在有限的空间展示大量选项供用户选择，或者一组选项由递进层级构成需要用户逐级选择时使用。 |
