layui.layer独⽴组件--解释
layer⾄今仍作为layui的代表作,她的受众⼴泛并⾮偶然,⽽是这五年多的坚持,不断完善和维护、不断建设和提升社区服务,使得猿们纷纷⾃发传播,乃⾄于成为今天的Layui最强劲的源动⼒。⽬前,layer已成为国内最多⼈使⽤的web弹层组件,⾃然Stars3000+,官⽹累计下载量达30w+,⼤概有20万Web平台正在使⽤layer。
使⽤场景:
由于layer可以独⽴使⽤,也可以通过Layui模块化使⽤。所以请按照你的实际需求来选择
1、作为独⽴组件使⽤layer
引⼊好layer.js后,直接⽤即可
<script src="layer.js"></script>
<script>
layer.msg('hello');
</script>
2、在layui中使⽤layer
layui.use('layer', function(){
var layer = layui.layer;
layer.msg('hello');
});
除了上⾯有所不同,其它都完全⼀致。
基础参数:
我们提到的基础参数主要指调⽤⽅法时⽤到的配置项,如:layer.open({content: ''})layer.msg('', {time: 3})等,其中的content和time即是基础参数,以键值形式存在,基础参数可合理应⽤于任何层类型中,您不需要所有都去配置,⼤多数都是可选的。⽽其中的layer.open、layer.msg就是内置⽅法。注意,从2.3开始,⽆需通过fig来加载拓展模块
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的不同⽽不同。譬如:
/!*
如果是页⾯层
*/
layer.open({
type: 1,
content: '传⼊任意的⽂本或html' //这⾥content是⼀个普通的String
});
layer.open({
type: 1,
content: $('#id') //这⾥content是⼀个DOM,注意:最好该元素要存放在body最外层,否则可能被其它的相对元素所影响
});
//Ajax获取
$.post('url', {}, function(str){
layer.open({
js控制css3动画触发type: 1,
content: str //注意,如果str是object,那么需要字符拼接。
});
});
如果是iframe层
*/
layer.open({
type: 2,
content: 'sentsin' //这⾥content是⼀个URL,如果你不想让iframe出现滚动条,你还可以content: ['sentsin', 'no']
});
/!*
如果是⽤layer.open执⾏tips层
*/
layer.open({
type: 4,
content: ['内容', '#id'] //数组第⼆项即吸附元素选择器或者DOM
});
skin - 样式类名
类型:String,默认:''
skin不仅允许你传⼊layer内置的样式class名,还可以传⼊您⾃定义的class名。这是⼀个很好的切⼊点,意味着你可以借助skin轻松完成不同的风格定制。⽬前layer内置的skin有:layui-layer-lanlayui-layer-molv,未来我们还会选择性地内置更多,但更推荐您⾃⼰来定义。以下是⼀个⾃定义风格的简单例⼦
//单个使⽤
layer.open({
skin: 'demo-class'
});
//全局使⽤。即所有弹出层都默认采⽤,但是单个配置skin的优先级更⾼
skin: 'demo-class'
})
/
/CSS
body .demo-class .layui-layer-title{background:#c00; color:#fff; border: none;}
body .demo-class .layui-layer-btn{border-top:1px solid #E9E7E7}
body .demo-class .layui-layer-btn a{background:#333;}
body .demo-class .layui-layer-btn .layui-layer-btn1{background:#999;}
…
加上body是为了保证优先级。你可以借助Chrome调试⼯具,定义更多样式控制层更多的区域。
area - 宽⾼
类型:String/Array,默认:'auto'
在默认状态下,layer是宽⾼都⾃适应的,但当你只想定义宽度时,你可以area: '500px',⾼度仍然是⾃适应的。当你宽⾼都要定义时,你可以area: ['500px', '300px']
offset - 坐标
类型:String/Array,默认:垂直⽔平居中
offset默认情况下不⽤设置。但如果你不想垂直⽔平居中,你还可以进⾏以下赋值:
icon - 图标。信息框和加载层的私有参数
类型:Number,默认:-1(信息框)/0(加载层)
信息框默认不显⽰图标。当你想显⽰图标时,默认⽪肤可以传⼊0-6如果是加载层,可以传⼊0-2。如:
//eg1
layer.alert('酷毙了', {icon: 1});
//eg2
layer.msg('不开⼼。。', {icon: 5});
//eg3
layer.load(1); //风格1的加载
btn - 按钮
类型:String/Array,默认:'确认'
信息框模式时,btn默认是⼀个确认按钮,其它层类型则默认不显⽰,加载层和tips层则⽆效。当您只想⾃定义⼀个按钮时,你可以btn: '我知道了',当你要定义两个按钮时,你可以btn: ['yes', 'no']。当然,你也可以定义更多按钮,⽐如:btn: ['按钮1', '按钮2', '按钮3', …],按钮1的回调是yes,⽽从按钮2开始,则回调为btn2: function(){},以此类推。如:
//eg1
btn: ['按钮⼀', '按钮⼆', '按钮三'] //可以⽆限个按钮
,btn3: function(index, layero){
//按钮【按钮三】的回调
}, function(index, layero){
/
/按钮【按钮⼀】的回调
}, function(index){
//按钮【按钮⼆】的回调
});
//eg2
layer.open({
content: 'test'
,btn: ['按钮⼀', '按钮⼆', '按钮三']
,yes: function(index, layero){
//按钮【按钮⼀】的回调
}
,
btn2: function(index, layero){
//按钮【按钮⼆】的回调
//return false 开启该代码可禁⽌点击该按钮关闭
}
,btn3: function(index, layero){
//按钮【按钮三】的回调
//return false 开启该代码可禁⽌点击该按钮关闭
}
,cancel: function(){
//右上⾓关闭回调
//return false 开启该代码可禁⽌点击该按钮关闭
}
});
btnAlign - 按钮排列
类型:String,默认:r
你可以快捷定义按钮的排列位置,btnAlign的默认值为r,即右对齐。该参数可⽀持的赋值如下:
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毫秒)
id - ⽤于控制弹层唯⼀标识
类型:String,默认:空字符
设置该值后,不管是什么类型的层,都只允许同时弹出⼀个。⼀般⽤于页⾯层和iframe层模式
anim - 弹出动画
类型:Number,默认:0
我们的出场动画全部采⽤CSS3。这意味着除了ie6-9,其它所有浏览器都是⽀持的。⽬前anim可⽀持的动画类型有0-6 如果不想显⽰动画,设置 anim: -1 即可。另外需要注意的是,3.0之前的版本⽤的是 shift 参数
isOutAnim - 关闭动画(layer 3.0.3新增)
类型:Boolean,默认:true
默认情况下,关闭层时会有⼀个过度动画。如果你不想开启,设置 isOutAnim: false 即可
maxmin - 最⼤最⼩化。
该参数值对type:1和type:2有效。默认不显⽰最⼤⼩化按钮。需要显⽰配置maxmin: true即可
fixed - 固定
类型:Boolean,默认:true
即⿏标滚动时,层是否固定在可视区域。如果不想,设置fixed: false即可
resize - 是否允许拉伸
类型:Boolean,默认:true
默认情况下,你可以在弹层右下⾓拖动来拉伸尺⼨。如果对指定的弹层屏蔽该功能,设置 false即可。该参数对loading、tips层⽆效
resizing - 监听窗⼝拉伸动作
类型:Function,默认:null
当你拖拽弹层右下⾓对窗体进⾏尺⼨调整时,如果你设定了该回调,则会执⾏。回调返回⼀个参数:当前层的DOM对象
resizing: function(layero){
console.log(layero);
}
scrollbar - 是否允许浏览器出现滚动条
类型:Boolean,默认:true
默认允许浏览器滚动,如果设定scrollbar: false,则屏蔽
maxWidth - 最⼤宽度
类型:,默认:360
请注意:只有当area: 'auto'时,maxWidth的设定才有效。
zIndex - 层叠顺序
类型:,默认:19891014(贤⼼⽣⽇ 0.0)
⼀般⽤于解决和其它组件的层叠冲突。
move - 触发拖动的元素
类型:String/DOM/Boolean,默认:'.layui-layer-title'
默认是触发标题区域拖拽。如果你想单独定义,指向元素的选择器或者DOM即可。如move: '.mine-move'。你还配置设定move: false来禁⽌拖拽moveOut - 是否允许拖拽到窗⼝外
类型:Boolean,默认:false
默认只能在窗⼝内拖拽,如果你想让拖到窗外,那么设定moveOut: true即可
moveEnd - 拖动完毕后的回调⽅法
类型:Function,默认:null
默认不会触发moveEnd,如果你需要,设定moveEnd: function(layero){}即可。其中layero为当前层的DOM对象
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当前层索引。如:
layer.open({
content: '测试回调',
success: function(layero, index){
console.log(layero, index);
}
});
yes - 确定按钮回调⽅法
类型:Function,默认:null
layer.open({
content: '测试回调',
yes: function(index, layero){
//do something
layer.close(index); //如果设定了yes回调,需进⾏⼿⼯关闭
}
});
cancel - 右上⾓关闭按钮触发的回调
类型:Function,默认:null
该回调携带两个参数,分别为:当前层索引参数(index)、当前层的DOM对象(layero),默认会⾃动触发关闭。如果不想关闭,return false即可,如;
cancel: function(index, layero){
if(confirm('确定要关闭么')){ //只有当点击confirm框的确定时,该层才会关闭
layer.close(index)
}
return false;
}
。。。。。。。。。。
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论