Vant4 Overlay 遮罩層

2023-02-16 17:55 更新

介紹

創(chuàng)建一個遮罩層,用于強(qiáng)調(diào)特定的頁面元素,并阻止用戶進(jìn)行其他操作。

引入

通過以下方式來全局注冊組件,更多注冊方式請參考組件注冊。

import { createApp } from 'vue';
import { Overlay } from 'vant';

const app = createApp();
app.use(Overlay);

代碼演示

基礎(chǔ)用法

<van-button type="primary" text="顯示遮罩層" @click="show = true" />
<van-overlay :show="show" @click="show = false" />
import { ref } from 'vue';

export default {
  setup() {
    const show = ref(false);
    return { show };
  },
};

嵌入內(nèi)容

通過默認(rèn)插槽可以在遮罩層上嵌入任意內(nèi)容。

<van-overlay :show="show" @click="show = false">
  <div class="wrapper" @click.stop>
    <div class="block" />
  </div>
</van-overlay>

<style>
  .wrapper {
    display: flex;
    align-items: center;
    justify-content: center;
    height: 100%;
  }

  .block {
    width: 120px;
    height: 120px;
    background-color: #fff;
  }
</style>

API

Props

參數(shù) 說明 類型 默認(rèn)值
show 是否展示遮罩層 boolean false
z-index z-index 層級 number | string 1
duration 動畫時長,單位秒,設(shè)置為 0 可以禁用動畫 number | string 0.3
class-name 自定義類名 string -
custom-style 自定義樣式 object -
lock-scroll 是否鎖定背景滾動,鎖定時蒙層里的內(nèi)容也將無法滾動 boolean true
lazy-render v3.4.2 是否在顯示時才渲染節(jié)點 boolean true

Events

事件名 說明 回調(diào)參數(shù)
click 點擊時觸發(fā) event: MouseEvent

Slots

名稱 說明
default 默認(rèn)插槽,用于在遮罩層上方嵌入內(nèi)容

類型定義

組件導(dǎo)出以下類型定義:

import type { OverlayProps } from 'vant';

主題定制

樣式變量

組件提供了下列 CSS 變量,可用于自定義樣式,使用方法請參考 ConfigProvider 組件。

名稱 默認(rèn)值 描述
--van-overlay-z-index 1 -
--van-overlay-background rgba(0, 0, 0, 0.7) -


以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號