layui-js/README.md

107 lines
4.4 KiB
Markdown
Raw Normal View History

2021-04-06 16:33:58 +00:00
<p align="center">
2017-08-21 00:51:13 +00:00
<a href="http://www.layui.com">
2018-10-31 19:12:35 +00:00
<img src="https://sentsin.gitee.io/res/images/layui/layui.png" alt="layui" width="360">
2017-08-21 00:51:13 +00:00
</a>
</p>
2021-04-06 16:33:58 +00:00
<p align="center">
2017-12-13 11:31:50 +00:00
Classic modular front-end UI framework
2017-08-21 00:51:13 +00:00
</p>
2021-04-06 16:56:02 +00:00
<p align="center">
2021-04-07 05:41:16 +00:00
<a href="https://www.npmjs.com/package/layui"><img src="https://img.shields.io/npm/v/layui.svg?sanitize=true" alt="Version"></a>
<a href="https://www.npmjs.com/package/layui"><img src="https://img.shields.io/npm/l/layui.svg?sanitize=true" alt="License"></a>
2021-04-06 16:56:02 +00:00
<a href="https://travis-ci.org/sentsin/layui"><img alt="Build Status" src="https://img.shields.io/travis/sentsin/layui/master.svg"></a>
<a href="https://coveralls.io/r/sentsin/layui?branch=master"><img alt="Test Coverage" src="https://img.shields.io/coveralls/sentsin/layui/master.svg"></a>
2021-04-06 17:18:07 +00:00
<!--<a href="https://saucelabs.com/beta/builds/7e6196205e4f492496203388fc003b65"><img src="https://saucelabs.com/buildstatus/layui" alt="Build Status"></a>-->
</p>
2021-04-06 16:33:58 +00:00
<!--
<p align="center">
<a href="https://saucelabs.com/beta/builds/7e6196205e4f492496203388fc003b65"><img src="https://saucelabs.com/browser-matrix/layui.svg" alt="Browser Matrix"></a>
</p>
2021-04-06 16:33:58 +00:00
-->
2017-08-21 00:51:13 +00:00
---
2022-04-03 14:56:54 +00:00
layui 是一套开源的 Web UI 解决方案,采用自身经典的模块化规范,并遵循原生 HTML/CSS/JS 的开发方式极易上手拿来即用。其风格简约轻盈而组件优雅丰盈从源代码到使用方法的每一处细节都经过精心雕琢非常适合网页界面的快速开发。layui 区别于那些基于 MVVM 底层的前端框架,却并非逆道而行,而是信奉返璞归真之道。准确地说,它更多是面向后端开发者,你无需涉足前端的各种工具,只需面对浏览器本身,让一切你所需要的元素与交互,从这里信手拈来。
2017-08-21 00:51:13 +00:00
## 返璞归真
2022-04-03 14:37:45 +00:00
layui 定义为「经典模块化」,并非是自吹她自身有多优秀,而是有意避开当下 JS 社区的主流方案,试图以最简单的方式去诠释高效!<em>她的所谓经典,是在于对返璞归真的执念</em>,她以当前浏览器普通认可的方式去组织模块!我们认为,这恰是符合当下国内绝大多数程序员从旧时代过渡到未来新标准的最佳指引。所以 layui 本身也并不是完全遵循于 AMD 时代,准确地说,她试图建立自己的模式,所以你会看到:
2017-08-21 00:51:13 +00:00
2017-10-10 04:17:51 +00:00
```js
2022-04-03 14:56:54 +00:00
//layui 模块的定义
2017-10-10 04:17:51 +00:00
layui.define([mods], function(exports){
//……
exports('mod', api);
});
//layui模块的使用
layui.use(['mod1', 'mod2'], function(args){
var mod = layui.mod1;
//……
});
2017-08-21 00:51:13 +00:00
```
2022-04-03 15:04:16 +00:00
没错,她具备 AMD 的影子,又并非受限于 CommonJS 的那些条条框框layui 认为这种轻量的组织方式,比 WebPack 更符合绝大多数场景。所以她坚持采用经典模块化,也正是能让人避开工具的复杂配置,回归简单,安静高效地编织原生态的 HTML/CSS/JS。
2017-08-21 00:51:13 +00:00
2022-04-03 15:04:16 +00:00
但是 layui 又并非是 RequireJS 那样的模块加载器,而是一款 UI 解决方案,她与 Bootstrap 最大的不同恰恰在于她糅合了自身对经典模块化的理解。这使得你可以在 layui 组织的框架之内,以更具可维护性的代码、去更好的编织丰富的用户界面。
2017-08-21 00:51:13 +00:00
## 快速上手
2021-03-31 06:07:23 +00:00
获得 layui 后,将其完整地部署到你的静态资源项目目录,你只需要引入下述两个文件:
2017-08-21 00:51:13 +00:00
```
./layui/css/layui.css
2021-03-31 06:07:23 +00:00
./layui/layui.js
2017-08-21 00:51:13 +00:00
```
2021-03-31 06:07:23 +00:00
这是一个基本的入门页面:
2017-08-21 00:51:13 +00:00
2017-10-10 04:17:51 +00:00
```html
2017-08-21 00:51:13 +00:00
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
2021-03-31 06:07:23 +00:00
<title>开始使用 layui</title>
2017-08-21 00:51:13 +00:00
<link rel="stylesheet" href="../layui/css/layui.css">
</head>
<body>
2022-04-03 14:37:45 +00:00
<!-- 你的 HTML 代码 -->
2017-08-21 00:51:13 +00:00
<script src="../layui/layui.js"></script>
<script>
2022-04-03 14:37:45 +00:00
//一般直接写在一个 js 文件中
2017-08-21 00:51:13 +00:00
layui.use(['layer', 'form'], function(){
var layer = layui.layer
,form = layui.form;
layer.msg('Hello World');
});
</script>
</body>
</html>
```
2022-03-16 01:55:53 +00:00
## 阅读文档
2022-03-16 02:00:42 +00:00
[**最新文档**](https://gitee.com/layui)
2022-03-16 01:55:53 +00:00
2022-03-16 01:57:56 +00:00
愿 layui 能成为你得心应手的 Web 界面解决方案,化作你方寸屏幕前的亿万字节!
2017-08-21 00:51:13 +00:00
2021-03-31 06:07:23 +00:00
## 贡献者
2022-03-16 01:38:44 +00:00
> 大概是因为 layui 让开发者变得更懒,所以贡献者才如此之少。
2021-03-31 06:40:16 +00:00
2022-03-16 01:38:44 +00:00
[贡献者列表](https://github.com/sentsin/layui/graphs/contributors)
2021-03-31 06:07:23 +00:00
2017-08-21 00:51:13 +00:00
## 相关
2022-03-16 01:42:53 +00:00
> layui 官网已于2021年10月13日下线。
2022-03-16 01:43:58 +00:00
2022-03-16 01:50:26 +00:00
目前包括版本更新、文档等在内的所有日常维护,都以 Github 或 Gitee 项目主页为准。