146 lines
8.5 KiB
Markdown
146 lines
8.5 KiB
Markdown
<p align="center">
|
||
<a href ="##"><img alt="Omi" src="http://images2015.cnblogs.com/blog/105416/201701/105416-20170120114244046-622856943.png"></a>
|
||
</p>
|
||
<p align="center">
|
||
Open and modern framework for building user interfaces.
|
||
</p>
|
||
<p align="center">
|
||
<a href="https://travis-ci.org/AlloyTeam/omi"><img src="https://travis-ci.org/AlloyTeam/omi.svg"></a>
|
||
</p>
|
||
|
||
---
|
||
|
||
## English | [中文](https://github.com/AlloyTeam/omi#中文--english)
|
||
|
||
* If you want to experience the Omi framework, you can visit [Omi Playground](https://alloyteam.github.io/omi/example/playground/)
|
||
* If you want to use the Omi framework or develop and improve omi framework, please read [the Omi documentation](https://github.com/AlloyTeam/omi/tree/master/docs#omi使用文档)
|
||
* If you want to get a better reading experience of the documents, you can visit [Docs Website](https://alloyteam.github.io/omi/website/docs.html)
|
||
* If you are too lazy to build a project scaffolding, you can try [omi-cli](https://github.com/AlloyTeam/omi/tree/master/cli)
|
||
* If you have Any problems，please [New issue](https://github.com/AlloyTeam/omi/issues/new)
|
||
* If you want to be more convenient on the exchange of all Omi can join the QQ Omi exchange group (256426170)
|
||
|
||
## omi-cli
|
||
|
||
``` js
|
||
$ 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 run dev //develop
|
||
$ npm run dist //release
|
||
```
|
||
|
||
## 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
|
||
|
||
* [omi-finger](https://github.com/AlloyTeam/omi/tree/master/plugins/omi-finger) : Omi /[AlloyFinger](https://github.com/AlloyTeam/AlloyFinger) integration.
|
||
* [omi-transform](https://github.com/AlloyTeam/omi/tree/master/plugins/omi-transform) : Omi /[transformjs](https://alloyteam.github.io/AlloyTouch/transformjs/) integration.
|
||
* [omi-touch](https://github.com/AlloyTeam/omi/tree/master/plugins/omi-touch) : Omi /[AlloyTouch](https://github.com/AlloyTeam/AlloyTouch) integration.
|
||
* [omi-jquery-date-picker](https://github.com/AlloyTeam/omi/tree/master/plugins/omi-jquery-date-picker): Omi / JQuery Date Picker integration.
|
||
|
||
## Install
|
||
|
||
``` js
|
||
$ npm install omi
|
||
```
|
||
|
||
## Hello World
|
||
|
||
|
||
You can use [webpack](https://webpack.github.io/) + [babel](http://babeljs.io/)，configure the [babel-loader](https://github.com/babel/babel-loader) in the module settings of webpack，then you can use ES6+ to write your web program.
|
||
|
||
* [[Hello World ES6+ ->Try it on Playground]](http://alloyteam.github.io/omi/website/redirect.html?type=hello_nest)
|
||
* [[Hello World ES5 ->Try it on Playground]](http://alloyteam.github.io/omi/website/redirect.html?type=hello_es5)
|
||
|
||
if using 'omi.lite.js' (without [mustache.js](https://github.com/janl/mustache.js))，you can [use the ${this.data.name} way](http://alloyteam.github.io/omi/website/redirect.html?type=without_tpl)。
|
||
|
||
## CDN
|
||
|
||
* [https://unpkg.com/omi@1.0.3/dist/omi.min.js](https://unpkg.com/omi@1.0.3/dist/omi.min.js)
|
||
* [https://unpkg.com/omi@1.0.3/dist/omi.js](https://unpkg.com/omi@1.0.3/dist/omi.js)
|
||
* [https://unpkg.com/omi@1.0.3/dist/omi.lite.min.js](https://unpkg.com/omi@1.0.3/dist/omi.lite.min.js)
|
||
* [https://unpkg.com/omi@1.0.3/dist/omi.lite.js](https://unpkg.com/omi@1.0.3/dist/omi.lite.js)
|
||
|
||
## 中文 | [English](https://github.com/AlloyTeam/omi#english--中文)
|
||
|
||
* 如果想体验一下Omi框架，可以访问 [Omi Playground](https://alloyteam.github.io/omi/example/playground/)
|
||
* 如果想使用Omi框架或者开发完善Omi框架，可以访问 [Omi使用文档](https://github.com/AlloyTeam/omi/tree/master/docs#omi使用文档)
|
||
* 如果你想获得更佳的阅读体验，可以访问 [Docs Website](https://alloyteam.github.io/omi/website/docs.html)
|
||
* 如果你懒得搭建项目脚手架，可以试试 [omi-cli](https://github.com/AlloyTeam/omi/tree/master/cli)
|
||
* 如果你有Omi相关的问题可以 [New issue](https://github.com/AlloyTeam/omi/issues/new)
|
||
* 如果想更加方便的交流关于Omi的一切可以加入QQ的Omi交流群(256426170)
|
||
|
||
<img alt="Omi" src="http://alloyteam.github.io/omi/asset/omi_group.png">
|
||
|
||
## 命令行
|
||
|
||
``` js
|
||
$ npm install omi-cli -g //安装cli
|
||
$ omi init your_project_name //初始化项目，你也可以在一个空的文件夹下执行 omi init
|
||
$ cd your_project_name //如果你是在空文件夹下执行的 omi init。请无视这条命令
|
||
$ npm run dev //开发
|
||
$ npm run dist //部署发布
|
||
```
|
||
|
||
## 特性
|
||
|
||
* 超小的尺寸，7 kb (gzip)
|
||
* 良好的兼容性，支持IE8 （请自行引用es5-shim或es5-sham）
|
||
* 完全面向对象的组件体系
|
||
* 局部CSS，HTML+ Scoped CSS + JS组成可复用的组件
|
||
* 更自由的更新，每个组件都有update方法，自由选择时机进行更新
|
||
* 模板引擎可替换，开发者可以重写Omi.template方法来使用任意模板引擎
|
||
* 提供了ES6+和ES5的两种开发方案供开发者自由选择
|
||
|
||
## 生态
|
||
|
||
* [omi-finger](https://github.com/AlloyTeam/omi/tree/master/plugins/omi-finger) Omi的[AlloyFinger](https://github.com/AlloyTeam/AlloyFinger)插件，支持各种触摸事件和手势
|
||
* [omi-transform](https://github.com/AlloyTeam/omi/tree/master/plugins/omi-transform) Omi的[transformjs](https://alloyteam.github.io/AlloyTouch/transformjs/)插件，快速方便地设置DOM的CSS3 Transform属性
|
||
* [omi-touch](https://github.com/AlloyTeam/omi/tree/master/plugins/omi-touch) Omi的[AlloyTouch](https://github.com/AlloyTeam/AlloyTouch)插件，Omi项目的触摸运动解决方案（支持触摸滚动、旋转、翻页、选择等等）
|
||
* [omi-jquery-date-picker](https://github.com/AlloyTeam/omi/tree/master/plugins/omi-jquery-date-picker) Omi的时间选择插件，支持各种时间或者时间区域选择
|
||
|
||
## 通过npm安装
|
||
|
||
``` js
|
||
$ npm install omi
|
||
```
|
||
|
||
## Hello World
|
||
|
||
你可以使用 [webpack](https://webpack.github.io/) + [babel](http://babeljs.io/)，在webpack配置的module设置[babel-loader](https://github.com/babel/babel-loader)，立马就能使用ES6+来编写你的web程序。
|
||
|
||
* [[Hello World ES6+ ->在线试试]](http://alloyteam.github.io/omi/website/redirect.html?type=hello_nest)
|
||
* [[Hello World ES5 ->在线试试]](http://alloyteam.github.io/omi/website/redirect.html?type=hello_es5)
|
||
|
||
如果使用omi.lite.js版本(不包含[mustache.js](https://github.com/janl/mustache.js)模板引擎)的话，也可以[使用 ${this.data.name} 的方式](http://alloyteam.github.io/omi/website/redirect.html?type=without_tpl)。
|
||
|
||
## CDN
|
||
|
||
* [https://unpkg.com/omi@1.0.3/dist/omi.min.js](https://unpkg.com/omi@1.0.3/dist/omi.min.js)
|
||
* [https://unpkg.com/omi@1.0.3/dist/omi.js](https://unpkg.com/omi@1.0.3/dist/omi.js)
|
||
* [https://unpkg.com/omi@1.0.3/dist/omi.lite.min.js](https://unpkg.com/omi@1.0.3/dist/omi.lite.min.js)
|
||
* [https://unpkg.com/omi@1.0.3/dist/omi.lite.js](https://unpkg.com/omi@1.0.3/dist/omi.lite.js)
|
||
|
||
## Contributors
|
||
|
||
|name |avatars |company |
|
||
|---|---|---|
|
||
| [CodeFalling](https://github.com/CodeFalling) |  | alibaba |
|
||
| [abell123456](https://github.com/abell123456) |  | alibaba |
|
||
| [Aresn](https://github.com/icarusion) |  | TalkingCoder |
|
||
| [pasturn](https://github.com/pasturn) |  | Mars Holding |
|
||
| [vorshen](https://github.com/vorshen) |  | Tencent |
|
||
| [xcatliu](https://github.com/xcatliu) |  | Microsoft |
|
||
| [dntzhang](https://github.com/dntzhang) |  | Tencent |
|
||
|
||
# License
|
||
This content is released under the [MIT](http://opensource.org/licenses/MIT) License.
|