常见接口如下:
方法名 | 描述 |
$.layer({}) | 核心接口,参数是一个对象,对象属性参见上述列表。诸如layer.alert()之类的为$.layer()的包装方法。 |
layer.v | 获取版本号。 |
layer.ready(callback) | layer中的样式文件装载完毕后执行的方法,一般用于页面加载时调用layer,这样可避免样式未加载即调用层导致的错乱。 示例:
layer.ready(function(){ |
layer.alert() | 对单按钮信息框的重新封装,layer.alert(alertMsg , alertType, alertTit , alertYes),四个参数,alertMsg:信息内容(文本),alertType:提示图标(整数,0-10的选择),alertTit:标题 (文本),alertYes:按钮的回调函数。 如:layer.alert('前端攻城师贤心') |
layer.confirm() | 对询问框的重新封装,layer.confirm(conMsg , conYes , conTit , conNo),四个参数,conMsg:信息内容(文本),conYes:按钮一回调,conTit:标题(文本),conNo:按钮二的回调。
如: layer.confirm('确定删除?', function(){ |
layer.msg() | 对无标题栏信息框层的重新封装,layer.msg(msgText, msgTime, parme),三个参数,1.7.0开始对参数做了多重判断,msgText:信息内容(文本),msgTime:自动关闭所需等待秒数(默认2秒),如 果parme是一个数字,则将作为msg的图标参数,如果parme是一个函数,则将作为层消失后的end的回调,如果parme是一个object,您 可配置{type:图标类型,shade:false//是否遮罩,如果是,不用配置,rate:'top'//弹出的动画类型,具体值见 layer.shift的参数说明} |
layer.tips() | 对tips层的重新封装,layer.tips(html, follow, parme),三个参数,html:信息内容(文本),follow:触发事件对应的选择器,parme是一个对象,其中包含了{time:自动关闭所需 等待秒数, maxWidth:最大宽度, guide:指引方向, style: tips样式(参加api表格一中的style属性)}
如: $('.demo').click(function(){ |
layer.load(parme, loadIcon) | 对加载层的重新封装,如果你想在loading中附加一些文字的话,您可以这样:layer.load('加载中'); 如果parme是一个数字,意味着parme为自动关闭所需最长等待秒数(0时则不自动关闭),loadIcon:加载图标(整数,0-3的选择) 如:layer.load(0, 1); |
layer.area(index, options) | 用于重定义指定层的宽高、坐标、z-index等。index为层的索引,options包含 {width:'',height:'',top:'',left:'',zIndex:''}等css属性。该方法仅针对页面层(type:1)和 iframe层(type:2)有效; 此方法为1.6.0开始新增 |
layer.index | 静态属性,用于获取最近一次触发的层索引值 |
layer.getChildFrame(selector, index) | 获取子iframe中的DOM。非常实用,父窗口操作iframe中内容时可以大显神威。index参数为1.6.0开始新增,由于允许弹出多个iframe层,所以需借助index索引来操作指定层 |
layer.getFrameIndex(window.name) | 获取当前所在iframe层的索引。 只允许在iframe页面内部调用。如在内部关闭自身:
var i = parent.layer.getFrameIndex(window.name); |
layer.close(index) | 用于手动关闭层。参数为layer的索引值。索引即通过弹出方法返回的值。如:
var i = $.layer({}); //或者 var i = layer.alert();之类的也可返回索引 |
layer.closeAll() | 用于关闭所有层,在多层模式时也许会用到 |
layer.shift(type , rate) | layer弹出时内置动画,在success回调中使用。type:动画类型,供七种选择,左上(left-top),上(top), 右上(right-top),右下(right-bottom),下(bottom),左下(left-bottom),左('left')。 rate:动画频率,毫秒。 如: success : function(){ |
layer.autoArea(index) | 用来处理在层中宽高改变时,重新自适应层宽高。必填参数为层的索引值 |
layer.iframeAuto(index) | 用于让iframe层自适应。非常实用,如果是在iframe层内部,则可通过var index = layer.getFrameIndex (window.name)得到;若在父页面,则可通过调用iframe层的返回值得到,如var index = $.layer(); 详见官网实例演示之iframe子父操作。 |
layer.setMove() | 当拖拽元素改变时,可用此方法重新初始化拖拽。 |
layer.zIndex | 全局属性,用于获取layer容器中的最大z-index值 |
layer.setTop(layerNow) | 引用此方法可开启点击使当前窗口置顶功能,只能用于用在success回调中,layerNow参数即为success回调函数中传过来 的参数,即当前layer容器。type:1/type:2多窗口模式时可能非常实用,当需要时,需配置zIndex:layer.zIndex,可详见 [实力加强版]一页的例子:[页面层]之无限层中层 |
layer.path | 静态属性一枚,获取当前layer的存放路径。 |
layer.use(module, callback) | 载入一个模块,支持载入js、css,当你试图给layer拓展个js模块时,用它会更高大上不是么。如载入一个js:layer.use('extend/layer.ext.js', function(){}); 详细参考layer.ext.js |
参数说明如下:
键: 值 | 描述 |
type : 0, | 层的类型。0:信息框(默认),1:页面层,2:iframe层,3:加载层,4:tips层。
此为重要参数,不同类型层类型的总开关,调用时必须设置。 |
shade : [0.5 , '#000' , true] | 控制遮罩。0.5:遮罩透明度,'#000':遮罩颜色,true:是否遮罩(否:false) |
shadeClose : false | 用来控制点击遮罩区域是否关闭层。(是:true)。 |
fix : true, | 层是否固定在可视区域。否:false |
fadeIn: 300, | (1.7.0重新新增,1.4.*貌似也有),用于层的渐显,值为毫秒数 |
move : ['.xubox_title' , true] | 通过拖拽层的某个元素来实现对层的拖拽。'.xubox_title':拖拽绑定事件所在元素选择器(默认为标题栏),true:是否允许拖拽(否:false) |
moveOut : false | 用于控制层是否允许被拖出可视窗口外,false:不允许,true:允许 |
moveType: 0 | (1.7.0新增)用于配置拖拽类型,默认为空心方块式拖动层,若值设为1,则直接拖动层 |
title : '信息' | 控制标题栏。不想显示标题栏,配置title:false 即可 |
offset : ['220px' , '50%'] | 控制层坐标。'220px':纵坐标,'50%':横坐标。 需要注意的是,像素必须带px单位,百分比不需要。该参数灵活运用,可助你实现诸多特效。 |
area : ['310px' , 'auto'] | 控制层宽高。'310px':宽,'auto':高。 当设置为auto时,意味着采用自适应, 当然,对于宽度,并不推荐您这样做。 |
closeBtn : [0 , true] | 控制层右上角关闭按钮。0:关闭按钮风格(1:风格2),当标题栏不存在时,自动切换为风格2。 true:是否显示关闭按钮(否:false) |
time : 0 | 自动关闭等待秒数,整数值。也许它可以助你做蛮多事,想象一下吧。 |
bgcolor : '#fff' | 用于控制层的背景色,默认白色(#fff),如设置透明,设置空字符即可。 |
border : [10 , 0.3 , '#000', true] | 10:边框大小,0.3:边框透明度,'#000':边框颜色,true:是否显示边框(否:false)。通过它您可以任意配置边框,譬如你觉得边框碍眼,赶紧启用[0,0,'',false]吧 |
zIndex : 19891014 | 控制层堆叠顺序(z-index)。整数值,默认是贤心的生日。合理设置它,可以避免与其它插件的层级冲突 |
maxWidth : 400 | 最大宽度。整数值。当宽度设为auto时才有用。 |
dialog: { |
信息框层模式提供的私有参数。使用时,按需配置即可 btns : 按钮的个数。提供了0-2的选择 btn : [按钮一的文本值 , 按钮二的文本值] type : 图标类型,提供了0-15的选择,也许有你喜欢的。 设置-1不显示图标(1.6.0) msg : 信息框内容,重要参数 yes : 按钮一的回调函数 no : 按钮二的回调函数 |
page: { |
页面层模式私有参数。dom:需要弹出的html片段所对应的选择器(class 或 id,推荐用id,确保唯一)。html: 自定义html字符串。url:ajax请求地址。ok,ajax请求完毕后执行的回调。需要注意的是,优先级 是:html>url>dom,这意味着,当你一旦配置了html的非空值,将优先采用html中的元素弹出,如此类推,若配置html或 url,你必须也配置宽高值。html参数为layer-v1.5.1开始新增。url和ok为1.6.0开始新增 |
iframe: { |
iframe层模式私有参数。src:要打开的网址。使用率非常高,尤其是对于喜欢用iframe的同学。 |
loading : {type : 0} | 加载层私有属性。type:loading图标类型(提供了0-3的选择,试试吧,看看有无你喜欢的)。一般配合ajax使用 |
tips : { |
tips小提示层私有属性。 msg:提示内容。 follow:触发事件对应的选择器。 guide:指引方向(0:上,1:右,2:下,3:左)。 isGuide:是否显示默认三角形。 这个参数可配合msg帮助你自定义三角形icon [自定义样式示例] style: ['background-color:#FFF8ED; color:#000; border:1px solid #FF9900', '#FF9900']]。 layer-v1.7.0开始,对tips有了更为完善的支持,提供了上、右、下、左模式,可智能识别指引方向。 |
success : function(layer){} | 层弹出成功后的回调函数 |
close : function(index){} | 层右上角关闭按钮的回调函数。 |
end : function(){} | 层被彻底关闭后执行的回调函数。它的存在让close回调成为浮云。 |
moveEnd : function(){} | 拖拽时鼠标按键放下后的回调函数 |
实例:
function openDialogView(title,url,width,height){
parent.layer.open({
type: 2,
area: [width, height],
title: '<font style="font-size:15px;">'+title+'</font>', //参数传过来进行显示
maxmin: true,
content: url ,
btn: ['关闭'],
cancel: function(index){}
});
}
结果: