layer,一个可让你想到便可作到的javascript弹窗（层）解决方案

学习网址：http://layer.layui.com/

下载地址：http://res.layui.com/download/layer-v2.1.zip

咱们提到的基础参数主要指调用方法时用到的配置项，如：

　　layer.open({content: ''})，

　　layer.msg('', {time: 3})，

　　其中的content和time便是基础参数，以键值形式存在，基础参数可合理应用于任何层类型中，您不须要全部都去配置，大多数都是可选的。而其中的

　　layer.open、

　　layer.msg、

　　就是内置方法。但咱们一般还会在别的js文件中扩展一些层，

　　好比layer.prompt()便是咱们的扩展方法，扩展的js文件默认不会加载，一般需进行layer.config({extend: 'extend/layer.ext.js'})后才可以使用，而关于其中的extend下面也有讲解。

 

基础参数

type - 基本层类型

类型：Number，默认：0

layer提供了5种层类型。可传入的值有：0（信息框，默认）1（页面层）2（iframe层）3（加载层）4（tips层）。 若你采用layer.open({type: 1})方式调用，则type为必填项（信息框除外）

 

title - 标题

类型：String/Array/Boolean，默认：'信息'

title支持三种类型的值，若你传入的是普通的字符串，如title :'我是标题'，那么只会改变标题文本；若你还须要自定义标题区域样式，那么你能够title: ['文本', 'font-size:18px;']，数组第二项能够写任意css样式；若是你不想显示标题栏，你能够title: false

 

content - 内容

类型：String/DOM/Array，默认：''

content可传入的值是灵活多变的，不只能够传入普通的html内容，还能够指定DOM，更能够随着type的不一样而不一样。譬如：

 1 /!*
 2  若是是页面层
 3  */
 4 layer.open({
 5     type: 1, 
 6     content: '传入任意的文本或html' //这里content是一个普通的String
 7 });
 8 layer.open({
 9     type: 1,
10     content: $('#id') //这里content是一个DOM
11 });
12 //Ajax获取
13 $.post('url', {}, function(str){
14     layer.open({
15         type: 1,
16         content: str //注意，若是str是object，那么须要字符拼接。
17     });
18 });
19 
20 /!*
21  若是是iframe层
22  */
23 layer.open({
24     type: 2, 
25     content: 'http://sentsin.com' //这里content是一个URL，若是你不想让iframe出现滚动条，你还能够content: ['http://sentsin.com', 'no']
26 }); 
27 
28 /!*
29  若是是用layer.open执行tips层
30  */
31 layer.open({
32     type: 4,
33     content: ['内容', '#id'] //数组第二项即吸附元素选择器或者DOM
34 }); 

skin - 样式类名

类型：String，默认：''

skin不只容许你传入layer内置的样式class名，还能够传入您自定义的class名。这是一个很好的切入点，意味着你能够借助skin轻松完成不一样的风格定制。目前layer内置的skin有：layui-layer-lanlayui-layer-molv，将来咱们还会选择性地内置更多，但更推荐您本身来定义。如下是一个自定义风格的简单例子

 1 //单个使用
 2 layer.open({
 3     skin: 'demo-class'
 4 });
 5 
 6 //全局使用。即全部弹出层都默认采用，可是单个配置skin的优先级更高
 7 layer.config({
 8     skin: 'demo-class'
 9 })
