59 lines
2.6 KiB
Markdown
59 lines
2.6 KiB
Markdown
---
|
||
title: Drawer 抽屉
|
||
description: 用作一组平行关系页面/内容的切换器，相较于Tab，同屏可展示更多的选项数量。。
|
||
spline: message
|
||
isComponent: true
|
||
---
|
||
|
||
<span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20lines-100%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20functions-100%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20statements-100%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20branches-100%25-blue" /></span>
|
||
## 引入
|
||
|
||
全局引入，在 miniprogram 根目录下的`app.json`中配置，局部引入，在需要引入的页面或组件的`index.json`中配置。
|
||
|
||
```json
|
||
"usingComponents": {
|
||
"t-drawer": "tdesign-miniprogram/drawer/drawer"
|
||
}
|
||
```
|
||
|
||
### 主题定制
|
||
CSS 变量名|说明
|
||
--|--
|
||
--td-drawer-sidebar-bg-color | 抽屉背景颜色
|
||
--td-drawer-sidebar-border-color | 列表项下边框颜色
|
||
--td-drawer-sidebar-title-color | 列表项标题颜色
|
||
--td-drawer-sidebar-icon-color | 列表项图标颜色
|
||
|
||
## 代码演示
|
||
|
||
### 基础抽屉
|
||
{{ base }}
|
||
|
||
### 带图标的抽屉
|
||
{{ icon-drawer }}
|
||
|
||
>Drawer的 `visible` 是受控的，需要手动设置 `visible` 为 `true` 才会开启抽屉
|
||
|
||
|
||
|
||
## API
|
||
### Drawer Props
|
||
|
||
名称 | 类型 | 默认值 | 说明 | 必传
|
||
-- | -- | -- | -- | --
|
||
close-on-overlay-click | Boolean | true | 点击蒙层时是否触发抽屉关闭事件 | N
|
||
destroy-on-close | Boolean | false | 抽屉关闭时是否销毁节点 | 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
|
||
visible | Boolean | false | 组件是否可见 | N
|
||
z-index | Number | 11500 | 组件层级，样式默认为 11500 | N
|
||
|
||
### Drawer Events
|
||
|
||
名称 | 参数 | 描述
|
||
-- | -- | --
|
||
close | `(trigger: DrawerEventSource)` | 关闭事件，取消按钮点击时、关闭按钮点击时、点击蒙层时均会触发。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/drawer/type.ts)。<br/>`type DrawerEventSource = 'esc' | 'close-btn' | 'cancel' | 'overlay'`<br/>
|
||
item-click | `(index: number; item: DrawerItem)` | 点击抽屉里的列表项
|
||
overlay-click | - | 如果蒙层存在，点击蒙层时触发
|