目录
一：基本用法
弹出层组件 layer 是 Layui 最古老的组件，也是使用覆盖面最广泛的代表性组件。 layer 集众多弹层功能为一体，灵活而多样，是许多开发者的网页弹出层的首选交互方案，在各类业务场景都能发挥重要作用
| 场景 | 用前准备 | 使用方式 |
| 作为独立组件使用 | 你可以去 layer 独立版本官网下载组件包。你需要在你的页面引入jQuery1.8以上的任意版本，并引入layer.js | 通过script标签引入layer.js后，直接用即可 |
| 模块化使用 | 如果你使用的是 layui，那么你直接在官网下载 layui 框架即可，无需引入JQuery和 layer.js，但需要引入layui.css和layui.js | 通过layui.use(‘layer’, callback)加载模块 |
API
打开弹层
layer.open(options);
- 参数
options: 基础属性配置项。#详见属性
打开弹层的核心方法，其他不同类型的弹出方法均为该方法的二次封装
// 该方法返回当前层的唯一索引，以便其他方法对该弹层进行相关操作
var index = layer.open({
type: 1, // page 层类型，其他类型详见「基础属性」
content: '<div style="padding: 16px;">test</div>'
});基础属性
| 属性名 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| type | 弹层类型。 可选值有：
|
number |
|
| title | 弹层标题。其值支持以下可选类型：
|
string array boolean |
|
| 弹层内容。 可传入的值比较灵活，支持以下使用场景：
注意： 若采用捕获层，则捕获的元素必须存放在
相关效果可参考：#示例 |
|||
| 设置弹层的宽高，其值支持以下可选类型：
|
array string |
|
|
| maxWidth | 弹层的最大宽度。当 |
number |
|
| maxHeight | 弹层的最大高度。当 |
number | - |
| 弹层的偏移坐标。 支持以下可选值：
当设置边缘坐标时，可配合 |
string array |
|
|
| 弹层的出场动画。支持以下可选值：
边缘抽屉动画 2.8+：
抽屉动画一般配合 |
number string |
|
|
| isOutAnim | 是否开启弹层关闭时的动画。 |
boolean |
|
| maxmin | 是否开启标题栏的最大化和最小化图标。 |
array |
|
| 是否开启标题栏的关闭图标，或设置关闭图标风格。
|
number |
|
|
| 提示图标。 信息框和加载层的私有参数。
|
number |
|
|
| 自定义按钮。 页面层默认不开启。 按钮可无限数量，每一个按钮均会按照数组顺序生成对应的回调函数，如：
|
string | - | |
| 按钮水平对其方式。支持以下可选值：
|
string |
|
|
| 弹层的主题风格。通过赋值对应的 className，实现对主题样式的定制。除了默认主题风格，还支持以下可选主题：
还可传入其他任意 className 来自定义主题。 参考：#示例 |
string | - | |
| 弹层的遮罩。 支持以下写法：
|
number array |
|
|
| shadeClose | 是否点击遮罩时关闭弹层。当遮罩存在时有效。 |
boolean |
|
| time | 弹层自动关闭所需的毫秒数。 如 |
number |
|
| id | 弹层的 ID 值。一般用于防止页面层或 iframe 层的重复弹出。 |
string | - |
| fixed | 弹层是否固定定位，即始终显示在页面可视区域。 |
boolean |
|
| zIndex | 弹层的初始层叠顺序值。 |
number |
|
| resize | 是否允许拖拽弹层右下角拉伸尺寸。 该属性对加载层和 tips 层无效。 |
boolean |
|
| scrollbar | 打开弹层时，是否允许浏览器出现滚动条。 |
boolean |
|
| minStack 2.6+ | 点击标题栏的最小化时，是否从页面左下角堆叠排列。 |
boolean |
|
| removeFocus 2.8+ | 是否移除弹层触发元素的焦点，避免按回车键时重复弹出。 |
boolean |
|
| move | 绑定弹层的拖拽元素。 默认为触发弹层的标题栏进行拖拽。也可以设置 |
string DOM boolean |
- |
| moveOut | 否允许拖拽到窗口外 |
boolean |
|
| tips | 设置 tips 层的吸附位置和背景色，tips 层的私有属性。
|
number array |
|
| tipsMore | 是否允许同时存在多个 tips 层，即不销毁上一个 tips。 |
boolean |
|
| 打开弹层成功后的回调函数。返回的参数如下：
|
|||
| 点击「确定」按钮的回调函数。返回的参数同
|
|||
| 点击标题栏关闭按钮的回调函数。返回的参数同 `success`
|
|||
| 弹层被关闭且销毁后的回调函数。
|
|||
| 弹层拖拽完毕后的回调函数。
|
|||
| 弹层拉伸过程中的回调函数
|
|||
| 弹层最大化后的回调函数。返回的参数同
|
|||
| 弹层最小化后的回调函数。返回的参数同
|
|||
| 弹层被还原后的回调函数。返回的参数同 `success`
|
|||
弹出信息框
layer.alert(content, options, yes);
- 参数
content: 弹出内容 - 参数
options: 基础属性配置项。#详见属性 - 参数
yes: 点击确定后的回调函数
该方法用于弹出 dialog 类型信息框（type: 0），参数自动向左补位
// eg1
layer.alert('一个简单的信息框');
// eg2
layer.alert('开启图标', {icon: 1}, function(index){
// do something
// …
layer.close(index);
});
// eg3
layer.alert('不开启图标', function(index){
// do something
// …
layer.close(index);
});弹出询问框
layer.confirm(content, options, yes, cancel);
- 参数
content: 弹出内容 - 参数
options: 基础属性配置项。#详见属性 - 参数
yes: 点击确定后的回调函数 - 参数
cancel: 点击第二个按钮（默认「取消」）后的回调函数
该方法用于弹出 dialog 类型询问框（type: 0），参数自动向左补位。
// eg1
layer.confirm('确定吗?', {icon: 3, title:'提示'}, function(index){
// do something
// …
layer.close(index);
});
// eg2
layer.confirm('确定吗?', function(index){
// do something
// …
layer.close(index);
});弹出提示框
layer.msg(content, options, end);
- 参数
content: 弹出内容 - 参数
options: 基础属性配置项。#详见属性 - 参数
end: 提示框关闭后的回调函数
该方法用于弹出 dialog 类型提示框（type: 0），默认 3 秒后自动关闭。参数自动向左补位。
// eg1
layer.msg('普通提示');
// eg2
layer.msg('带 icon 的提示', {icon: 6});
// eg3
layer.msg('关闭后想做些什么', function(){
// do something
});
// eg
layer.msg('提示框', {
icon: 1,
time: 2000 // 设置 2 秒后自动关闭
}, function(){
// do something
});弹出加载层
layer.load(icon, options);
- 参数
icon: 加载图标风格，支持0-2可选值 - 参数
options: 基础属性配置项。#详见属性
该方法用于弹出 load 类型加载层（type: 3）。
// eg1
var index = layer.load(); // 默认加载图标风格
// eg2
var index = layer.load(1); // 加载图标风格 1
// eg3
var index = layer.load(2, {time: 10*1000}); // 加载图标风格，并设置最长等待 10 秒
// 关闭加载层
layer.close(index);弹出贴士层
layer.tips(content, elem, options);
- 参数
content: 弹出内容 - 参数
elem: 吸附的目标元素选择器或对象 - 参数
options: 基础属性配置项。#详见属性
该方法用于弹出 tips 类型贴士层（type: 4），默认 3 秒后自动关闭。
// eg1
layer.tips('小贴士', '#id');
// eg2
$('#id').on('click', function(){
var elem = this;
layer.tips('小贴士', elem); //在元素的事件回调体中，follow直接赋予this即可
});
// eg3
layer.tips('显示在目标元素上方', '#id', {
tips: 1 // 支持 1-4 可选值，更多详见基础属性中的 tips 介绍
});弹出输入框
layer.prompt(options, yes);
- 参数
options: 基础属性配置项。除了支持 基础属性 之外，还支持下表私有属性：
| 私有属性 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| formType | 输入框类型。支持以下可选值：
|
number | 0 |
| value | 输入框初始值 | string | - |
| maxlength | 可输入的最大字符长度 | number | 500 |
- 参数
yes: 点击确定后的回调函数
该方法用于弹出输入框层，基于 type: 1（即 page 层）的自定义内容。 效果参考：
// eg1
layer.prompt(function(value, index, elem){
alert(value); // 得到 value
layer.close(index); // 关闭层
});
// eg2
layer.prompt({
formType: 2,
value: '初始值',
title: '请输入值',
area: ['800px', '350px'] // 自定义文本域宽高
}, function(value, index, elem){
alert(value); // 得到 value
layer.close(index); // 关闭层
});弹出图片层
layer.photos(options);
- 参数
options: 基础属性配置项。除了支持 基础属性 之外，还支持下表私有属性：
| 私有属性 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| photos | 图片层的数据源，格式详见下述示例。 | object | - |
| tab | 图片层切换后的回调函数，返回的参数见下述示例 | function | - |
该方法用于弹出图片层，基于 type: 1（即 page 层）的自定义内容。
用法一：直接赋值图片数据。 效果参考：
layer.photos({
photos: { // 图片层的数据源
"title": "", // 相册标题
"id": 123, // 相册 id
"start": 0, // 初始显示的图片序号，默认 0
"data": [ // 相册包含的图片，数组格式
{
"alt": "图片名",
"pid": 666, // 图片id
"src": "", // 原图地址
"thumb": "" // 缩略图地址
},
// …
]
},
tab: function(data, layero){ // 图片层切换后的回调
console.log(data); // 当前图片数据信息
console.log(layero); // 图片层的容器对象
}
});用法二：绑定页面图片元素。点击图片时，弹出对应的图片层
<style>
.class-photos-demo img{width: 160px; height: 100px; cursor: pointer;}
</style>
<div id="ID-photos-demo" class="class-photos-demo">
<!-- <img src="缩略图" layer-src="大图地址" layer-pid="图片id，可不写" alt="图片名"> -->
<img src="https://unpkg.com/outeres/demo/layer.png" layer-src="https://unpkg.com/outeres/demo/layer.png" layer-pid="" alt="layer">
<img src="https://unpkg.com/outeres/demo/000.jpg" layer-src="https://unpkg.com/outeres/demo/000.jpg" layer-pid="" alt="壁纸">
<img src="https://unpkg.com/outeres/demo/outer-space.jpg" layer-src="https://unpkg.com/outeres/demo/outer-space.jpg" layer-pid="" alt="星空如此深邃">
</div>
<script>
layui.use(function(){
var layer = layui.layer;
// 图片层
layer.photos({
photos: '#ID-photos-demo'
});
});
</script>弹出标签层
layer.tab(options);
- 参数
options: 基础属性配置项。除了支持 基础属性 之外，还支持下表私有属性：
| 私有属性 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| tab | 标签层的数据源，格式详见下述示例。 | array | - |
该方法用于弹出标签层，基于 type: 1（即 page 层）的自定义内容。 效果参考：
layer.tab({
area: ['600px', '300px'],
tab: [{ // 标签层的数据源
title: '标题 1',
content: '内容 1'
}, {
title: '标题 2',
content: '内容 2'
}, {
title: '标题 3',
content: '内容 3'
}]
});关闭弹层
layer.close(index);
- 参数
index: 打开弹层时返回的唯一索引
该方法用于关闭对应的弹层。
// 每一种弹层调用方式，都会返回一个 index
var index1 = layer.open();
var index2 = layer.alert();
var index3 = layer.load();
var index4 = layer.tips();
// 关闭对应的弹层
layer.close(index1);在 iframe 弹层页面中关闭自身
var index = parent.layer.getFrameIndex(window.name); // 先得到当前 iframe 层的索引
parent.layer.close(index); // 再执行关闭关闭所有层
layer.closeAll(type);
- 参数
type: 弹层的类型。可选值：dialog,page,iframe,loading,tips
该方法用于关闭所有同类型的弹层。
layer.closeAll(); // 关闭所有类型的层
layer.closeAll('dialog'); // 关闭所有的信息框
layer.closeAll('page'); // 关闭所有的页面层
layer.closeAll('iframe'); // 关闭所有的 iframe 层
layer.closeAll('loading'); // 关闭所有的加载层
layer.closeAll('tips'); // 关闭所有的 tips 层关闭最近一次打开的层 2.8+
layer.closeLast(type);
- 参数
type: 弹层的类型。可选值：dialog,page,iframe,loading,tips
该方法用于关闭最近一次打开的对应类型的层
layer.closeLast('dialog'); // 关闭最近一次打开的信息框
layer.closeLast('page'); // 关闭最近一次打开的页面层
layer.closeLast('iframe'); // 关闭最近一次打开的 iframe 层
layer.closeLast('loading'); // 关闭最近一次打开的加载层
layer.closeLast('tips'); // 关闭最近一次打开的 tips 层全局配置默认属性
layer.config(options);
- 参数
options: 基础属性配置项。
该方法用于全局设置弹层的默认基础属性。
layer.config({
title: '默认标题',
skin: '', // 设置默认主题
// … 其他任意基础属性
})样式初始化就绪
layer.ready(callback);
- 参数
callback: 初始化完毕后的回调函数
该方法一般是在源码方式引入 layui.js，且要在页面初始即弹出层时使用，以确保弹层所依赖的样式文件先行加载。 而引入 release 版的 layui.js 则无需使用该方法，因为弹层样式已经统一合并到 layui.css 中。
// 页面初始弹出层
layer.ready(function(){
layer.alert('对话框内容');
});重新设置弹层样式
layer.style(index, css);
- 参数
index: 打开弹层时返回的唯一索引 - 参数
css: 要设置的css属性
该方法对 loading 层和 tips 层无效。
// 打开弹层
var index = layer.open({
type: 1,
content: '内容'
});
// 重新给对应层设定 width、top 等
layer.style(index, {
width: '1000px',
top: '10px'
});设置弹层的标题
layer.title(title, index);
- 参数
title: 标题 - 参数
index: 打开弹层时返回的唯一索引
// 打开弹层
var index = layer.open({
type: 1,
content: '内容'
});
// 重新设置标题
layer.title('新标题', index)获取 iframe 页中的元素
layer.getChildFrame(selector, index);
- 参数
selector: iframe 子页面的选择器或元素对象 - 参数
index: 打开弹层时返回的唯一索引
该方法用于在父页面获取 iframe 子页面中的元素
layer.open({
type: 2, // iframe 层
content: '/layer/test/iframe.html',
success: function(layero, index){
// 获取 iframe 中 body 元素的 jQuery 对象
var body = layer.getChildFrame('body', index);
// 给 iframe 页中的某个输入框赋值
body.find('input').val('Hello layer.');
}
});在 iframe 页中获取弹层索引
layer.getFrameIndex(window.name);
- 参数
window.name: 当前 iframe 窗口的name属性值
该方法用于在 iframe 页面内部获取当前 iframe 弹层的索引，以便关闭自身。
var index = parent.layer.getFrameIndex(window.name); // 获取当前 iframe 层的索引
parent.layer.close(index); // 关闭当前 iframe 弹层设置 iframe 层高度自适应
layer.iframeAuto(index);
- 参数
index: 打开弹层时返回的唯一索引
该方法可让 iframe 高度跟随内容自适应
layer.open({
type: 2, // iframe 层
content: '/layer/test/iframe.html',
area: '600px', // 弹层初始宽度
success: function(layero, index, that){
layer.iframeAuto(index); // 让 iframe 高度自适应
that.offset(); // 重新自适应弹层坐标
}
});重新设置 iframe 层 URL
layer.iframeSrc(index, url);
- 参数
index: 打开弹层时返回的唯一索引 - 参数
url: URL 地址
// 打开弹层
var index = layer.open({
type: 2, // iframe 层
content: '/layer/test/iframe.html'
});
// 重置 iframe 页面 URL
layer.iframeSrc(index, 'https://cn.bing.com/');置顶弹层
layer.setTop(layero);
- 参数
layero: layer 最外层容器的元素对象，一般可通过各个回调函数返回的参数获取。
该方法一般用于多弹层模式时，实现点击某个弹层让其层叠顺序置顶。效果参考：
// 多弹层模式的层叠顺序置顶
layer.open({
type: 1, // 页面层
shade: false,
area: ['520px', '320px'],
maxmin: true,
content: '<div style="padding: 16px;">多弹层模式的层叠顺序置顶</div>',
zIndex: layer.zIndex, // 重点 1 --- 初始设置当前最高层叠顺序，
success: function(layero){
layer.setTop(layero); // 重点 2 --- 保持选中窗口置顶
}
});设置弹层最大化
layer.full(index);
- 参数
index: 打开弹层时返回的唯一索引
// 打开弹窗
var index = layer.open({
type: 1, // 页面层
content: '弹层内容'
});
// 设置弹层最大化
layer.full(index);设置弹层最小化
layer.min(index);
- 参数
index: 打开弹层时返回的唯一索引
// 打开弹窗
var index = layer.open({
type: 1, // 页面层
content: '弹层内容'
});
// 设置弹层最大化
layer.min(index);还原弹层
layer.restore(index);
- 参数
index: 打开弹层时返回的唯一索引
当弹层最大化或最小化状态时，执行该方法可还原弹层。
二：案例演示
<div class="layui-btn-container">
<button type="button" class="layui-btn layui-btn-primary" lay-on="test-offset" data-offset="t">上</button>
<button type="button" class="layui-btn layui-btn-primary" lay-on="test-offset" data-offset="r">右</button>
<button type="button" class="layui-btn layui-btn-primary" lay-on="test-offset" data-offset="b">下</button>
<button type="button" class="layui-btn layui-btn-primary" lay-on="test-offset" data-offset="l">左</button>
<button type="button" class="layui-btn layui-btn-primary" lay-on="test-offset" data-offset="rt">右上</button>
<button type="button" class="layui-btn layui-btn-primary" lay-on="test-offset" data-offset="rb">右下</button>
<button type="button" class="layui-btn layui-btn-primary" lay-on="test-offset" data-offset="lb">左下</button>
<button type="button" class="layui-btn layui-btn-primary" lay-on="test-offset" data-offset="lt">左上</button>
<button type="button" class="layui-btn layui-btn-primary" lay-on="test-offset" data-offset="auto">正中</button>
<button type="button" class="layui-btn layui-btn-primary" lay-on="test-offset" data-offset="">任意</button>
</div>
<script>
layui.use(function(){
var layer = layui.layer;
var util = layui.util;
var $ = layui.$;
// 事件
util.on('lay-on', {
'test-offset': function(){
var othis = $(this);
var offset = othis.data('offset');
// 弹出位置
layer.open({
type: 1,
offset: offset || ['200px', '280px'], // 详细可参考 offset 属性
id: 'ID-demo-layer-offset-'+ offset, // 防止重复弹出
content: '<div style="padding: 16px;">'+ othis.text() +'</div>',
area: '240px',
btn: '关闭全部',
btnAlign: 'c', // 按钮居中
shade: 0, // 不显示遮罩
yes: function(){
layer.closeAll();
}
});
}
});
});
</script>