1.0.2 • Published 3 years ago

@ophiuchus/popup v1.0.2

Weekly downloads
-
License
MIT
Repository
-
Last release
3 years ago

Popup 弹出层

介绍

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

引入

import Vue from 'vue';
import Popup from '@ophiuchus/popup';

Vue.use(Popup);

代码演示

基础用法

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

<sf-cell is-link @click="showPopup">展示弹出层</sf-cell>
<sf-popup v-model="show">内容</sf-popup>
export default {
  data() {
    return {
      show: false,
    };
  },

  methods: {
    showPopup() {
      this.show = true;
    },
  },
};

弹出位置

通过 position 属性设置弹出位置,默认居中弹出,可以设置为 topbottomleftright

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

关闭图标

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

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

圆角弹窗

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

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

指定挂载位置

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

<!-- 挂载到 body 节点下 -->
<sf-popup v-model="show" get-container="body" />

<!-- 挂载到 #app 节点下 -->
<sf-popup v-model="show" get-container="#app" />

<!-- 通过函数指定挂载位置 -->
<sf-popup v-model="show" :get-container="getContainer" />
export default {
  methods: {
    // 返回一个特定的 DOM 节点,作为挂载的父节点
    getContainer() {
      return document.querySelector('.my-container');
    },
  },
};

注意:使用 get-container 属性的组件不能为根节点

API

Props

参数说明类型默认值
v-model (value)是否显示弹出层booleanfalse
overlay是否显示遮罩层booleantrue
position弹出位置,可选值为 top bottom right leftstringcenter
overlay-class自定义遮罩层类名string-
overlay-style自定义遮罩层样式object-
duration动画时长,单位秒number | string0.3
round是否显示圆角booleanfalse
lock-scroll是否锁定背景滚动booleantrue
lazy-render是否在显示弹层时才渲染节点booleantrue
close-on-popstate是否在页面回退时自动关闭booleanfalse
close-on-click-overlay是否在点击遮罩层后关闭booleantrue
closeable是否显示关闭图标booleanfalse
close-icon关闭图标名称或图片链接stringcross
close-icon-position关闭图标位置,可选值为top-leftbottom-left bottom-rightstringtop-right
transition动画类名,等价于 transtionname属性string-
transition-appear是否在初始渲染时启用过渡动画booleanfalse
get-container指定挂载的节点string | () => Element-
<!--safe-area-inset-bottom是否开启底部安全区适配booleanfalse-->

Events

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

样式变量

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

名称默认值描述
@popup-background-color@white-
@popup-transitiontransform @animation-duration-base-
@popup-round-border-radius16px-
@popup-close-icon-size22px-
@popup-close-icon-color@gray-5-
@popup-close-icon-active-color@gray-6-
@popup-close-icon-margin16px-
@popup-close-icon-z-index1-