A6Brgeuka / ember-cordova

Ember Cordova

ember-cordova simplifies building Cordova and Crosswalk applications with Ember.js.

It includes a CLI for builds, hooks, device event bindings, and handles splash screens, icons and a growing number of supported Ember/Cordova plugin bindings.

1. Platforms & Requirements
2. Getting Started
3. Features and Documentation;
4. Upcoming Extensions;
5. Contributing;
6. Credits

It is a beta fork of ember-cli-cordova, but should have similar stability. It includes new features discussed below.

Platforms & Requirements

ember-cordova has been tested and works on Ember 1.13 & greater, including 2+.

When push comes to shove we are likely to only support Ember 2.4 or greater.

Before you can use this addon, you will need to have Cordova's CLI installed on your machine. If you do not already have it installed, you can install it with:

  npm install -g cordova

Getting Started

If you are migrating from ember-cli-cordova, read the migration guide.

  ember install ember-cordova

You can optionally pass name & cordovaid params, which will set the id & display name of your Cordova application. If none exist, your Ember Apps name will be used.

If you already have a Cordova project here it will not be overwritten.

1. Set your config.locationType to 'hash'.

2. Cordova requires relative asset paths so check that none of yours are absolute. For ember-cli v2.7.0 and newer, you'll want to remove the references to {{rootURL}} from the asset paths in app/index.html.

3. As a final step, add your desired platforms, e.g.:

ember cdv platform add ios
ember cdv platform add android
ember cdv platform add browser #experimental

Cordova working relies on the cordova.js script being injected. By default, this happens using ember cdv commands. Your vanilla ember build && ember s commands will not inject cordova.js by design.

A note on browser platform

Some cordova/phonegap plugins have browser fallbacks. For example phonegap-plugin-barcodescanner will ask you to manually type the barcode value. Using the browser platform, you'll be able to develop your cordova app as it was a regular ember app.

Features and Documentation

• CLI
• Cordova Service & Event Bindings
• Device:
• • Platform Service
• • Splash Screen Management
• • Keyboard
• Icon Management
• Hooks
• Live reload
• Available Plugins

Upcoming Extensions

We are working on four major items right now:

1. Improving test coverage;
2. Bindings to Cordova Plugins see plugins; and
3. Either having ember install ember-cordova-plugin-foo install both the ember addon & cordova plugin, or achieving the same through ember cdv:install foo.

Contributing

PRs are very welcome. You can read our style guides here.

If you are unsure about your contribution idea, please feel free to open an Issue for feedback.

Credits

ember-cordova is maintained by Isle of Code, and started as a fork of ember-cli-cordova.