弹层组件文档 - layui.layer

弹层组件文档 - layui.layer

layer.config(options) - 初始化全局配置

这是一个可以重要也可以不重要的方法,重要的是,它的权利真的很大,尤其是在模块化加载layer时,你会发现你必须要用到它。它不仅可以配置一些诸如路径、加载的模块,甚至还可以决定整个弹层的默认参数。而说它不重要,是因为多数情况下,你会发现,你似乎不是那么十分需要它。但你真的需要认识一下这位伙计。

如果您是采用seajs或者requirejs加载layer,你需要执行该方法来完成初始化的配置。比如:

layer.config({

path: '/res/layer/' //layer.js所在的目录,可以是绝对目录,也可以是相对目录

});

//这样的话,layer就会去加载一些它所需要的配件,比如 css 等。

//当然,你即便不用seajs或者requirejs,也可以通过上述方式设定路径

如果你是采用合并的方式引入 layer,那么您需要在 script 标签上加一个自定义属性 merge="true"。如:

提示 1:上述只针对独立版 layer,其 LAYUI_GLOBAL 设定的 layer_dir 优先级高于 layer.config 设定的 path;

提示 2:如果是 layui 加载的 layer,可以无视上述所有的目录设定。前置工作都会在 layui 内部完成。

另外,layer.config 还可以配置层 默认的基础参数,如:

layer.config({

anim: 1, //默认动画风格

skin: 'layui-layer-molv' //默认皮肤

//…

});

//除此之外,extend 还允许你加载拓展的 css 皮肤,如:

layer.config({

//如果是独立版的layer,则将 myskin 存放在 ./skin 目录下

//如果是layui中使用layer,则将 myskin 存放在 ./css/modules/layer 目录下

extend: 'myskin/style.css'

});

//具体的皮肤定制,可以参见:skin参数说明

layer.ready(callback) - 初始化就绪

由于我们的layer内置了轻量级加载器,所以你根本不需要单独引入css等文件。但是加载总是需要过程的。当你在页面一打开就要执行弹层时,你最好是将弹层放入ready方法中,如:

//页面一打开就执行弹层

layer.ready(function(){

layer.msg('很高兴一开场就见到你');

});

我是华丽的酱油:介绍完上面两位引导者,接下来我们真正的主角闪亮登场了。此处应有掌声 ^,^

layer.open(options) - 原始核心方法

基本上是露脸率最高的方法,不管是使用哪种方式创建层,都是走layer.open(),创建任何类型的弹层都会返回一个当前层索引,上述的options即是基础参数,另外,该文档统一采用options作为基础参数的标识例子:

var index = layer.open({

content: 'test'

});

//拿到的index是一个重要的凭据,它是诸如layer.close(index)等方法的必传参数。

噢,请等等,上面这位主角的介绍篇幅怎么看怎么都觉得跟它的地位不符,作者在文档中只给了它如此可怜的一块地??这是因为,它真的已经大众得不能再大众了,你真正需要了解的,是它的内部器官,即上面一大篇幅介绍的各种基础参数。 ←_←

layer.alert(content, options, yes) - 普通信息框

它的弹出似乎显得有些高调,一般用于对用户造成比较强烈的关注,类似系统alert,但却比alert更灵便。它的参数是自动向左补齐的。通过第二个参数,可以设定各种你所需要的基础参数,但如果你不需要的话,直接写回调即可。如

//eg1

layer.alert('只想简单的提示');

//eg2

layer.alert('加了个图标', {icon: 1}); //这时如果你也还想执行yes回调,可以放在第三个参数中。

//eg3

layer.alert('有了回调', function(index){

//do something

layer.close(index);

});

layer.confirm(content, options, yes, cancel) - 询问框

类似系统confirm,但却远胜confirm,另外它不是和系统的confirm一样阻塞你需要把交互的语句放在回调体中。同样的,它的参数也是自动补齐的。

//eg1

layer.confirm('is not?', {icon: 3, title:'提示'}, function(index){

//do something

layer.close(index);

});

//eg2

layer.confirm('is not?', function(index){

//do something

layer.close(index);

});

layer.msg(content, options, end) - 提示框

我们在源码中用了相对较大的篇幅来定制了这个msg,目的是想将其打造成露脸率最高的提示框。而事实上我的确也在大量地使用它。因为它简单,而且足够得自觉,它不仅占据很少的面积,而且默认还会3秒后自动消失所有这一切都决定了我对msg的爱。因此我赋予了它许多可能在外形方面,它坚持简陋的变化,在作用方面,它坚持零用户操作。而且它的参数也是自动补齐的。

//eg1

layer.msg('只想弱弱提示');

//eg2

layer.msg('有表情地提示', {icon: 6});

//eg3

layer.msg('关闭后想做些什么', function(){

//do something

});

//eg

layer.msg('同上', {

icon: 1,

time: 2000 //2秒关闭(如果不配置,默认是3秒)

}, function(){

//do something

});

layer.load(icon, options) - 加载层

type:3的深度定制。load并不需要你传太多的参数,但如果你不喜欢默认的加载风格,你还有选择空间。icon支持传入0-2如果是0,无需传。另外特别注意一点:load默认是不会自动关闭的,因为你一般会在ajax回调体中关闭它。

