Skip to content

弹出层容器,用于展示弹窗、信息提示等内容,支持上、下、左、右和中部弹出。组件只提供容器,内部内容由用户自定义。

平台差异说明

App(vue)App(nvue)H5小程序

基本使用

  • 弹出层的内容通过slot传入,由用户自定义
  • 通过show绑定一个布尔值的变量控制弹出层的打开和收起,通过v-model:show双向绑定简化使用。
html
<template>
	<view>
		<up-popup :show="show" @close="close" @open="open">
        <view>
            <text>出淤泥而不染,濯清涟而不妖</text>
        </view>
		</up-popup>
    <up-popup v-model:show="show">
        <view>
            <text>出淤泥而不染,濯清涟而不妖</text>
        </view>
		</up-popup>
		<up-button @click="show = true">打开</up-button>
	</view>
</template>
js
<script setup>  
import { ref } from 'vue';  
  
// 创建响应式数据  
const show = ref(false);
  
// 定义方法  
function open() {  
  // 打开逻辑,比如设置 show 为 true  
  show.value = true;  
  // console.log('open');  
}  
  
function close() {  
  // 关闭逻辑,设置 show 为 false  
  show.value = false;  
  // console.log('close');  
}  
</script>
js
<script>
	export default {
      data() {
        return {
          show: false
        }
      }, 
      methods: {
        open() {
          // console.log('open');
        },
        close() {
          this.show = false
          // console.log('close');
        }
      }
	}
</script>

设置弹出层的方向

  • 可以通过mode参数设置,可以设置为lefttoprightbottomcenter
html
<template>
	<up-popup :show="show" mode="top"  @close="close" @open="open">
        <view>
            <text>人生若只如初见,何事秋风悲画扇</text>
        </view>
	</up-popup>
</template>
js
<script setup>  
import { ref } from 'vue';  
  
// 创建响应式数据  
const show = ref(false);  
  
// 定义方法  
function open() {  
  // 打开逻辑,比如设置 show 为 true  
  show.value = true;  
  // console.log('open');  
}  
  
function close() {  
  // 关闭逻辑,设置 show 为 false  
  show.value = false;  
  // console.log('close');  
}  
</script>
js
<script>
  export default {
    data() {
      return {
        show: false
      }
    },
    methods: {
      open() {
        // console.log('open');
      },
      close() {
        this.show = false
        // console.log('close');
      }
    }
  }
</script>

设置弹出层的圆角

需要将round设置为圆角值(仅对mode = top | bottom | center有效)。

html
<template>
	<up-popup :show="show" :round="10" mode="top" @close="close" @open="open">
		<view>
        <text>人生若只如初见,何事秋风悲画扇</text>
		</view>
	</up-popup>
</template>
js
<script setup>  
import { ref } from 'vue';  
  
// 创建响应式数据  
const show = ref(false);  
  
// 定义方法  
function open() {  
  // 打开逻辑,比如设置 show 为 true  
  show.value = true;  
  // console.log('open');  
}  
  
function close() {  
  // 关闭逻辑,设置 show 为 false  
  show.value = false;  
  // console.log('close');  
}  
</script>
js
<script>
  export default {
    data() {
      return {
        show: false
      }
    },
    methods: {
      open() {
        // console.log('open');
      },
      close() {
        this.show = false
        // console.log('close');
      }
    }
  }
</script>

右侧演示页面源代码地址

点击以下链接以查看右侧演示页面的源码


 github  gitee

API

Props

参数说明类型默认值可选值
show是否展示弹窗Booleanfalsetrue
overlay是否显示遮罩Booleantruefalse
mode弹出方向Stringbottomtop / right / bottom / center
duration遮罩打开或收起的动画过渡时间,单位msString | Number300-
closeable是否显示关闭图标Booleanfalsetrue
overlayStyle遮罩自定义样式,一般用于修改遮罩颜色,如:Object | String--
overlayOpacity遮罩透明度,0-1之间,勿与overlayStyle共用Number | String0.5-
closeOnClickOverlay点击遮罩是否关闭弹窗(注意:关闭事件需要自行处理,只会在开启closeOnClickOverlay后点击遮罩层执行close回调)Booleantruefalse
zIndex弹出层的z-indexNumber | String10075-
safeAreaInsetBottom是否为留出底部安全距离Booleantruefalse
safeAreaInsetTop是否留出顶部安全距离(状态栏高度)Booleanfalsetrue
closeIconPos自定义关闭图标位置,top-left为左上角,top-right为右上角,bottom-left为左下角,bottom-right为右下角Stringtop-righttop-left / bottom-left / bottom-right
round设置圆角值,仅对`mode = topbottomcener`有效Number | String
zoom当mode=center时 是否开启缩放Booleantruefalse
bgColor背景色,一般用于特殊弹窗内容场景,设置为transparent可去除默认的白色背景String--
customStyle用户自定义样式Object--

Event

事件名说明回调参数版本
open弹出层打开--
close弹出层收起--