-
Notifications
You must be signed in to change notification settings - Fork 85
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
235 changed files
with
127,888 additions
and
14 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
Copyright 2013-2017 ASIAL CORPORATION | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,110 @@ | ||
# OnsenUI-dist | ||
Bower and NPM distribution repository for Onsen UI. | ||
|
||
## Download Onsen UI | ||
<p align="center"><a href="https://onsen.io/" target="_blank"><img width="140" src="https://onsenui.github.io/art/logos/onsenui-logo-1.png"></a></p> | ||
|
||
Using bower: | ||
<p align="center"> | ||
<a href="https://community.onsen.io/"><img src="https://img.shields.io/badge/forum-onsen--ui-FF412D.svg" alt="Forum"></a> | ||
<a href="https://github.com/OnsenUI/OnsenUI/blob/master/core/src/onsenui.d.ts"><img src="http://definitelytyped.org/badges/standard.svg" alt="TypeScript definitions"></a> | ||
<br> | ||
<a href="https://circleci.com/gh/OnsenUI/OnsenUI"><img src="https://circleci.com/gh/OnsenUI/OnsenUI.svg?style=shield" alt="Circle CI"></a> | ||
<a href="https://badge.fury.io/js/onsenui"><img src="https://badge.fury.io/js/onsenui.svg" alt="NPM version"></a> | ||
<a href="https://cdnjs.com/libraries/onsen"><img src="https://img.shields.io/cdnjs/v/onsen.svg" alt="CDNJS"></a> | ||
</p> | ||
|
||
```bash | ||
$ bower install onsenui | ||
``` | ||
# [Onsen UI](https://onsen.io/) - Cross-Platform Hybrid App and PWA Framework | ||
|
||
Onsen UI is an <strong>open source</strong> framework that makes it easy to create native-feeling Progressive Web Apps (PWAs) and hybrid apps. | ||
|
||
The core library is written in <strong>pure Javascript</strong> (on top of <a href="http://webcomponents.org/">Web Components</a>) and is <strong>framework agnostic</strong>, 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: | ||
|
||
<table> | ||
<tbody><tr> | ||
<td align="center" width="150"><a href="https://onsen.io/react"><img src="https://onsen.io/images/common/icn_react_top.svg" height="40"><br><strong>React</strong></a></td> | ||
<td align="center" width="150"><a href="https://onsen.io/angular2"><img src="https://onsen.io/images/common/icn_angular2_top.svg" height="40"><br><strong>Angular 2+</strong></a><br></td> | ||
<td align="center" width="150"><a href="https://onsen.io/vue"><img src="https://onsen.io/images/common/icn_vuejs_top.svg" height="40"><br><strong>Vue</strong></a><br></td> | ||
<td align="center" width="150"><a href="https://onsen.io/v2/docs/guide/angular1/index.html"><img src="https://onsen.io/images/common/icn_angular1_top.svg" height="40"><br><strong>AngularJS 1.x</strong></a><br></td> | ||
</tr></tbody> | ||
</table> | ||
|
||
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 <strong>flat (iOS) and Material (Android) designs</strong> are included. The components are optionally auto-styled based on the platform, which makes it possible to support both iOS and Android with the <strong>same source code</strong>. | ||
|
||
Using npm: | ||
|
||
## 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__, __bower__ and __jspm__. Example: | ||
|
||
```bash | ||
$ npm install onsenui | ||
npm install onsenui | ||
``` | ||
|
||
## How to tag a new release | ||
This downloads the core Onsen UI library. To install bindings, you can install `react-onsenui`, `vue-onsenui`, `ngx-onsenui` or `angularjs-onsenui`. | ||
|
||
These releases are generated by [dist-release.sh](https://github.com/OnsenUI/OnsenUI/blob/master/scripts/dist-release.sh) script. Once the files are modified and ready to be relased simply run the script from OnsenUI directory: | ||
### __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). | ||
|
||
```bash | ||
./dist-release.sh [no-build] | ||
### __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. | ||
|
||
<p align="center"> | ||
<a href="https://argelius.github.io/angular2-onsenui-pokedex/" target="_blank"><img src="https://onsen.io/images/samples/pokedex-pikachu.png"></a> | ||
<a href="http://argelius.github.io/react-onsenui-redux-weather/demo.html" target="_blank"><img src="https://onsen.io/images/samples/react-redux-weather.png"></a> | ||
<a href="https://frandiox.github.io/OnsenUI-YouTube" target="_blank"><img src="https://onsen.io/images/samples/youtube.png"></a> | ||
</p> | ||
|
||
## 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/). | ||
|
||
<p align="center"><a href="https://monaca.io" target="_blank"><img width="300"src="https://onsenui.github.io/art/logos/monaca-logo-2.png"></a></p> | ||
|
||
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: | ||
|
||
<p align="center"> | ||
<a href="https://monaca.io/cloud.html"><strong>Cloud IDE</strong></a> - | ||
<a href="https://monaca.io/cli.html"><strong>Command Line Interface</strong></a> - | ||
<a href="https://monaca.io/localkit.html"><strong>Localkit GUI</strong></a> | ||
</p> | ||
|
||
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 # Production build on the cloud | ||
``` | ||
Add `no-build` option to skip `gulp build` OnsenUI in case it's already built. This script will install required dependencies, build css-components + OnsenUI and upload a new tag to OnsenUI-dist repository using the version listed in `package.json`. | ||
|
||
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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
{ | ||
"name": "onsenui", | ||
"homepage": "https://onsen.io", | ||
"authors": [ | ||
"Kruy Vanna <[email protected]>", | ||
"Mitsunori KUBOTA <[email protected]>" | ||
], | ||
"description": "Web Component inspired HTML5 UI framework for building modern mobile application", | ||
"main": [ | ||
"js/onsenui.js", | ||
"css/onsenui.css", | ||
"css/onsen-css-components.css" | ||
], | ||
"keywords": [ | ||
"onsenui", | ||
"angular", | ||
"html5", | ||
"cordova", | ||
"phonegap", | ||
"web", | ||
"component", | ||
"monaca" | ||
], | ||
"dependencies": {}, | ||
"license": "Apache License, Version 2.0" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Onsen CSS Components | ||
|
||
Onsen CSS Components is CSS components for Cordova Apps. | ||
|
||
![Screenshot](./misc/screenshot-01.png) | ||
![Screenshot](./misc/screenshot-02.png) | ||
|
||
## How to Build | ||
|
||
This CSS components is built by PostCSS + cssnext. You can build with following commands. | ||
|
||
``` | ||
$ yarn install --pure-lockfile | ||
$ yarn run build | ||
``` | ||
|
||
## How to Customize CSS Components | ||
|
||
Execute the following command. | ||
|
||
``` | ||
$ yarn install --pure-lockfile | ||
$ yarn run serve | ||
``` | ||
|
||
When you open `http://localhost:4321/` in the browser, a preview of the CSS components is displayed. | ||
|
||
When you edit the cssnext files under the `src` directory, the cssnext files is automatically built into the CSS and the browser is reloaded. The built CSS file is located in `./build/onsen-css-components.css`. | ||
|
||
To customize theme colors, you can edit `./src/theme.css`. This file contains CSS variables for the theme colors. | ||
|
||
If you want to customize components' details, you can edit `./src/components/*.css`. These files contain actual rules for all CSS components. But these files may be changed significantly by minor version release. | ||
|
Oops, something went wrong.