Open and modern framework for building user interfaces.

中文 | English

Omi 官网
Omi Cli 和 Cli 指南
Omi Playground
Omi 文档
Omi 教程
New issue
如果想更加方便的交流关于Omi的一切可以加入QQ的Omi交流群(256426170)

命令行

$ npm install omi-cli -g       //安装cli
$ omi init your_project_name   //初始化项目，你也可以在一个空的文件夹下执行 omi init
$ cd your_project_name         //如果你是在空文件夹下执行的 omi init。请无视这条命令
$ npm start                    //开发
$ npm run dist                 //部署发布

当然omi-cli还有一个特殊命令:

$ npm run ie    //用于生成未压缩js的发布包用来定位ie8的问题

特性

超小的尺寸，7 kb (gzip)
完全面向对象的组件体系
局部CSS，HTML+ Scoped CSS + JS组成可复用的组件
更自由的更新，每个组件都有update方法，自由选择时机进行更新
模板引擎可替换，开发者可以重写Omi.template方法来使用任意模板引擎
提供了ES6+和ES5的两种开发方案供开发者自由选择
良好的兼容性，支持IE8
- omi.art.js和omi.lite.js以及omi.mustache.js兼容到IE8
- omi.js 兼容到IE9
- 兼容IE8请自行引用 es5-shim 或 es5-sham 和 console-polyfill）,比如:

<!--[if lt IE 9]><script type="text/javascript" crossorigin="anonymous" src="//s.url.cn/qqun/xiaoqu/buluo/p/js/console-polyfill.min.848060c4.js"></script>
      <script type="text/javascript" crossorigin="anonymous" src="//s.url.cn/qqun/xiaoqu/buluo/p/js/es5-sham-es5-sham.min.77c4325f.js"></script><![endif]-->

插件

omi-router : Omi专属的官方Router插件.
omi-finger Omi的AlloyFinger插件，支持各种触摸事件和手势
omi-transform Omi的transformjs插件，快速方便地设置DOM的CSS3 Transform属性
omi-touch Omi的AlloyTouch插件，Omi项目的触摸运动解决方案（支持触摸滚动、旋转、翻页、选择等等）
omi-jquery-date-picker Omi的时间选择插件，支持各种时间或者时间区域选择

通过npm安装

$ npm install omi

Hello World

你可以使用 webpack + babel，在webpack配置的module设置babel-loader，立马就能使用ES6+来编写你的web程序。

如果使用omi.lite.js版本(不包含mustache.js模板引擎)的话，也可以使用 ${this.data.name} 的方式。

CDN

感谢

morphdom-Fast and lightweight DOM diffing/patching (no virtual DOM needed)
art-template-JS template engine with excellent performance
sodajs-Light weight but powerful template engine for JavaScript
mustache.js-Minimal templating with {{mustaches}} in JavaScript

English | 中文

Omi Cli and Cli Usage
If you want to experience the Omi framework, you can visit Omi Playground or read the code of TodoMVC by Omi
If you want to use the Omi framework or develop and improve omi framework, please read the Omi documentation
If you want to get a better reading experience of the documents, you can visit Docs Website
Tutorial or blogs about omi framework，you can visit Omi Tutorial
If you have Any problems，please New issue
If you want to be more convenient on the exchange of all Omi can join the QQ Omi exchange group (256426170)

omi-cli

$ npm install omi-cli -g       //install cli
$ omi init your_project_name   //init project, you can also exec 'omi init' in an empty folder
$ cd your_project_name         //please ignore this command if you executed 'omi init' in an empty folder
$ npm start                    //develop
$ npm run dist                 //release

other cmd:

$ npm run ie    //for debugging in ie8

Features

Super tiny size, 7 KB (gzip)
Good compatibility, support IE8 (please import es5-shim or es5-sham by yourself)
Fully object-oriented component system
Support Scoped CSS, reusable components are composed of HTML， Scoped CSS and JS
More free updates, each component has a update method, free to choose the right time to update
Template engines can be replaced, developers can override the Omi.template method to use any template engine
Provides two development way ( ES6+ and ES5) for developers to choose freely