omi

Open and modern framework for building user interfaces.

---

中文 | English

• 如果想体验一下Omi框架，可以访问 Omi Playground
• 如果想使用Omi框架或者开发完善Omi框架，可以访问 Omi使用文档
• 如果你想获得更佳的阅读体验，可以访问 Docs Website
• 如果你懒得搭建项目脚手架，可以试试 omi-cli
• 如果你有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 run dev                  //开发
$ npm run dist                 //部署发布

特性

• 超小的尺寸，7 kb (gzip)
• 良好的兼容性，支持IE8
• 完全面向对象的组件体系
• 局部CSS，HTML+ Scoped CSS + JS组成可复用的组件
• 更自由的更新，每个组件都有update方法，自由选择时机进行更新
• 模板引擎可替换，开发者可以重写Omi.template方法来使用任意模板引擎
• 提供了ES6+和ES5的两种开发方案供开发者自由选择

生态

• 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程序。

• [Hello World ES6+ ->在线试试]
• [Hello World ES5 ->在线试试]

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

中文 | English

• If you want to experience the Omi framework, you can visit Omi Playground
• 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
• If you are too lazy to build a project scaffolding, you can try omi-cli
• 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 run dev                  //develop
$ npm run dist                 //release

Fetures

• Super tiny size, 7 KB (gzip)
• Good compatibility, support IE8
• 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 : Omi /AlloyFinger integration.
• omi-transform : Omi /transformjs integration.
• omi-touch : Omi /AlloyTouch integration.
• omi-jquery-date-picker: Omi / JQuery Date Picker integration.

Install

$ npm install omi

Hello World

You can use webpack + babel，configure the 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]
• [Hello World ES5 ->Try it on Playground]

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

Contributors

name	avatars	company
Aresn		TalkingCoder
pasturn		Mars Holding
dntzhang		Tencent
xcatliu		Microsoft

License

This content is released under the MIT License.