Overlay 遮罩层

创建一个遮罩层，用于强调特定的页面元素，并阻止用户对遮罩下层的内容进行操作，一般用于弹窗场景

平台差异说明

App(vue)	App(nvue)	H5	微信小程序
√	√	√	√

基本使用

• 通过show参数配置是否显示遮罩
• 遮罩被点击时，会发送一个click事件，如不需要此事件，请设置mask-click-able参数为false

template>
	<su-overlay :show="show" @click="show = false"></su-overlay>
</template>

<script setup>
import { ref } from 'vue';

const show = ref(true);
</script>

嵌入内容

通过默认插槽可以在遮罩层上嵌入任意内容 注意：如果不想让slot插槽内容的点击事件冒泡到遮罩，请给指定元素添加上@tap.stop

<template>
  <su-overlay :show="show" @click="show = false">
    <view class="warp">
      <view class="rect" @tap.stop></view>
    </view>
  </su-overlay>
</template>

<script setup>
  import { ref } from 'vue'

  const show = ref(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

<su-overlay :show="show" :duration="400" :z-index="999" :opacity="0.3"></su-overlay>

示例源码

点击可以查看 右侧演示页面的源码

API

Props

参数	说明	类型	默认值	可选值
show	是否显示遮罩	Boolean	false	true
z-index	z-index 层级	String | Number	10070	-
duration	动画时长，单位毫秒	String | Number	300	-
opacity	不透明度值，当做rgba的第四个参数	String | Number	0.5	-

Events

事件名	说明	回调参数
click	点击遮罩发送此事件	-

Slot

名称	说明
default	默认插槽，用于在遮罩层上方嵌入内容