10 
11 //CSS 
12 body .demo-class .layui-layer-title{background:#c00; color:#fff; border: none;}
13 body .demo-class .layui-layer-btn{border-top:1px solid #E9E7E7}
14 body .demo-class .layui-layer-btn a{background:#333;}
15 body .demo-class .layui-layer-btn .layui-layer-btn1{background:#999;}
16 …
17 加上body是为了保证优先级。你能够借助Chrome调试工具，定义更多样式控制层更多的区域。   

 

area - 宽高

类型：String/Array，默认：'auto'

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

 

offset - 坐标

类型：String/Array，默认：'auto'

默认垂直水平居中。但当你只想定义top时，你能够offset: '100px'。当您top、left都要定义时，你能够offset: ['100px', '200px']。除此以外，你还能够定义offset: 'rb'，表示右下角。其它的特殊坐标，你能够本身计算赋值。

 

icon - 图标。信息框和加载层的私有参数

类型：Number，默认：-1（信息框）/0（加载层）

信息框默认不显示图标。当你想显示图标时，默认皮肤能够传入0-6若是是加载层，能够传入0-2。如：

1 //eg1
2 layer.alert('酷毙了', {icon: 1});
3 
4 //eg2
5 layer.msg('不开心。。', {icon: 5});
6 
7 //eg3
8 layer.load(1); //风格1的加载

 

btn - 按钮

类型：String/Array，默认：'确认'

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

 1 //eg1           
 2 layer.confirm('纳尼？', {
 3     btn: ['按钮一', '按钮二', '按钮三'] //能够无限个按钮
 4     ,btn3: function(index, layero){
 5         //按钮【按钮三】的回调
 6     }
 7 }, function(index, layero){
 8     //按钮【按钮一】的回调
 9 }, function(index){
10     //按钮【按钮二】的回调
11 });
12 
13 //eg2
14 layer.open({
15     content: 'test'
16     ,btn: ['按钮一', '按钮二', '按钮三']
17     ,yes: function(index, layero){ //或者使用btn1
18         //按钮【按钮一】的回调
19     },cancel: function(index){ //或者使用btn2
20         //按钮【按钮二】的回调
21     },btn3: function(index, layero){
22         //按钮【按钮三】的回调
23     }
24 });

 

closeBtn - 关闭按钮

类型：String/Boolean，默认：1

layer提供了两种风格的关闭按钮，可经过配置1和2来展现，若是不显示，则closeBtn: 0

 

shade - 遮罩

类型：String/Array/Boolean，默认：0.3

即弹层外区域。默认是0.3透明度的黑色背景（'#000'）。若是你想定义别的颜色，能够shade: [0.8, '#393D49']；若是你不想显示遮罩，能够shade: 0

 

shadeClose - 是否点击遮罩关闭

类型：Boolean，默认：false

若是你的shade是存在的，那么你能够设定shadeClose来控制点击弹层外区域关闭。

 

time - 自动关闭所需毫秒

类型：Number，默认：0

默认不会自动关闭。当你想自动关闭时，能够time: 5000，即表明5秒后自动关闭，注意单位是毫秒（1秒=1000毫秒）

 

shift - 动画

类型：Number，默认：0

从1.9开始，咱们的出场动画所有采用CSS3。这意味着除了ie6-9，其它全部浏览器都是支持的。目前shift可支持的动画类型有0-6

 

maxmin - 最大最小化。

类型：Boolean，默认：false

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

 

fix - 固定

类型：Boolean，默认：true

即鼠标滚动时，层是否固定在可视区域。若是不想，设置fix: false便可

 

scrollbar - 是否容许浏览器出现滚动条

类型：Boolean，默认：true

默认容许浏览器滚动，若是设定scrollbar: false，则屏蔽

 

maxWidth - 最大宽度

类型：，默认：360

当area: 'auto'时，maxWidth的设定才有效。

 

zIndex - 层叠顺序

类型：，默认：19891014

通常用于解决和其它组件的层叠冲突。

 

move - 触发拖动的元素

类型：String/DOM/Boolean，默认：'.layui-layer-title'

默认是触发标题区域拖拽。若是你想单独定义，指向元素的选择器或者DOM便可。如move: '.mine-move'。你还配置设定move: false来禁止拖拽

 

moveType - 拖拽风格

类型：Number，默认：0

默认的拖拽风格正如你所见到的，会有个过分的透明框。可是若是你不喜欢，你能够设定moveType: 1切换到传统的拖拽模式

 

moveOut - 是否容许拖拽到窗口外

类型：Boolean，默认：false

默认只能在窗口内拖拽，若是你想让拖到窗外，那么设定moveOut: true便可

 

moveEnd - 拖动完毕后的回调方法

类型：Function，默认：null

默认不会触发moveEnd，若是你须要，设定moveEnd: function(){}便可。

 

tips - tips方向和颜色

类型：Number/Array，默认：2

tips层的私有参数。支持上右下左四个方向，经过1-4进行方向设定。如tips: 3则表示在元素的下面出现。有时你还可能会定义一些颜色，能够设定tips: [1, '#c00']

 

tipsMore - 是否容许多个tips

类型：Boolean，默认：false

容许多个意味着不会销毁以前的tips层。经过tipsMore: true开启

 

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

类型：Function，默认：null

当你须要在层建立完毕时即执行一些语句，能够经过该回调。success会携带两个参数，分别是当前层DOM当前层索引。如：

1 layer.open({
2     content: '测试回调',
3     success: function(layero, index){
4         console.log(layero, index);
5     }
6 });      

 

yes - 肯定按钮回调方法

类型：Function，默认：null

该回调携带两个参数，分别为当前层索引、当前层DOM对象。如：

1 layer.open({
2     content: '测试回调',
3     yes: function(index, layero){
4         //do something
5         layer.close(index); //若是设定了yes回调，需进行手工关闭
6     }
7 });     

 

cancel - 取消和关闭按钮触发的回调

类型：Function，默认：null

该回调一样只携带当前层索引一个参数，无需进行手工关闭。若是不想关闭，return false便可，如 cancel: function(index){ return false; } 则不会关闭；

 

end - 层销毁后触发的回调

类型：Function，默认：null

不管是确认仍是取消，只要层被销毁了，end都会执行，不携带任何参数。

 

full/min/restore -分别表明最大化、最小化、还原 后触发的回调

类型：Function，默认：null

携带一个参数，即当前层DOM

 

内置方法

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

这是一个能够重要也能够不重要的方法，重要的是，它的权利真的很大，尤为是在模块化加载layer时，你会发现你必需要用到它。它不只能够配置一些诸如路径、加载的模块，甚至还能够决定整个弹层的默认参数。而说它不重要，是由于多数状况下，你会发现，你彷佛不是那么十分须要它。但你真的须要认识一下这位伙计。

若是您是采用seajs或者requirejs加载layer，你须要执行该方法来完成初始化的配置。好比：

1 layer.config({
2     path: '/res/layer/' //layer.js所在的目录，能够是绝对目录，也能够是相对目录
3 });
4 //这样的话，layer就会去加载一些它所须要的配件，好比css等。  
5 //固然，你即使不用seajs或者requirejs，也能够经过上述方式设定路径    

若是你是采用<script src="?a.js&layer.js">这种合并的方式引入layer，那么您须要在script标签上加一个自定义属性merge="true"。如：

1 <script src="?a.js&layer.js" merge="true">
2 
3 这样的话，layer就不会去自动去获取路径，但你须要经过如下方式来完成初始化的配置
4 layer.config({
5     path: '/res/layer/' //layer.js所在的目录，能够是绝对目录，也能够是相对目录
6 });

但layer.config的做用远不止上述这样。它还能够配置layer的拓展模块，以及默认的基础参数，如：

 1 layer.config({
 2     extend: 'extend/layer.ext.js', //注意，目录是相对layer.js根目录。若是加载多个，则 [a.js, b.js, …]
 3     shift: 1, //默认动画风格
 4     skin: 'layui-layer-molv' //默认皮肤
 5     …
 6 });
 7 
 8 //除此以外，extend还容许你加载css。这对于layer的第三方皮肤有极大的帮助，如：
 9 layer.config({
10     extend: [
11         'extend/layer.ext.js',
12         'skin/layer-ext-myskin/style.css' //layer-ext-myskin便是你拓展的皮肤文件
13     ]
14 });
15 
16 //扩展css的规范：您必须在你扩展中的css文件加上这段
17 html #layui_layer_skinlayer-ext-myskinstylecss{display:none; position: absolute; width:1989px;}
18 规则就是：html #layui_layer_skin{文件夹名}{文件名}css
19 skin名以文件夹名为标准。

 

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

因为咱们的layer内置了轻量级加载器，因此你根本不须要单独引入css等文件。可是加载老是须要过程的。当你在页面一打开就要执行弹层时，layer.ready()会是一个不错的帮手。它也能够作一些layer.config能够作的事，好比指向layer.js所在目录。可是若是你已经经过layer.config配置了path，你在使用layer.ready时，是不须要path的，如：

1 //页面一打开就执行弹层
2 layer.ready(function(){
3     layer.msg('很高兴一开场就见到你');
4 });  

 

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

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

1 var index = layer.open({
2     content: 'test'
3 });
4 //拿到的index是一个重要的凭据，它是诸如layer.close(index)等方法的必传参数。 

 

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

它的弹出彷佛显得有些高调，通常用于对用户形成比较强烈的关注，相似系统alert，但却比alert更灵便。它的参数是自动向左补齐的。经过第二个参数，能够设定各类你所须要的基础参数，但若是你不须要的话，直接写回调便可。如

 1 //eg1
 2 layer.alert('只想简单的提示');                
 3 //eg2
 4 layer.alert('加了个图标', {icon: 1}); //这时若是你也还想执行yes回调，能够放在第三个参数中。
 5 //eg3
 6 layer.alert('有了回调', function(index){
 7     //do something
 8     
 9     layer.close(index);
10 });     

 

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

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

 1 //eg1
 2 layer.confirm('is not?', {icon: 3, title:'提示'}, function(index){
 3     //do something
 4     
 5     layer.close(index);
 6 });
 7 //eg2
 8 layer.confirm('is not?', function(index){
 9     //do something
10     
11     layer.close(index);
12 });    

 

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

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

 1 //eg1
 2 layer.msg('只想弱弱提示');
 3 //eg2
 4 layer.msg('有表情地提示', {icon: 6}); 
 5 //eg3
 6 layer.msg('关闭后想作些什么', function(){
 7     //do something
 8 }); 
 9 //eg
10 layer.msg('同上', {
11     icon: 1,
12     time: 2000 //2秒关闭（若是不配置，默认是3秒）
13 }, function(){
14     //do something
15 });   

 

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

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

1 //eg1
2 var index = layer.load();
3 //eg2
4 var index = layer.load(1); //换了种风格
5 //eg3
6 var index = layer.load(2, {time: 10*1000}); //又换了种风格，而且设定最长等待10秒 
7 
8 //关闭
9 layer.close(index);  

 

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

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

 1 //eg1
 2 layer.tips('只想提示地精准些', '#id');
 3 //eg 2
 4 $('#id').on('click', function(){
 5     var that = this;
 6     layer.tips('只想提示地精准些', that); //在元素的事件回调体中，follow直接赋予this便可
 7 });
 8 //eg 3
 9 layer.tips('在上面', '#id', {
10     tips: 1
11 });

 

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

关于它彷佛没有太多介绍的必要，惟一让你疑惑的，可能就是这个index了吧

事实上它很是容易获得。

 1 //当你想关闭当前页的某个层时
 2 var index = layer.open();
 3 var index = layer.alert();
 4 var index = layer.load();
 5 var index = layer.tips();
 6 //正如你看到的，每一种弹层调用方式，都会返回一个index
 7 layer.close(index); //此时你只须要把得到的index，轻轻地赋予layer.close便可
 8 
 9 //当你在iframe页面关闭自身时
10 var index = parent.layer.getFrameIndex(window.name); //先获得当前iframe层的索引
11 parent.layer.close(index); //再执行关闭     

 

layer.closeAll(type) - 关闭全部层

若是你很懒，你不想去获取index你只想关闭。那么closeAll真的能够帮上你。若是你不指向层类型的话，它会销毁掉当前页全部的layer层。固然，若是你只想关闭某个类型的层，那么你能够

1 layer.closeAll(); //疯狂模式，关闭全部层
2 layer.closeAll('dialog'); //关闭信息框
3 layer.closeAll('page'); //关闭全部页面层
4 layer.closeAll('iframe'); //关闭全部的iframe层
5 layer.closeAll('loading'); //关闭加载层
6 layer.closeAll('tips'); //关闭全部的tips层     

 

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

cssStyle容许你传入任意的css属性

1 //从新给指定层设定width、top等
2 layer.style(index, {
3     width: '1000px',
4     top: '10px'
5 });     

 

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

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

 

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

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

 1 layer.open({
 2     type: 2,
 3     content: 'test/iframe.html',
 4     success: function(layero, index){
 5         var body = layer.getChildFrame('body', index);
 6         var iframeWin = window[layero.find('iframe')[0]['name']]; //获得iframe页的窗口对象，执行iframe页的方法：iframeWin.method();
 7         console.log(body.html()) //获得iframe页的body内容
 8         body.find('input').val('Hi，我是从父页来的')
 9     }
10 });   

 

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

此方法通常用于在iframe页关闭自身时用到。

1 //假设这是iframe页
2 var index = parent.layer.getFrameIndex(window.name); //先获得当前iframe层的索引
3 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能够来轻松实现。它采用巧妙的逻辑，以使这种置顶的性能达到最优

 1 //经过这种方式弹出的层，每当它被选择，就会置顶。
 2 layer.open({
 3     type: 2,
 4     shade: false,
 5     area: '500px',
 6     maxmin: true,
 7     content: 'http://www.layui.com',
 8     zIndex: layer.zIndex, //重点1
 9     success: function(layero){
10         layer.setTop(layero); //重点2
11     }
12 });    

 

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

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

 

扩展方法

请注意，扩展方法依赖于layer.ext.js，默认不会加载，必须进行如下配置才可以使用：

1 layer.config({
2     extend: 'extend/layer.ext.js'
3 });   

 

layer.prompt(options, yes) - 输入层

prompt的参数也是向前补齐的。options不只可支持传入基础参数，还能够传入prompt专用的属性。固然，也能够不传。yes携带value 表单值index 索引elem 表单元素

 1 //prompt层新定制的成员以下
 2 {
 3     formType: 1, //输入框类型，支持0（文本）默认1（密码）2（多行文本）
 4     value: '', //初始时的值，默认空字符
 5     maxlength: 140, //可输入文本的最大长度，默认500
 6 }
 7 
 8 //例子1
 9 layer.prompt(function(value, index, elem){
10     alert(value); //获得value
11     layer.close(index);
12 });
13 //例子2
14 layer.prompt({
15     formType: 2,
16     value: '初始值',
17     title: '请输入值'
18 }, function(value, index, elem){
19     alert(value); //获得value
20     layer.close(index);
21 });

 

layer.tab(options) - tab层

tab层只单独定制了一个成员，即tab: []，这个好像没有什么可介绍的，简单粗暴看例子

 1 layer.tab({
 2     area: ['600px', '300px'],
 3     tab: [{
 4         title: 'TAB1', 
 5         content: '内容1'
 6     }, {
 7         title: 'TAB2', 
 8         content: '内容2'
 9     }, {
10         title: 'TAB3', 
11         content: '内容3'
12     }]
13 });            

 

layer.photos(options) - 相册层

相册层，也能够称之为图片查看器。它的出场动画从layer内置的动画类型中随机展示。photos支持传入json和直接读取页面图片两种方式。若是是json传入，以下：

$.getJSON('/jquery/layer/test/photos.json', function(json){
    layer.photos({
        photos: json
    });
});

//而返回的json需严格按照以下格式：

{
    "title": "", //相册标题
    "id": 123, //相册id
    "start": 0, //初始显示的图片序号，默认0
    "data": [   //相册包含的图片，数组格式
        {
            "alt": "图片名",
            "pid": 666, //图片id
            "src": "", //原图地址
            "thumb": "" //缩略图地址
        }
    ]
}

 

若是是直接从页面中获取图片，那么须要指向图片的父容器，而且你的img能够设定一些规定的属性（但不是必须的）。

 1 //HTML示例
 2 <div id="layer-photos-demo" class="layer-photos-demo">
 3     <img layer-pid="图片id，能够不写" layer-src="大图地址" src="缩略图" alt="图片名">
 4     <img layer-pid="图片id，能够不写" layer-src="大图地址" src="缩略图" alt="图片名">
 5 </div>
 6 
 7 //调用示例
 8 layer.ready(function(){ //为了layer.ext.js加载完毕再执行
 9     layer.photos({
10         photos: '#layer-photos-demo'
11     });
12 });     

 

第二种方式的图片查看器显然更加简单，由于无需像第一种那样返回规定的json，可是他们仍是有各自的应用场景的，你能够按照你的需求进行选择。另外，photos还有个tab回调，切换图片时触发。

1 layer.photos({
2     photos: json/选择器,
3     tab: function(pic, layero){
4         console.log(pic) //当前图片的一些信息
5     }
6 });

 

合理地设定基础参数，合理地选择内置方法，合理地运用拓展方法，合理的心态，合理地阅读，只要一切都在合理的前提下，你才会感知到layer许许多多使人愉悦的地方，她真的是否如你所愿，取决于你对她了解的深远。愿layer能给你的web开发带来一段美妙的旅程。相信这一版的API文档，也会给你带来全新的便捷。