Overlay 遮罩层
uni-appH5微信小程序App
覆盖页面内容的跨端遮罩容器,适合与弹层组件组合。
何时使用
全局加载遮罩、自定义弹层的背景层、引导蒙层。
何时不使用
标准确认/表单弹窗直接用 Dialog;轻提示用 Toast。
本文档为 uni-app 端组件契约;Web 端同名组件 API 可能略有差异,请以对应包文档为准。下方手机预览实时运行 uni-app H5 演示。
9:41
Overlay 遮罩层 · uni-app H5 实时运行 新窗口打开
Props
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
modelValue | boolean | false | 显隐(v-model) |
zIndex | number | 1000 | 层级;不传则使用 overlay 层级 token |
blur | boolean | false | 背景模糊(backdrop-filter: blur(8px)) |
Events
| 名称 | 载荷 | 说明 |
|---|---|---|
update:modelValue | boolean | 配合 v-model 更新显隐 |
click | Event | 点击遮罩时触发;是否关闭由调用方决定 |
Slots
| 名称 | 说明 |
|---|---|
default | 遮罩上的内容 |
示例
基础用法
vue
<Button variant="primary" @click="show = true">打开遮罩</Button>
<Overlay v-model="show" />内嵌内容
vue
<Button variant="secondary" @click="show2 = true">居中内容</Button>
<Overlay v-model="show2">
<view class="dark-box"><Loading variant="white" text="加载中" /></view>
</Overlay>自定义层级
vue
<Button variant="ghost" @click="show3 = true">高层级遮罩</Button>
<Overlay v-model="show3" :z-index="2000" />毛玻璃模糊
vue
<Button variant="primary" @click="visible5 = true">模糊遮罩</Button>
<Overlay v-model="visible5" blur />