Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yued-fe/lulu

跨端跨框架的原生 UI 组件库，即插即用
https://github.com/yued-fe/lulu

components css html javascript lulu lulu-ui-js ui web-components

Last synced: about 9 hours ago
JSON representation

跨端跨框架的原生 UI 组件库，即插即用

Awesome Lists containing this project

README 

        


  



追本溯源，穿越沉浮




     




# LuLu UI



LuLu UI 是阅文集团荣誉出品的前端 UI 组件库。



形象气质如下图，柔软亲近，使用简单灵活，适用场景广泛，适合面向外部用户的 PC 网站，或者需要轻量与敏捷的项目。






## 开发



拉取完整项目，包括 gh-pages 分支，然后执行下面的语句即可开发：



```js

// 所有主题

node run

```



也可以只启动某一个主题，例如：



```js

// Edge主题

node run edge

```

```js

// Hope主题

node run hope

```



对应主题的演示兼文档页面的本地访问入口：



* Pure主题：http://localhost:10086/docs/pure/about.use.html

* Edge主题：http://localhost:10086/docs/edge/about.use.html

* Hope主题：http://localhost:10086/docs/hope/about.html



此时，修改项目的 JS 和 CSS 文件，刷新对应的组件页面，就可以看到变化的效果了。



### 注意：

如果执行失败，提示 gh-pages 是无效名称，可以执行下 ```git checkout gh-pages``` ，然后在回到 master 分支执行 ```node run```。



文档页面禁止在 master 分支提交，如果需要推送，请切换到 gh-pages 分支。



## 使用文档



* LuLu UI 中文文档兼演示（GitHub 托管，访问有延迟，IE8 无法访问）

* LuLu UI 中文文档兼演示（国内服务器托管，速度可以，IE8 可以访问）



关于适合使用 LuLu UI 的场景，可以访问下面的视频介绍：






## 使用教程



* LuLu UI 中文教程



## 上手简单



LuLu 整个项目就是提供一些 UI 组件的 JS 和 CSS，很纯粹的 JS 和 CSS，贴近原生，简单直白，即插即用。



LuLu UI 支持直接引入 CSS 和 JS 文件地址，所有主题通用，例如下面的代码引用了全部的 UI 组件库：



```html



    

    

    

    LuLu UI Edge 主题

    



    



    

    // 业务代码这里



```



您也可以直接单独引入某一个组件，例如：



```html



```

```html



```



Edge 主题还支持浏览器原生的 import 引入，例如：



```html



import Dialog from 'https://unpkg.com/lu2/theme/edge/js/common/ui/Dialog.js';



```



也支持 npm install 后作为包文件使用，例如：



```js

import Dialog from 'lu2/theme/edge/js/common/ui/Dialog.js';

```



或者是在业务代码中动态引入：



```js

import('lu2/theme/edge/js/common/ui/Dialog.js');

```



LuLu UI 基于原生 HTML 特性构建，因此使用的时候 HTML 还是原来的 HTML，CSS 还是原来的 CSS，无需掌握流行概念，参照文档，复制复制，粘贴粘贴，效果就出来了。



由于 LuLu UI 中的代码基础，结构简单，没有炫技成分，也没有复杂技巧，因此非常适合新人的学习。



## 使用场景广泛



LuLu UI 既保留了传统插件即插即用的特性，也支持适合多人合作的模块化加载方式，因此适用场景更加广泛。



* 单人完成的某个简单运营活动页，需要个弹框提示功能，可以直接引入 LuLu UI 中的 Dialog.js，就可以使用了。

* 某网站看中了 LuLu UI 某一个组件，例如日期选择功能，想拿过来使用，`` 引入日期选择JS，然后就可以使用了。

* 对于多人合作大型项目，可以基于 AMD/CMD 规范，或者 ES6 原生的 import/export 进行模块化加载与开发。

* 对于 Vue 或者 React 项目，想要使用某个组件，但又不希望引入一大堆东西，则 LuLu UI 非常合适，支持 Vue/React 单独引入（见下方使用示意）。



