示例

layer.js 文档

由于 vue-layer 是基于 layer.js 上层封装的组件,所以支持 layer.js 演示open in new window layer.js 文档open in new window中所有的参数和 API,如果你对 layer.js 不够熟悉,可以参考layer.js 文档open in new window一起使用

直接使用 layer.js

很多时候,方法式的调用比组件来的更方便,比如 layer.msg('听君一席话'),所以 vue3-layer 也把 layer.js 原生暴露了出来,让大家更方便的使用

import { layer } from "vue3-layer";
layer.msg("听君一席话");
1
2

参数

type - 基本层类型 类型:Number,默认:0

  • 0(信息框,默认)
  • 1(内容层)
  • 2(iframe 层)

01.初体验

02.自定义宽高 area

类型:String/Array,默认:'auto'

在默认状态下,layer 是宽高都自适应的,但当你只想定义宽度时,你可以 area: '500px',高度仍然是自适应的。当你宽高都要定义时,你可以 area: ['500px', '300px']

03.自定义坐标 offset

类型:String/Array,默认:垂直水平居中

offset 默认情况下不用设置。但如果你不想垂直水平居中,你还可以进行以下赋值:

备注
offset: 'auto'默认坐标,即垂直水平居中
offset: '100px'只定义 top 坐标,水平保持居中
offset: ['100px', '50px']同时定义 top、left 坐标
offset: 't'快捷设置顶部坐标
offset: 'r'快捷设置右边缘坐标
offset: 'b'快捷设置底部坐标
offset: 'l'快捷设置左边缘坐标
offset: 'lt'快捷设置左上角
offset: 'lb'快捷设置左下角
offset: 'rt'快捷设置右上角
offset: 'rb'快捷设置右下角

04.自定义按钮 btn

类型:String/Array,默认:'确认'

信息框模式时,btn 默认是一个确认按钮,其它层类型则默认不显示,加载层和 tips 层则无效。当您只想自定义一个按钮时,你可以 btn: '我知道了',当你要定义两个按钮时,你可以 btn: ['yes', 'no']。当然,你也可以定义更多按钮,比如:btn: ['按钮 1', '按钮 2', '按钮 3', …],按钮 1 的回调是 yes,而从按钮 2 开始,则回调为 btn2: function(){},以此类推。

05.按钮排列 btnAlign

类型:String,默认:r

你可以快捷定义按钮的排列位置,btnAlign 的默认值为 r,即右对齐。该参数可支持的赋值如下:

备注
btnAlign: 'l'按钮左对齐
btnAlign: 'c'按钮居中对齐
btnAlign: 'r'按钮右对齐。默认值,不用设置

06.关闭按钮 closeBtn

类型:String/Boolean,默认:1

layer 提供了两种风格的关闭按钮,可通过配置 1 和 2 来展示,如果不显示,则 closeBtn: 0

07.遮罩 shade

类型:String/Array/Boolean,默认:0.3

即弹层外区域。默认是 0.3 透明度的黑色背景('#000')。如果你想定义别的颜色,可以 shade: [0.8, '#393D49'];如果你不想显示遮罩,可以 shade: 0

08.是否点击遮罩关闭 shadeClose

类型:Boolean,默认:false

如果你的 shade 是存在的,那么你可以设定 shadeClose 来控制点击弹层外区域关闭。

09.自动关闭所需毫秒 time

类型:Number,默认:0

默认不会自动关闭。当你想自动关闭时,可以 time: 5000,即代表 5 秒后自动关闭,注意单位是毫秒(1 秒=1000 毫秒)

10.弹出动画 anim

类型:Number,默认:0

我们的出场动画全部采用 CSS3。这意味着除了 ie6-9,其它所有浏览器都是支持的。目前 anim 可支持的动画类型有 0-6 如果不想显示动画,设置 anim: -1 即可

备注
anim: 0平滑放大。默认
anim: 1从上掉落
anim: 2从最底部往上滑入
anim: 3从左滑入
anim: 4从左翻滚
anim: 5渐显
anim: 6抖动

11.关闭动画 isOutAnim

类型:Boolean,默认:true

默认情况下,关闭层时会有一个过度动画。如果你不想开启,设置 isOutAnim: false 即可

12.最大最小化 maxmin

类型:Boolean,默认:false

该参数值对 type:1 和 type:2 有效。默认不显示最大小化按钮。需要显示配置 maxmin: true 即可

13.固定 fixed

类型:Boolean,默认:true

即鼠标滚动时,层是否固定在可视区域。如果不想,设置 fixed: false 即可

14.是否允许拉伸 resize

类型:Boolean,默认:true

默认情况下,你可以在弹层右下角拖动来拉伸尺寸。如果对指定的弹层屏蔽该功能,设置 false 即可。

15.浏览器出现滚动条 scrollbar

类型:Boolean,默认:true

默认允许浏览器滚动,如果设定 scrollbar: false,则屏蔽

16.触发拖动的元素 move

类型:Boolean,默认:'true'

默认允许拖拽,move: false 来禁止拖拽

17.是否允许拖拽到窗口外 moveOut

类型:Boolean,默认:false

默认只能在窗口内拖拽,如果你想让拖到窗外,那么设定 moveOut: true 即可

18.iframe 嵌入

只需要设置 type="2",content="网址"

事件

01.监听窗口拉伸动作 resizing

类型:Function,默认:null

当你拖拽弹层右下角对窗体进行尺寸调整时,如果你设定了该回调,则会执行。回调返回一个参数:当前层的 $(DOM) 对象

02.拖动完毕后的回调方法 moveEnd

类型:Function,默认:null

默认不会触发 moveEnd,如果你需要,设定 moveEnd: function(layero){}即可。其中 layero 为当前层的 $(DOM) 对象

03.层弹出后的成功回调方法 success

类型:Function,默认:null

当你需要在层创建完毕时即执行一些语句,可以通过该回调。success 会携带两个参数,分别是当前层$(DOM)和当前层索引 index

04.确定按钮回调方法 yes

类型:Function,默认:null

该回调携带两个参数,分别为当前层索引 index、当前层 $(DOM) 对象 ,注意:如果设定了 yes 回调,需进行手工关闭

05.右上角关闭按钮触发 cancel

类型:Function,默认:null

该回调携带两个参数,分别为:当前层索引参数(index)、当前层的 DOM 对象(layero),默认会自动触发关闭。如果不想关闭,return false 即可

06.层销毁后触发的回调 end

类型:Function,默认:null

无论是确认还是取消,只要层被销毁了,end 都会执行,不携带任何参数。

07.最大化、最小化、还原 full/min/restore

类型:Function,默认:null

携带两个参数,即当前层 DOM、当前层索引

方法

文档待完善....

  • layer.open
  • layer.alert
  • layer.confirm
  • layer.msg
  • layer.load
  • layer.tips
  • layer.close
  • layer.closeAll
  • layer.style
  • layer.title
  • layer.getChildFrame
  • layer.getFrameIndex
  • layer.iframeAuto
  • layer.iframeSrc
  • layer.full()、layer.min()、layer.restore()
  • layer.prompt
  • layer.tab
  • layer.photos
Last Updated: 12/2/2021, 8:12:02 PM
Contributors: liaojinping