[](https://circleci.com/gh/OnsenUI/OnsenUI)
The best place to start with Onsen UI is our Getting Started page.
Built on top of AngularJS and Topcoat, Onsen UI is open source, free and open for all. Onsen UI is designed and implemented to deliver unprecedented user experience for your apps. Applications can be built using HTML tags web developers already know and love. We love AngularJS and all the power it brings. But we've also added support for JQuery so developers less familiar with AngularJS can take advantage of Onsen UI, too.
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.
Onsen UI is tested with the following browsers and mobile OS.
Click here to see Onsen UI in action!
See the Onsen UI Getting Started page.
See the Onsen UI Getting Started Page and scroll down to the Using Onsen UI with Monaca section.
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.
$ git clone https://github.com/OnsenUI/OnsenUI.git
$ cd OnsenUI
$ npm install
$ [sudo] npm install -g gulp
$ gulp build
The files will be built and copied into build, demo/lib/onsen/, and app/lib/onsen/ folder.
$ npm install
$ [sudo] npm install -g gulp
$ gulp serve
Onsen UI has end-to-end testing using Protractor. Use the following command to run the tests:
$ npm install
$ gulp 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 test --specs test/e2e/lazyRepeat/scenarios.js
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 folder. You will see the instruction on how to run the project there.
See the current Onsen UI docs.
Run gulp task to develop Onsen UI itself with livereload.
gulp serve
Access http://0.0.0.0:8000/demo/index.html and your code changes will be reloaded.
Please see the following file for information about upcoming releases and what will be included.
Please tell us if you have any suggestions for features that you would like to see included.
We will happily accept contributions to Onsen UI. It can be both fixes for bugs or typos or even new features that extend Onsen UI.
The basic workflow when making contributions is the following:
After you've made a pull request we will review it. If everything is fine and we like the change the contribution will be pulled into the main Onsen UI repository. In the case where there are some issues with the code or we disagree with how it's been implemented we will describe the issues in the comments so they can be corrected.
Please see the full list of contributors.
The following is an overview of how the source code is structures to give contributors an idea of where to look when making changes.
Please don't make changes directly to generated files like onsenui.js and onsenui.css!
Components will generally have one "view" file and one "directive" file.
[/framework/views/](/OnsenUI/OnsenUI/tree/master/framework/views). The view file contains the logic of the component. This is often the place to look when making additions or fixes to a component.[/framework/directives/](/OnsenUI/OnsenUI/tree/master/framework/directives) directory. These files define the AngularJS directives.Most of the style is defined in a separate project called Onsen CSS Components which is located here.
Changes to the style should be made by editing the files in this directory. These files will compile into the onsen-css-components.css file.
There is also a stylesheet that is specific to the custom elements called onsenui.css, this file is compiled from the files in this directory.
There are some things to keep in mind when making code contributions to Onsen UI. The code must adhere to the general code style used.
Here is a list of some rules that should be followed:
var x = 1+1 is incorrect, it should be written as: var x = 1 + 1.if, while, for, etc. should be separated from the paranthesis with a space.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.
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).
FAQs
HTML5 Mobile Framework & UI Components
The npm package onsenui receives a total of 17,070 weekly downloads. As such, onsenui popularity was classified as popular.
We found that onsenui demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 9 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.