Vant4 Popup 弹出层

介绍

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

引入

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

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="" />

关闭图标

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

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

圆角弹窗

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

<van-popup
  v-model:show="show"
  round
  position="bottom"
  :style=""
/>

指定挂载位置

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

<!-- 挂载到 body 节点下 -->
<van-popup v-model:show="show" teleport="body" />

<!-- 挂载到 #app 节点下 -->
<van-popup v-model:show="show" teleport="#app" />

API

Props

参数说明类型默认值
v-model:show是否显示弹出层booleanfalse
overlay是否显示遮罩层booleantrue
position弹出位置,可选值为 top bottom right leftstringcenter
overlay-class自定义遮罩层类名string | Array | object
overlay-style自定义遮罩层样式object
duration动画时长,单位秒,设置为 0 可以禁用动画number | string0.3
z-index将弹窗的 z-index 层级设置为一个固定值number | string2000+
round是否显示圆角booleanfalse
lock-scroll是否锁定背景滚动booleantrue
lazy-render是否在显示弹层时才渲染节点booleantrue
close-on-popstate是否在页面回退时自动关闭booleanfalse
close-on-click-overlay是否在点击遮罩层后关闭booleantrue
closeable是否显示关闭图标booleanfalse
close-icon关闭图标名称或图片链接,等同于 Icon 组件的 name 属性stringcross
close-icon-position关闭图标位置,可选值为 top-left

bottom-left bottom-right

stringtop-right
before-close v3.1.4关闭前的回调函数,返回 false 可阻止关闭,支持返回 Promise(action: string) => boolean | Promise<boolean>
icon-prefix v3.0.18图标类名前缀,等同于 Icon 组件的 class-prefix 属性stringvan-icon
transition动画类名,等价于 transition 的 name 属性string
transition-appear是否在初始渲染时启用过渡动画booleanfalse
teleport指定挂载的节点,等同于 Teleport 组件的 to 属性string | Element
safe-area-inset-top是否开启顶部安全区适配booleanfalse
safe-area-inset-bottom是否开启底部安全区适配booleanfalse

Events

事件名说明回调参数
click点击弹出层时触发event: MouseEvent
click-overlay点击遮罩层时触发event: MouseEvent
click-close-icon点击关闭图标时触发event: MouseEvent
open打开弹出层时触发
close关闭弹出层时触发
opened打开弹出层且动画结束后触发
closed关闭弹出层且动画结束后触发

Slots

名称说明
default弹窗内容
overlay-content v3.0.18遮罩层的内容

类型定义

组件导出以下类型定义:

import type {
  PopupProps,
  PopupPosition,
  PopupInstance,
  PopupCloseIconPosition,
} from vant;

主题定制

样式变量

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

名称默认值描述
–van-popup-backgroundvar(–van-background-2)
–van-popup-transitiontransform var(–van-duration-base)
–van-popup-round-radius16px
–van-popup-close-icon-size22px
–van-popup-close-icon-colorvar(–van-gray-5)
–van-popup-close-icon-margin16px
–van-popup-close-icon-z-index1

作者:唐伯虎点蚊香,如若转载,请注明出处:https://www.web176.com/vant4/18935.html

(0)
打赏 支付宝 支付宝 微信 微信
唐伯虎点蚊香的头像唐伯虎点蚊香
上一篇 2023年4月28日
下一篇 2023年4月28日

相关推荐

发表回复

登录后才能评论