omi/README.md

6.6 KiB

Omi

Open and modern framework for building user interfaces.

Version Download PRs

中文README

Omi

  • 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    # 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 + babel, configure the babel-loader in the module settings of webpack, then 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.