@neosjs/overlay
遮罩层组件。创建一个覆盖全屏的蒙层,通常作为 Modal、Dialog 等弹层的底层容器使用,也可单独使用。
安装
sh
pnpm add @neosjs/overlaysh
npm i @neosjs/overlaysh
yarn add @neosjs/overlay快速上手
mask 为 true 时渲染带遮罩样式的蒙层;为 false 时渲染一个全屏透明的固定定位容器(不带遮罩背景)。
vue
<script setup lang="ts">
import { Overlay } from '@neosjs/overlay'
import { ref } from 'vue'
const visible = ref(false)
</script>
<template>
<button @click="visible = true">
显示遮罩层
</button>
<Overlay
v-if="visible"
:z-index="2000"
overlay-class="custom-overlay"
@click="visible = false"
>
<div>遮罩层内容</div>
</Overlay>
</template>Props
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| mask | boolean | true | 是否渲染遮罩背景;为 false 时仅渲染全屏透明容器 |
| custom-mask-event | boolean | false | 是否自定义遮罩点击事件;为 true 时不代理 click 事件 |
| overlay-class | string | string[] | Record<string, boolean> | — | 遮罩层的自定义类名 |
| z-index | string | number | — | 遮罩层的 z-index |
Emits
| 事件名 | 参数 | 说明 |
|---|---|---|
| click | (evt: MouseEvent) | 点击遮罩层时触发 |
TIP
组件内部通过 mousedown / mouseup 判断是否为同一目标的点击,只有"同点按下并抬起"才会触发 click,避免鼠标在遮罩上按下、在遮罩外抬起时误触发。
Slots
| 插槽名 | 说明 |
|---|---|
| default | 遮罩层上渲染的内容 |