Onsen UI

The best place to start with Onsen UI is our Getting Started page.

We just released the RC of Onsen UI 2. The new version includes Material Design, React Components and much more. Check out all the new features here!

Onsen UI is open source, free and open for all. Onsen UI is designed and implemented to deliver unprecedented user interface and user experience for your mobile and hybrid apps. Onsen UI is built on top of Web Components so applications can be built using HTML tags web developers already know and love.

Onsen UI is framework agnostic. This means that it can be used with whatever front-end framework you prefer. However, Onsen UI also provides a binding library for AngularJS which makes it easy to integrate our custom tags in AngularJS apps.

Onsen UI also includes Onsen CSS Components, a free resource of UI templates with "theme roller" functionality. Developers can pick and choose, grab the code they need, and they're off and running. And they can create their own templates and submit to Onsen UI to be included with other templates available.

Our Monaca IDE fully supports Onsen UI plugin.

Browser Support

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

Android 4.0.2+
iOS7+
Windows Phone 8.1+
Google Chrome
Safari

For versions earlier than 1.3.0, iOS 8.4+ is not supported. In order to use these versions with iOS 8.4+ the included FastClick library must be manually updated to the latest version.

Demo

Click here to see Onsen UI in action!

What's Included

Material Design: For Native-like Android UI
Web Components: for Custom Elements
AngularJS module: bindings are backwards compatible with Onsen UI 1

Getting Started Using Templates

See the Onsen UI Getting Started page.

Getting Started Using Monaca

See the Onsen UI Getting Started Page and scroll down to the Using Onsen UI with Monaca section.

Download Onsen UI

Using bower:

$ bower install onsenui

Using npm:

$ npm install onsenui

The distribution repository is located here.

Download the latest build

A new build is generated every time the code changes. It can be downloaded on this page.

Please use this with caution. However, we are very grateful if people try it out so we can find bugs and things to improve before the sharp releases.

How to build

Clone this repository

$ git clone https://github.com/OnsenUI/OnsenUI.git

Open the terminal from OnsenUI directory

$ cd OnsenUI

Install dependencies using npm

$ npm install

Install gulp (globally)

$ [sudo] npm install -g gulp

Type gulp to start building

$ gulp build

The files will be built and copied into build and examples/lib/onsen/ folder.

Running Examples

$ npm install
$ [sudo] npm install -g gulp
$ gulp serve

Then navigate your browser to http://0.0.0.0:3000/examples/index.html

Running the test suite

Onsen UI has unit tests for the Web Components as well as end-to-end testing of the AngularJS directives using Protractor.

Use the following commands to run the unit tests:

$ npm install
$ gulp core-test

or these commands for the protractor tests:

$ npm install
$ gulp e2e-test

It will take some time the because it will download a stand-alone Selenium Server and a Chrome webdriver the first time it's executed.

To run a single test or a group of tests use the --specs parameter and provide a comma-separated list of spec files:

$ gulp e2e-test --specs test/e2e/lazyRepeat/scenarios.js

In order to run both the unit tests and the end-to-end tests use the following command:

$ gulp test

Developing your app

Our Monaca IDE makes it super easy to create Onsen UI project, but if you want to use other IDEs, we provide project templates for you in the project-templates repository. You will see the instruction on how to run the project there.

Documentation

See the current Onsen UI docs.

Developing Onsen UI

Run gulp task to develop Onsen UI itself with livereload.

gulp serve

Access http://0.0.0.0:3000/examples/index.html and your code changes will be reloaded.

Contributors

Please see the full list of contributors.

How to contribute

Please see our document on contributing.

Getting support

If anything about Onsen UI is unclear, please ask a question on Stackoverflow, and tag it "onsen-ui". An Onsen UI support engineer will answer it.

You can also join our Gitter channel if you want to talk about Onsen UI.

If you have any requests or comments regarding the development of Onsen UI, please feel free to direct them to the Twitter account (@Onsen_UI).

meshileya / OnsenUI