# Backdrop 遮罩层
概述
Backdrop 遮罩层,在组件中设置显示蒙层。
# 支持平台
目前开发小程序与H5推荐使用 FirstUI nvue版本 (opens new window)。
安卓系统版本 | 安卓uni-app | 安卓uniapp-x | iOS系统版本 | iOS uniapp | iOS uniapp-x | 小程序 | H5/Web |
---|---|---|---|---|---|---|---|
5.0 | × | ✓ | 9.0 | × | × | × | ✓ |
# 引入
以下介绍两种常用的引入方式。
第一种:在页面中引用、注册
import fuiBackdrop from "@/components/firstui/fui-backdrop/fui-backdrop.uvue"
export default {
components:{
fuiBackdrop
}
}
1
2
3
4
5
6
2
3
4
5
6
第二种:easycom组件规范
传统vue组件,需要安装、引用、注册,三个步骤后才能使用组件。easycom将其精简为一步。
First UI easycom配置请查看 快速上手。
如果不了解easycom,可先查看 官网文档 (opens new window)。
# 代码演示
部分示例演示,完整使用请参考示例程序以及文档API。
基础使用
通过 show
属性设置遮罩层显示隐藏,closable
属性设置是否可以点击遮罩层进行关闭。
<fui-button type="gray" btn-size="medium" text="打开遮罩层" :bold="true" margin="24rpx" @onclick="open">
</fui-button>
<!--closable为true时click事件才生效-->
<fui-backdrop v-model:visible="show" :closable="true" @onclick="close"></fui-backdrop>
1
2
3
4
2
3
4
export default {
data() {
return {
show: false
}
},
methods: {
open() {
this.show = true
},
close() {
console.log('关闭~')
}
}
}
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
# Slots
插槽名称 | 说明 |
---|---|
default | 标签内部自定义内容 |
# Props
属性名 | 类型 | 说明 | 默认值 | 平台差异说明 |
---|---|---|---|---|
visible | Boolean | 是否显示遮罩层 | false | - |
background | String | 遮罩层背景颜色 | rgba(0, 0, 0, 0.6) | - |
absolute | Boolean | 是否绝对定位,默认为固定定位fixed | false | - |
zIndex | Number | 遮罩层z-index值 | 980 | - |
closable | Boolean | 是否可点击遮罩层,设为true后点击事件生效 | false | - |
# Events
事件名 | 类型 | 说明 | 回调参数 |
---|---|---|---|
@onclick | () => void | 点击遮罩层且closable设为true时触发 | - |
@update:visible | (event:boolean) => void | 点击遮罩层且closable设为true时触发,用于双向绑定 | boolean:是否显示 |
示例预览
# 示例代码地址
← Toast 轻提示 Dialog 对话框 →