创建一个遮罩层,用于强调特定的页面元素,并阻止用户对遮罩下层的内容进行操作,一般用于弹窗场景
#平台差异说明
App | H5 | 微信小程序 | 支付宝小程序 | 百度小程序 | 头条小程序 | QQ小程序 |
√ | √ | √ | √ | √ | √ | √ |
#基本使用
- 通过
show
参数配置是否显示遮罩 - 遮罩被点击时,会发送一个
click
事件,如不需要此事件,请设置mask-click-able
参数为false
<template> <u-mask :show="show" @click="show = false"></u-mask> </template> <script> export default { data() { return { show: true } } } </script>
#嵌入内容
通过默认插槽可以在遮罩层上嵌入任意内容
注意:如果不想让slot
插槽内容的点击事件冒泡到遮罩,请给指定元素添加上@tap.stop
<template> <u-mask :show="show" @click="show = false"> <view class="warp"> <view class="rect" @tap.stop></view> </view> </u-mask> </template> <script> export default { data() { return { show: true } } } </script> <style scoped> .warp { display: flex; align-items: center; justify-content: center; height: 100%; } .rect { width: 120px; height: 120px; background-color: #fff; } </style>
#遮罩样式
- 通过
duration
设置遮罩淡入淡出的时长,单位ms
- 通过
zoom
设置遮罩淡入淡出时是否带有轻微的缩放效果,内部通过transform: scale(1.2, 1.2)
实现
- 通过
custom-style
传入一个对象,自定义样式,如"{backgroundColor: 'red', color: 'blue'}"
<u-mask :show="show" :duration="400" :zoom="true" :custom-style="{background: 'rgba(0, 0, 0, 0.5)'}"></u-mask>
#API
#Props
参数 | 说明 | 类型 | 默认值 | 可选值 |
show | 是否显示遮罩 | Boolean | false | true |
z-index | z-index 层级 | String | Number | 10070 | - |
custom-style | 自定义样式对象,见上方说明 | Object | - | - |
duration | 动画时长,单位毫秒 | String | Number | 300 | - |
zoom | 是否使用scale 对遮罩进行缩放 |
Boolean | true | false |
mask-click-able | 遮罩是否可点击,为false 时点击不会发送click 事件 |
Boolean | true | false |
#Events
事件名 | 说明 | 回调参数 |
click | mask-click-able 为true 时,点击遮罩发送此事件 |
- |
#Slot
名称 | 说明 |
default | 默认插槽,用于在遮罩层上方嵌入内容 |