github/awesome-cordova-plugins
3
0
Fork 1
mirror of https://github.com/danielsogl/awesome-cordova-plugins.git synced 2026-05-02 00:07:23 +08:00
Code Issues Projects Releases Wiki Activity

feat!: replace dgeni/gulp with TypeDoc for README generation

Browse Source 
Replace the legacy dgeni/gulp documentation pipeline with TypeDoc
and typedoc-plugin-markdown. Generates plugin README files with
extracted @Plugin() decorator metadata. Register custom JSDoc tags
used by plugin source files.
This commit is contained in:
Daniel Sogl
2026-03-21 15:10:30 -07:00
parent a5e3ccd185
commit 76b4e03d04
283 changed files with 1249 additions and 1704 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/plugins/abbyy-rtr/README.md
+1 -3
View File
@@ -15,7 +15,5 @@ ABBYY Real-Time Recognition SDK (RTR SDK) in apps.
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/action-sheet/README.md
+4 -6
View File
@@ -16,10 +16,8 @@ Requires Cordova plugin: `cordova-plugin-actionsheet`. For more info, please see
## Supported platforms
- Android
- Browser
- iOS
- Windows
- Windows Phone 8
- Browser
- iOS
- Windows
- Windows Phone 8
docs/plugins/adjust/README.md
+5 -5
View File
@@ -1,5 +1,7 @@
# AdjustThirdPartySharing
ova plugin add com.adjust.sdk
# Adjust
```
$ ionic cordova plugin add com.adjust.sdk
$ npm install @awesome-cordova-plugins/adjust
```
@@ -14,7 +16,5 @@ Requires Cordova plugin: `com.adjust.sdk`. For more info, please see the [Adjust
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/admob-plus/README.md
+3 -11
View File
@@ -1,4 +1,4 @@
# RewardVideo
# AdMob
```
$ ionic cordova plugin add cordova-admob-plus
@@ -7,18 +7,10 @@ $ npm install @awesome-cordova-plugins/admob-plus
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/admob-plus/)
Plugin Repo: []()
github.com/admob-plus/admob-plus](https://github.com/admob-plus/admob-plus)
AdMob Plus is the successor of cordova-plugin-admob-free, which provides a cleaner API and build with modern tools.
Plugin Repo: [https://github.com/admob-plus/admob-plus](https://github.com/admob-plus/admob-plus)
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/admob-pro/README.md
+2 -4
View File
@@ -16,8 +16,6 @@ IMPORTANT NOTICE: this plugin takes a percentage out of your earnings if you pro
## Supported platforms
- Android
- iOS
- Windows Phone 8
- iOS
- Windows Phone 8
docs/plugins/admob/README.md
+2 -4
View File
@@ -21,8 +21,6 @@ Supports:**
## Supported platforms
- Android
- iOS
- Browser
- iOS
- Browser
docs/plugins/advanced-image-picker/README.md
+1 -3
View File
@@ -14,7 +14,5 @@ This Cordova Plugin is for a better (multiple) ImagePicker with more options.
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/aes-256/README.md
+1 -3
View File
@@ -16,7 +16,5 @@ The encryption and decryption are performed on the device native layer so that t
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/airship/README.md
+18
View File
@@ -0,0 +1,18 @@
# Airship
```
$ ionic cordova plugin add @ua/cordova-airship
$ npm install @awesome-cordova-plugins/airship
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/airship/)
Plugin Repo: [https://www.npmjs.com/package/@ua/cordova-airship](https://www.npmjs.com/package/@ua/cordova-airship)
This plugin does something
## Supported platforms
- Android
- iOS
docs/plugins/all-in-one-sdk/README.md
+1 -3
View File
@@ -17,7 +17,5 @@ For more information about Paytm All-in-One SDK, please visit https://developer.
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/analytics-firebase/README.md
+1 -3
View File
@@ -14,7 +14,5 @@ Google Analytics Firebase plugin for Ionic Native apps.
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/android-exoplayer/README.md
-2
View File
@@ -16,6 +16,4 @@ https://github.com/google/ExoPlayer
## Supported platforms
- Android
docs/plugins/android-full-screen/README.md
-2
View File
@@ -16,6 +16,4 @@ In Android 4.4+, however, you can now enter true full screen, fully interactive
## Supported platforms
- Android
docs/plugins/android-notch/README.md
-2
View File
@@ -16,6 +16,4 @@ This plugin works on all android versions, but we can only detect notches starti
## Supported platforms
- Android
docs/plugins/android-permissions/README.md
-2
View File
@@ -16,6 +16,4 @@ You can find all permissions here: https://developer.android.com/reference/andro
## Supported platforms
- Android
docs/plugins/anyline/README.md
+1 -3
View File
@@ -14,7 +14,5 @@ Anyline provides an easy-to-use SDK for applications to enable Optical Character
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/app-availability/README.md
+1 -3
View File
@@ -16,7 +16,5 @@ Requires Cordova plugin: cordova-plugin-appavailability. For more info, please s
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/app-center-analytics/README.md
+1 -3
View File
@@ -19,7 +19,5 @@ For more info, please see https://docs.microsoft.com/en-us/appcenter/sdk/analyti
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/app-center-crashes/README.md
+1 -3
View File
@@ -19,7 +19,5 @@ For more info, please see https://docs.microsoft.com/en-us/appcenter/sdk/crashes
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/app-center-low-memory/README.md
+1 -3
View File
@@ -15,7 +15,5 @@ For more info, please see: https://github.com/Microsoft/appcenter-sdk-cordova/tr
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/app-center-push/README.md
+1 -3
View File
@@ -14,7 +14,5 @@ For more info, please see https://docs.microsoft.com/en-us/appcenter/sdk/push/co
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/app-center-shared/README.md
+1 -3
View File
@@ -16,7 +16,5 @@ For more info, please see https://docs.microsoft.com/en-us/appcenter/sdk/other-a
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/app-preferences/README.md
+6 -8
View File
@@ -14,12 +14,10 @@ This plugin allows you to read and write app preferences
## Supported platforms
- Android
- BlackBerry 10
- Browser
- iOS
- macOS
- Windows 8
- Windows Phone
- BlackBerry 10
- Browser
- iOS
- macOS
- Windows 8
- Windows Phone
docs/plugins/app-rate/README.md
+3 -5
View File
@@ -16,9 +16,7 @@ Requires Cordova plugin: cordova-plugin-apprate. For more info, please see the [
## Supported platforms
- Android
- BlackBerry 10
- iOS
- Windows
- BlackBerry 10
- iOS
- Windows
docs/plugins/app-review/README.md
+1 -3
View File
@@ -14,7 +14,5 @@ Cordova plugin to review app
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/app-version/README.md
+2 -4
View File
@@ -16,8 +16,6 @@ Requires Cordova plugin: `cordova-plugin-app-version`. For more info, please see
## Supported platforms
- Android
- iOS
- Windows
- iOS
- Windows
docs/plugins/apple-wallet/README.md
-2
View File
@@ -14,6 +14,4 @@ A Cordova plugin that enables users from Add Payment Cards to their Apple Wallet
## Supported platforms
- iOS
docs/plugins/applovin/README.md
+1 -3
View File
@@ -14,7 +14,5 @@ This plugin allows you to easily configure, integrate and interact with Applovin
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/approov-advanced-http/README.md
+3 -5
View File
@@ -1,13 +1,13 @@
# HTTP
```
$ ionic cordova plugin add cordova-approov-advanced-http
$ ionic cordova plugin add @approov/cordova-plugin-advanced-http
$ npm install @awesome-cordova-plugins/approov-advanced-http
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/approov-advanced-http/)
Plugin Repo: [https://github.com/approov/quickstart-ionic-advancedhttp](https://github.com/approov/quickstart-ionic-advancedhttp)
Plugin Repo: [https://github.com/approov/quickstart-cordova-advancedhttp](https://github.com/approov/quickstart-cordova-advancedhttp)
Cordova / Phonegap plugin for communicating with HTTP servers. Supports iOS and Android.
@@ -22,7 +22,5 @@ we have only added approov functionality on top of it. All credit goes to the ac
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/appsflyer/README.md
+1 -3
View File
@@ -14,7 +14,5 @@ Appsflyer Cordova SDK support for Attribution
## Supported platforms
- iOS
- Android
- Android
docs/plugins/audio-management/README.md
+18
View File
@@ -0,0 +1,18 @@
# Audio Management
```
$ ionic cordova plugin add clovelced-plugin-audiomanagement
$ npm install @awesome-cordova-plugins/audio-management
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/audio-management/)
Plugin Repo: [https://github.com/clovelCed/cordova-plugin-audiomanagement](https://github.com/clovelCed/cordova-plugin-audiomanagement)
A Cordova plugin to manage volume of audio streams for: ring, music, notification and system. Possible
ringer values for those streams are: silent, vibrate and normal.
## Supported platforms
- Android
docs/plugins/background-fetch/README.md
-2
View File
@@ -16,6 +16,4 @@ For more detail, please see https://github.com/transistorsoft/cordova-plugin-bac
## Supported platforms
- iOS
docs/plugins/background-mode/README.md
+4 -6
View File
@@ -15,10 +15,8 @@ Requires Cordova plugin: cordova-plugin-background-mode. For more info about plu
## Supported platforms
- AmazonFire OS
- Android
- Browser
- iOS
- Windows
- Android
- Browser
- iOS
- Windows
docs/plugins/background-upload/README.md
+1 -3
View File
@@ -14,7 +14,5 @@ This plugin does something
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/badge/README.md
+3 -5
View File
@@ -18,9 +18,7 @@ Android Note: Badges have historically only been a feature implemented by third
## Supported platforms
- Android
- Browser
- iOS
- Windows
- Browser
- iOS
- Windows
docs/plugins/barcode-scanner/README.md
+4 -6
View File
@@ -16,10 +16,8 @@ Requires Cordova plugin: `phonegap-plugin-barcodescanner`. For more info, please
## Supported platforms
- Android
- BlackBerry 10
- Browser
- iOS
- Windows
- BlackBerry 10
- Browser
- iOS
- Windows
docs/plugins/barkoder/README.md
+16
View File
@@ -0,0 +1,16 @@
# Barkoder
```
$ ionic cordova plugin add barkoder-cordova
$ npm install @awesome-cordova-plugins/barkoder
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/barkoder/)
The barKoder Barcode Scanner SDK cordova plugin grants an easy to use solution with a great and completely customizable interface that can be instantly integrated in both iOS and Android apps.
## Supported platforms
- Android
- iOS
docs/plugins/battery-status/README.md
+3 -5
View File
@@ -14,9 +14,7 @@ Requires Cordova plugin: cordova-plugin-batterystatus. For more info, please see
## Supported platforms
- iOS
- Android
- Windows
- Browser
- Android
- Windows
- Browser
docs/plugins/biocatch/README.md
+1 -3
View File
@@ -14,7 +14,5 @@ BioCatch SDK Cordova support
## Supported platforms
- iOS
- Android
- Android
docs/plugins/biometric-wrapper/README.md
+1 -5
View File
@@ -1,20 +1,16 @@
# BiometricWrapper
```
$ ''
$
$ npm install @awesome-cordova-plugins/biometric-wrapper
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/biometric-wrapper/)
Plugin Repo: ['']('')
This plugin capture biometric(Iris and Fingerprint) and validate the user.
May be used in Banking domain
## Supported platforms
- Android
docs/plugins/ble/README.md
+1 -3
View File
@@ -26,7 +26,5 @@ Simultaneous connections to multiple peripherals are supported.
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/blinkid/README.md
+1 -3
View File
@@ -15,7 +15,5 @@ blinkid-phonegap repository for available recognizers and other settings
## Supported platforms
- iOS
- Android
- Android
docs/plugins/bluetooth-classic-serial-port/README.md
+2 -4
View File
@@ -14,8 +14,6 @@ This plugin is written using the iOS Accessory Framework (MFi) to support Classi
## Supported platforms
- Android
- iOS
- Browser
- iOS
- Browser
docs/plugins/bluetooth-le/README.md
+1 -3
View File
@@ -16,7 +16,5 @@ It supports peripheral **and** central modes and covers most of the API methods
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/bluetooth-serial/README.md
+2 -4
View File
@@ -14,8 +14,6 @@ This plugin enables serial communication over Bluetooth. It was written for comm
## Supported platforms
- Android
- iOS
- Windows Phone 8
- iOS
- Windows Phone 8
docs/plugins/branch-io/README.md
+1 -3
View File
@@ -14,7 +14,5 @@ Branch.io is an attribution service for deeplinking and invitation links
## Supported platforms
- iOS
- Android
- Android
docs/plugins/brightness/README.md
+1 -3
View File
@@ -16,7 +16,5 @@ Requires Cordova plugin: `cordova-plugin-brightness`. For more info, please see
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/broadcaster/README.md
+2 -4
View File
@@ -14,8 +14,6 @@ This plugin adds exchanging events between native code and your app.
## Supported platforms
- Android
- iOS
- Browser
- iOS
- Browser
docs/plugins/browser-tab/README.md
+1 -3
View File
@@ -14,7 +14,5 @@ This plugin provides an interface to in-app browser tabs that exist on some mobi
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/build-info/README.md
+5 -7
View File
@@ -14,11 +14,9 @@ This plugin provides build information.
## Supported platforms
- Android
- iOS
- Windows
- macOS
- browser
- Electron
- iOS
- Windows
- macOS
- browser
- Electron
docs/plugins/calendar/README.md
+1 -3
View File
@@ -16,7 +16,5 @@ Requires Cordova plugin: `cordova-plugin-calendar`. For more info, please see th
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/call-directory/README.md
-2
View File
@@ -15,6 +15,4 @@ to process the changes in the call directory extension.
## Supported platforms
- iOS
docs/plugins/call-number/README.md
+1 -3
View File
@@ -15,7 +15,5 @@ NOTE**: The iOS Simulator (and maybe Android Simulators) do not provide access t
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/camera-preview/README.md
+1 -10
View File
@@ -1,12 +1,5 @@
# Camera Preview
<p style="color:orange">
This plugin is still in beta stage and may not work as expected. Please
submit any issues to the <a target="_blank"
href="/issues">plugin repo</a>.
</p>
```
$ ionic cordova plugin add cordova-plugin-camera-preview
$ npm install @awesome-cordova-plugins/camera-preview
@@ -23,7 +16,5 @@ Requires Cordova plugin: `https://github.com/cordova-plugin-camera-preview/cordo
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/camera/README.md
+3 -5
View File
@@ -24,9 +24,7 @@ inside of the `<platform name='ios>` section
## Supported platforms
- Android
- Browser
- iOS
- Windows
- Browser
- iOS
- Windows
docs/plugins/cashfree-pg/README.md
+5 -7
View File
@@ -1,5 +1,7 @@
# CFPaymentComponentBuilder
nic cordova plugin add cordova-plugin-cashfree-pg
# CFPaymentGateway
```
$ ionic cordova plugin add cordova-plugin-cashfree-pg
$ npm install @awesome-cordova-plugins/cashfree-pg
```
@@ -7,12 +9,8 @@ $ npm install @awesome-cordova-plugins/cashfree-pg
Plugin Repo: [https://github.com/cashfree/cordova-plugin-cashfree](https://github.com/cashfree/cordova-plugin-cashfree)
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/checkout/README.md
+2 -4
View File
@@ -1,7 +1,7 @@
# Checkout
```
$ ''
$
$ npm install @awesome-cordova-plugins/checkout
```
@@ -14,7 +14,5 @@ Checkout.com cordova plugin
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/chooser-simple-file/README.md
+1 -3
View File
@@ -26,7 +26,5 @@ The following must be added to config.xml to prevent crashing when selecting lar
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/chooser/README.md
+1 -3
View File
@@ -26,7 +26,5 @@ The following must be added to config.xml to prevent crashing when selecting lar
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/clevertap/README.md
+1 -3
View File
@@ -14,7 +14,5 @@ Cordova Plugin that wraps CleverTap SDK for Android and iOS
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/clipboard/README.md
+2 -4
View File
@@ -14,8 +14,6 @@ Clipboard management plugin for Cordova that supports iOS, Android, and Windows
## Supported platforms
- Android
- iOS
- Windows Phone 8
- iOS
- Windows Phone 8
docs/plugins/cloud-settings/README.md
+2 -4
View File
@@ -1,7 +1,7 @@
# Cloud Settings
```
$ ionic cordova plugin add cordova-plugin-cloud-settings --variable ANDROID_BACKUP_SERVICE_KEY=myapikey
$ ionic cordova plugin add @marysuon/cordova-plugin-cloud-settings --variable ANDROID_BACKUP_SERVICE_KEY=myapikey
$ npm install @awesome-cordova-plugins/cloud-settings
```
@@ -14,7 +14,5 @@ Stores app settings in cloud storage so if the user re-installs the app or insta
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/code-push/README.md
+1 -3
View File
@@ -16,7 +16,5 @@ For more info, please see https://github.com/Dellos7/example-cordova-code-push-p
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/contacts/README.md
+25
View File
@@ -0,0 +1,25 @@
# Contacts
```
$ ionic cordova plugin add cordova-plugin-contacts
$ npm install @awesome-cordova-plugins/contacts
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/contacts/)
Plugin Repo: [https://github.com/herdwatch-apps/cordova-plugin-contacts](https://github.com/herdwatch-apps/cordova-plugin-contacts)
Access and manage Contacts on the device.
## Supported platforms
- Android
- BlackBerry 10
- Browser
- Firefox OS
- iOS
- Ubuntu
- Windows
- Windows 8
- Windows Phone
docs/plugins/core/README.md
+273
View File
@@ -0,0 +1,273 @@
![](https://img.shields.io/npm/v/@awesome-cordova-plugins/core.svg)
# Awesome Cordova Plugins
Awesome Cordova Plugins is a curated set of wrappers for Cordova plugins that make adding any native functionality you need to your [Ionic](https://ionicframework.com/) mobile app easy.
Awesome Cordova Plugins wraps plugin callbacks in a Promise or Observable, providing a common interface for all plugins and making it easy to use plugins with Angular change detection.
To learn more about the reasons why Ionic Native was renamed to Awesome Cordova Plugins, read the official [Ionic blog](https://ionicframework.com/blog/a-new-chapter-for-ionic-native/) post by Max Lyncht.
## Capacitor Support
In addition to Cordova, Awesome Cordova Plugins also works with [Capacitor](https://capacitorjs.com), Ionic's official native runtime. Basic usage below. For complete details, [see the Capacitor documentation](https://capacitorjs.com/docs/v2/cordova/using-cordova-plugins).
## Installation
Run following command to install Awesome Cordova Plugins in your project.
```bash
npm install @awesome-cordova-plugins/core --save
```
You also need to install the Awesome Cordova Plugins package for each plugin you want to add. Please see the [Awesome Cordova Plugins documentation](https://ionicframework.com/docs/native/) for complete instructions on how to add and use the plugins.
## Documentation
For the full Awesome Cordova Plugins documentation, please visit [https://ionicframework.com/docs/native/](https://ionicframework.com/docs/native/).
### Basic Usage
#### Ionic/Angular apps
To use a plugin, import and add the plugin provider to your `@NgModule`, and then inject it where you wish to use it.
Make sure to import the injectable class from the `/ngx` directory as shown in the following examples:
```typescript
// app.module.ts
import { Camera } from '@awesome-cordova-plugins/camera/ngx';
...
@NgModule({
...
providers: [
...
Camera
...
]
...
})
export class AppModule { }
```
```typescript
import { Geolocation } from '@awesome-cordova-plugins/geolocation/ngx';
import { Platform } from 'ionic-angular';
@Component({ ... })
export class MyComponent {
constructor(private geolocation: Geolocation, private platform: Platform) {
this.platform.ready().then(() => {
// get position
this.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();
});
}
}
```
#### Ionic/React apps
React apps must use Capacitor to build native mobile apps. However, Awesome Cordova Plugins (and therefore, Cordova plugins) can still be used.
```bash
# Install Core library (once per project)
npm install @awesome-cordova-plugins/core
# Install Awesome Cordova Plugins TypeScript wrapper
npm install @awesome-cordova-plugins/barcode-scanner
# Install Cordova plugin
npm install phonegap-plugin-barcodescanner
# Update native platform project(s) to include newly added plugin
ionic cap sync
```
Import the plugin object then use its static methods:
```typescript
import { BarcodeScanner } from '@awesome-cordova-plugins/barcode-scanner';
const Tab1: React.FC = () => {
const openScanner = async () => {
const data = await BarcodeScanner.scan();
console.log(`Barcode data: ${data.text}`);
};
return (
<IonPage>
<IonHeader>
<IonToolbar>
<IonTitle>Tab 1</IonTitle>
</IonToolbar>
</IonHeader>
<IonContent>
<IonButton onClick={openScanner}>Scan barcode</IonButton>
</IonContent>
</IonPage>
);
};
```
#### ES2015+/TypeScript
These modules can work in any ES2015+/TypeScript app (including Angular/Ionic apps). To use any plugin, import the class from the appropriate package, and use it's static methods.
```js
import { Camera } from '@awesome-cordova-plugins/camera';
document.addEventListener('deviceready', () => {
Camera.getPicture()
.then((data) => console.log('Took a picture!', data))
.catch((e) => console.log('Error occurred while taking a picture', e));
});
```
#### AngularJS
Awesome Cordova Plugins generates an AngularJS module in runtime and prepares a service for each plugin. To use the plugins in your AngularJS app:
1. Download the latest bundle from the [Github releases](https://github.com/danielsogl/awesome-cordova-plugins/releases) page.
2. Include it in `index.html` before your app's code.
3. Inject `ionic.native` module in your app.
4. Inject any plugin you would like to use with a `$cordova` prefix.
```js
angular.module('myApp', ['ionic.native']).controller('MyPageController', function ($cordovaCamera) {
$cordovaCamera.getPicture().then(
function (data) {
console.log('Took a picture!', data);
},
function (err) {
console.log('Error occurred while taking a picture', err);
}
);
});
```
#### Vanilla JS
To use Awesome Cordova Plugins in any other setup:
1. Download the latest bundle from the [Github releases](https://github.com/danielsogl/awesome-cordova-plugins/releases) page.
2. Include it in `index.html` before your app's code.
3. Access any plugin using the global `IonicNative` variable.
```js
document.addEventListener('deviceready', function () {
IonicNative.Camera.getPicture().then(
function (data) {
console.log('Took a picture!', data);
},
function (err) {
console.log('Error occurred while taking a picture', err);
}
);
});
```
### Mocking and Browser Development (Ionic/Angular apps only)
Awesome Cordova Plugins makes it possible to mock plugins and develop nearly the entirety of your app in the browser or in `ionic serve`.
To do this, you need to provide a mock implementation of the plugins you wish to use. Here's an example of mocking the `Camera` plugin to return a stock image while in development:
First import the `Camera` class in your `src/app/app.module.ts` file:
```typescript
import { Camera } from '@awesome-cordova-plugins/camera/ngx';
```
Then create a new class that extends the `Camera` class with a mock implementation:
```typescript
class CameraMock extends Camera {
getPicture(options) {
return new Promise((resolve, reject) => {
resolve('BASE_64_ENCODED_DATA_GOES_HERE');
});
}
}
```
Finally, override the previous `Camera` class in your `providers` for this module:
```typescript
providers: [{ provide: Camera, useClass: CameraMock }];
```
Here's the full example:
```typescript
import { ErrorHandler, NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { IonicApp, IonicModule, IonicErrorHandler } from 'ionic-angular';
import { MyApp } from './app.component';
import { HomePage } from '../pages/home/home';
import { Camera } from '@awesome-cordova-plugins/camera/ngx';
import { HomePage } from '../pages/home/home';
import { MyApp } from './app.component';
class CameraMock extends Camera {
getPicture(options) {
return new Promise((resolve, reject) => {
resolve('BASE_64_ENCODED_DATA_GOES_HERE');
});
}
}
@NgModule({
declarations: [MyApp, HomePage],
imports: [BrowserModule, IonicModule.forRoot(MyApp)],
bootstrap: [IonicApp],
entryComponents: [MyApp, HomePage],
providers: [
{ provide: ErrorHandler, useClass: IonicErrorHandler },
{ provide: Camera, useClass: CameraMock },
],
})
export class AppModule {}
```
### Runtime Diagnostics
Spent way too long diagnosing an issue only to realize a plugin wasn't firing or installed? Awesome Cordova Plugins lets you know what the issue is and how you can resolve it.
![img](https://ionic-io-assets.s3.amazonaws.com/ionic-native-console.png)
## Plugin Missing?
Let us know or submit a PR! Take a look at [the Developer Guide](https://github.com/danielsogl/awesome-cordova-plugins/blob/master/DEVELOPER.md) for more on how to contribute. :heart:
# Credits
Ibby Hadeed - [@ihadeed](https://github.com/ihadeed)
Daniel Sogl - [@sogldaniel](https://twitter.com/sogldaniel)
Tim Lancina - [@timlancina](https://twitter.com/timlancina)
Mike Hartington - [@mhartington](https://twitter.com/mhartington)
Max Lynch - [@maxlynch](https://twitter.com/maxlynch)
Rob Wormald - [@robwormald](https://twitter.com/robwormald)
docs/plugins/crop-plugin-privacy/README.md
-2
View File
@@ -14,6 +14,4 @@ This plugin does something
## Supported platforms
- Android
docs/plugins/custom-ui-sdk/README.md
+15
View File
@@ -0,0 +1,15 @@
# CustomUiSdk
```
$
$ npm install @awesome-cordova-plugins/custom-ui-sdk
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/custom-ui-sdk/)
This plugin is used to access Paytmpayments native CustomUiSdk framework's apis.
## Supported platforms
- Android, iOS
docs/plugins/custom-uisdk/README.md
+1 -3
View File
@@ -1,7 +1,7 @@
# CustomUISDK
```
$ ''
$
$ npm install @awesome-cordova-plugins/custom-uisdk
```
@@ -14,6 +14,4 @@ This plugin is used to access Paytm's native CustomUISDK framework's apis.
## Supported platforms
- Android, iOS
docs/plugins/deeplinks/README.md
+2 -4
View File
@@ -18,8 +18,6 @@ You must add `universal-links` to your `config.xml` and set up Apple App Site As
## Supported platforms
- Android
- Browser
- iOS
- Browser
- iOS
docs/plugins/device-accounts/README.md
-2
View File
@@ -14,6 +14,4 @@ Gets the Google accounts associated with the Android device
## Supported platforms
- Android
docs/plugins/device-motion/README.md
+8 -10
View File
@@ -14,14 +14,12 @@ Requires Cordova plugin: `cordova-plugin-device-motion`. For more info, please s
## Supported platforms
- Android
- BlackBerry 10
- Browser
- Firefox OS
- iOS
- Tizen
- Ubuntu
- Windows
- Windows Phone 8
- BlackBerry 10
- Browser
- Firefox OS
- iOS
- Tizen
- Ubuntu
- Windows
- Windows Phone 8
docs/plugins/device-orientation/README.md
+9 -11
View File
@@ -14,15 +14,13 @@ Requires Cordova plugin: `cordova-plugin-device-orientation`. For more info, ple
## Supported platforms
- Amazon Fire OS
- Android
- BlackBerry 10
- Browser
- Firefox OS
- iOS
- Tizen
- Ubuntu
- Windows
- Windows Phone
- Android
- BlackBerry 10
- Browser
- Firefox OS
- iOS
- Tizen
- Ubuntu
- Windows
- Windows Phone
docs/plugins/device/README.md
+4 -6
View File
@@ -14,10 +14,8 @@ Access information about the underlying device and platform.
## Supported platforms
- Android
- Browser
- iOS
- macOS
- Windows
- Browser
- iOS
- macOS
- Windows
docs/plugins/dfu-update/README.md
+1 -3
View File
@@ -14,7 +14,5 @@ This plugin is a Wrapper to use Nordic Semiconductor's Device Firmware Update (D
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/diagnostic/README.md
+2 -4
View File
@@ -14,8 +14,6 @@ Checks whether device hardware features are enabled or available to the app, e.g
## Supported platforms
- Android
- iOS
- Windows
- iOS
- Windows
docs/plugins/dialogs/README.md
+4 -6
View File
@@ -16,10 +16,8 @@ Requires Cordova plugin: `cordova-plugin-dialogs`. For more info, please see the
## Supported platforms
- Amazon Fire OS
- Android
- Browser
- iOS
- Windows
- Android
- Browser
- iOS
- Windows
docs/plugins/dns/README.md
-2
View File
@@ -14,6 +14,4 @@ A plugin for Apache Cordova that enables applications to manually resolve hostna
## Supported platforms
- Android
docs/plugins/document-picker/README.md
-2
View File
@@ -15,6 +15,4 @@ Allows the user to upload files from iCloud
## Supported platforms
- iOS
docs/plugins/document-scanner/README.md
+1 -3
View File
@@ -14,7 +14,5 @@ This plugin processes images of documents, compensating for perspective.
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/document-viewer/README.md
+2 -4
View File
@@ -14,8 +14,6 @@ This plugin offers a slim API to view PDF files which are either stored in the a
## Supported platforms
- Android
- iOS
- Windows
- iOS
- Windows
docs/plugins/downloader/README.md
+17
View File
@@ -0,0 +1,17 @@
# Document Downloader
```
$ ionic cordova plugin add integrator-cordova-plugin-downloader
$ npm install @awesome-cordova-plugins/downloader
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/downloader/)
Plugin Repo: [https://github.com/Luka313/integrator-cordova-plugin-downloader.git](https://github.com/Luka313/integrator-cordova-plugin-downloader.git)
This plugin is designed to support downloading files using Android DownloadManager.
## Supported platforms
- Android
docs/plugins/dynamsoft-barcode-scanner/README.md
+2 -4
View File
@@ -1,7 +1,7 @@
# dynamsoft-barcode-scanner
```
$ ''
$
$ npm install @awesome-cordova-plugins/dynamsoft-barcode-scanner
```
@@ -14,7 +14,5 @@ This plugin scans barcodes using Dynamsoft Barcode Reader
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/email-composer/README.md
+5 -7
View File
@@ -14,11 +14,9 @@ Requires Cordova plugin: cordova-plugin-email-composer. For more info, please se
## Supported platforms
- Amazon Fire OS
- Android
- Browser
- iOS
- Windows
- macOS
- Android
- Browser
- iOS
- Windows
- macOS
docs/plugins/fabric/README.md
+3 -5
View File
@@ -1,4 +1,4 @@
# Crashlytics
# Answers
```
$ ionic cordova plugin add cordova-fabric-plugin --variable FABRIC_API_KEY=XXX --variable FABRIC_API_SECRET=xxx
@@ -9,14 +9,12 @@ $ npm install @awesome-cordova-plugins/fabric
Plugin Repo: [https://www.npmjs.com/package/cordova-fabric-plugin](https://www.npmjs.com/package/cordova-fabric-plugin)
API for interacting with the Crashlytics kit.
API for interacting with the Answers kit.
https://docs.fabric.io/crashlytics/index.html
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/facebook/README.md
+2 -4
View File
@@ -77,8 +77,6 @@ For tracking events, see `logEvent` and `logPurchase`.
## Supported platforms
- Android
- iOS
- Browser
- iOS
- Browser
docs/plugins/fbsdk/README.md
+2 -4
View File
@@ -82,8 +82,6 @@ For tracking events, see `logEvent` and `logPurchase`.
## Supported platforms
- Android
- iOS
- Browser
- iOS
- Browser
docs/plugins/fcm/README.md
+1 -3
View File
@@ -14,7 +14,5 @@ Provides basic functionality for Firebase Cloud Messaging
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/ffmpeg/README.md
+1 -3
View File
@@ -14,7 +14,5 @@ Simple plugin that binds mobile ffmpeg to execute ffmpeg commands
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/file-chooser/README.md
-2
View File
@@ -14,6 +14,4 @@ Cordova FileChooser Plugin
## Supported platforms
- Android
docs/plugins/file-md5/README.md
+1 -3
View File
@@ -14,7 +14,5 @@ This plugin reads large files in chunks and build the md5sum incrementally.
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/file-opener/README.md
+3 -5
View File
@@ -14,9 +14,7 @@ This plugin will open a file on your device file system with its default applica
## Supported platforms
- Android
- iOS
- Windows
- Windows Phone 8
- iOS
- Windows
- Windows Phone 8
docs/plugins/file-path/README.md
-2
View File
@@ -14,6 +14,4 @@ This plugin allows you to resolve the native filesystem path for Android content
## Supported platforms
- Android
docs/plugins/file-transfer/README.md
+6 -8
View File
@@ -14,12 +14,10 @@ This plugin allows you to upload and download files.
## Supported platforms
- Amazon Fire OS
- Android
- Browser
- iOS
- Ubuntu
- Windows
- Windows Phone
- Android
- Browser
- iOS
- Ubuntu
- Windows
- Windows Phone
docs/plugins/file/README.md
+4 -6
View File
@@ -35,10 +35,8 @@ this.file.checkDir(this.file.dataDirectory, 'mydir').then(_ => console.log('Dire
## Supported platforms
- Android
- Browser
- iOS
- macOS
- Windows
- Browser
- iOS
- macOS
- Windows
docs/plugins/fingerprint-aio/README.md
+1 -3
View File
@@ -15,7 +15,5 @@ Requires Cordova plugin: cordova-plugin-fingerprint-aio. For more info about plu
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/firebase-analytics/README.md
+1 -10
View File
@@ -1,12 +1,5 @@
# Firebase Analytics
<p style="color:orange">
This plugin is still in beta stage and may not work as expected. Please
submit any issues to the <a target="_blank"
href="/issues">plugin repo</a>.
</p>
```
$ ionic cordova plugin add cordova-plugin-firebase-analytics
$ npm install @awesome-cordova-plugins/firebase-analytics
@@ -41,7 +34,5 @@ And in the same file, you'll have to add `xmlns:tools="http://schemas.android.co
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/firebase-authentication/README.md
+1 -3
View File
@@ -14,7 +14,5 @@ Cordova plugin for Firebase Authentication
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/firebase-config/README.md
+1 -10
View File
@@ -1,12 +1,5 @@
# Firebase Config
<p style="color:orange">
This plugin is still in beta stage and may not work as expected. Please
submit any issues to the <a target="_blank"
href="/issues">plugin repo</a>.
</p>
```
$ ionic cordova plugin add cordova-plugin-firebase-config
$ npm install @awesome-cordova-plugins/firebase-config
@@ -21,7 +14,5 @@ Cordova plugin for Firebase Config
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/firebase-crash/README.md
+1 -3
View File
@@ -14,7 +14,5 @@ This plugin brings crash reporting from Google Firebase to your Cordova project!
## Supported platforms
- Android
- iOS
- iOS
docs/plugins/firebase-crashlytics/README.md
+1 -3
View File
@@ -14,7 +14,5 @@ A Google Firebase Crashlytics plugin to enable capture of crash reports.
## Supported platforms
- Android
- iOS
- iOS

Some files were not shown because too many files have changed in this diff Show More