# Drawer 抽屉
概述
Drawer 抽屉，抽屉式导航，用于展示侧滑菜单，侧滑导航。
# 支持平台
| App-vue | App-Nvue | 微信小程序 | 支付宝小程序 | 百度小程序 | 字节小程序 | QQ小程序 | H5 | PC | 快手小程序 | 钉钉小程序 |
|---|---|---|---|---|---|---|---|---|---|---|
| ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
温馨提示
一般来说我们会通过 z-index + position 来进行层级的设置，但是 weex （Nvue）不支持 z-index 设置层级关系，默认越靠后的元素层级越高。
App端如果需要覆盖原生导航栏以及tabbar请使用 subNVue 原生子窗体 (opens new window) 方案。
# 引入
以下介绍两种常用的引入方式。
第一种：在页面中引用、注册
import fuiDrawer from "@/components/firstui/fui-drawer/fui-drawer.vue"
export default {
components:{
fuiDrawer
}
}
1
2
3
4
5
6
2
3
4
5
6
第二种：easycom组件规范
传统vue组件，需要安装、引用、注册，三个步骤后才能使用组件。easycom将其精简为一步。
First UI easycom配置请查看 快速上手。
如果不了解easycom，可先查看 官网文档 (opens new window)。
# 代码演示
部分示例演示，完整使用请参考示例程序以及文档API（以下示例写于.vue页面中）。
基础使用
通过 show 属性控制是否显示抽屉，@close 事件为当 maskClosable 属性值为true时点击遮罩回调事件，通过设置 show 属性为false来关闭抽屉。
当内容较多需要滚动时，可在组件内部使用 scroll-view 来达到内容滚动效果。
<fui-drawer :show="show" @close="closeDrawer">
<scroll-view scroll-y class="fui-scroll__view">
<view>
<fui-list-cell arrow v-for="(item,index) in itemList" :key="index">
item{{index+1}}
</fui-list-cell>
</view>
</scroll-view>
</fui-drawer>
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
/* 自定义内容区样式需自行控制 */
.fui-scroll__view {
width: 520rpx;
flex: 1;
overflow: hidden;
}
1
2
3
4
5
6
2
3
4
5
6
data() {
return {
show: false,
itemList: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]
}
},
methods: {
//调用此方法显示抽屉
showDrawer(type) {
this.show = true
},
closeDrawer(type) {
this.show = false
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
从左往右开
通过 show 属性控制是否显示抽屉，direction 属性控制抽屉打开方向，maskClosable 属性设置是否可点击遮罩关闭抽屉（值为true时点击后回调事件为@close）。
当内容较多需要滚动时，可在组件内部使用 scroll-view 来达到内容滚动效果。
<fui-drawer :show="show" direction="left" :maskClosable="false">
<view class="fui-scroll__view">
<view class="fui-title">左侧菜单栏</view>
<scroll-view scroll-y style="height: 720rpx;">
<view>
<fui-list-cell v-for="(item,index) in itemList" :key="index">
item{{index+1}}
</fui-list-cell>
</view>
</scroll-view>
<view class="fui-btn__box">
<fui-button type="warning" width="400rpx" height="84rpx" text="关闭菜单栏" bold @click="closeDrawer">
</fui-button>
</view>
</view>
</fui-drawer>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
.fui-scroll__view {
width: 520rpx;
flex: 1;
overflow: hidden;
}
.fui-title {
padding: 64rpx 32rpx 32rpx;
box-sizing: border-box;
font-weight: bold;
}
.fui-btn__box {
padding: 40rpx 0;
display: flex;
justify-content: center;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
data() {
return {
show: false,
itemList: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]
}
},
methods: {
//调用此方法显示抽屉
showDrawer() {
this.show = true
},
closeDrawer() {
this.show = false
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
TIP
如果自定义内容中包含输入框类组件，小程序端抽屉未显示时可能无法隐藏输入框，需要自行使用 v-if 对输入框进行隐藏。
# Slots
| 插槽名称 | 说明 |
|---|---|
| default | 自定义显示内容 |
# Props
| 属性名 | 类型 | 说明 | 默认值 | 平台差异说明 |
|---|---|---|---|---|
| show | Boolean | 是否显示抽屉 | false | - |
| direction | String | 抽屉打开方向，可选值：left，right | right | - |
| background | String | 抽屉背景颜色 | #fff | - |
| zIndex | Number, String | 抽屉z-index值 | 996 | Nvue端无效，默认越靠后的元素层级越高 |
| maskClosable | Boolean | 点击遮罩 是否可关闭 | true | - |
| maskBackground | String | 遮罩背景色 | rgba(0,0,0,.6) | - |
| radius V1.8.0+ | Number, String | 外层容器圆角值，左侧打开时为右侧圆角，右侧打开时为左侧圆角 | 0 | - |
# Events
| 事件名 | 说明 | 回调参数 |
|---|---|---|
| @close | 点击遮罩层（maskClosable=true）时触发 | - |
Drawer 抽屉