弹出层容器,用于展示弹窗、信息提示等内容,支持多个弹出层叠加展示。
通过以下方式来全局注册组件,更多注册方式请参考组件注册。
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" />
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
v-model:show | 是否显示弹出层 | boolean | false
|
overlay | 是否显示遮罩层 | boolean | true
|
position | 弹出位置,可选值为 top bottom right left
|
string | center
|
overlay-class | 自定义遮罩层类名 | string | Array | object | - |
overlay-style | 自定义遮罩层样式 | object | - |
duration | 动画时长,单位秒,设置为 0 可以禁用动画 | number | string | 0.3
|
z-index | 将弹窗的 z-index 层级设置为一个固定值 | number | string | 2000+
|
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 | 关闭图标名称或图片链接,等同于 Icon 组件的 name 属性 | string | cross
|
close-icon-position | 关闭图标位置,可选值为 top-left
bottom-left bottom-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 | 动画类名,等价于 transition 的 name 属性 |
string | - |
transition-appear | 是否在初始渲染时启用过渡动画 | boolean | false
|
teleport | 指定挂载的节点,等同于 Teleport 组件的 to 属性 | string | Element | - |
safe-area-inset-top | 是否开启顶部安全区适配 | boolean | false
|
safe-area-inset-bottom | 是否开启底部安全区适配 | boolean | false
|
事件名 | 说明 | 回调参数 |
---|---|---|
click | 点击弹出层时触发 | event: MouseEvent |
click-overlay | 点击遮罩层时触发 | event: MouseEvent |
click-close-icon | 点击关闭图标时触发 | event: MouseEvent |
open | 打开弹出层时触发 | - |
close | 关闭弹出层时触发 | - |
opened | 打开弹出层且动画结束后触发 | - |
closed | 关闭弹出层且动画结束后触发 | - |
名称 | 说明 |
---|---|
default | 弹窗内容 |
overlay-content v3.0.18
|
遮罩层的内容 |
组件导出以下类型定义:
import type {
PopupProps,
PopupPosition,
PopupInstance,
PopupCloseIconPosition,
} from "vant";
组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件。
名称 | 默认值 | 描述 |
---|---|---|
--van-popup-background | var(--van-background-2) | - |
--van-popup-transition | transform var(--van-duration-base) | - |
--van-popup-round-radius | 16px | - |
--van-popup-close-icon-size | 22px | - |
--van-popup-close-icon-color | var(--van-gray-5) | - |
--van-popup-close-icon-margin | 16px | - |
--van-popup-close-icon-z-index | 1 | - |
介绍用户可以在文本框内输入或编辑文字。引入通过以下方式来全局注册组件,更多注册方式请参考组件注册。import { createApp } f...
介绍圆环形的进度条组件,支持进度渐变动画。引入通过以下方式来全局注册组件,更多注册方式请参考组件注册。import { createApp...
介绍级联选择框,用于多层级数据的选择,典型场景为省市区选择。实例演示引入通过以下方式来全局注册组件,更多注册方式请参考组...
介绍底部导航栏,用于在不同页面之间进行切换。实例演示引入通过以下方式来全局注册组件,更多注册方式请参考组件注册。import {...
提供了一套常用的图标集合。使用方法直接通过设置类名为 el-icon-iconName 来使用即可。例如:render() {return (divi className...
内置过渡动画Element Plus 内应用在部分组件的过渡动画,你也可以直接使用。在使用之前请阅读transition 组件文档。fade 淡入淡...