layer弹出框

http://www.cnblogs.com/jiangxiaobo/p/5276482.html

学习网址: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提供了两种风格的关闭按钮,可通过配置12来展示,如果不显示,则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:1type: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,也可以通过上述方式设定路径    

如果你是采用

你可能感兴趣的:(layer,工具类)