Skip to content
master
Go to file
Code
This branch is even with CMUI:master.

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

CMUI

CMUI is a UI framework for mobile web. It provides rich widgets and simple interfaces out-of-the-box, which helps developers get rid of details of styling and troubles of compatibility, and focus on building their own applications.

CMUI 是一个专攻移动网页的 UI 框架,它提供了丰富的组件和简洁的接口,开箱即用。CMUI 帮助开发者摆脱样式细节和兼容性困扰,从而腾出更多精力投入到业务开发中。

兼容性

浏览器支持

  • 支持以下移动平台的主流浏览器:

    • iOS 10+
    • Android 4.4+
  • 同样支持以下桌面浏览器:

    • Firefox (Latest)
    • Chrome (Latest)
    • Safari (Latest)

(更多细节参见 CMUI 的浏览器分级支持策略。)

外部依赖

  • Underscore 1.8+
  • Zepto 1.1+
  • Gearbox 0.7+

安装与使用

传统方式

  1. 通过 npm 3 安装:

    $ npm install cmui
  2. 在页面中加载 CMUI 的样式文件、脚本文件及必要的依赖:

    <!DOCTYPE html>
    <html>
    <head>
    	...
    	<link rel="stylesheet" href="node_modules/cmui/dist/cmui.css">
    </head>
    <body>
    	...
    	<script src="node_modules/underscore/underscore-min.js"></script>
    	<script src="node_modules/zepto.js/dist/zepto.min.js"></script>
    	<script src="node_modules/cmui-gearbox/dist/gearbox.min.js"></script>
    	<script src="node_modules/cmui/dist/cmui.js"></script>
    </body>
    </html>

通过 Stylus 加载

如果你的项目以 Stylus 作为 CSS 预处理器语言,则可以在你的源码中直接引入 CMUI 的样式入口文件:

@import './node_modules/cmui/src/css/theme/baixing/index'

在这种方式下,你可以在源码中使用 CMUI 提供的高级 API

  • 变量
  • Mixin

演示与文档

建议使用 iOS/Android 设备访问:CMUI Demo

cmui-demo

谁在用?

以下网站基于 CMUI 构建(请使用 iOS/Android 设备访问):


参与开发

功能模块

CMUI 的部分模块已经分离出去,成为独立项目。这些模块以开发依赖的方式引入,并打包到发布文件中。因此,参与这些独立项目的开发即可修改这些模块。

构建

  1. 把本项目的代码 fork 并 clone 到本地。
  2. 在项目根目录执行 npm install,安装必要的依赖。
  3. 在项目根目录执行 npm run dist,运行构建脚本。
  4. 构建生成的发布文件将存放在 /dist 目录下。

单元测试

  1. 把本项目的代码 fork 并 clone 到本地。
  2. 在项目根目录执行 npm install,安装必要的依赖。
  3. 在浏览器中打开以下文件即可运行单元测试:
    • test/test-dev.html - 测试源码(用于开发阶段的测试)

Thanks

CMUI is based on these open source projects:

CMUI team is using JetBrains IDE (WebStorm) with Open Source License:

  • WebStorm Logo

License

MIT License

About

Lightweight UI solution for mobile web.

Resources

License

Packages

No packages published
You can’t perform that action at this time.