Vant3 中文入门教程 Vant3 Popup 弹出层

2024-02-25 开发教程 Vant3 中文入门教程 匿名 4

介绍

弹出层容器,用于展示弹窗、信息提示等内容,支持多个弹出层叠加展示。

实例演示

引入

通过以下方式来全局注册组件,更多注册方式请参考组件注册。

import { createApp } from 'vue';
import { Popup } from 'vant';
const app = createApp();
app.use(Popup);

代码演示

基础用法

通过 v-model:show 控制弹出层是否展示。

<van-cell is-link @click="showPopup">展示弹出层</van-cell>
<van-popup v-model:show="show">内容</van-popup>
import { ref } from 'vue';
export default {
setup() {
const show = ref(false);
const showPopup = () => {
show.value = true;
};
return {
show,
showPopup,
};
},
};

弹出位置

通过 position 属性设置弹出位置,默认居中弹出,可以设置为 top、bottom、left、right。

<van-popup v-model:show="show" position="top" :style="{ height: '30%' }" />

关闭图标

设置 closeable 属性后,会在弹出层的右上角显示关闭图标,并且可以通过 close-icon 属性自定义图标,使用 close-icon-position 属性可以自定义图标位置。

<van-popup
v-model:show="show"
closeable
position="bottom"
:style="{ height: '30%' }"
/>
<!-- 自定义图标 -->
<van-popup
v-model:show="show"
closeable
close-icon="close"
position="bottom"
:style="{ height: '30%' }"
/>
<!-- 图标位置 -->
<van-popup
v-model:show="show"
closeable
close-icon-position="top-left"
position="bottom"
:style="{ height: '30%' }"
/>

圆角弹窗

设置 round 属性后,弹窗会根据弹出位置添加不同的圆角样式。

<van-popup
v-model:show="show"
round
position="bottom"
:style="{ height: '30%' }"
/>

指定挂载位置

弹出层默认挂载到组件标签所在位置,可以通过 teleport 属性指定挂载位置。

<!-- 挂载到 body 节点下 -->
<van-popup v-model:show="show" teleport="body" />
<!-- 挂载到 #app 节点下 -->
<van-popup v-model:show="show" teleport="#app" />
<!-- 挂载到指定的元素下 -->
<van-popup v-model:show="show" :teleport="myContainer" />
export default {
setup() {
const myContainer = document.querySelector('.my-container');
return {
myContainer,
};
},
};

API

Props

参数说明类型默认值
v-model:show是否显示弹出层

boolean

false

overlay是否显示遮罩层

boolean

true

position

弹出位置,可选值为 topbottomrightleft

string

center

overlay-class自定义遮罩层类名

string | Array | object

-
overlay-style自定义遮罩层样式

object

-
duration动画时长,单位秒

number | string

0.3

round是否显示圆角

boolean

false

lock-scroll是否锁定背景滚动

boolean

true

lazy-render是否在显示弹层时才渲染节点

boolean

true

close-on-popstate是否在页面回退时自动关闭

boolean

false

close-on-click-overlay是否在点击遮罩层后关闭

boolean

true

closeable是否显示关闭图标

boolean

false

close-icon关闭图标名称或图片链接

string

cross

close-icon-position

关闭图标位置,可选值为 top-left

bottom-leftbottom-right

string

top-right

before-close v3.1.4

关闭前的回调函数,返回 false可阻止关闭,支持返回 Promise

(action: string) => boolean | Promise<boolean>

-

icon-prefix v3.0.18

图标类名前缀,同 Icon 组件的 class-prefix 属性

string

van-icon

transition动画类名,等价于 transitionname属性

string

-
transition-appear是否在初始渲染时启用过渡动画

boolean

false

teleport指定挂载的节点

string | Element

-
safe-area-inset-bottom

是否开启底部安全区适配

boolean

false

Events

事件名说明回调参数
click点击弹出层时触发

event: MouseEvent

click-overlay点击遮罩层时触发

event: MouseEvent

click-close-icon点击关闭图标时触发

event: MouseEvent

open打开弹出层时触发-
close关闭弹出层时触发-
opened打开弹出层且动画结束后触发-
closed关闭弹出层且动画结束后触发-

Slots

名称说明
default弹窗内容

overlay-content v3.0.18

遮罩层的内容

主题定制

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件。

名称默认值描述
--van-popup-background-color

var(--van-white)

-
--van-popup-transition

transform var(--van-animation-duration-base)

-
--van-popup-round-border-radius

16px

-
--van-popup-close-icon-size

22px

-
--van-popup-close-icon-color

var(--van-gray-5)

-
--van-popup-close-icon-active-color

var(--van-gray-6)

-
--van-popup-close-icon-margin

16px

-
--van-popup-close-icon-z-index

1

-