Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/OnsenUI/OnsenUI

Mobile app development framework and SDK using HTML5 and JavaScript. Create beautiful and performant cross-platform mobile apps. Based on Web Components, and provides bindings for Angular 1, 2, React and Vue.js.
https://github.com/OnsenUI/OnsenUI

android angular cordova customelements html hybrid-apps ios javascript material monaca onsen-ui pwa react vue webcomponents

Last synced: 10 days ago
JSON representation

Mobile app development framework and SDK using HTML5 and JavaScript. Create beautiful and performant cross-platform mobile apps. Based on Web Components, and provides bindings for Angular 1, 2, React and Vue.js.

Awesome Lists containing this project

README 

        







  Circle CI

  NPM version

  CDNJS




# [Onsen UI](https://onsen.io/) - Cross-Platform Hybrid App and PWA Framework



Onsen UI is an open source framework that makes it easy to create native-feeling Progressive Web Apps (PWAs) and hybrid apps.



The core library is written in pure Javascript (on top of Web Components) and is framework agnostic, which means you can use it with your favorite framework and its tools. We provide some extra binding packages to make it easy to use Onsen UI's API with many popular frameworks:



  

    
React

    
Angular 2+


    
Vue


    
AngularJS 1.x


  



Some other frameworks are supported by __community__ packages (not tested or implemented by the core team): [Aurelia](https://www.npmjs.com/package/aurelia-onsenui), [EmberJS](https://www.npmjs.com/package/ember-onsenui).



Both flat (iOS) and Material (Android) designs are included. The components are optionally auto-styled based on the platform, which makes it possible to support both iOS and Android with the same source code.



## Getting started

We have several resources to help you get started creating hybrid apps and PWAs with Onsen UI:



* __The official docs__: We provide guides and references for all of the components and bindings, as well as how to publish your app. These are our _Getting Started_ guides:

  * [Core guide (no framework)](https://onsen.io/v2/guide)

  * [Vue guide](https://onsen.io/v2/guide/vue/)

  * [React guide](https://onsen.io/v2/guide/react/)

  * [Angular 2+ guide](https://onsen.io/v2/guide/angular2/)

  * [AngularJS 1.x guide](https://onsen.io/v2/guide/angular1/)

  * [jQuery guide](https://onsen.io/v2/guide/jquery/)

  * [Creating an Onsen UI hybrid app using Cordova](https://onsen.io/v2/guide/hybrid/cordova.html)

  * [Progressive Web Apps (PWAs) with Onsen UI](https://onsen.io/v2/guide/pwa/intro.html)

* __Components overview__: a [list of included CSS components](https://onsen.io/v2/docs/css.html) in both flat and Material Design. Note that these components are just pure and performant CSS without JavaScript behavior. Some extra details (such as dragging or ripple effect) are added by Onsen UI custom elements.

* __Playground__: an [interactive Onsen UI tutorial](https://onsen.io/playground/) where you can learn how to use Onsen UI and play around with the components.

* __Blog__: there are lots of great tutorials and guides published in our [official Onsen UI blog](https://onsen.io/blog/categories/tutorial.html) and we are adding new content regularly.

* __Support__: if you are having trouble using some component the best place to get help is the [Onsen UI Forum](https://community.onsen.io/) or the community-run [Discord Chat](https://discord.gg/JWhBbnE). We are also available to answer short questions on Twitter at [@Onsen_UI](https://twitter.com/Onsen_UI).



## Get Onsen UI



### __Download the latest released version__

We have a [distribution repository](https://github.com/OnsenUI/OnsenUI-dist/releases) with changelog. Onsen UI is also available in __npm__ and __jspm__. Example:



```bash

npm install onsenui

```



This downloads the core Onsen UI library. To install bindings, you can install `react-onsenui`, `vue-onsenui`, `ngx-onsenui` or `angularjs-onsenui`.



### __Download or request from a CDN__

You can also take the necessary files from a CDN. Some of the options are [unpkg](https://unpkg.com/onsenui/), [jsDelivr](https://www.jsdelivr.com/package/npm/onsenui) and [cdnjs](https://cdnjs.com/libraries/onsen).



### __Get the latest development build__

Optionally, you can download the [latest development build here](https://onsenui.github.io/latest-build). Be careful, usually everything there is already tested but it might be unstable sometimes.



## Examples with source code

There are lots of sample applications written using Onsen UI. __[Here are some examples](https://onsen.io/samples) with source code and tutorials__ to give you an idea of what kind of apps you can create.





  

  

  




## Onsen UI ecosystem

Because sometimes a UI framework may not be enough to make hybrid app development easy, Onsen UI comes with a __complete ecosystem__ of well integrated tools. Meet [__Monaca__](https://monaca.io/).






Developed by the Onsen UI team, __Monaca__ is a toolkit that makes hybrid mobile app development with __PhoneGap / Cordova__ simple and easy: Onsen UI Cordova templates, debugging suite, push notifications, remote build, back-end solutions, encryption, version control, continuous integration and more. Furthermore, it provides multiple development environments with everything already configured and ready to go:





  Cloud IDE -

  Command Line Interface -

  Localkit GUI




Example with __CLI__:



```

$ [sudo] npm -g install monaca

$ monaca create helloworld # And choose the starter template

$ monaca preview # Preview on the browser

$ monaca debug # Preview on a real device

$ monaca remote build --browser # Production build on the cloud

```



See the [Onsen UI Getting Started Page](http://onsen.io/v2/guide/) for more information.



## Browser Support

Onsen UI is tested to work with the following browsers and mobile OS.



 * Android 4.4.4+

 * iOS 9+

 * Chrome

 * Safari



## Contribution

We welcome your contribution, no matter how big or small! Please have a look at the [contribution guide](https://github.com/OnsenUI/OnsenUI/blob/master/CONTRIBUTING.md) for details about project structure, development environment, test suite, code style, etc. All the version updates are mentioned in the [changelog](https://github.com/OnsenUI/OnsenUI/blob/master/CHANGELOG.md).