awesome-cordova-plugins/README.md

[![Circle CI](https://circleci.com/gh/driftyco/ionic-native.svg?style=shield)](https://circleci.com/gh/driftyco/ionic-native) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
[![npm](https://img.shields.io/npm/l/express.svg)](https://www.npmjs.com/package/ionic-native)

[![NPM](https://nodei.co/npm/ionic-native.png?stars&downloads)](https://nodei.co/npm/ionic-native/)
[![NPM](https://nodei.co/npm-dl/ionic-native.png?months=6&height=2)](https://nodei.co/npm/ionic-native/)

# Ionic Native

Ionic Native is a curated set of wrappers for Cordova plugins that make adding any native functionality you need to your [Ionic 2](http://ionicframework.com/) mobile app easy.

### Documentation

For the full Ionic Native documentation, please visit [http://ionicframework.com/docs/v2/native/](http://ionicframework.com/docs/v2/native/).

### Promises and Observables

Ionic Native wraps plugin callbacks in a Promise or [Observable](https://gist.github.com/staltz/868e7e9bc2a7b8c1f754), providing a common interface for all plugins and ensuring that native events trigger change detection in Angular 2.

```typescript
import { Geolocation } from '@ionic-native/geolocation';
import { Platform } from 'ionic-angular';

@Component({ ... })
export class MyComponent {

  constructor(private geolocation: Geolocation, private platform: Platform) {
  
    platform.ready().then(() => {
    
      // get position
      geolocation.getCurrentPosition().then(pos => {
        
        console.log(`lat: ${pos.coords.latitude}, lon: ${pos.coords.longitude}`)
        
      });
        
        
      // watch position
      const watch = geolocation.watchPosition().subscribe(pos => {
      
        console.log(`lat: ${pos.coords.latitude}, lon: ${pos.coords.longitude}`)
      
      });
      
      // to stop watching
      watch.unsubscribe();
    
    });
  
  }

}
```

### Runtime Diagnostics

Spent way too long diagnosing an issue only to realize a plugin wasn't firing or installed? Ionic Native lets you know what the issue is and how you can resolve it.

![img](http://ionic-io-assets.s3.amazonaws.com/ionic-native-console.png)

## Installation

Run following commmand to install ionic-native in your project.
```
npm install ionic-native --save
```


## Plugin Missing?
Let us know or submit a PR! Take a look at [the Developer Guide](https://github.com/driftyco/ionic-native/blob/master/DEVELOPER.md) for more on how to contribute. :heart:


# Credits

Ibby Hadeed - [@ihadeed](http://github.com/ihadeed)

Tim Lancina - [@timlancina](http://twitter.com/timlancina)

Max Lynch - [@maxlynch](http://twitter.com/maxlynch)

Rob Wormald - [@robwormald](https://twitter.com/robwormald)
add shields 2016-03-15 02:15:01 +08:00			`[![Circle CI](https://circleci.com/gh/driftyco/ionic-native.svg?style=shield)](https://circleci.com/gh/driftyco/ionic-native) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)`
fix badges 2016-09-26 05:57:38 +08:00			`[![npm](https://img.shields.io/npm/l/express.svg)](https://www.npmjs.com/package/ionic-native)`
add shields 2016-03-15 02:15:01 +08:00
			`[![NPM](https://nodei.co/npm/ionic-native.png?stars&downloads)](https://nodei.co/npm/ionic-native/)`
fix badges 2016-09-26 05:58:32 +08:00			`[![NPM](https://nodei.co/npm-dl/ionic-native.png?months=6&height=2)](https://nodei.co/npm/ionic-native/)`
add shields 2016-03-15 02:15:01 +08:00
Ionic Native 2015-11-28 13:05:15 +08:00			`# Ionic Native`

chore(): update readme 2017-03-21 04:46:08 +08:00			`Ionic Native is a curated set of wrappers for Cordova plugins that make adding any native functionality you need to your [Ionic 2](http://ionicframework.com/) mobile app easy.`
docs(): update README 2016-02-19 01:54:23 +08:00
Update README.md 2016-05-10 00:01:51 +08:00			`### Documentation`

			`For the full Ionic Native documentation, please visit [http://ionicframework.com/docs/v2/native/](http://ionicframework.com/docs/v2/native/).`

docs(): update README 2016-02-19 01:54:23 +08:00			`### Promises and Observables`

			`Ionic Native wraps plugin callbacks in a Promise or [Observable](https://gist.github.com/staltz/868e7e9bc2a7b8c1f754), providing a common interface for all plugins and ensuring that native events trigger change detection in Angular 2.`

chore(): set code type to typescript 2017-03-21 04:46:29 +08:00			```typescript
chore(): update readme 2017-03-21 04:46:08 +08:00			`import { Geolocation } from '@ionic-native/geolocation';`
			`import { Platform } from 'ionic-angular';`

			`@Component({ ... })`
			`export class MyComponent {`

			`constructor(private geolocation: Geolocation, private platform: Platform) {`

			`platform.ready().then(() => {`

			`// get position`
			`geolocation.getCurrentPosition().then(pos => {`

			console.log(`lat: ${pos.coords.latitude}, lon: ${pos.coords.longitude}`)

note about ng1 observables 2016-08-02 03:25:55 +08:00			`});`
chore(): update readme 2017-03-21 04:46:08 +08:00

			`// watch position`
			`const watch = geolocation.watchPosition().subscribe(pos => {`

			console.log(`lat: ${pos.coords.latitude}, lon: ${pos.coords.longitude}`)

			`});`

			`// to stop watching`
			`watch.unsubscribe();`

note about ng1 observables 2016-08-02 03:25:55 +08:00			`});`
chore(): update readme 2017-03-21 04:46:08 +08:00
			`}`

			`}`
note about ng1 observables 2016-08-02 03:25:55 +08:00			```

docs(): update README 2016-02-19 01:54:23 +08:00			`### Runtime Diagnostics`

			`Spent way too long diagnosing an issue only to realize a plugin wasn't firing or installed? Ionic Native lets you know what the issue is and how you can resolve it.`

Update README.md 2016-07-27 02:34:53 +08:00			`![img](http://ionic-io-assets.s3.amazonaws.com/ionic-native-console.png)`

Update README.md 2016-02-27 01:31:21 +08:00			`## Installation`
Aww yis 2015-11-29 08:36:38 +08:00
note about ng1 observables 2016-08-02 03:25:55 +08:00			`Run following commmand to install ionic-native in your project.`
Update README.md 2016-02-26 21:02:07 +08:00			```
			`npm install ionic-native --save`
			```

Update README.md 2016-02-27 01:31:21 +08:00
			`## Plugin Missing?`
			`Let us know or submit a PR! Take a look at [the Developer Guide](https://github.com/driftyco/ionic-native/blob/master/DEVELOPER.md) for more on how to contribute. :heart:`


Aww yis 2015-11-29 08:36:38 +08:00			`# Credits`

legal name change 2017-01-24 11:22:19 +08:00			`Ibby Hadeed - [@ihadeed](http://github.com/ihadeed)`
Update README.md 2016-03-16 03:12:21 +08:00
Update README.md 2016-02-11 00:07:19 +08:00			`Tim Lancina - [@timlancina](http://twitter.com/timlancina)`

Aww yis 2015-11-29 08:36:38 +08:00			`Max Lynch - [@maxlynch](http://twitter.com/maxlynch)`

			`Rob Wormald - [@robwormald](https://twitter.com/robwormald)`