//eg1

var index = layer.load();

//eg2

var index = layer.load(1); //换了种风格

//eg3

var index = layer.load(2, {time: 10*1000}); //又换了种风格,并且设定最长等待10秒

//关闭

layer.close(index);

layer.tips(content, follow, options) - tips层

type:4的深度定制。也是我本人比较喜欢的一个层类型,因为它拥有和msg一样的低调和自觉,而且会智能定位,即灵活地判断它应该出现在哪边。默认是在元素右边弹出

//eg1

layer.tips('只想提示地精准些', '#id');

//eg 2

$('#id').on('click', function(){

var that = this;

layer.tips('只想提示地精准些', that); //在元素的事件回调体中,follow直接赋予this即可

});

//eg 3

layer.tips('在上面', '#id', {

tips: 1

});

上面主要是一些弹层的调用方式,而下面介绍的是一些辅助性的方法

layer.close(index) - 关闭指定层

关于它似乎没有太多介绍的必要,唯一让你疑惑的,可能就是这个index了吧。事实上它非常容易得到。

//当你想关闭当前页的某个层时

var index = layer.open();

var index = layer.alert();

var index = layer.load();

var index = layer.tips();

//正如你看到的,每一种弹层调用方式,都会返回一个index

layer.close(index); //此时你只需要把获得的index,轻轻地赋予layer.close即可

//如果你想关闭最新弹出的层,直接获取layer.index即可

layer.close(layer.index); //它获取的始终是最新弹出的某个层,值是由layer内部动态递增计算的

//当你在iframe页面关闭自身时

var index = parent.layer.getFrameIndex(window.name); //先得到当前iframe层的索引

parent.layer.close(index); //再执行关闭

//关闭后的回调(layui 2.6.5、layer 3.4.0 新增)

layer.close(index, function(){

//do something

});

layer.closeAll(type) - 关闭所有层

如果你很懒,你不想去获取index你只想关闭。那么closeAll真的可以帮上你。如果你不指向层类型的话,它会销毁掉当前页所有的layer层。当然,如果你只想关闭某个类型的层,那么你可以

layer.closeAll(); //疯狂模式,关闭所有层

layer.closeAll('dialog'); //关闭信息框

layer.closeAll('page'); //关闭所有页面层

layer.closeAll('iframe'); //关闭所有的iframe层

layer.closeAll('loading'); //关闭加载层

layer.closeAll('tips'); //关闭所有的tips层

//关闭后的回调(layui 2.6.5、layer 3.4.0 新增)

layer.closeAll('loading', function(){ //关闭 loading 并执行回调

//do something

});

layer.closeAll(function(){ //关闭所有层并执行回调

//do something

});

layer.style(index, cssStyle) - 重新定义层的样式

该方法对loading层和tips层无效。参数index为层的索引,cssStyle允许你传入任意的css属性

//重新给指定层设定width、top等

layer.style(index, {

width: '1000px',

top: '10px'

});

layer.title(title, index) - 改变层的标题

使用方式:layer.title('标题变了', index)

layer.getChildFrame(selector, index) - 获取iframe页的DOM

当你试图在当前页获取iframe页的DOM元素时,你可以用此方法。selector即iframe页的选择器

layer.open({

type: 2,

content: 'test/iframe.html',

success: function(layero, index){

var body = layer.getChildFrame('body', index);

var iframeWin = window[layero.find('iframe')[0]['name']]; //得到iframe页的窗口对象,执行iframe页的方法:iframeWin.method();

console.log(body.html()) //得到iframe页的body内容

body.find('input').val('Hi,我是从父页来的')

}

});

layer.getFrameIndex(windowName) - 获取特定iframe层的索引

此方法一般用于在iframe页关闭自身时用到。

//假设这是iframe页

var index = parent.layer.getFrameIndex(window.name); //先得到当前iframe层的索引

parent.layer.close(index); //再执行关闭

layer.iframeAuto(index) - 指定iframe层自适应

调用该方法时,iframe层的高度会重新进行适应

layer.iframeSrc(index, url) - //重置特定iframe url

似乎不怎么常用的样子。使用方式:layer.iframeSrc(index, 'http://sentsin.com')

layer.setTop(layero) -置顶当前窗口

非常强大的一个方法,虽然一般很少用。但是当你的页面有很多很多layer窗口,你需要像Window窗体那样,点击某个窗口,该窗体就置顶在上面,那么setTop可以来轻松实现。它采用巧妙的逻辑,以使这种置顶的性能达到最优

//通过这种方式弹出的层,每当它被选择,就会置顶。

layer.open({

type: 2,

shade: false,

area: '500px',

maxmin: true,

content: '/2.7',

zIndex: layer.zIndex, //重点1

success: function(layero){

layer.setTop(layero); //重点2

}

});

layer.full()、layer.min()、layer.restore() - 手工执行最大小化

一般用于在自定义元素上触发最大化、最小化和全屏。

layer.full(index); //执行最大化

layer.min(index); //执行最小化

layer.restore(index); //执行还原

相关推荐