Go to file
dntzhang e3e4c3825a update doc 2017-07-02 10:59:02 +08:00
asset update md2site 2017-03-04 20:03:38 +08:00
dist omi v1.7.4 2017-07-01 09:56:39 +08:00
docs clean up 2017-06-16 10:50:59 +08:00
example omi v1.7.3 2017-07-01 09:02:05 +08:00
md2site update md2site 2017-05-03 09:07:43 +08:00
plugins omi-touch v0.1.3 2017-06-28 18:21:57 +08:00
src omi v1.7.4 2017-07-01 09:56:39 +08:00
test slot test 2017-04-06 21:12:44 +08:00
todomvc omi v1.1.6 - spelling mistakes 2017-03-28 09:57:06 +08:00
ts update ts test 2017-04-02 11:13:44 +08:00
tutorial update doc 2017-07-02 10:59:02 +08:00
website update readme 2017-05-18 18:04:16 +08:00
.gitignore remove old ssr example 2017-04-03 16:00:40 +08:00
.travis.yml add travis.yml 2017-01-23 16:02:59 +08:00
README.md omi v1.7.4 2017-07-01 09:56:39 +08:00
change-log.md omi v1.7.4 2017-07-01 09:56:39 +08:00
index.d.ts update ts test 2017-04-02 11:13:44 +08:00
index.html update readme 2017-06-24 17:17:28 +08:00
package.json omi v1.7.4 2017-07-01 09:56:39 +08:00
webpack.config.js omi v1.7.0 - add omi.art.js and omi.art.min.js 2017-05-26 11:28:14 +08:00

README.md

Omi

Open and modern framework for building user interfaces.


中文 | English

命令行

$ 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)
  • 完全面向对象的组件体系
  • 局部CSSHTML+ 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-shamconsole-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]-->

插件

通过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 frameworkyou can visit Omi Tutorial
  • If you have Any problemsplease 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

Plugins

Install

$ npm install omi

Hello World

You can use webpack + babelconfigure the babel-loader in the module settings of webpackthen you can use ES6+ to write your web program.

if using 'omi.lite.js' (without mustache.js)you can use the ${this.data.name} way

CDN

Thanks

  • 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

Contributors

name avatars company
CodeFalling alibaba
abell123456 alibaba
Aresn TalkingCoder
pasturn Mars Holding
vorshen Tencent
xcatliu Microsoft
dorsywang Tencent
dntzhang Tencent

License

This content is released under the MIT License.