#### 在Vue/React中使用



安装：

```js

npm install lu2

```



Vue/React项目建议使用Edge主题。



在 Vue-CLI 环境中：

```html

<script>

import Dialog from 'lu2/theme/edge/js/common/ui/Dialog'



```

```html



```



React 框架中：



```js

import "lu2/theme/edge/css/common/ui/Button.css";

import "lu2/theme/edge/css/common/ui/Dialog.css";

import Dialog from "lu2/theme/edge/js/common/ui/Dialog.js";

```



Svelte 框架中：



```js

import Dialog from 'lu2/theme/edge/js/common/ui/Dialog.js';

// 或者全局引入

// import 'lu2/theme/edge/js/common/all.js';

import 'lu2/theme/edge/css/common/ui.css';

```



## 成熟



LuLu UI 诞生于 2015 年，非 KPI 项目，服务于真实业务场景，会一直不断迭代，不要担心遇到问题会无人问津。



开源是件严肃的事情，LuLu UI 一直认为，如果组件还没有达到不动如山的境地，那就应该继续埋头打磨。这么多年过去了，LuLu UI 经过阅文集团对内对外近20个大中小型项目的实践与打磨，无论是交互细节还是代码本身细节，LuLu UI 现在都已经可以做到不显山露水了。



## 体验



LuLu UI 支持高清屏幕，支持辅助阅读设备无障碍访问，以及不少 UI 框架忽略的键盘无障碍访问。



借助扎实的前端基础知识，LuLu UI 有着很多创新的细节打磨，举个例子：如果用户是通过鼠标点击按钮打开的弹框，则弹框界面平平无奇；如果用户是通过 ENTER 回车键点击按钮打开的弹框，则弹框中的按钮默认会 outline 高亮！






这样的细节处理对于 C 端产品颇有价值。



## 快速了解项目目录结构



所有资源都在 /theme/ 目录下，目前支持4个主题：



* Modern 主题


  基于 jQuery，兼容 IE7+，针对 PC 网站。分 sass, css 和 js 3个目录，如果你不想要 sass，那这个文件夹就不用管。图片资源在 css 目录下。

* Peak 主题


  基于 jQuery，兼容 IE8+，针对PC网站。分 sass, css 和 js 3个目录，如果你不想要 sass，那这个文件夹就不用管。图片资源在 css 目录下。

* Pure 主题


  原生 JavaScript 编写，兼容 IE9+，PC，Mobile 网站通用。分 css 和 js 2个目录，没有图片资源目录，所有图像 CSS 内联。

* Edge 主题


  原生 JavaScript 编写，ES6 module，兼容现代浏览器，PC，Mobile 网站通用，Vue、Preact、React全兼容，是面向未来的现代 Web 组件库，目前主力维护主题，所有组件免初始化即可使用。

* Hope 主题


  原生 JavaScript 编写，ES6 module，技术前沿，移动端适用。



组件分 ui 和 comp 两个目录，前者是 UI 组件，后者是基于 UI 组件整合的前端解决方案。



更具体信息可以参见：



* 文档-使用与发布（Pure主题）

* 文档-使用与发布（Edge主题）

* 文档-设计思考（Hope主题）



文档在 gh-pages 分支。



另外，本 git 只展示了输出版本，原始 git 项目在公司内部，测试目录并未对外，并不是说本项目没有测试用例，以及 theme 中的 CSS 和 JS 文件就是开发版本，非编译版本，fork 项目后可直接二次开发。



## 项目成员



排名不分先后：nanaSun，ziven27，lennonover，wiia, popeyesailorman, 5ibinbin, littleLionGuoQing, peter006qi, HSDPA-wen, ShineaSYR, xiaoxiao78, zhangxinxu



## 其他说明



因为 IE7 大势已去，目前 modern 主题已停止维护。



组件均有测试（Hope主题除外），不过在内部项目中，没有对外。



LuLu UI 的设计理念、使用方式不同于常规 UI 组件库。



LuLu UI 没有版本概念，均以发包日期作为版本号。






MIT License