[TOC]
- 简介
- 初始化接口后端示例(V2版)
- 使用说明(V2版)
- 使用说明(V1版)
- 本书使用 GitBook 发布
iframe版
- 使用说明(iframe v2版本)
- 更新说明
- 基础参数一览表
- 后台模板初始化
- 初始化api接口返回的参数说明
- 缓存清理接口返回的参数说明
- 在页面中弹出新的Tab窗口(标签)
- 在页面中弹出新的Tab窗口(JS方法)
- 在iframe页面中关闭当前Tab窗口
- 后台主题方案配色
- 常见问题
- 备注信息
使用说明(iframe v2版本)
更新说明
V2版本相比于V1,核心代码进行重构,更加更加规范,配置使用起来也更方便。
- js模块的拆分,代码更加规范化。
- 配置项移出到外部的初始化配置里面。
- tab选项卡进行重构,视觉和操作体验上更加良好。
- 新增tab选项卡的切换与菜单之间的联动功能。
- 新增菜单在初始化的时候可以展开子菜单。
- 新增初始化时一个配置项完成
多模块
和单模块
之间的切换,接口的初始化数据还是一样的。 - 优化手机端初始化时的自适应,不会出现闪动的问题。
- 重构手机端左侧菜单,弹出菜单时不会挤压内容内面。
- 优化初始化时的接口返回的数据格式
api/init.json
,以适配单模块的切换。 - 新增初始化加载层,更好的视觉体验
- 优化主题配色方案
基础参数一览表
以下参数是
miniAdmin.render();
初始化时进行传入。
参数 | 说明 | 类型 | 默认值 | 备注 |
---|---|---|---|---|
iniUrl | 初始化接口 | string | null | 实际使用,请对接后端接口动态生成,格式请参考文件:api/init.json |
clearUrl | 缓存清理接口 | string | null | 实际使用,请对接后端接口动态生成,格式请参考文件:api/init.json |
urlHashLocation | 是否打开hash定位 | bool | false | 开启后,会显示路由信息,刷新页面后将定位到当前页 |
bgColorDefault | 主题默认配置 | int | 0 | 如需添加更多主题信息,请在js/lay-module/layuimini/miniTheme.js 文件内添加 |
multiModule | 是否开启多模块 | bool | false | 个人建议开启 |
menuChildOpen | 是否默认展开菜单 | bool | false | 个人建议关闭 |
loadingTime | 初始化加载时间 | 0 | 0 | 建议0-2之间 |
pageAnim | iframe窗口动画 | bool | false | 添加tab或者切换时的过渡动漫 |
maxTabNum | 最大的tab打开数量 | int | 20 | 防止打开太多的tab窗口导致页面卡死 |
示例说明
var options = {
iniUrl: "api/init.json", // 初始化接口
clearUrl: "api/clear.json", // 缓存清理接口
urlHashLocation: true, // 是否打开hash定位
bgColorDefault: 0, // 主题默认配置
multiModule: true, // 是否开启多模块
menuChildOpen: false, // 是否默认展开菜单
loadingTime: 0, // 初始化加载时间
pageAnim: true, // iframe窗口动画
};
miniAdmin.render(options);
后台模板初始化
- 在
index.html
文件内进行初始化 - 引入
lay-config.js
文件,请根据实际情况修改里面扩展的路径。 - 引入miniAdmin模块,根据需要传入初始化参数,执行
miniAdmin.render(options);
方法。 - 初始化api接口返回的参数可以参考
api目录下的init.json文件
或者查看使用说明的第二点的参数说明
示例说明
layui.use(['jquery', 'layer', 'miniAdmin'], function () {
var $ = layui.jquery,
layer = layui.layer,
miniAdmin = layui.miniAdmin;
var options = {
iniUrl: "api/init.json", // 初始化接口
clearUrl: "api/clear.json", // 缓存清理接口
urlHashLocation: true, // 是否打开hash定位
bgColorDefault: 0, // 主题默认配置
multiModule: true, // 是否开启多模块
menuChildOpen: false, // 是否默认展开菜单
};
miniAdmin.render(options);
});
初始化api接口返回的参数说明
homeInfo
是首页信息logoInfo
是logo信息menuInfo
是头部模块和左侧菜单对应的信息
示例说明
{
"homeInfo": {
"title": "首页",
"href": "page/welcome-1.html?t=1"
},
"logoInfo": {
"title": "LAYUI MINI",
"image": "images/logo.png",
"href": ""
},
"menuInfo": [
{
"title": "常规管理",
"icon": "fa fa-address-book",
"href": "",
"target": "_self",
"child":[...]
},
{
"title": "组件管理",
"icon": "fa fa-lemon-o",
"href": "",
"target": "_self",
"child":[...]
},
{
"title": "其它管理",
"icon": "fa fa-slideshare",
"href": "",
"target": "_self",
"child":[...]
}
]
}
缓存清理接口返回的参数说明
返回参数对应的事例(code:0,清除缓存失败;code:1,表示清除缓存成功;)
{
"code": 1,
"msg": "清除服务端缓存成功"
}
在页面中弹出新的Tab窗口(标签)
- 如需在页面中弹出新的Tab窗口,请参考下方代码。(备注:需要引入
miniTab.js
文件) - 参数说明(layuimini-content-href:页面链接,data-title:标题)
- 调用方法进行监听:
miniTab.listen();
- 示例在
page/welcome-1.html
页面中有
示例说明
<a href="javascript:;" layuimini-content-href="page/user-setting.html" data-title="基本资料" >基本资料</a>
layui.use(['form','miniTab'], function () {
var form = layui.form,
layer = layui.layer,
miniTab = layui.miniTab;
miniTab.listen();
});
在页面中弹出新的Tab窗口(JS方法)
- 如需在页面中弹出新的Tab窗口,请参考下方代码。(备注:需要引入
miniTab.js
文件) - 参数说明(href:页面链接,title:标题)
示例说明
layui.use(['form','miniTab'], function () {
var form = layui.form,
layer = layui.layer,
miniTab = layui.miniTab;
// 打开新的窗口
miniTab.openNewTabByIframe({
href:"page/form.html",
title:"按钮示例",
});
});
在iframe页面中关闭当前Tab窗口
- 如需在iframe页面中,请参考下方代码。(备注:miniTab.js文件)
- 调用方法:
miniTab.deleteCurrentByIframe();
- 示例在
user-password.html
,user-setting.html
页面中都有
示例说明
layui.use(['form','miniTab'], function () {
var form = layui.form,
layer = layui.layer,
miniTab = layui.miniTab;
//监听提交
form.on('submit(saveBtn)', function (data) {
var index = layer.alert(JSON.stringify(data.field), {
title: '最终的提交信息'
}, function () {
layer.close(index);
miniTab.deleteCurrentByIframe();
});
return false;
});
});
后台主题方案配色
系统已内置12套主题配色,如果需要自定义皮肤配色,请在miniTheme.config
方法内按相同格式添加。
示例说明
var bgColorConfig = [
{
headerRightBg: '#ffffff', //头部右侧背景色
headerRightBgThis: '#e4e4e4', //头部右侧选中背景色,
headerRightColor: 'rgba(107, 107, 107, 0.7)', //头部右侧字体颜色,
headerRightChildColor: 'rgba(107, 107, 107, 0.7)', //头部右侧下拉字体颜色,
headerRightColorThis: '#565656', //头部右侧鼠标选中,
headerRightNavMore: 'rgba(160, 160, 160, 0.7)', //头部右侧更多下拉颜色,
headerRightNavMoreBg: '#1E9FFF', //头部右侧更多下拉列表选中背景色,
headerRightNavMoreColor: '#ffffff', //头部右侧更多下拉列表字体色,
headerRightToolColor: '#565656', //头部缩放按钮样式,
headerLogoBg: '#192027', //logo背景颜色,
headerLogoColor: 'rgb(191, 187, 187)', //logo字体颜色,
leftMenuNavMore: 'rgb(191, 187, 187)', //左侧菜单更多下拉样式,
leftMenuBg: '#28333E', //左侧菜单背景,
leftMenuBgThis: '#1E9FFF', //左侧菜单选中背景,
leftMenuChildBg: '#0c0f13', //左侧菜单子菜单背景,
leftMenuColor: 'rgb(191, 187, 187)', //左侧菜单字体颜色,
leftMenuColorThis: '#ffffff', //左侧菜单选中字体颜色,
tabActiveColor: '#1e9fff', //tab选项卡选中颜色,
},
];
常见问题
- 修改js后刷新页面未生效,请尝试清除浏览器缓存。
- IIS环境下请配置支持解析
.json
格式文件
备注信息
- 菜单栏建议最多四级菜单,四级以后菜单显示并没有那么友好。
© zhongshaofa all right reserved,powered by Gitbook文件修订时间: 2021-04-06 22:10:57