mantoxing / omi

Open and Modern framework for building user Interfaces - 开放现代的Web组件化框架

Open and modern framework for building user interfaces.

中文README

Omi

• Use Omix if your like JSX or hyperscript
• Omi Cli and Cli Usage
• Omi Docs
• Omi Playground
• Omi Tutorial
• 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

• omi-router: Router for Omi.
• 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

CDN

• https://unpkg.com/[email protected]/dist/omi.min.js
• https://unpkg.com/[email protected]/dist/omi.js
• https://unpkg.com/[email protected]/dist/omi.art.min.js
• https://unpkg.com/[email protected]/dist/omi.art.js
• https://unpkg.com/[email protected]/dist/omi.lite.min.js
• https://unpkg.com/[email protected]/dist/omi.lite.js
• https://unpkg.com/[email protected]/dist/omi.mustache.min.js
• https://unpkg.com/[email protected]/dist/omi.mustache.js

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

Thanks to omi contributors

License

This content is released under the MIT License.