diff --git a/docs/plugins/abbyy-rtr/README.md b/docs/plugins/abbyy-rtr/README.md new file mode 100644 index 000000000..70588e6c2 --- /dev/null +++ b/docs/plugins/abbyy-rtr/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# ABBYY Real-Time Recognition + +``` +$ ionic cordova plugin add cordova-plugin-abbyy-rtr-sdk +$ npm install @ionic-native/plugins/abbyy-rtr +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/abbyy-rtr/) + +Plugin Repo: [https://github.com/abbyysdk/RTR-SDK.Cordova](https://github.com/abbyysdk/RTR-SDK.Cordova) + +This plugin allows to use the Text Capture and Data Capture features of +ABBYY Real-Time Recognition SDK (RTR SDK) in apps. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/action-sheet/README.md b/docs/plugins/action-sheet/README.md new file mode 100644 index 000000000..88c5e30e0 --- /dev/null +++ b/docs/plugins/action-sheet/README.md @@ -0,0 +1,26 @@ + + Improve this doc + + +# Action Sheet + +``` +$ ionic cordova plugin add cordova-plugin-actionsheet +$ npm install @ionic-native/plugins/action-sheet +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/action-sheet/) + +Plugin Repo: [https://github.com/EddyVerbruggen/cordova-plugin-actionsheet](https://github.com/EddyVerbruggen/cordova-plugin-actionsheet) + +The ActionSheet plugin shows a native list of options the user can choose from. + +Requires Cordova plugin: `cordova-plugin-actionsheet`. For more info, please see the [ActionSheet plugin docs](https://github.com/EddyVerbruggen/cordova-plugin-actionsheet). + +## Supported platforms + +- Android + - Browser + - iOS + - Windows + - Windows Phone 8 diff --git a/docs/plugins/adjust/README.md b/docs/plugins/adjust/README.md new file mode 100644 index 000000000..9c16df5af --- /dev/null +++ b/docs/plugins/adjust/README.md @@ -0,0 +1,23 @@ + + Improve this doc + + +# Adjust + +``` +$ ionic cordova plugin add com.adjust.sdk +$ npm install @ionic-native/plugins/adjust +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/adjust/) + +Plugin Repo: [https://github.com/adjust/cordova_sdk](https://github.com/adjust/cordova_sdk) + +This is the Ionic Cordova SDK of Adjust™. You can read more about Adjust™ at adjust.com. + +Requires Cordova plugin: `com.adjust.sdk`. For more info, please see the [Adjust Cordova SDK](https://github.com/adjust/cordova_sdk) + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/admob-plus/README.md b/docs/plugins/admob-plus/README.md new file mode 100644 index 000000000..e9d5472b0 --- /dev/null +++ b/docs/plugins/admob-plus/README.md @@ -0,0 +1,26 @@ + + Improve this doc + + +# AdMob + +``` +$ ionic cordova plugin add cordova-admob-plus +$ npm install @ionic-native/plugins/admob-plus +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/admob-plus/) + +Plugin Repo: [https://github.com/admob-plus/admob-plus](https://github.com/admob-plus/admob-plus) + +## Supported platforms + +- Android + - iOS + +-admob-free, which provides a cleaner API and build with modern tools. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/admob-pro/README.md b/docs/plugins/admob-pro/README.md new file mode 100644 index 000000000..944ffb0cc --- /dev/null +++ b/docs/plugins/admob-pro/README.md @@ -0,0 +1,24 @@ + + Improve this doc + + +# AdMob Pro + +``` +$ ionic cordova plugin add cordova-plugin-admobpro +$ npm install @ionic-native/plugins/admob-pro +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/admob-pro/) + +Plugin Repo: [https://github.com/floatinghotpot/cordova-admob-pro](https://github.com/floatinghotpot/cordova-admob-pro) + +Plugin for Google Ads, including AdMob / DFP (DoubleClick for publisher) and mediations to other Ad networks. + +IMPORTANT NOTICE: this plugin takes a percentage out of your earnings if you profit more than $1,000. Read more about this on the plugin's repo. For a completely free alternative, see [AdMobPro Free](../admob-free). + +## Supported platforms + +- Android + - iOS + - Windows Phone 8 diff --git a/docs/plugins/admob/README.md b/docs/plugins/admob/README.md new file mode 100644 index 000000000..1bc9e00aa --- /dev/null +++ b/docs/plugins/admob/README.md @@ -0,0 +1,30 @@ + + Improve this doc + + +# AdMob + +``` +$ ionic cordova plugin add cordova-admob +$ npm install @ionic-native/plugins/admob +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/admob/) + +Plugin Repo: [https://github.com/appfeel/admob-google-cordova](https://github.com/appfeel/admob-google-cordova) + +Most complete Admob plugin with support for [Tappx](http://www.tappx.com/?h=dec334d63287772de859bdb4e977fce6) ads. +Monetize your apps and games with AdMob ads, using latest Google AdMob SDK. With this plugin you can show AdMob ads easily! + +Supports:\*\* + +- Banner ads (top and bottom) +- Interstitial ads +- Rewarded ads +- [Tappx](http://www.tappx.com/?h=dec334d63287772de859bdb4e977fce6) ads + +## Supported platforms + +- Android + - iOS + - Browser diff --git a/docs/plugins/aes-256/README.md b/docs/plugins/aes-256/README.md new file mode 100644 index 000000000..b7e9659ad --- /dev/null +++ b/docs/plugins/aes-256/README.md @@ -0,0 +1,23 @@ + + Improve this doc + + +# AES256 + +``` +$ ionic cordova plugin add cordova-plugin-aes256-encryption +$ npm install @ionic-native/plugins/aes-256 +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/aes-256/) + +Plugin Repo: [https://github.com/Ideas2IT/cordova-aes256](https://github.com/Ideas2IT/cordova-aes256) + +This cordova ionic plugin allows you to perform AES 256 encryption and decryption on the plain text. +It's a cross-platform plugin which supports both Android and iOS. +The encryption and decryption are performed on the device native layer so that the performance is much faster. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/all-in-one-sdk/README.md b/docs/plugins/all-in-one-sdk/README.md new file mode 100644 index 000000000..d93b74d3f --- /dev/null +++ b/docs/plugins/all-in-one-sdk/README.md @@ -0,0 +1,24 @@ + + Improve this doc + + +# AllInOneSDK + +``` +$ ionic cordova plugin add cordova-paytm-allinonesdk +$ npm install @ionic-native/plugins/all-in-one-sdk +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/all-in-one-sdk/) + +Plugin Repo: [https://github.com/paytm/paytm-allinonesdk-ionic-cordova.git](https://github.com/paytm/paytm-allinonesdk-ionic-cordova.git) + +Paytm All-in-One SDK plugin for Cordova/Ionic Applications +Paytm All-in-One SDK provides a swift, secure and seamless payment experience to your users by invoking the Paytm app (if installed on your user’s smartphone) to complete payment for your order. +Paytm All-in-One SDK enables payment acceptance via Paytm wallet, Paytm Payments Bank, saved Debit/Credit cards, Net Banking, BHIM UPI and EMI as available in your customer’s Paytm account. If Paytm app is not installed on a customer's device, the transaction will be processed via web view within the All-in-One SDK. +For more information about Paytm All-in-One SDK, please visit https://developer.paytm.com/docs/all-in-one-sdk/hybrid-apps/cordova/ + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/analytics-firebase/README.md b/docs/plugins/analytics-firebase/README.md new file mode 100644 index 000000000..6a0af0a90 --- /dev/null +++ b/docs/plugins/analytics-firebase/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Analytics Firebase + +``` +$ ionic cordova plugin add cordova-plugin-analytics +$ npm install @ionic-native/plugins/analytics-firebase +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/analytics-firebase/) + +Plugin Repo: [https://github.com/appfeel/analytics-google](https://github.com/appfeel/analytics-google) + +Google Analytics Firebase plugin for Ionic Native apps. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/android-exoplayer/README.md b/docs/plugins/android-exoplayer/README.md new file mode 100644 index 000000000..7098a1a4a --- /dev/null +++ b/docs/plugins/android-exoplayer/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Android ExoPlayer + +``` +$ ionic cordova plugin add cordova-plugin-exoplayer +$ npm install @ionic-native/plugins/android-exoplayer +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/android-exoplayer/) + +Plugin Repo: [https://github.com/frontyard/cordova-plugin-exoplayer](https://github.com/frontyard/cordova-plugin-exoplayer) + +Cordova media player plugin using Google's ExoPlayer framework. + +https://github.com/google/ExoPlayer + +## Supported platforms + +- Android diff --git a/docs/plugins/android-full-screen/README.md b/docs/plugins/android-full-screen/README.md new file mode 100644 index 000000000..6b20203da --- /dev/null +++ b/docs/plugins/android-full-screen/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Android Full Screen + +``` +$ ionic cordova plugin add cordova-plugin-fullscreen +$ npm install @ionic-native/plugins/android-full-screen +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/android-full-screen/) + +Plugin Repo: [https://github.com/mesmotronic/cordova-plugin-fullscreen](https://github.com/mesmotronic/cordova-plugin-fullscreen) + +This plugin enables developers to offer users a true full screen experience in their Cordova and PhoneGap apps for Android. +Using Android 4.0+, you can use true full screen in "lean mode", the way you see in apps like YouTube, expanding the app right to the edges of the screen, hiding the status and navigation bars until the user next interacts. This is ideally suited to video or cut-scene content. +In Android 4.4+, however, you can now enter true full screen, fully interactive immersive mode. In this mode, your app will remain in true full screen until you choose otherwise; users can swipe down from the top of the screen to temporarily display the system UI. + +## Supported platforms + +- Android diff --git a/docs/plugins/android-notch/README.md b/docs/plugins/android-notch/README.md new file mode 100644 index 000000000..35c7b1bfb --- /dev/null +++ b/docs/plugins/android-notch/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Android Notch + +``` +$ ionic cordova plugin add cordova-plugin-android-notch +$ npm install @ionic-native/plugins/android-notch +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/android-notch/) + +Plugin Repo: [https://github.com/tobspr/cordova-plugin-android-notch.git](https://github.com/tobspr/cordova-plugin-android-notch.git) + +This plugin enables developers to get the cutout and android devices inset sizes +It is based on the cordova plugin developed by @tobspr: https://github.com/tobspr/cordova-plugin-android-notch +This plugin works on all android versions, but we can only detect notches starting from Android 9. + +## Supported platforms + +- Android diff --git a/docs/plugins/android-permissions/README.md b/docs/plugins/android-permissions/README.md new file mode 100644 index 000000000..021835dbf --- /dev/null +++ b/docs/plugins/android-permissions/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Android Permissions + +``` +$ ionic cordova plugin add cordova-plugin-android-permissions +$ npm install @ionic-native/plugins/android-permissions +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/android-permissions/) + +Plugin Repo: [https://github.com/NeoLSN/cordova-plugin-android-permissions](https://github.com/NeoLSN/cordova-plugin-android-permissions) + +This plugin is designed to support Android new permissions checking mechanism. + +You can find all permissions here: https://developer.android.com/reference/android/Manifest.permission.html + +## Supported platforms + +- Android diff --git a/docs/plugins/anyline/README.md b/docs/plugins/anyline/README.md new file mode 100644 index 000000000..f686602d3 --- /dev/null +++ b/docs/plugins/anyline/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Anyline + +``` +$ ionic cordova plugin add io-anyline-cordova +$ npm install @ionic-native/plugins/anyline +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/anyline/) + +Plugin Repo: [https://github.com/Anyline/anyline-ocr-cordova-module](https://github.com/Anyline/anyline-ocr-cordova-module) + +Anyline provides an easy-to-use SDK for applications to enable Optical Character Recognition (OCR) on mobile devices. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/app-availability/README.md b/docs/plugins/app-availability/README.md new file mode 100644 index 000000000..811eee343 --- /dev/null +++ b/docs/plugins/app-availability/README.md @@ -0,0 +1,23 @@ + + Improve this doc + + +# App Availability + +``` +$ ionic cordova plugin add cordova-plugin-appavailability +$ npm install @ionic-native/plugins/app-availability +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/app-availability/) + +Plugin Repo: [https://github.com/ohh2ahh/AppAvailability](https://github.com/ohh2ahh/AppAvailability) + +This plugin allows you to check if an app is installed on the user's device. It requires an URI Scheme (e.g. twitter://) on iOS or a Package Name (e.g com.twitter.android) on Android. + +Requires Cordova plugin: cordova-plugin-appavailability. For more info, please see the [AppAvailability plugin docs](https://github.com/ohh2ahh/AppAvailability). + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/app-center-analytics/README.md b/docs/plugins/app-center-analytics/README.md new file mode 100644 index 000000000..4da7de2c3 --- /dev/null +++ b/docs/plugins/app-center-analytics/README.md @@ -0,0 +1,26 @@ + + Improve this doc + + +# App Center Analytics + +``` +$ ionic cordova plugin add cordova-plugin-appcenter-analytics +$ npm install @ionic-native/plugins/app-center-analytics +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/app-center-analytics/) + +Plugin Repo: [https://github.com/Microsoft/appcenter-sdk-cordova/tree/master/cordova-plugin-appcenter-analytics](https://github.com/Microsoft/appcenter-sdk-cordova/tree/master/cordova-plugin-appcenter-analytics) + +App Center Analytics helps you understand user behavior and customer engagement to improve your app. +The SDK automatically captures session count and device properties like model, OS version, etc. +You can define your own custom events to measure things that matter to you. +All the information captured is available in the App Center portal for you to analyze the data. + +For more info, please see https://docs.microsoft.com/en-us/appcenter/sdk/analytics/cordova + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/app-center-crashes/README.md b/docs/plugins/app-center-crashes/README.md new file mode 100644 index 000000000..ccdbbc883 --- /dev/null +++ b/docs/plugins/app-center-crashes/README.md @@ -0,0 +1,26 @@ + + Improve this doc + + +# App Center Crashes + +``` +$ ionic cordova plugin add cordova-plugin-appcenter-crashes +$ npm install @ionic-native/plugins/app-center-crashes +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/app-center-crashes/) + +Plugin Repo: [https://github.com/Microsoft/appcenter-sdk-cordova/tree/master/cordova-plugin-appcenter-crashes](https://github.com/Microsoft/appcenter-sdk-cordova/tree/master/cordova-plugin-appcenter-crashes) + +App Center Analytics helps you understand user behavior and customer engagement to improve your app. +The SDK automatically captures session count and device properties like model, OS version, etc. +You can define your own custom events to measure things that matter to you. +All the information captured is available in the App Center portal for you to analyze the data. + +For more info, please see https://docs.microsoft.com/en-us/appcenter/sdk/crashes/cordova + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/app-center-low-memory/README.md b/docs/plugins/app-center-low-memory/README.md new file mode 100644 index 000000000..3c73d5768 --- /dev/null +++ b/docs/plugins/app-center-low-memory/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# App Center Low Memory + +``` +$ ionic cordova plugin add https://github.com/Microsoft/appcenter-sdk-cordova/tree/master/cordova-plugin-appcenter-generate-low-memory +$ npm install @ionic-native/plugins/app-center-low-memory +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/app-center-low-memory/) + +Plugin Repo: [https://github.com/Microsoft/appcenter-sdk-cordova/tree/master/cordova-plugin-appcenter-generate-low-memory](https://github.com/Microsoft/appcenter-sdk-cordova/tree/master/cordova-plugin-appcenter-generate-low-memory) + +Generates a low memory warning. +For more info, please see: https://github.com/Microsoft/appcenter-sdk-cordova/tree/master/cordova-plugin-appcenter-generate-low-memory + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/app-center-push/README.md b/docs/plugins/app-center-push/README.md new file mode 100644 index 000000000..a70772326 --- /dev/null +++ b/docs/plugins/app-center-push/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# App Center Push + +``` +$ ionic cordova plugin add cordova-plugin-appcenter-push +$ npm install @ionic-native/plugins/app-center-push +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/app-center-push/) + +Plugin Repo: [https://github.com/Microsoft/appcenter-sdk-cordova/tree/master/cordova-plugin-appcenter-push](https://github.com/Microsoft/appcenter-sdk-cordova/tree/master/cordova-plugin-appcenter-push) + +For more info, please see https://docs.microsoft.com/en-us/appcenter/sdk/push/cordova + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/app-center-shared/README.md b/docs/plugins/app-center-shared/README.md new file mode 100644 index 000000000..10e7049c2 --- /dev/null +++ b/docs/plugins/app-center-shared/README.md @@ -0,0 +1,23 @@ + + Improve this doc + + +# App Center Shared + +``` +$ ionic cordova plugin add cordova-plugin-appcenter-shared +$ npm install @ionic-native/plugins/app-center-shared +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/app-center-shared/) + +Plugin Repo: [https://github.com/Microsoft/appcenter-sdk-cordova/tree/master/cordova-plugin-appcenter-shared](https://github.com/Microsoft/appcenter-sdk-cordova/tree/master/cordova-plugin-appcenter-shared) + +Exposes additional shared APIs for App Center. + +For more info, please see https://docs.microsoft.com/en-us/appcenter/sdk/other-apis/cordova + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/app-preferences/README.md b/docs/plugins/app-preferences/README.md new file mode 100644 index 000000000..4dbd0fe85 --- /dev/null +++ b/docs/plugins/app-preferences/README.md @@ -0,0 +1,26 @@ + + Improve this doc + + +# App Preferences + +``` +$ ionic cordova plugin add cordova-plugin-app-preferences +$ npm install @ionic-native/plugins/app-preferences +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/app-preferences/) + +Plugin Repo: [https://github.com/apla/me.apla.cordova.app-preferences](https://github.com/apla/me.apla.cordova.app-preferences) + +This plugin allows you to read and write app preferences + +## Supported platforms + +- Android + - BlackBerry 10 + - Browser + - iOS + - macOS + - Windows 8 + - Windows Phone diff --git a/docs/plugins/app-rate/README.md b/docs/plugins/app-rate/README.md new file mode 100644 index 000000000..af58cea4a --- /dev/null +++ b/docs/plugins/app-rate/README.md @@ -0,0 +1,25 @@ + + Improve this doc + + +# App Rate + +``` +$ ionic cordova plugin add cordova-plugin-apprate +$ npm install @ionic-native/plugins/app-rate +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/app-rate/) + +Plugin Repo: [https://github.com/pushandplay/cordova-plugin-apprate](https://github.com/pushandplay/cordova-plugin-apprate) + +The AppRate plugin makes it easy to prompt the user to rate your app, either now, later, or never. + +Requires Cordova plugin: cordova-plugin-apprate. For more info, please see the [AppRate plugin docs](https://github.com/pushandplay/cordova-plugin-apprate). + +## Supported platforms + +- Android + - BlackBerry 10 + - iOS + - Windows diff --git a/docs/plugins/app-version/README.md b/docs/plugins/app-version/README.md new file mode 100644 index 000000000..220fe2df6 --- /dev/null +++ b/docs/plugins/app-version/README.md @@ -0,0 +1,24 @@ + + Improve this doc + + +# App Version + +``` +$ ionic cordova plugin add cordova-plugin-app-version +$ npm install @ionic-native/plugins/app-version +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/app-version/) + +Plugin Repo: [https://github.com/whiteoctober/cordova-plugin-app-version](https://github.com/whiteoctober/cordova-plugin-app-version) + +Reads the version of your app from the target build settings. + +Requires Cordova plugin: `cordova-plugin-app-version`. For more info, please see the [Cordova App Version docs](https://github.com/whiteoctober/cordova-plugin-app-version). + +## Supported platforms + +- Android + - iOS + - Windows diff --git a/docs/plugins/apple-wallet/README.md b/docs/plugins/apple-wallet/README.md new file mode 100644 index 000000000..370d86b76 --- /dev/null +++ b/docs/plugins/apple-wallet/README.md @@ -0,0 +1,20 @@ + + Improve this doc + + +# Apple Wallet + +``` +$ ionic cordova plugin add cordova-apple-wallet +$ npm install @ionic-native/plugins/apple-wallet +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/apple-wallet/) + +Plugin Repo: [https://github.com/tomavic/cordova-apple-wallet](https://github.com/tomavic/cordova-apple-wallet) + +A Cordova plugin that enables users from Add Payment Cards to their Apple Wallet. + +## Supported platforms + +- iOS diff --git a/docs/plugins/approov-advanced-http/README.md b/docs/plugins/approov-advanced-http/README.md new file mode 100644 index 000000000..5686f60c8 --- /dev/null +++ b/docs/plugins/approov-advanced-http/README.md @@ -0,0 +1,30 @@ + + Improve this doc + + +# HTTP + +``` +$ ionic cordova plugin add cordova-approov-advanced-http +$ npm install @ionic-native/plugins/approov-advanced-http +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/approov-advanced-http/) + +Plugin Repo: [https://github.com/approov/quickstart-ionic-advancedhttp](https://github.com/approov/quickstart-ionic-advancedhttp) + +Cordova / Phonegap plugin for communicating with HTTP servers. Supports iOS and Android. + +Advantages over Javascript requests: + +- SSL / TLS Pinning +- CORS restrictions do not apply +- Handling of HTTP code 401 - read more at [Issue CB-2415](https://issues.apache.org/jira/browse/CB-2415) + +Note: This plugin extends the pre-existing [cordova-advanced-http-plugin](https://github.com/silkimen/cordova-plugin-advanced-http), +we have only added approov functionality on top of it. All credit goes to the actual plugin developer. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/appsflyer/README.md b/docs/plugins/appsflyer/README.md new file mode 100644 index 000000000..ba2eee805 --- /dev/null +++ b/docs/plugins/appsflyer/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Appsflyer + +``` +$ Add to config.xml like stated on github and then start +$ npm install @ionic-native/plugins/appsflyer +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/appsflyer/) + +Plugin Repo: [https://github.com/AppsFlyerSDK/cordova-plugin-appsflyer-sdk](https://github.com/AppsFlyerSDK/cordova-plugin-appsflyer-sdk) + +Appsflyer Cordova SDK support for Attribution + +## Supported platforms + +- iOS + - Android diff --git a/docs/plugins/background-fetch/README.md b/docs/plugins/background-fetch/README.md new file mode 100644 index 000000000..0a760a562 --- /dev/null +++ b/docs/plugins/background-fetch/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Background Fetch + +``` +$ ionic cordova plugin add cordova-plugin-background-fetch +$ npm install @ionic-native/plugins/background-fetch +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/background-fetch/) + +Plugin Repo: [https://github.com/transistorsoft/cordova-plugin-background-fetch](https://github.com/transistorsoft/cordova-plugin-background-fetch) + +iOS Background Fetch Implementation. See: https://developer.apple.com/reference/uikit/uiapplication#1657399 +iOS Background Fetch is basically an API which wakes up your app about every 15 minutes (during the user's prime-time hours) and provides your app exactly 30s of background running-time. This plugin will execute your provided callbackFn whenever a background-fetch event occurs. There is no way to increase the rate which a fetch-event occurs and this plugin sets the rate to the most frequent possible value of UIApplicationBackgroundFetchIntervalMinimum -- iOS determines the rate automatically based upon device usage and time-of-day (ie: fetch-rate is about ~15min during prime-time hours; less frequently when the user is presumed to be sleeping, at 3am for example). +For more detail, please see https://github.com/transistorsoft/cordova-plugin-background-fetch + +## Supported platforms + +- iOS diff --git a/docs/plugins/background-geolocation/README.md b/docs/plugins/background-geolocation/README.md new file mode 100644 index 000000000..d3627819c --- /dev/null +++ b/docs/plugins/background-geolocation/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Background Geolocation + +``` +$ ionic cordova plugin add @mauron85/cordova-plugin-background-geolocation +$ npm install @ionic-native/plugins/background-geolocation +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/background-geolocation/) + +Plugin Repo: [https://github.com/mauron85/cordova-plugin-background-geolocation](https://github.com/mauron85/cordova-plugin-background-geolocation) + +This plugin provides foreground and background geolocation with battery-saving "circular region monitoring" and "stop detection". For +more detail, please see https://github.com/mauron85/cordova-plugin-background-geolocation + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/background-mode/README.md b/docs/plugins/background-mode/README.md new file mode 100644 index 000000000..7e15a9ed9 --- /dev/null +++ b/docs/plugins/background-mode/README.md @@ -0,0 +1,25 @@ + + Improve this doc + + +# Background Mode + +``` +$ ionic cordova plugin add cordova-plugin-background-mode +$ npm install @ionic-native/plugins/background-mode +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/background-mode/) + +Plugin Repo: [https://github.com/katzer/cordova-plugin-background-mode](https://github.com/katzer/cordova-plugin-background-mode) + +Cordova plugin to prevent the app from going to sleep while in background. +Requires Cordova plugin: cordova-plugin-background-mode. For more info about plugin, visit: https://github.com/katzer/cordova-plugin-background-mode + +## Supported platforms + +- AmazonFire OS + - Android + - Browser + - iOS + - Windows diff --git a/docs/plugins/background-upload/README.md b/docs/plugins/background-upload/README.md new file mode 100644 index 000000000..5f053ad48 --- /dev/null +++ b/docs/plugins/background-upload/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# BackgroundUpload + +``` +$ ionic cordova plugin add cordova-plugin-background-upload +$ npm install @ionic-native/plugins/background-upload +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/background-upload/) + +Plugin Repo: [https://github.com/spoonconsulting/cordova-plugin-background-upload](https://github.com/spoonconsulting/cordova-plugin-background-upload) + +This plugin does something + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/badge/README.md b/docs/plugins/badge/README.md new file mode 100644 index 000000000..f3c888727 --- /dev/null +++ b/docs/plugins/badge/README.md @@ -0,0 +1,27 @@ + + Improve this doc + + +# Badge + +``` +$ ionic cordova plugin add cordova-plugin-badge +$ npm install @ionic-native/plugins/badge +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/badge/) + +Plugin Repo: [https://github.com/katzer/cordova-plugin-badge](https://github.com/katzer/cordova-plugin-badge) + +The essential purpose of badge numbers is to enable an application to inform its users that it has something for them — for example, unread messages — when the application isn’t running in the foreground. + +Requires Cordova plugin: cordova-plugin-badge. For more info, please see the [Badge plugin docs](https://github.com/katzer/cordova-plugin-badge). + +Android Note: Badges have historically only been a feature implemented by third party launchers and not visible unless one of those launchers was being used (E.G. Samsung or Nova Launcher) and if enabled by the user. As of Android 8 (Oreo), [notification badges](https://developer.android.com/training/notify-user/badges) were introduced officially to reflect unread notifications. This plugin is unlikely to work as expected on devices running Android 8 or newer. Please see the [local notifications plugin docs](https://github.com/katzer/cordova-plugin-local-notifications) for more information on badge use with notifications. + +## Supported platforms + +- Android + - Browser + - iOS + - Windows diff --git a/docs/plugins/barcode-scanner/README.md b/docs/plugins/barcode-scanner/README.md new file mode 100644 index 000000000..ca1aeaca8 --- /dev/null +++ b/docs/plugins/barcode-scanner/README.md @@ -0,0 +1,26 @@ + + Improve this doc + + +# Barcode Scanner + +``` +$ ionic cordova plugin add phonegap-plugin-barcodescanner +$ npm install @ionic-native/plugins/barcode-scanner +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/barcode-scanner/) + +Plugin Repo: [https://github.com/phonegap/phonegap-plugin-barcodescanner](https://github.com/phonegap/phonegap-plugin-barcodescanner) + +The Barcode Scanner Plugin opens a camera view and automatically scans a barcode, returning the data back to you. + +Requires Cordova plugin: `phonegap-plugin-barcodescanner`. For more info, please see the [BarcodeScanner plugin docs](https://github.com/phonegap/phonegap-plugin-barcodescanner). + +## Supported platforms + +- Android + - BlackBerry 10 + - Browser + - iOS + - Windows diff --git a/docs/plugins/battery-status/README.md b/docs/plugins/battery-status/README.md new file mode 100644 index 000000000..3833c2762 --- /dev/null +++ b/docs/plugins/battery-status/README.md @@ -0,0 +1,23 @@ + + Improve this doc + + +# Battery Status + +``` +$ ionic cordova plugin add cordova-plugin-battery-status +$ npm install @ionic-native/plugins/battery-status +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/battery-status/) + +Plugin Repo: [https://github.com/apache/cordova-plugin-battery-status](https://github.com/apache/cordova-plugin-battery-status) + +Requires Cordova plugin: cordova-plugin-batterystatus. For more info, please see the [BatteryStatus plugin docs](https://github.com/apache/cordova-plugin-battery-status). + +## Supported platforms + +- iOS + - Android + - Windows + - Browser diff --git a/docs/plugins/biocatch/README.md b/docs/plugins/biocatch/README.md new file mode 100644 index 000000000..b5455820e --- /dev/null +++ b/docs/plugins/biocatch/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# BioCatch + +``` +$ ionic cordova plugin add cordova-plugin-biocatch +$ npm install @ionic-native/plugins/biocatch +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/biocatch/) + +Plugin Repo: [https://bitbucket.org/carlos_orellana/ionic-plugin](https://bitbucket.org/carlos_orellana/ionic-plugin) + +BioCatch SDK Cordova support + +## Supported platforms + +- iOS + - Android diff --git a/docs/plugins/biometric-wrapper/README.md b/docs/plugins/biometric-wrapper/README.md new file mode 100644 index 000000000..81c7698bf --- /dev/null +++ b/docs/plugins/biometric-wrapper/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# BiometricWrapper + +``` +$ '' +$ npm install @ionic-native/plugins/biometric-wrapper +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/biometric-wrapper/) + +Plugin Repo: ['']('') + +This plugin capture biometric(Iris and Fingerprint) and validate the user. +May be used in Banking domain + +## Supported platforms + +- Android diff --git a/docs/plugins/ble/README.md b/docs/plugins/ble/README.md new file mode 100644 index 000000000..b82cbfd99 --- /dev/null +++ b/docs/plugins/ble/README.md @@ -0,0 +1,33 @@ + + Improve this doc + + +# BLE + +``` +$ ionic cordova plugin add cordova-plugin-ble-central +$ npm install @ionic-native/plugins/ble +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/ble/) + +Plugin Repo: [https://github.com/don/cordova-plugin-ble-central](https://github.com/don/cordova-plugin-ble-central) + +This plugin enables communication between a phone and Bluetooth Low Energy (BLE) peripherals. + +The plugin provides a simple JavaScript API for iOS and Android. + +- Scan for peripherals +- Connect to a peripheral +- Read the value of a characteristic +- Write new value to a characteristic +- Get notified when characteristic's value changes + +Advertising information is returned when scanning for peripherals. Service, characteristic, and property info is returned when connecting to a peripheral. All access is via service and characteristic UUIDs. The plugin manages handles internally. + +Simultaneous connections to multiple peripherals are supported. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/blinkid/README.md b/docs/plugins/blinkid/README.md new file mode 100644 index 000000000..c99df493b --- /dev/null +++ b/docs/plugins/blinkid/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# BlinkId + +``` +$ ionic cordova plugin add blinkid-cordova --variable CAMERA_USAGE_DESCRIPTION="Enable your camera so that you can scan your ID to validate your account" +$ npm install @ionic-native/plugins/blinkid +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/blinkid/) + +Plugin Repo: [https://github.com/BlinkID/blinkid-phonegap](https://github.com/BlinkID/blinkid-phonegap) + +Microblink SDK wrapper for barcode and document scanning. See the +blinkid-phonegap repository for available recognizers and other settings + +## Supported platforms + +- iOS + - Android diff --git a/docs/plugins/bluetooth-classic-serial-port/README.md b/docs/plugins/bluetooth-classic-serial-port/README.md new file mode 100644 index 000000000..7616ad8e0 --- /dev/null +++ b/docs/plugins/bluetooth-classic-serial-port/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Bluetooth Classic Serial Port + +``` +$ ionic cordova plugin add cordova-plugin-bluetooth-classic-serial-port +$ npm install @ionic-native/plugins/bluetooth-classic-serial-port +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/bluetooth-classic-serial-port/) + +Plugin Repo: [https://github.com/MaximBelov/cordova-plugin-bluetooth-classic-serial-port](https://github.com/MaximBelov/cordova-plugin-bluetooth-classic-serial-port) + +This plugin is written using the iOS Accessory Framework (MFi) to support Classic Bluetooth on iOS. + +## Supported platforms + +- Android + - iOS + - Browser diff --git a/docs/plugins/bluetooth-le/README.md b/docs/plugins/bluetooth-le/README.md new file mode 100644 index 000000000..25d828d61 --- /dev/null +++ b/docs/plugins/bluetooth-le/README.md @@ -0,0 +1,23 @@ + + Improve this doc + + +# BluetoothLE + +``` +$ ionic cordova plugin add cordova-plugin-bluetoothle +$ npm install @ionic-native/plugins/bluetooth-le +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/bluetooth-le/) + +Plugin Repo: [https://github.com/randdusing/cordova-plugin-bluetoothle](https://github.com/randdusing/cordova-plugin-bluetoothle) + +This plugin has the most complete implementation for interacting with Bluetooth LE devices on Android, iOS and partially Windows. +It's a wrap around [randdusing/cordova-plugin-bluetoothle](https://github.com/randdusing/cordova-plugin-bluetoothle/blob/master/readme.md) cordova plugin for Ionic. +It supports peripheral **and** central modes and covers most of the API methods available on Android and iOS. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/bluetooth-serial/README.md b/docs/plugins/bluetooth-serial/README.md new file mode 100644 index 000000000..56fa73bbd --- /dev/null +++ b/docs/plugins/bluetooth-serial/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Bluetooth Serial + +``` +$ ionic cordova plugin add cordova-plugin-bluetooth-serial +$ npm install @ionic-native/plugins/bluetooth-serial +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/bluetooth-serial/) + +Plugin Repo: [https://github.com/don/BluetoothSerial](https://github.com/don/BluetoothSerial) + +This plugin enables serial communication over Bluetooth. It was written for communicating between Android or iOS and an Arduino (not Android to Android or iOS to iOS). + +## Supported platforms + +- Android + - iOS + - Windows Phone 8 diff --git a/docs/plugins/branch-io/README.md b/docs/plugins/branch-io/README.md new file mode 100644 index 000000000..cca55f17d --- /dev/null +++ b/docs/plugins/branch-io/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# BranchIo + +``` +$ ionic cordova plugin add branch-cordova-sdk +$ npm install @ionic-native/plugins/branch-io +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/branch-io/) + +Plugin Repo: [https://github.com/BranchMetrics/cordova-ionic-phonegap-branch-deep-linking](https://github.com/BranchMetrics/cordova-ionic-phonegap-branch-deep-linking) + +Branch.io is an attribution service for deeplinking and invitation links + +## Supported platforms + +- iOS + - Android diff --git a/docs/plugins/broadcaster/README.md b/docs/plugins/broadcaster/README.md new file mode 100644 index 000000000..9607ea874 --- /dev/null +++ b/docs/plugins/broadcaster/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Broadcaster + +``` +$ ionic cordova plugin add cordova-plugin-broadcaster +$ npm install @ionic-native/plugins/broadcaster +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/broadcaster/) + +Plugin Repo: [https://github.com/bsorrentino/cordova-broadcaster](https://github.com/bsorrentino/cordova-broadcaster) + +This plugin adds exchanging events between native code and your app. + +## Supported platforms + +- Android + - iOS + - Browser diff --git a/docs/plugins/build-info/README.md b/docs/plugins/build-info/README.md new file mode 100644 index 000000000..3909ff2ed --- /dev/null +++ b/docs/plugins/build-info/README.md @@ -0,0 +1,25 @@ + + Improve this doc + + +# Build Info + +``` +$ ionic cordova plugin add cordova-plugin-buildinfo +$ npm install @ionic-native/plugins/build-info +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/build-info/) + +Plugin Repo: [https://github.com/lynrin/cordova-plugin-buildinfo](https://github.com/lynrin/cordova-plugin-buildinfo) + +This plugin provides build information. + +## Supported platforms + +- Android + - iOS + - Windows + - macOS + - browser + - Electron diff --git a/docs/plugins/calendar/README.md b/docs/plugins/calendar/README.md new file mode 100644 index 000000000..37fd1f885 --- /dev/null +++ b/docs/plugins/calendar/README.md @@ -0,0 +1,23 @@ + + Improve this doc + + +# Calendar + +``` +$ ionic cordova plugin add cordova-plugin-calendar +$ npm install @ionic-native/plugins/calendar +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/calendar/) + +Plugin Repo: [https://github.com/EddyVerbruggen/Calendar-PhoneGap-Plugin](https://github.com/EddyVerbruggen/Calendar-PhoneGap-Plugin) + +This plugin allows you to add events to the Calendar of the mobile device. + +Requires Cordova plugin: `cordova-plugin-calendar`. For more info, please see the [Calendar plugin docs](https://github.com/EddyVerbruggen/Calendar-PhoneGap-Plugin). + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/call-directory/README.md b/docs/plugins/call-directory/README.md new file mode 100644 index 000000000..62fb7825b --- /dev/null +++ b/docs/plugins/call-directory/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Call Directory + +``` +$ cordova plugin add cordova-plugin-call-directory --variable EXT_NAME="Cordova-Directory" --variable ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES="NO" +$ npm install @ionic-native/plugins/call-directory +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/call-directory/) + +Plugin Repo: [https://github.com/GEDYSIntraWare/cordova-plugin-call-directory](https://github.com/GEDYSIntraWare/cordova-plugin-call-directory) + +This plugin can add phone numbers to an Callkit call directory extension. Call `reloadExtension` after using `addIdentification` and `removeIdentification` +to process the changes in the call directory extension. + +## Supported platforms + +- iOS diff --git a/docs/plugins/call-number/README.md b/docs/plugins/call-number/README.md new file mode 100644 index 000000000..257433d85 --- /dev/null +++ b/docs/plugins/call-number/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Call Number + +``` +$ ionic cordova plugin add call-number +$ npm install @ionic-native/plugins/call-number +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/call-number/) + +Plugin Repo: [https://github.com/Rohfosho/CordovaCallNumberPlugin](https://github.com/Rohfosho/CordovaCallNumberPlugin) + +Call a number directly from your Cordova/Ionic application. +NOTE\*\*: The iOS Simulator (and maybe Android Simulators) do not provide access to the phone subsystem. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/camera-preview/README.md b/docs/plugins/camera-preview/README.md new file mode 100644 index 000000000..7009583bf --- /dev/null +++ b/docs/plugins/camera-preview/README.md @@ -0,0 +1,29 @@ + + Improve this doc + + +# Camera Preview + +

+ This plugin is still in beta stage and may not work as expected. Please + submit any issues to the plugin repo. +

+ +``` +$ ionic cordova plugin add cordova-plugin-camera-preview +$ npm install @ionic-native/plugins/camera-preview +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/camera-preview/) + +Plugin Repo: [https://github.com/cordova-plugin-camera-preview/cordova-plugin-camera-preview](https://github.com/cordova-plugin-camera-preview/cordova-plugin-camera-preview) + +Showing camera preview in HTML + +Requires Cordova plugin: `https://github.com/cordova-plugin-camera-preview/cordova-plugin-camera-preview.git`. For more info, please see the [Cordova Camera Preview docs](https://github.com/cordova-plugin-camera-preview/cordova-plugin-camera-preview). + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/camera/README.md b/docs/plugins/camera/README.md new file mode 100644 index 000000000..f47b7e62c --- /dev/null +++ b/docs/plugins/camera/README.md @@ -0,0 +1,35 @@ + + Improve this doc + + +# Camera + +``` +$ ionic cordova plugin add cordova-plugin-camera +$ npm install @ionic-native/plugins/camera +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/camera/) + +Plugin Repo: [https://github.com/apache/cordova-plugin-camera](https://github.com/apache/cordova-plugin-camera) + +Take a photo or capture video. + +Requires the Cordova plugin: `cordova-plugin-camera`. For more info, please see the [Cordova Camera Plugin Docs](https://github.com/apache/cordova-plugin-camera). + +[Warning] Since IOS 10 the camera requires permissions to be placed in your config.xml add + +```xml + + You can take photos + +``` + +inside of the + Improve this doc + + +# Chooser + +``` +$ ionic cordova plugin add cordova-plugin-chooser +$ npm install @ionic-native/plugins/chooser +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/chooser/) + +Plugin Repo: [https://github.com/cyph/cordova-plugin-chooser](https://github.com/cyph/cordova-plugin-chooser) + +File chooser plugin for Cordova. + +The following must be added to config.xml to prevent crashing when selecting large files on Android: + +```xml + + + + + +``` + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/clevertap/README.md b/docs/plugins/clevertap/README.md new file mode 100644 index 000000000..cd47e8e59 --- /dev/null +++ b/docs/plugins/clevertap/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# CleverTap + +``` +$ ionic cordova plugin add clevertap-cordova +$ npm install @ionic-native/plugins/clevertap +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/clevertap/) + +Plugin Repo: [https://github.com/CleverTap/clevertap-cordova](https://github.com/CleverTap/clevertap-cordova) + +Cordova Plugin that wraps CleverTap SDK for Android and iOS + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/clipboard/README.md b/docs/plugins/clipboard/README.md new file mode 100644 index 000000000..3c5898f23 --- /dev/null +++ b/docs/plugins/clipboard/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Clipboard + +``` +$ ionic cordova plugin add cordova-clipboard +$ npm install @ionic-native/plugins/clipboard +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/clipboard/) + +Plugin Repo: [https://github.com/ihadeed/cordova-clipboard](https://github.com/ihadeed/cordova-clipboard) + +Clipboard management plugin for Cordova that supports iOS, Android, and Windows Phone 8. + +## Supported platforms + +- Android + - iOS + - Windows Phone 8 diff --git a/docs/plugins/cloud-settings/README.md b/docs/plugins/cloud-settings/README.md new file mode 100644 index 000000000..5b539580a --- /dev/null +++ b/docs/plugins/cloud-settings/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Cloud Settings + +``` +$ ionic cordova plugin add cordova-plugin-cloud-settings --variable ANDROID_BACKUP_SERVICE_KEY=myapikey +$ npm install @ionic-native/plugins/cloud-settings +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/cloud-settings/) + +Plugin Repo: [https://github.com/dpa99c/cordova-plugin-cloud-settings](https://github.com/dpa99c/cordova-plugin-cloud-settings) + +Stores app settings in cloud storage so if the user re-installs the app or installs it on a different device, the settings will be restored and available in the new installation. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/code-push/README.md b/docs/plugins/code-push/README.md new file mode 100644 index 000000000..3a94ad79c --- /dev/null +++ b/docs/plugins/code-push/README.md @@ -0,0 +1,23 @@ + + Improve this doc + + +# Code Push + +``` +$ ionic cordova plugin add cordova-plugin-code-push +$ npm install @ionic-native/plugins/code-push +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/code-push/) + +Plugin Repo: [https://github.com/Microsoft/cordova-plugin-code-push](https://github.com/Microsoft/cordova-plugin-code-push) + +CodePush plugin for Cordova by Microsoft that supports iOS and Android. + +For more info, please see https://github.com/Dellos7/example-cordova-code-push-plugin + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/custom-uisdk/README.md b/docs/plugins/custom-uisdk/README.md new file mode 100644 index 000000000..267f0825e --- /dev/null +++ b/docs/plugins/custom-uisdk/README.md @@ -0,0 +1,20 @@ + + Improve this doc + + +# CustomUISDK + +``` +$ '' +$ npm install @ionic-native/plugins/custom-uisdk +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/custom-uisdk/) + +Plugin Repo: [https://github.com/paytm/paytm-customuisdk-cordova](https://github.com/paytm/paytm-customuisdk-cordova) + +This plugin is used to access Paytm's native CustomUISDK framework's apis. + +## Supported platforms + +- Android, iOS diff --git a/docs/plugins/deeplinks/README.md b/docs/plugins/deeplinks/README.md new file mode 100644 index 000000000..15538a447 --- /dev/null +++ b/docs/plugins/deeplinks/README.md @@ -0,0 +1,26 @@ + + Improve this doc + + +# Deeplinks + +``` +$ ionic cordova plugin add ionic-plugin-deeplinks --variable URL_SCHEME=myapp --variable DEEPLINK_SCHEME=https --variable DEEPLINK_HOST=example.com --variable ANDROID_PATH_PREFIX=/ +$ npm install @ionic-native/plugins/deeplinks +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/deeplinks/) + +Plugin Repo: [https://github.com/ionic-team/ionic-plugin-deeplinks](https://github.com/ionic-team/ionic-plugin-deeplinks) + +This plugin handles deeplinks on iOS and Android for both custom URL scheme links +and Universal App Links. + +Please read the [ionic plugin deeplinks docs](https://github.com/ionic-team/ionic-plugin-deeplinks) for iOS and Android integration. +You must add `universal-links` to your `config.xml` and set up Apple App Site Association (AASA) for iOS and Asset Links for Android. + +## Supported platforms + +- Android + - Browser + - iOS diff --git a/docs/plugins/device-accounts/README.md b/docs/plugins/device-accounts/README.md new file mode 100644 index 000000000..774236112 --- /dev/null +++ b/docs/plugins/device-accounts/README.md @@ -0,0 +1,20 @@ + + Improve this doc + + +# Device Accounts + +``` +$ ionic cordova plugin add cordova-device-accounts-v2 +$ npm install @ionic-native/plugins/device-accounts +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/device-accounts/) + +Plugin Repo: [https://github.com/xUnholy/cordova-device-accounts-v2](https://github.com/xUnholy/cordova-device-accounts-v2) + +Gets the Google accounts associated with the Android device + +## Supported platforms + +- Android diff --git a/docs/plugins/device-motion/README.md b/docs/plugins/device-motion/README.md new file mode 100644 index 000000000..a98acfbed --- /dev/null +++ b/docs/plugins/device-motion/README.md @@ -0,0 +1,28 @@ + + Improve this doc + + +# Device Motion + +``` +$ ionic cordova plugin add cordova-plugin-device-motion +$ npm install @ionic-native/plugins/device-motion +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/device-motion/) + +Plugin Repo: [https://github.com/apache/cordova-plugin-device-motion](https://github.com/apache/cordova-plugin-device-motion) + +Requires Cordova plugin: `cordova-plugin-device-motion`. For more info, please see the [Device Motion docs](https://github.com/apache/cordova-plugin-device-motion). + +## Supported platforms + +- Android + - BlackBerry 10 + - Browser + - Firefox OS + - iOS + - Tizen + - Ubuntu + - Windows + - Windows Phone 8 diff --git a/docs/plugins/device-orientation/README.md b/docs/plugins/device-orientation/README.md new file mode 100644 index 000000000..6059d57d6 --- /dev/null +++ b/docs/plugins/device-orientation/README.md @@ -0,0 +1,29 @@ + + Improve this doc + + +# Device Orientation + +``` +$ ionic cordova plugin add cordova-plugin-device-orientation +$ npm install @ionic-native/plugins/device-orientation +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/device-orientation/) + +Plugin Repo: [https://github.com/apache/cordova-plugin-device-orientation](https://github.com/apache/cordova-plugin-device-orientation) + +Requires Cordova plugin: `cordova-plugin-device-orientation`. For more info, please see the [Device Orientation docs](https://github.com/apache/cordova-plugin-device-orientation). + +## Supported platforms + +- Amazon Fire OS + - Android + - BlackBerry 10 + - Browser + - Firefox OS + - iOS + - Tizen + - Ubuntu + - Windows + - Windows Phone diff --git a/docs/plugins/device/README.md b/docs/plugins/device/README.md new file mode 100644 index 000000000..45c0094d5 --- /dev/null +++ b/docs/plugins/device/README.md @@ -0,0 +1,24 @@ + + Improve this doc + + +# Device + +``` +$ ionic cordova plugin add cordova-plugin-device +$ npm install @ionic-native/plugins/device +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/device/) + +Plugin Repo: [https://github.com/apache/cordova-plugin-device](https://github.com/apache/cordova-plugin-device) + +Access information about the underlying device and platform. + +## Supported platforms + +- Android + - Browser + - iOS + - macOS + - Windows diff --git a/docs/plugins/dfu-update/README.md b/docs/plugins/dfu-update/README.md new file mode 100644 index 000000000..5a85cf20d --- /dev/null +++ b/docs/plugins/dfu-update/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Dfu Update + +``` +$ ionic cordova plugin add cordova-plugin-dfu-update --variable ANDROID_NORDIC_VERSION="1.11.0" +$ npm install @ionic-native/plugins/dfu-update +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/dfu-update/) + +Plugin Repo: [https://github.com/EinfachHans/cordova-plugin-dfu-update](https://github.com/EinfachHans/cordova-plugin-dfu-update) + +This plugin is a Wrapper to use Nordic Semiconductor's Device Firmware Update (DFU) service to update a Bluetooth LE device. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/diagnostic/README.md b/docs/plugins/diagnostic/README.md new file mode 100644 index 000000000..76c466fae --- /dev/null +++ b/docs/plugins/diagnostic/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Diagnostic + +``` +$ ionic cordova plugin add cordova.plugins.diagnostic +$ npm install @ionic-native/plugins/diagnostic +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/diagnostic/) + +Plugin Repo: [https://github.com/dpa99c/cordova-diagnostic-plugin](https://github.com/dpa99c/cordova-diagnostic-plugin) + +Checks whether device hardware features are enabled or available to the app, e.g. camera, GPS, wifi + +## Supported platforms + +- Android + - iOS + - Windows diff --git a/docs/plugins/dialogs/README.md b/docs/plugins/dialogs/README.md new file mode 100644 index 000000000..e2b3062cb --- /dev/null +++ b/docs/plugins/dialogs/README.md @@ -0,0 +1,26 @@ + + Improve this doc + + +# Dialogs + +``` +$ ionic cordova plugin add cordova-plugin-dialogs +$ npm install @ionic-native/plugins/dialogs +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/dialogs/) + +Plugin Repo: [https://github.com/apache/cordova-plugin-dialogs](https://github.com/apache/cordova-plugin-dialogs) + +This plugin gives you ability to access and customize the device native dialogs. + +Requires Cordova plugin: `cordova-plugin-dialogs`. For more info, please see the [Dialogs plugin docs](https://github.com/apache/cordova-plugin-dialogs). + +## Supported platforms + +- Amazon Fire OS + - Android + - Browser + - iOS + - Windows diff --git a/docs/plugins/dns/README.md b/docs/plugins/dns/README.md new file mode 100644 index 000000000..62522fb73 --- /dev/null +++ b/docs/plugins/dns/README.md @@ -0,0 +1,20 @@ + + Improve this doc + + +# DNS + +``` +$ ionic cordova plugin add cordova-plugin-dns +$ npm install @ionic-native/plugins/dns +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/dns/) + +Plugin Repo: [https://bitbucket.org/zegeba/cordova-plugin-dns](https://bitbucket.org/zegeba/cordova-plugin-dns) + +A plugin for Apache Cordova that enables applications to manually resolve hostnames into an underlying network address. This is mostly useful for determining whether there is a problem with the device's DNS server configuration. + +## Supported platforms + +- Android diff --git a/docs/plugins/document-picker/README.md b/docs/plugins/document-picker/README.md new file mode 100644 index 000000000..ec82ae77c --- /dev/null +++ b/docs/plugins/document-picker/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# iOS DocumentPicker + +``` +$ ionic cordova plugin add cordova-plugin-documentpicker.DocumentPicker +$ npm install @ionic-native/plugins/document-picker +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/document-picker/) + +Plugin Repo: [https://github.com/iampossible/Cordova-DocPicker](https://github.com/iampossible/Cordova-DocPicker) + +Opens the file picker on iOS for the user to select a file, returns a file URI. +Allows the user to upload files from iCloud + +## Supported platforms + +- iOS diff --git a/docs/plugins/document-scanner/README.md b/docs/plugins/document-scanner/README.md new file mode 100644 index 000000000..a34b9307b --- /dev/null +++ b/docs/plugins/document-scanner/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Document Scanner + +``` +$ ionic cordova plugin add cordova-plugin-document-scanner +$ npm install @ionic-native/plugins/document-scanner +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/document-scanner/) + +Plugin Repo: [https://github.com/NeutrinosPlatform/cordova-plugin-document-scanner](https://github.com/NeutrinosPlatform/cordova-plugin-document-scanner) + +This plugin processes images of documents, compensating for perspective. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/document-viewer/README.md b/docs/plugins/document-viewer/README.md new file mode 100644 index 000000000..5d11b0361 --- /dev/null +++ b/docs/plugins/document-viewer/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Document Viewer + +``` +$ ionic cordova plugin add cordova-plugin-document-viewer +$ npm install @ionic-native/plugins/document-viewer +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/document-viewer/) + +Plugin Repo: [https://github.com/sitewaerts/cordova-plugin-document-viewer](https://github.com/sitewaerts/cordova-plugin-document-viewer) + +This plugin offers a slim API to view PDF files which are either stored in the apps assets folder (/www/\*) or in any other file system directory available via the cordova file plugin. + +## Supported platforms + +- Android + - iOS + - Windows diff --git a/docs/plugins/email-composer/README.md b/docs/plugins/email-composer/README.md new file mode 100644 index 000000000..d848fc2b7 --- /dev/null +++ b/docs/plugins/email-composer/README.md @@ -0,0 +1,25 @@ + + Improve this doc + + +# Email Composer + +``` +$ ionic cordova plugin add cordova-plugin-email-composer +$ npm install @ionic-native/plugins/email-composer +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/email-composer/) + +Plugin Repo: [https://github.com/katzer/cordova-plugin-email-composer](https://github.com/katzer/cordova-plugin-email-composer) + +Requires Cordova plugin: cordova-plugin-email-composer. For more info, please see the [Email Composer plugin docs](https://github.com/hypery2k/cordova-email-plugin). + +## Supported platforms + +- Amazon Fire OS + - Android + - Browser + - iOS + - Windows + - macOS diff --git a/docs/plugins/fabric/README.md b/docs/plugins/fabric/README.md new file mode 100644 index 000000000..ab8358e2b --- /dev/null +++ b/docs/plugins/fabric/README.md @@ -0,0 +1,23 @@ + + Improve this doc + + +# Answers + +``` +$ ionic cordova plugin add cordova-fabric-plugin --variable FABRIC_API_KEY=XXX --variable FABRIC_API_SECRET=xxx +$ npm install @ionic-native/plugins/fabric +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/fabric/) + +Plugin Repo: [https://www.npmjs.com/package/cordova-fabric-plugin](https://www.npmjs.com/package/cordova-fabric-plugin) + +API for interacting with the Answers kit. + +https://docs.fabric.io/crashlytics/index.html + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/facebook/README.md b/docs/plugins/facebook/README.md new file mode 100644 index 000000000..f531d619e --- /dev/null +++ b/docs/plugins/facebook/README.md @@ -0,0 +1,86 @@ + + Improve this doc + + +# Facebook + +``` +$ ionic cordova plugin add cordova-plugin-facebook-connect --variable APP_ID="123456789" --variable APP_NAME="myApplication" +$ npm install @ionic-native/plugins/facebook +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/facebook/) + +Plugin Repo: [https://github.com/cordova-plugin-facebook-connect/cordova-plugin-facebook-connect](https://github.com/cordova-plugin-facebook-connect/cordova-plugin-facebook-connect) + +Use the Facebook Connect plugin to obtain access to the native FB application on iOS and Android. + +Requires Cordova plugin: `cordova-plugin-facebook-connect`. For more info, please see the [Facebook Connect](https://github.com/cordova-plugin-facebook-connect/cordova-plugin-facebook-connect). + +#### Installation + +To use the FB plugin, you first have to create a new Facebook App inside of the Facebook developer portal at [https://developers.facebook.com/apps](https://developers.facebook.com/apps). + +[![fb-getstarted-1](/img/docs/native/Facebook/1.png)](https://developers.facebook.com/apps/) + +Retrieve the `App ID` and `App Name`. + +[![fb-getstarted-2](/img/docs/native/Facebook/2.png)](https://developers.facebook.com/apps/) + +Then type in the following command in your Terminal, where APP_ID and APP_NAME are the values from the Facebook Developer portal. + +```bash + ionic cordova plugin add cordova-plugin-facebook-connect --variable APP_ID="123456789" --variable APP_NAME="myApplication" +``` + +After, you'll need to add the native platforms you'll be using to your app in the Facebook Developer portal under your app's Settings: + +[![fb-getstarted-3](/img/docs/native/Facebook/3.png)](https://developers.facebook.com/apps/) + +Click `'Add Platform'`. + +[![fb-getstarted-4](/img/docs/native/Facebook/4.png)](https://developers.facebook.com/apps/) + +At this point you'll need to open your project's [`config.xml`](https://cordova.apache.org/docs/en/latest/config_ref/index.html) file, found in the root directory of your project. + +Take note of the `id` for the next step: + +``` + +``` + +You can also edit the `id` to whatever you'd like it to be. + +#### iOS Install + +Under 'Bundle ID', add the `id` from your `config.xml` file: + +[![fb-getstarted-5](/img/docs/native/Facebook/5.png)](https://developers.facebook.com/apps/) + +#### Android Install + +Under 'Google Play Package Name', add the `id` from your `config.xml` file: + +[![fb-getstarted-6](/img/docs/native/Facebook/6.png)](https://developers.facebook.com/apps/) + +And that's it! You can now make calls to Facebook using the plugin. + +## Events + +App events allow you to understand the makeup of users engaging with your app, measure the performance of your Facebook mobile app ads, and reach specific sets of your users with Facebook mobile app ads. + +- [iOS] [https://developers.facebook.com/docs/ios/app-events](https://developers.facebook.com/docs/ios/app-events) +- [Android] [https://developers.facebook.com/docs/android/app-events](https://developers.facebook.com/docs/android/app-events) +- [JS] Does not have an Events API, so the plugin functions are empty and will return an automatic success + +Activation events are automatically tracked for you in the plugin. + +Events are listed on the [insights page](https://www.facebook.com/insights/). + +For tracking events, see `logEvent` and `logPurchase`. + +## Supported platforms + +- Android + - iOS + - Browser diff --git a/docs/plugins/fcm/README.md b/docs/plugins/fcm/README.md new file mode 100644 index 000000000..8284fadfe --- /dev/null +++ b/docs/plugins/fcm/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# FCM + +``` +$ ionic cordova plugin add cordova-plugin-fcm-with-dependecy-updated +$ npm install @ionic-native/plugins/fcm +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/fcm/) + +Plugin Repo: [https://github.com/andrehtissot/cordova-plugin-fcm-with-dependecy-updated](https://github.com/andrehtissot/cordova-plugin-fcm-with-dependecy-updated) + +Provides basic functionality for Firebase Cloud Messaging + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/file-opener/README.md b/docs/plugins/file-opener/README.md new file mode 100644 index 000000000..6474e1b47 --- /dev/null +++ b/docs/plugins/file-opener/README.md @@ -0,0 +1,23 @@ + + Improve this doc + + +# File Opener + +``` +$ ionic cordova plugin add cordova-plugin-file-opener2 +$ npm install @ionic-native/plugins/file-opener +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/file-opener/) + +Plugin Repo: [https://github.com/pwlin/cordova-plugin-file-opener2](https://github.com/pwlin/cordova-plugin-file-opener2) + +This plugin will open a file on your device file system with its default application. + +## Supported platforms + +- Android + - iOS + - Windows + - Windows Phone 8 diff --git a/docs/plugins/file-path/README.md b/docs/plugins/file-path/README.md new file mode 100644 index 000000000..75955cdcc --- /dev/null +++ b/docs/plugins/file-path/README.md @@ -0,0 +1,20 @@ + + Improve this doc + + +# File Path + +``` +$ ionic cordova plugin add cordova-plugin-filepath +$ npm install @ionic-native/plugins/file-path +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/file-path/) + +Plugin Repo: [https://github.com/hiddentao/cordova-plugin-filepath](https://github.com/hiddentao/cordova-plugin-filepath) + +This plugin allows you to resolve the native filesystem path for Android content URIs and is based on code in the aFileChooser library. + +## Supported platforms + +- Android diff --git a/docs/plugins/file-transfer/README.md b/docs/plugins/file-transfer/README.md new file mode 100644 index 000000000..c431dd155 --- /dev/null +++ b/docs/plugins/file-transfer/README.md @@ -0,0 +1,26 @@ + + Improve this doc + + +# File Transfer + +``` +$ ionic cordova plugin add cordova-plugin-file-transfer +$ npm install @ionic-native/plugins/file-transfer +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/file-transfer/) + +Plugin Repo: [https://github.com/apache/cordova-plugin-file-transfer](https://github.com/apache/cordova-plugin-file-transfer) + +This plugin allows you to upload and download files. + +## Supported platforms + +- Amazon Fire OS + - Android + - Browser + - iOS + - Ubuntu + - Windows + - Windows Phone diff --git a/docs/plugins/file/README.md b/docs/plugins/file/README.md new file mode 100644 index 000000000..0577a4cf6 --- /dev/null +++ b/docs/plugins/file/README.md @@ -0,0 +1,46 @@ + + Improve this doc + + +# File + +``` +$ ionic cordova plugin add cordova-plugin-file +$ npm install @ionic-native/plugins/file +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/file/) + +Plugin Repo: [https://github.com/apache/cordova-plugin-file](https://github.com/apache/cordova-plugin-file) + +This plugin implements a File API allowing read/write access to files residing on the device. + +The File class implements static convenience functions to access files and directories. + +Example: + +``` +import { File } from '@awesome-cordova-plugins/file/ngx'; + +constructor(private file: File) { } + +... + +this.file.checkDir(this.file.dataDirectory, 'mydir').then(_ => console.log('Directory exists')).catch(err => + console.log('Directory doesn't exist')); + +``` + +This plugin is based on several specs, including : The HTML5 File API http: //www.w3.org/TR/FileAPI/ +The (now-defunct) Directories and System extensions Latest: http: //www.w3.org/TR/2012/WD-file-system-api-20120417/ +Although most of the plugin code was written when an earlier spec was current: http: +//www.w3.org/TR/2011/WD-file-system-api-20110419/ It also implements the FileWriter spec : http: +//dev.w3.org/2009/dap/file-system/file-writer.html + +## Supported platforms + +- Android + - Browser + - iOS + - macOS + - Windows diff --git a/docs/plugins/fingerprint-aio/README.md b/docs/plugins/fingerprint-aio/README.md new file mode 100644 index 000000000..8c342e63a --- /dev/null +++ b/docs/plugins/fingerprint-aio/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Fingerprint AIO + +``` +$ ionic cordova plugin add cordova-plugin-fingerprint-aio +$ npm install @ionic-native/plugins/fingerprint-aio +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/fingerprint-aio/) + +Plugin Repo: [https://github.com/NiklasMerz/cordova-plugin-fingerprint-aio](https://github.com/NiklasMerz/cordova-plugin-fingerprint-aio) + +Use simple fingerprint authentication on Android and iOS. +Requires Cordova plugin: cordova-plugin-fingerprint-aio. For more info about plugin, vist: https://github.com/NiklasMerz/cordova-plugin-fingerprint-aio + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/firebase-analytics/README.md b/docs/plugins/firebase-analytics/README.md new file mode 100644 index 000000000..ce22a530a --- /dev/null +++ b/docs/plugins/firebase-analytics/README.md @@ -0,0 +1,49 @@ + + Improve this doc + + +# Firebase Analytics + +

+ This plugin is still in beta stage and may not work as expected. Please + submit any issues to the plugin repo. +

+ +``` +$ ionic cordova plugin add cordova-plugin-firebase-analytics +$ npm install @ionic-native/plugins/firebase-analytics +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/firebase-analytics/) + +Plugin Repo: [https://github.com/chemerisuk/cordova-plugin-firebase-analytics](https://github.com/chemerisuk/cordova-plugin-firebase-analytics) + +Cordova plugin for Firebase Analytics + +Go to firebase console and export google-services.json and GoogleService-Info.plist. Put those files into the root of your cordova app folder. + +NOTE: on iOS in order to collect demographic, age, gender data etc. you should additionally include AdSupport.framework into your project. + +## Using capacitor? + +For Android you'll have to add in **android/app/src/main/AndroidManfiest.xml** under `` + +``` + + + +``` + +And in the same file, you'll have to add `xmlns:tools="http://schemas.android.com/tools"` to your _manifest_ tag. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/firebase-authentication/README.md b/docs/plugins/firebase-authentication/README.md new file mode 100644 index 000000000..9755791ef --- /dev/null +++ b/docs/plugins/firebase-authentication/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Firebase Authentication + +``` +$ ionic cordova plugin add cordova-plugin-firebase-authentication --variable FIREBASE_AUTH_VERSION=version +$ npm install @ionic-native/plugins/firebase-authentication +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/firebase-authentication/) + +Plugin Repo: [https://github.com/chemerisuk/cordova-plugin-firebase-authentication](https://github.com/chemerisuk/cordova-plugin-firebase-authentication) + +Cordova plugin for Firebase Authentication + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/firebase-config/README.md b/docs/plugins/firebase-config/README.md new file mode 100644 index 000000000..b3df68eb7 --- /dev/null +++ b/docs/plugins/firebase-config/README.md @@ -0,0 +1,27 @@ + + Improve this doc + + +# Firebase Config + +

+ This plugin is still in beta stage and may not work as expected. Please + submit any issues to the plugin repo. +

+ +``` +$ ionic cordova plugin add cordova-plugin-firebase-config +$ npm install @ionic-native/plugins/firebase-config +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/firebase-config/) + +Plugin Repo: [https://github.com/chemerisuk/cordova-plugin-firebase-config](https://github.com/chemerisuk/cordova-plugin-firebase-config) + +Cordova plugin for Firebase Config + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/firebase-crash/README.md b/docs/plugins/firebase-crash/README.md new file mode 100644 index 000000000..32ab26e9c --- /dev/null +++ b/docs/plugins/firebase-crash/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# FirebaseCrash + +``` +$ ionic cordova plugin add cordova-plugin-firebase-crash +$ npm install @ionic-native/plugins/firebase-crash +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/firebase-crash/) + +Plugin Repo: [https://github.com/chemerisuk/cordova-plugin-firebase-crash](https://github.com/chemerisuk/cordova-plugin-firebase-crash) + +This plugin brings crash reporting from Google Firebase to your Cordova project! Android and iOS supported. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/firebase-crashlytics/README.md b/docs/plugins/firebase-crashlytics/README.md new file mode 100644 index 000000000..9283b7b24 --- /dev/null +++ b/docs/plugins/firebase-crashlytics/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Firebase Crashlytics + +``` +$ ionic cordova plugin add cordova-plugin-firebase-crashlytics --variable ANDROID_FIREBASE_CORE_VERSION=16.0.0 +$ npm install @ionic-native/plugins/firebase-crashlytics +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/firebase-crashlytics/) + +Plugin Repo: [https://github.com/ReallySmallSoftware/cordova-plugin-firebase-crashlytics](https://github.com/ReallySmallSoftware/cordova-plugin-firebase-crashlytics) + +A Google Firebase Crashlytics plugin to enable capture of crash reports. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/firebase-dynamic-links/README.md b/docs/plugins/firebase-dynamic-links/README.md new file mode 100644 index 000000000..bbda71e91 --- /dev/null +++ b/docs/plugins/firebase-dynamic-links/README.md @@ -0,0 +1,46 @@ + + Improve this doc + + +# Firebase Dynamic Links + +

+ This plugin is still in beta stage and may not work as expected. Please + submit any issues to the plugin repo. +

+ +``` +$ ionic cordova plugin add cordova-plugin-firebase-dynamiclinks --save --variable APP_DOMAIN="example.com" --variable APP_PATH="/" +$ npm install @ionic-native/plugins/firebase-dynamic-links +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/firebase-dynamic-links/) + +Plugin Repo: [https://github.com/chemerisuk/cordova-plugin-firebase-dynamiclinks](https://github.com/chemerisuk/cordova-plugin-firebase-dynamiclinks) + +Cordova plugin for Firebase Dynamic Links + +Variables APP_DOMAIN and APP_PATH specify web URL where your app will start an activity to handle the link. They also used to setup support for App Indexing. +Go to firebase console and export google-services.json and GoogleService-Info.plist. Put those files into the root of your cordova app folder. + +Preferences: + +Preferences GoogleIOSClientId and GoogleAndroidClientId are used to setup dynamic links when you have an app for several platforms. +You can find values at your GoogleService-Info.plist (key ANDROID_CLIENT_ID) and google-services.json (key client[0].oauth_client[0].client_id). + +config.xml: + +```xml + + + + + + +``` + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/firebase-messaging/README.md b/docs/plugins/firebase-messaging/README.md new file mode 100644 index 000000000..f24239d5e --- /dev/null +++ b/docs/plugins/firebase-messaging/README.md @@ -0,0 +1,27 @@ + + Improve this doc + + +# Firebase Messaging + +

+ This plugin is still in beta stage and may not work as expected. Please + submit any issues to the plugin repo. +

+ +``` +$ ionic cordova plugin add cordova-plugin-firebase-messaging +$ npm install @ionic-native/plugins/firebase-messaging +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/firebase-messaging/) + +Plugin Repo: [https://github.com/chemerisuk/cordova-plugin-firebase-messaging](https://github.com/chemerisuk/cordova-plugin-firebase-messaging) + +Cordova plugin for Firebase Messaging + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/firebase-vision/README.md b/docs/plugins/firebase-vision/README.md new file mode 100644 index 000000000..6a7bc59ba --- /dev/null +++ b/docs/plugins/firebase-vision/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Firebase Vision + +``` +$ ionic cordova plugin add cordova-plugin-firebase-mlvision +$ npm install @ionic-native/plugins/firebase-vision +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/firebase-vision/) + +Plugin Repo: [https://github.com/alon22/cordova-plugin-firebase-mlvision](https://github.com/alon22/cordova-plugin-firebase-mlvision) + +Cordova plugin for Firebase MLKit Vision + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/firebase-x/README.md b/docs/plugins/firebase-x/README.md new file mode 100644 index 000000000..9b73ac105 --- /dev/null +++ b/docs/plugins/firebase-x/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Firebase X + +``` +$ ionic cordova plugin add cordova-plugin-firebasex +$ npm install @ionic-native/plugins/firebase-x +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/firebase-x/) + +Plugin Repo: [https://github.com/dpa99c/cordova-plugin-firebasex](https://github.com/dpa99c/cordova-plugin-firebasex) + +This plugin brings push notifications, analytics, event tracking, crash reporting and more from Google Firebase to your Cordova project! Android and iOS supported. +It is a maintained fork from unmaintained ionic-navite plugin called Firebase. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/firebase/README.md b/docs/plugins/firebase/README.md new file mode 100644 index 000000000..b628a0676 --- /dev/null +++ b/docs/plugins/firebase/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Firebase + +``` +$ ionic cordova plugin add cordova-plugin-firebase +$ npm install @ionic-native/plugins/firebase +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/firebase/) + +Plugin Repo: [https://github.com/arnesson/cordova-plugin-firebase](https://github.com/arnesson/cordova-plugin-firebase) + +This plugin brings push notifications, analytics, event tracking, crash reporting and more from Google Firebase to your Cordova project! Android and iOS supported (including iOS 10). + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/flashlight/README.md b/docs/plugins/flashlight/README.md new file mode 100644 index 000000000..c0ade7346 --- /dev/null +++ b/docs/plugins/flashlight/README.md @@ -0,0 +1,24 @@ + + Improve this doc + + +# Flashlight + +``` +$ ionic cordova plugin add cordova-plugin-flashlight +$ npm install @ionic-native/plugins/flashlight +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/flashlight/) + +Plugin Repo: [https://github.com/EddyVerbruggen/Flashlight-PhoneGap-Plugin](https://github.com/EddyVerbruggen/Flashlight-PhoneGap-Plugin) + +This plugin allows you to switch the flashlight / torch of the device on and off. + +Requires Cordova plugin: `cordova-plugin-flashlight`. For more info, please see the [Flashlight plugin docs](https://github.com/EddyVerbruggen/Flashlight-PhoneGap-Plugin). + +## Supported platforms + +- Android + - iOS + - Windows Phone 8 diff --git a/docs/plugins/foreground-service/README.md b/docs/plugins/foreground-service/README.md new file mode 100644 index 000000000..01d686dbb --- /dev/null +++ b/docs/plugins/foreground-service/README.md @@ -0,0 +1,33 @@ + + Improve this doc + + +# Foreground Service + +``` +$ ionic cordova plugin add cordova-plugin-foreground-service +$ npm install @ionic-native/plugins/foreground-service +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/foreground-service/) + +Plugin Repo: [https://github.com/DavidBriglio/cordova-plugin-foreground-service](https://github.com/DavidBriglio/cordova-plugin-foreground-service) + +This plugin allows for android devices to continue running services in the background, using a +foreground ongoing notification. This is targeted towards use with plugins such as +'cordova-geolocation' that will not run while the app is in the background on android API 26+. + +For android API 28+, the following xml snippet should be inserted into `config.xml`: + +``` +... + + + + + ... +``` + +## Supported platforms + +- Android diff --git a/docs/plugins/ftp/README.md b/docs/plugins/ftp/README.md new file mode 100644 index 000000000..46d9c5539 --- /dev/null +++ b/docs/plugins/ftp/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# FTP + +``` +$ ionic cordova plugin add cordova-plugin-ftp +$ npm install @ionic-native/plugins/ftp +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/ftp/) + +Plugin Repo: [https://github.com/xfally/cordova-plugin-ftp](https://github.com/xfally/cordova-plugin-ftp) + +This cordova plugin is created to use ftp (client) in web/js. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/gao-de-location/README.md b/docs/plugins/gao-de-location/README.md new file mode 100644 index 000000000..e6a40dccf --- /dev/null +++ b/docs/plugins/gao-de-location/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Gao De Location + +``` +$ ionic cordova plugin add cordova-plugin-gaodelocation-chenyu --variable ANDROID_API_KEY=your android key --variable IOS_API_KEY=your ios key +$ npm install @ionic-native/plugins/gao-de-location +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/gao-de-location/) + +Plugin Repo: [https://github.com/waliu/cordova-plugin-gaodelocation-chenyu.git](https://github.com/waliu/cordova-plugin-gaodelocation-chenyu.git) + +Because the original GPS positioning uses Google Browser positioning, and Google withdraws from China, resulting in GPS Android positioning can not be positioned. +Gaode location can directly return address informationGaode location can directly return address information + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/ge-tui-sdk-plugin/README.md b/docs/plugins/ge-tui-sdk-plugin/README.md new file mode 100644 index 000000000..96dd5794b --- /dev/null +++ b/docs/plugins/ge-tui-sdk-plugin/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Ge Tui Sdk Plugin + +``` +$ cordova plugin add cordova-plugin-getuisdk --variable PUSH_APPID=your appid --variable PUSH_APPKEY=your appkey --variable PUSH_APPSECRET=your appsecret +$ npm install @ionic-native/plugins/ge-tui-sdk-plugin +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/ge-tui-sdk-plugin/) + +Plugin Repo: [git@github.com:GetuiLaboratory/cordova-plugin-getuisdk.git](git@github.com:GetuiLaboratory/cordova-plugin-getuisdk.git) + +This plugin does something + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/geolocation/README.md b/docs/plugins/geolocation/README.md new file mode 100644 index 000000000..b553a3bfa --- /dev/null +++ b/docs/plugins/geolocation/README.md @@ -0,0 +1,34 @@ + + Improve this doc + + +# Geolocation + +``` +$ ionic cordova plugin add cordova-plugin-geolocation --variable GEOLOCATION_USAGE_DESCRIPTION="To locate you" +$ npm install @ionic-native/plugins/geolocation +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/geolocation/) + +Plugin Repo: [https://github.com/apache/cordova-plugin-geolocation](https://github.com/apache/cordova-plugin-geolocation) + +This plugin provides information about the device's location, such as latitude and longitude. Common sources of location information include Global Positioning System (GPS) and location inferred from network signals such as IP address, RFID, WiFi and Bluetooth MAC addresses, and GSM/CDMA cell IDs. + +This API is based on the W3C Geolocation API Specification, and only executes on devices that don't already provide an implementation. + +For iOS you have to add this configuration to your configuration.xml file + +```xml + + We use your location for full functionality of certain app features. + +``` + +## Supported platforms + +- Amazon Fire OS + - Android + - Browser + - iOS + - Windows diff --git a/docs/plugins/globalization/README.md b/docs/plugins/globalization/README.md new file mode 100644 index 000000000..175f4a5e2 --- /dev/null +++ b/docs/plugins/globalization/README.md @@ -0,0 +1,24 @@ + + Improve this doc + + +# Globalization + +``` +$ ionic cordova plugin add cordova-plugin-globalization +$ npm install @ionic-native/plugins/globalization +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/globalization/) + +Plugin Repo: [https://github.com/apache/cordova-plugin-globalization](https://github.com/apache/cordova-plugin-globalization) + +This plugin obtains information and performs operations specific to the user's locale, language, and timezone. + +## Supported platforms + +- Amazon Fire OS + - Android + - Browser + - iOS + - Windows diff --git a/docs/plugins/google-analytics/README.md b/docs/plugins/google-analytics/README.md new file mode 100644 index 000000000..62711c726 --- /dev/null +++ b/docs/plugins/google-analytics/README.md @@ -0,0 +1,28 @@ + + Improve this doc + + +# Google Analytics + +``` +$ ionic cordova plugin add cordova-plugin-google-analytics +$ npm install @ionic-native/plugins/google-analytics +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/google-analytics/) + +Plugin Repo: [https://github.com/danwilson/google-analytics-plugin](https://github.com/danwilson/google-analytics-plugin) + +This plugin connects to Google's native Universal Analytics SDK +Prerequisites: + +- A Cordova 3.0+ project for iOS and/or Android +- A Mobile App property through the Google Analytics Admin Console +- (Android) Google Play Services SDK installed via [Android SDK Manager](https://developer.android.com/sdk/installing/adding-packages.html) + +## Supported platforms + +- Android + - Browser + - iOS + - Windows Phone 8 diff --git a/docs/plugins/google-nearby/README.md b/docs/plugins/google-nearby/README.md new file mode 100644 index 000000000..ae8d4e8a8 --- /dev/null +++ b/docs/plugins/google-nearby/README.md @@ -0,0 +1,20 @@ + + Improve this doc + + +# Google Nearby + +``` +$ ionic cordova plugin add cordova-plugin-google-nearby --variable API_KEY="123456789" +$ npm install @ionic-native/plugins/google-nearby +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/google-nearby/) + +Plugin Repo: [https://github.com/hahahannes/cordova-plugin-google-nearby](https://github.com/hahahannes/cordova-plugin-google-nearby) + +This plugin adds support for the Google Nearby Messages API. + +## Supported platforms + +- Android diff --git a/docs/plugins/google-plus/README.md b/docs/plugins/google-plus/README.md new file mode 100644 index 000000000..e08b0cc2a --- /dev/null +++ b/docs/plugins/google-plus/README.md @@ -0,0 +1,19 @@ + + Improve this doc + + +# Google Plus + +``` +$ ionic cordova plugin add cordova-plugin-googleplus --variable REVERSED_CLIENT_ID=myreversedclientid +$ npm install @ionic-native/plugins/google-plus +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/google-plus/) + +Plugin Repo: [https://github.com/EddyVerbruggen/cordova-plugin-googleplus](https://github.com/EddyVerbruggen/cordova-plugin-googleplus) + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/header-color/README.md b/docs/plugins/header-color/README.md new file mode 100644 index 000000000..506aa1a44 --- /dev/null +++ b/docs/plugins/header-color/README.md @@ -0,0 +1,20 @@ + + Improve this doc + + +# Header Color + +``` +$ ionic cordova plugin add cordova-plugin-headercolor +$ npm install @ionic-native/plugins/header-color +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/header-color/) + +Plugin Repo: [https://github.com/tomloprod/cordova-plugin-headercolor](https://github.com/tomloprod/cordova-plugin-headercolor) + +Cordova plugin to change color of header in Android Multitask View + +## Supported platforms + +- Android diff --git a/docs/plugins/health-kit/README.md b/docs/plugins/health-kit/README.md new file mode 100644 index 000000000..a0046ad34 --- /dev/null +++ b/docs/plugins/health-kit/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Health Kit + +``` +$ ionic cordova plugin add com.telerik.plugins.healthkit +$ npm install @ionic-native/plugins/health-kit +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/health-kit/) + +Plugin Repo: [https://github.com/Telerik-Verified-Plugins/HealthKit](https://github.com/Telerik-Verified-Plugins/HealthKit) + +The HealthKit plugin allows you to read data from and write data to the iOS 8+ HealthKit framework. +Any data saved shows up in the iOS Health app and is available for other iOS apps. + +## Supported platforms + +- iOS diff --git a/docs/plugins/health/README.md b/docs/plugins/health/README.md new file mode 100644 index 000000000..79decc101 --- /dev/null +++ b/docs/plugins/health/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Health + +``` +$ ionic cordova plugin add cordova-plugin-health +$ npm install @ionic-native/plugins/health +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/health/) + +Plugin Repo: [https://github.com/dariosalvi78/cordova-plugin-health](https://github.com/dariosalvi78/cordova-plugin-health) + +A plugin that abstracts fitness and health repositories like Apple HealthKit or Google Fit. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/http/README.md b/docs/plugins/http/README.md new file mode 100644 index 000000000..4b1ecd652 --- /dev/null +++ b/docs/plugins/http/README.md @@ -0,0 +1,27 @@ + + Improve this doc + + +# HTTP + +``` +$ ionic cordova plugin add cordova-plugin-advanced-http +$ npm install @ionic-native/plugins/http +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/http/) + +Plugin Repo: [https://github.com/silkimen/cordova-plugin-advanced-http](https://github.com/silkimen/cordova-plugin-advanced-http) + +Cordova / Phonegap plugin for communicating with HTTP servers. Supports iOS and Android. + +Advantages over Javascript requests: + +- SSL / TLS Pinning +- CORS restrictions do not apply +- Handling of HTTP code 401 - read more at [Issue CB-2415](https://issues.apache.org/jira/browse/CB-2415) + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/hyper-track/README.md b/docs/plugins/hyper-track/README.md new file mode 100644 index 000000000..855474d98 --- /dev/null +++ b/docs/plugins/hyper-track/README.md @@ -0,0 +1,25 @@ + + Improve this doc + + +# Coordinates + +alidationError +ic cordova plugin add cordova-plugin-hypertrack-v3 +$ npm install @ionic-native/plugins/hyper-track + +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/hyper-track/) + +Plugin Repo: [https://github.com/hypertrack/cordova-plugin-hypertrack.git](https://github.com/hypertrack/cordova-plugin-hypertrack.git) + + + +## Supported platforms + +- Android, iOS + + + +``` diff --git a/docs/plugins/iamport-cordova/README.md b/docs/plugins/iamport-cordova/README.md new file mode 100644 index 000000000..de531107b --- /dev/null +++ b/docs/plugins/iamport-cordova/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Iamport Cordova + +``` +$ ionic cordova plugin add iamport-cordova +$ npm install @ionic-native/plugins/iamport-cordova +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/iamport-cordova/) + +Plugin Repo: [https://github.com/iamport/iamport-cordova](https://github.com/iamport/iamport-cordova) + +This plugin does something + +## Supported platforms + +- ios + - android diff --git a/docs/plugins/ibeacon/README.md b/docs/plugins/ibeacon/README.md new file mode 100644 index 000000000..d8273d9dc --- /dev/null +++ b/docs/plugins/ibeacon/README.md @@ -0,0 +1,23 @@ + + Improve this doc + + +# IBeacon + +``` +$ ionic cordova plugin add cordova-plugin-ibeacon +$ npm install @ionic-native/plugins/ibeacon +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/ibeacon/) + +Plugin Repo: [https://github.com/petermetz/cordova-plugin-ibeacon](https://github.com/petermetz/cordova-plugin-ibeacon) + +This plugin provides functions for working with iBeacons. + +The plugin's API closely mimics the one exposed through the [CLLocationManager](https://developer.apple.com/library/ios/documentation/CoreLocation/Reference/CLLocationManager_Class/index.html) introduced in iOS 7. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/image-picker/README.md b/docs/plugins/image-picker/README.md new file mode 100644 index 000000000..cebdd04b1 --- /dev/null +++ b/docs/plugins/image-picker/README.md @@ -0,0 +1,24 @@ + + Improve this doc + + +# Image Picker + +``` +$ ionic cordova plugin add cordova-plugin-telerik-imagepicker --variable PHOTO_LIBRARY_USAGE_DESCRIPTION="your usage message" +$ npm install @ionic-native/plugins/image-picker +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/image-picker/) + +Plugin Repo: [https://github.com/Telerik-Verified-Plugins/ImagePicker](https://github.com/Telerik-Verified-Plugins/ImagePicker) + +Cordova Plugin For Multiple Image Selection + +Requires Cordova plugin: `cordova-plugin-image-picker`. +For more info, please see the https://github.com/Telerik-Verified-Plugins/ImagePicker + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/imap/README.md b/docs/plugins/imap/README.md new file mode 100644 index 000000000..afb02e1b6 --- /dev/null +++ b/docs/plugins/imap/README.md @@ -0,0 +1,23 @@ + + Improve this doc + + +# Imap + +``` +$ ionic cordova plugin add cordova-plugin-imap +$ npm install @ionic-native/plugins/imap +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/imap/) + +Plugin Repo: [https://github.com/aleksandar888/cordova-plugin-imap.git](https://github.com/aleksandar888/cordova-plugin-imap.git) + +This plugin will enable an Ionic application to use the IMAP (Internet Message Access Protocol) features. +This plugin is in Beta version and it offers support only for Android. +The plugin uses Java Mail API. +Planned improvements and support for iOS. + +## Supported platforms + +- Android diff --git a/docs/plugins/in-app-browser/README.md b/docs/plugins/in-app-browser/README.md new file mode 100644 index 000000000..5ca4801db --- /dev/null +++ b/docs/plugins/in-app-browser/README.md @@ -0,0 +1,25 @@ + + Improve this doc + + +# In App Browser + +``` +$ ionic cordova plugin add cordova-plugin-inappbrowser +$ npm install @ionic-native/plugins/in-app-browser +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/in-app-browser/) + +Plugin Repo: [https://github.com/apache/cordova-plugin-inappbrowser](https://github.com/apache/cordova-plugin-inappbrowser) + +Launches in app Browser + +## Supported platforms + +- AmazonFire OS + - Android + - Browser + - iOS + - macOS + - Windows diff --git a/docs/plugins/in-app-purchase-2/README.md b/docs/plugins/in-app-purchase-2/README.md new file mode 100644 index 000000000..57445b7f3 --- /dev/null +++ b/docs/plugins/in-app-purchase-2/README.md @@ -0,0 +1,45 @@ + + Improve this doc + + +# In App Purchase 2 + +``` +$ ionic cordova plugin add cordova-plugin-purchase --variable BILLING_KEY="" +$ npm install @ionic-native/plugins/in-app-purchase-2 +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/in-app-purchase-2/) + +Plugin Repo: [https://github.com/j3k0/cordova-plugin-purchase](https://github.com/j3k0/cordova-plugin-purchase) + +In-App Purchase on iOS, Android, Windows, macOS and XBox. + +## Features + +| | ios | android | win-8 | win-10/uwp | mac | +| -------------------- | --- | ------- | ----- | ---------- | --- | +| consumables | ✅ | ✅ | ✅ | ✅ | ✅ | +| non consumables | ✅ | ✅ | ✅ | ✅ | ✅ | +| subscriptions | ✅ | ✅ | ✅ | ✅ | ✅ | +| restore purchases | ✅ | ✅ | ✅ | ✅ | ✅ | +| receipt validations | ✅ | ✅ | | ✅ | ✅ | +| downloadable content | ✅ | | | | ✅ | +| introductory prices | ✅ | ✅ | | ✅ | ✅ | + +Supports: + +- **iOS** version 7.0 or higher. +- **Android** version 2.2 (API level 8) or higher + - with Google Play client version 3.9.16 or higher +- **Windows** Store/Phone 8.1 or higher +- **Windows 10 Mobile** +- **macOS** version 10 +- **Xbox One** + - (and any platform supporting Microsoft's UWP) + +## Supported platforms + +- iOS + - Android + - Windows diff --git a/docs/plugins/in-app-review/README.md b/docs/plugins/in-app-review/README.md new file mode 100644 index 000000000..437ae81e7 --- /dev/null +++ b/docs/plugins/in-app-review/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# In App Review + +``` +$ ionic cordova plugin add com.omarben.inappreview +$ npm install @ionic-native/plugins/in-app-review +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/in-app-review/) + +Plugin Repo: [https://github.com/omaxlive/com.omarben.inappreview](https://github.com/omaxlive/com.omarben.inappreview) + +This plugin does use the iOS class SKStore​Review​Controller to open the inApp review popup available since iOS 10.3 + +This functionality only works on iOS devices + +## Supported platforms + +- iOS diff --git a/docs/plugins/in-app-update/README.md b/docs/plugins/in-app-update/README.md new file mode 100644 index 000000000..d95eb48fa --- /dev/null +++ b/docs/plugins/in-app-update/README.md @@ -0,0 +1,20 @@ + + Improve this doc + + +# In App Update + +``` +$ ionic cordova plugin add cordova-in-app-update +$ npm install @ionic-native/plugins/in-app-update +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/in-app-update/) + +Plugin Repo: [https://github.com/itsLucario/cordova-app-update-plugin](https://github.com/itsLucario/cordova-app-update-plugin) + +This pluging enabels In app update For cordova. + +## Supported platforms + +- Android diff --git a/docs/plugins/insomnia/README.md b/docs/plugins/insomnia/README.md new file mode 100644 index 000000000..3aead17a7 --- /dev/null +++ b/docs/plugins/insomnia/README.md @@ -0,0 +1,25 @@ + + Improve this doc + + +# Insomnia + +``` +$ ionic cordova plugin add cordova-plugin-insomnia +$ npm install @ionic-native/plugins/insomnia +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/insomnia/) + +Plugin Repo: [https://github.com/EddyVerbruggen/Insomnia-PhoneGap-Plugin](https://github.com/EddyVerbruggen/Insomnia-PhoneGap-Plugin) + +Prevent the screen of the mobile device from falling asleep. + +## Supported platforms + +- Android + - Browser + - Firefox OS + - iOS + - Windows + - Windows Phone 8 diff --git a/docs/plugins/instagram/README.md b/docs/plugins/instagram/README.md new file mode 100644 index 000000000..2937298b1 --- /dev/null +++ b/docs/plugins/instagram/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Instagram + +``` +$ ionic cordova plugin add cordova-instagram-plugin +$ npm install @ionic-native/plugins/instagram +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/instagram/) + +Plugin Repo: [https://github.com/vstirbu/InstagramPlugin](https://github.com/vstirbu/InstagramPlugin) + +Share a photo with the instagram app + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/intercom/README.md b/docs/plugins/intercom/README.md new file mode 100644 index 000000000..ee5fcb68d --- /dev/null +++ b/docs/plugins/intercom/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Intercom + +``` +$ ionic cordova plugin add cordova-plugin-intercom +$ npm install @ionic-native/plugins/intercom +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/intercom/) + +Plugin Repo: [https://github.com/intercom/intercom-cordova](https://github.com/intercom/intercom-cordova) + +This is a plugin that allows your Ionic app to use Intercom for iOS and/or Intercom for Android. +Follow the offical documentation to setup this plugin correctly: https://developers.intercom.com/docs/cordova-phonegap-configuration + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/ionic-webview/README.md b/docs/plugins/ionic-webview/README.md new file mode 100644 index 000000000..61565358f --- /dev/null +++ b/docs/plugins/ionic-webview/README.md @@ -0,0 +1,23 @@ + + Improve this doc + + +# Ionic Webview + +``` +$ ionic cordova plugin add cordova-plugin-ionic-webview +$ npm install @ionic-native/plugins/ionic-webview +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/ionic-webview/) + +Plugin Repo: [https://github.com/ionic-team/cordova-plugin-ionic-webview](https://github.com/ionic-team/cordova-plugin-ionic-webview) + +Access Web View utilities. + +Requires the Cordova plugin: `cordova-plugin-ionic-webview` > 2.0. For more info, please see the [Ionic Web View](https://github.com/ionic-team/cordova-plugin-ionic-webview) repository. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/ios-aswebauthenticationsession-api/README.md b/docs/plugins/ios-aswebauthenticationsession-api/README.md new file mode 100644 index 000000000..6faaac883 --- /dev/null +++ b/docs/plugins/ios-aswebauthenticationsession-api/README.md @@ -0,0 +1,20 @@ + + Improve this doc + + +# ios-aswebauthenticationsession-api + +``` +$ ionic cordova plugin add cordova-plugin-ios-aswebauthenticationsession-api +$ npm install @ionic-native/plugins/ios-aswebauthenticationsession-api +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/ios-aswebauthenticationsession-api/) + +Plugin Repo: [https://github.com/jwelker110/cordova-plugin-ios-aswebauthenticationsession-api](https://github.com/jwelker110/cordova-plugin-ios-aswebauthenticationsession-api) + +Plugin for iOS 12 ASWebAuthenticationSession API + +## Supported platforms + +- iOS diff --git a/docs/plugins/is-debug/README.md b/docs/plugins/is-debug/README.md new file mode 100644 index 000000000..1e2e06ec5 --- /dev/null +++ b/docs/plugins/is-debug/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Is Debug + +``` +$ ionic cordova plugin add cordova-plugin-is-debug +$ npm install @ionic-native/plugins/is-debug +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/is-debug/) + +Plugin Repo: [https://github.com/mattlewis92/cordova-plugin-is-debug](https://github.com/mattlewis92/cordova-plugin-is-debug) + +Detect if the app is running in debug mode or not. +Debug mode is when the app is built and installed locally via xcode / eclipse / the cordova cli etc, compared to release mode when the app was downloaded from the app / play store via an end user. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/keyboard/README.md b/docs/plugins/keyboard/README.md new file mode 100644 index 000000000..266fd6a1e --- /dev/null +++ b/docs/plugins/keyboard/README.md @@ -0,0 +1,23 @@ + + Improve this doc + + +# Keyboard + +``` +$ ionic cordova plugin add cordova-plugin-ionic-keyboard +$ npm install @ionic-native/plugins/keyboard +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/keyboard/) + +Plugin Repo: [https://github.com/ionic-team/cordova-plugin-ionic-keyboard](https://github.com/ionic-team/cordova-plugin-ionic-keyboard) + +Keyboard plugin for Cordova. + +Requires Cordova plugin: `cordova-plugin-ionic-keyboard`. For more info, please see the [Keyboard plugin docs](https://github.com/ionic-team/cordova-plugin-ionic-keyboard). + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/keychain/README.md b/docs/plugins/keychain/README.md new file mode 100644 index 000000000..04a3d5207 --- /dev/null +++ b/docs/plugins/keychain/README.md @@ -0,0 +1,24 @@ + + Improve this doc + + +# Keychain + +``` +$ ionic cordova plugin add cordova-plugin-ios-keychain +$ npm install @ionic-native/plugins/keychain +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/keychain/) + +Plugin Repo: [https://github.com/ionic-team/cordova-plugin-ios-keychain](https://github.com/ionic-team/cordova-plugin-ios-keychain) + +Get and set data in the iOS Keychain + +Requires Cordova plugin: `cordova-plugin-ios-keychain`. For more info, please see the [Keychain plugin docs](https://github.com/ionic-team/cordova-plugin-ios-keychain). + +See also [Secure Storage](https://ionicframework.com/docs/native/secure-storage/) for more supported platforms. + +## Supported platforms + +- iOS diff --git a/docs/plugins/kommunicate/README.md b/docs/plugins/kommunicate/README.md new file mode 100644 index 000000000..9333ddd21 --- /dev/null +++ b/docs/plugins/kommunicate/README.md @@ -0,0 +1,25 @@ + + Improve this doc + + +# Kommunicate + +``` +$ ionic cordova plugin add kommunicate-cordova-plugin +$ npm install @ionic-native/plugins/kommunicate +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/kommunicate/) + +Plugin Repo: [https://github.com/Kommunicate-io/Kommunicate-Cordova-Ionic-PhoneGap-Chat-Plugin](https://github.com/Kommunicate-io/Kommunicate-Cordova-Ionic-PhoneGap-Chat-Plugin) + +The plugin for the Kommunicate SDK. +With the help of this plugin, you can easily add human + bot chat support functionality to you app. +Refer to: TODO: insert site link +For documentation: TODO: insert link + +## Supported platforms + +- Android + - Browser + - iOS diff --git a/docs/plugins/launch-navigator/README.md b/docs/plugins/launch-navigator/README.md new file mode 100644 index 000000000..f31a284a3 --- /dev/null +++ b/docs/plugins/launch-navigator/README.md @@ -0,0 +1,23 @@ + + Improve this doc + + +# Launch Navigator + +``` +$ ionic cordova plugin add uk.co.workingedge.phonegap.plugin.launchnavigator +$ npm install @ionic-native/plugins/launch-navigator +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/launch-navigator/) + +Plugin Repo: [https://github.com/dpa99c/phonegap-launch-navigator](https://github.com/dpa99c/phonegap-launch-navigator) + +Requires Cordova plugin: uk.co.workingedge.phonegap.plugin.launchnavigator. For more info, please see the [LaunchNavigator plugin docs](https://github.com/dpa99c/phonegap-launch-navigator). + +## Supported platforms + +- Android + - iOS + - Windows + - Windows Phone 8 diff --git a/docs/plugins/launch-review/README.md b/docs/plugins/launch-review/README.md new file mode 100644 index 000000000..b7eb80019 --- /dev/null +++ b/docs/plugins/launch-review/README.md @@ -0,0 +1,24 @@ + + Improve this doc + + +# Launch Review + +``` +$ ionic cordova plugin add cordova-launch-review +$ npm install @ionic-native/plugins/launch-review +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/launch-review/) + +Plugin Repo: [https://github.com/dpa99c/cordova-launch-review](https://github.com/dpa99c/cordova-launch-review) + +Assists in leaving user reviews/ratings in the App Stores. + +- Launches the platform's App Store page for the current app in order for the user to leave a review. +- On iOS (10.3 and above) invokes the native in-app rating dialog which allows a user to rate your app without needing to open the App Store. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/line-login/README.md b/docs/plugins/line-login/README.md new file mode 100644 index 000000000..6edd6b62e --- /dev/null +++ b/docs/plugins/line-login/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Line Login + +``` +$ ionic cordova plugin add https://github.com/nrikiji/cordova-line-login-plugin.git --variable LINE_CHANNEL_ID="your_line_channel_id" +$ npm install @ionic-native/plugins/line-login +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/line-login/) + +Plugin Repo: [https://github.com/nrikiji/cordova-line-login-plugin](https://github.com/nrikiji/cordova-line-login-plugin) + +The function login, logs out, acquires, verifies, and refreshes the access token. The version of LineSDK you are using is as follows. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/local-backup/README.md b/docs/plugins/local-backup/README.md new file mode 100644 index 000000000..dd45aa502 --- /dev/null +++ b/docs/plugins/local-backup/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# LocalBackup + +``` +$ ionic cordova plugin add cordova-plugin-local-backup +$ npm install @ionic-native/plugins/local-backup +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/local-backup/) + +Plugin Repo: [https://github.com/MaximBelov/cordova-plugin-local-backup](https://github.com/MaximBelov/cordova-plugin-local-backup) + +This plugin to create local backup + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/local-notifications/README.md b/docs/plugins/local-notifications/README.md new file mode 100644 index 000000000..eeb5c17af --- /dev/null +++ b/docs/plugins/local-notifications/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Local Notifications + +``` +$ ionic cordova plugin add cordova-plugin-local-notification +$ npm install @ionic-native/plugins/local-notifications +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/local-notifications/) + +Plugin Repo: [https://github.com/katzer/cordova-plugin-local-notifications](https://github.com/katzer/cordova-plugin-local-notifications) + +This plugin allows you to display local notifications on the device + +## Supported platforms + +- Android + - iOS + - Windows diff --git a/docs/plugins/location-accuracy/README.md b/docs/plugins/location-accuracy/README.md new file mode 100644 index 000000000..b1df15340 --- /dev/null +++ b/docs/plugins/location-accuracy/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Location Accuracy + +``` +$ ionic cordova plugin add cordova-plugin-request-location-accuracy +$ npm install @ionic-native/plugins/location-accuracy +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/location-accuracy/) + +Plugin Repo: [https://github.com/dpa99c/cordova-plugin-request-location-accuracy](https://github.com/dpa99c/cordova-plugin-request-location-accuracy) + +This Cordova/Phonegap plugin for Android and iOS to request enabling/changing of Location Services by triggering a native dialog from within the app, avoiding the need for the user to leave your app to change location settings manually. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/lottie-splash-screen/README.md b/docs/plugins/lottie-splash-screen/README.md new file mode 100644 index 000000000..818415e0f --- /dev/null +++ b/docs/plugins/lottie-splash-screen/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Lottie Splash Screen + +``` +$ '' +$ npm install @ionic-native/plugins/lottie-splash-screen +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/lottie-splash-screen/) + +Plugin Repo: [https://github.com/timbru31/cordova-plugin-lottie-splashscreen](https://github.com/timbru31/cordova-plugin-lottie-splashscreen) + +Cordova plugin to show bodymovin/Lottie animations as the splash screen with Airbnb's Lottie wrapper + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/media-capture/README.md b/docs/plugins/media-capture/README.md new file mode 100644 index 000000000..b2ebcd350 --- /dev/null +++ b/docs/plugins/media-capture/README.md @@ -0,0 +1,25 @@ + + Improve this doc + + +# Media Capture + +``` +$ ionic cordova plugin add cordova-plugin-media-capture +$ npm install @ionic-native/plugins/media-capture +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/media-capture/) + +Plugin Repo: [https://github.com/apache/cordova-plugin-media-capture](https://github.com/apache/cordova-plugin-media-capture) + +This plugin provides access to the device's audio, image, and video capture capabilities. + +Requires Cordova plugin: `cordova-plugin-media-capture`. For more info, please see the [Media Capture plugin docs](https://github.com/apache/cordova-plugin-media-capture). + +## Supported platforms + +- Android + - Browser + - iOS + - Windows diff --git a/docs/plugins/media/README.md b/docs/plugins/media/README.md new file mode 100644 index 000000000..91d2ec081 --- /dev/null +++ b/docs/plugins/media/README.md @@ -0,0 +1,23 @@ + + Improve this doc + + +# Media + +``` +$ ionic cordova plugin add cordova-plugin-media +$ npm install @ionic-native/plugins/media +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/media/) + +Plugin Repo: [https://github.com/apache/cordova-plugin-media](https://github.com/apache/cordova-plugin-media) + +This plugin provides the ability to record and play back audio files on a device. + +## Supported platforms + +- Android + - Browser + - iOS + - Windows diff --git a/docs/plugins/metrix/README.md b/docs/plugins/metrix/README.md new file mode 100644 index 000000000..8202d2d36 --- /dev/null +++ b/docs/plugins/metrix/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Metrix + +``` +$ ionic cordova plugin add ir.metrix.sdk +$ npm install @ionic-native/plugins/metrix +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/metrix/) + +Plugin Repo: [https://github.com/metrixorg/MetrixSDK-CordovaPlugin](https://github.com/metrixorg/MetrixSDK-CordovaPlugin) + +This is the Ionic Cordova SDK of Metrix™. You can read more about Metrix™ at metrix.ir. + +Requires Cordova plugin: `ir.metrix.sdk`. For more info, please see the [Metrix Cordova SDK](https://github.com/metrixorg/MetrixSDK-CordovaPlugin) + +## Supported platforms + +- Android diff --git a/docs/plugins/mixpanel/README.md b/docs/plugins/mixpanel/README.md new file mode 100644 index 000000000..e914beaf1 --- /dev/null +++ b/docs/plugins/mixpanel/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Mixpanel + +``` +$ ionic cordova plugin add cordova-plugin-mixpanel +$ npm install @ionic-native/plugins/mixpanel +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/mixpanel/) + +Plugin Repo: [https://github.com/samzilverberg/cordova-mixpanel-plugin](https://github.com/samzilverberg/cordova-mixpanel-plugin) + +Cordova Plugin that wraps Mixpanel SDK for Android and iOS + +## Supported platforms + +- Android + - Browser + - iOS diff --git a/docs/plugins/mlkit-translate/README.md b/docs/plugins/mlkit-translate/README.md new file mode 100644 index 000000000..1a723188e --- /dev/null +++ b/docs/plugins/mlkit-translate/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# MLKitTranslate + +``` +$ ionic cordova plugin add cordova-plugin-mlkit-translate +$ npm install @ionic-native/plugins/mlkit-translate +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/mlkit-translate/) + +Plugin Repo: [https://github.com/rigelglen/cordova-plugin-mlkit-translate](https://github.com/rigelglen/cordova-plugin-mlkit-translate) + +Plugin that implements MLKit Translation and Language Identification features. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/mobile-messaging/README.md b/docs/plugins/mobile-messaging/README.md new file mode 100644 index 000000000..d6c52099d --- /dev/null +++ b/docs/plugins/mobile-messaging/README.md @@ -0,0 +1,25 @@ + + Improve this doc + + +# Mobile Messaging + +``` +$ ionic cordova plugin add com-infobip-plugins-mobilemessaging +$ npm install @ionic-native/plugins/mobile-messaging +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/mobile-messaging/) + +Plugin Repo: [https://github.com/infobip/mobile-messaging-cordova-plugin](https://github.com/infobip/mobile-messaging-cordova-plugin) + +Mobile Messaging SDK is designed and developed to easily enable push notification channel in your mobile application. +In almost no time of implementation you get push notification in your application and access to the features of [Infobip IP Messaging Platform](https://portal.infobip.com/push/). +This document describes library integration steps for your Cordova project. + +For more info see [Cordova plugin docs](https://github.com/infobip/mobile-messaging-cordova-plugin) + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/multiple-document-picker/README.md b/docs/plugins/multiple-document-picker/README.md new file mode 100644 index 000000000..eb52cb997 --- /dev/null +++ b/docs/plugins/multiple-document-picker/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Multiple Documents Picker + +``` +$ ionic cordova plugin add cordova-plugin-multiple-documents-picker +$ npm install @ionic-native/plugins/multiple-document-picker +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/multiple-document-picker/) + +Plugin Repo: [https://github.com/akeotech/cordova-plugin-multiple-documents-picker](https://github.com/akeotech/cordova-plugin-multiple-documents-picker) + +This plugin allows users to pick multiple documents/images at once + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/music-controls/README.md b/docs/plugins/music-controls/README.md new file mode 100644 index 000000000..09ebc3336 --- /dev/null +++ b/docs/plugins/music-controls/README.md @@ -0,0 +1,24 @@ + + Improve this doc + + +# Music Controls + +``` +$ ionic cordova plugin add cordova-plugin-music-controls2 +$ npm install @ionic-native/plugins/music-controls +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/music-controls/) + +Plugin Repo: [https://github.com/ghenry22/cordova-plugin-music-controls2](https://github.com/ghenry22/cordova-plugin-music-controls2) + +Music controls for Cordova applications. +Display a 'media' notification with play/pause, previous, next buttons, allowing the user to control the play. +Handle also headset event (plug, unplug, headset button). + +## Supported platforms + +- Android + - iOS + - Windows diff --git a/docs/plugins/native-audio/README.md b/docs/plugins/native-audio/README.md new file mode 100644 index 000000000..4912c5016 --- /dev/null +++ b/docs/plugins/native-audio/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Native Audio + +``` +$ ionic cordova plugin add cordova-plugin-nativeaudio +$ npm install @ionic-native/plugins/native-audio +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/native-audio/) + +Plugin Repo: [https://github.com/floatinghotpot/cordova-plugin-nativeaudio](https://github.com/floatinghotpot/cordova-plugin-nativeaudio) + +Native Audio Playback + +## Supported platforms + +- Android + - Browser + - iOS diff --git a/docs/plugins/native-geocoder/README.md b/docs/plugins/native-geocoder/README.md new file mode 100644 index 000000000..f88892e29 --- /dev/null +++ b/docs/plugins/native-geocoder/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Native Geocoder + +``` +$ ionic cordova plugin add cordova-plugin-nativegeocoder +$ npm install @ionic-native/plugins/native-geocoder +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/native-geocoder/) + +Plugin Repo: [https://github.com/sebastianbaar/cordova-plugin-nativegeocoder](https://github.com/sebastianbaar/cordova-plugin-nativegeocoder) + +Cordova plugin for native forward and reverse geocoding + +## Supported platforms + +- iOS + - Android diff --git a/docs/plugins/native-keyboard/README.md b/docs/plugins/native-keyboard/README.md new file mode 100644 index 000000000..acf52698a --- /dev/null +++ b/docs/plugins/native-keyboard/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Native Keyboard + +``` +$ ionic cordova plugin add cordova-plugin-native-keyboard +$ npm install @ionic-native/plugins/native-keyboard +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/native-keyboard/) + +Plugin Repo: [https://github.com/EddyVerbruggen/cordova-plugin-native-keyboard](https://github.com/EddyVerbruggen/cordova-plugin-native-keyboard) + +A cross platform WhatsApp / Messenger / Slack -style keyboard even. For your Cordova app. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/native-page-transitions/README.md b/docs/plugins/native-page-transitions/README.md new file mode 100644 index 000000000..385b38744 --- /dev/null +++ b/docs/plugins/native-page-transitions/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Native Page Transitions + +``` +$ ionic cordova plugin add com.telerik.plugins.nativepagetransitions +$ npm install @ionic-native/plugins/native-page-transitions +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/native-page-transitions/) + +Plugin Repo: [https://github.com/Telerik-Verified-Plugins/NativePageTransitions](https://github.com/Telerik-Verified-Plugins/NativePageTransitions) + +The Native Page Transitions plugin uses native hardware acceleration to animate your transitions between views. You have complete control over the type of transition, the duration, and direction. + +## Supported platforms + +- Android + - iOS + - Windows Phone 8 diff --git a/docs/plugins/native-storage/README.md b/docs/plugins/native-storage/README.md new file mode 100644 index 000000000..2b4b217d5 --- /dev/null +++ b/docs/plugins/native-storage/README.md @@ -0,0 +1,24 @@ + + Improve this doc + + +# Native Storage + +``` +$ ionic cordova plugin add cordova-plugin-nativestorage +$ npm install @ionic-native/plugins/native-storage +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/native-storage/) + +Plugin Repo: [https://github.com/TheCocoaProject/cordova-plugin-nativestorage](https://github.com/TheCocoaProject/cordova-plugin-nativestorage) + +Native storage of variables in Android and iOS + +## Supported platforms + +- Android + - Browser + - iOS + - macOS + - Windows diff --git a/docs/plugins/native-view/README.md b/docs/plugins/native-view/README.md new file mode 100644 index 000000000..2c0c91189 --- /dev/null +++ b/docs/plugins/native-view/README.md @@ -0,0 +1,19 @@ + + Improve this doc + + +# NativeView + +``` +$ ionic cordova plugin add cordova-plugin-nativeview +$ npm install @ionic-native/plugins/native-view +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/native-view/) + +Plugin Repo: [https://github.com/mfdeveloper/cordova-plugin-nativeview](https://github.com/mfdeveloper/cordova-plugin-nativeview) + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/network-interface/README.md b/docs/plugins/network-interface/README.md new file mode 100644 index 000000000..3b30810d9 --- /dev/null +++ b/docs/plugins/network-interface/README.md @@ -0,0 +1,25 @@ + + Improve this doc + + +# Network Interface + +``` +$ ionic cordova plugin add cordova-plugin-networkinterface +$ npm install @ionic-native/plugins/network-interface +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/network-interface/) + +Plugin Repo: [https://github.com/salbahra/cordova-plugin-networkinterface](https://github.com/salbahra/cordova-plugin-networkinterface) + +Network interface information plugin for Cordova/PhoneGap that supports Android, Blackberry 10, Browser, iOS, and Windows Phone 8. + +## Supported platforms + +- Android + - BlackBerry 10 + - Browser + - iOS + - Windows + - Windows Phone diff --git a/docs/plugins/network/README.md b/docs/plugins/network/README.md new file mode 100644 index 000000000..8eeffa956 --- /dev/null +++ b/docs/plugins/network/README.md @@ -0,0 +1,24 @@ + + Improve this doc + + +# Network + +``` +$ ionic cordova plugin add cordova-plugin-network-information +$ npm install @ionic-native/plugins/network +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/network/) + +Plugin Repo: [https://github.com/apache/cordova-plugin-network-information](https://github.com/apache/cordova-plugin-network-information) + +Requires Cordova plugin: cordova-plugin-network-information. For more info, please see the [Network plugin docs](https://github.com/apache/cordova-plugin-network-information). + +## Supported platforms + +- Amazon Fire OS + - Android + - Browser + - iOS + - Windows diff --git a/docs/plugins/nfc/README.md b/docs/plugins/nfc/README.md new file mode 100644 index 000000000..6511d0e4d --- /dev/null +++ b/docs/plugins/nfc/README.md @@ -0,0 +1,34 @@ + + Improve this doc + + +# TextHelper + +onic cordova plugin add phonegap-nfc +$ npm install @ionic-native/plugins/nfc + +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/nfc/) + +Plugin Repo: [https://github.com/chariotsolutions/phonegap-nfc](https://github.com/chariotsolutions/phonegap-nfc) + +The NFC plugin allows you to read and write NFC tags. You can also beam to, and receive from, other NFC enabled devices. + +Use to +- read data from NFC tags +- write data to NFC tags +- send data to other NFC enabled devices +- receive data from NFC devices + +This plugin uses NDEF (NFC Data Exchange Format) for maximum compatibilty between NFC devices, tag types, and operating systems. + +## Supported platforms + +- Android + - iOS + - Windows + + + +``` diff --git a/docs/plugins/ocr/README.md b/docs/plugins/ocr/README.md new file mode 100644 index 000000000..30f9b9522 --- /dev/null +++ b/docs/plugins/ocr/README.md @@ -0,0 +1,24 @@ + + Improve this doc + + +# OCR + +``` +$ ionic cordova plugin add cordova-plugin-mobile-ocr +$ npm install @ionic-native/plugins/ocr +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/ocr/) + +Plugin Repo: [https://github.com/NeutrinosPlatform/cordova-plugin-mobile-ocr](https://github.com/NeutrinosPlatform/cordova-plugin-mobile-ocr) + +This plugin attempts to identify and extract text from an image. +Please note: This plugin depends on the GoogleMobileVision pod which is referencing UIWebview, that has been deprecated by Apple. +Don't use this plugin in an app intended for App Store as you will get a review rejection from Apple: `Deprecated API Usage — Apple will stop accepting submissions of apps that use UIWebView APIs` +For more info, please see the following Github issue [Google Mobile Vision relying on deprecated UIWebview](https://github.com/NeutrinosPlatform/cordova-plugin-mobile-ocr/issues/27). + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/onesignal/README.md b/docs/plugins/onesignal/README.md new file mode 100644 index 000000000..9a65bff36 --- /dev/null +++ b/docs/plugins/onesignal/README.md @@ -0,0 +1,91 @@ + + Improve this doc + + +# OneSignal + +``` +$ ionic cordova plugin add onesignal-cordova-plugin +$ npm install @ionic-native/plugins/onesignal +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/onesignal/) + +Plugin Repo: [https://github.com/OneSignal/OneSignal-Cordova-SDK](https://github.com/OneSignal/OneSignal-Cordova-SDK) + +The OneSignal plugin is an client implementation for using the [OneSignal](https://onesignal.com/) Service. +OneSignal is a simple implementation for delivering push notifications. + +Please view the official [OneSignal Ionic SDK Installation](https://documentation.onesignal.com/docs/ionic-sdk-setup) guide +for more information. + +#### Icons + +If you want to use generated icons with command `ionic cordova resources`: + +1. Add a file to your `hooks` directory called `copy_android_notification_icons.js` + +2. Configure the hook in your config.xml + +``` + + + +``` + +3. Put the following code in it: + +``` +#!/usr/bin/env node + +var fs = require('fs'); +var path = require('path'); + +var filestocopy = [{ + "resources/android/icon/drawable-hdpi-icon.png": + "platforms/android/app/src/main/res/drawable-hdpi/ic_stat_onesignal_default.png" +}, { + "resources/android/icon/drawable-mdpi-icon.png": + "platforms/android/app/src/main/res/drawable-mdpi/ic_stat_onesignal_default.png" +}, { + "resources/android/icon/drawable-xhdpi-icon.png": + "platforms/android/app/src/main/res/drawable-xhdpi/ic_stat_onesignal_default.png" +}, { + "resources/android/icon/drawable-xxhdpi-icon.png": + "platforms/android/app/src/main/res/drawable-xxhdpi/ic_stat_onesignal_default.png" +}, { + "resources/android/icon/drawable-xxxhdpi-icon.png": + "platforms/android/app/src/main/res/drawable-xxxhdpi/ic_stat_onesignal_default.png" +} ]; + +module.exports = function(context) { + + // no need to configure below + var rootdir = context.opts.projectRoot; + + filestocopy.forEach(function(obj) { + Object.keys(obj).forEach(function(key) { + var val = obj[key]; + var srcfile = path.join(rootdir, key); + var destfile = path.join(rootdir, val); + console.log("copying "+srcfile+" to "+destfile); + var destdir = path.dirname(destfile); + if (fs.existsSync(srcfile) && fs.existsSync(destdir)) { + fs.createReadStream(srcfile).pipe( + fs.createWriteStream(destfile)); + } + }); + }); + +}; +``` + +3. From the root of your project make the file executable: + `$ chmod +x hooks/copy_android_notification_icons.js` + +## Supported platforms + +- Amazon Fire OS + - Android + - iOS + - Windows diff --git a/docs/plugins/open-native-settings/README.md b/docs/plugins/open-native-settings/README.md new file mode 100644 index 000000000..93d1b351a --- /dev/null +++ b/docs/plugins/open-native-settings/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Open Native Settings + +``` +$ ionic cordova plugin add cordova-open-native-settings +$ npm install @ionic-native/plugins/open-native-settings +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/open-native-settings/) + +Plugin Repo: [https://github.com/guyromb/Cordova-open-native-settings](https://github.com/guyromb/Cordova-open-native-settings) + +Plugin to open native screens of iOS/android settings + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/openalpr/README.md b/docs/plugins/openalpr/README.md new file mode 100644 index 000000000..8aaedc8f4 --- /dev/null +++ b/docs/plugins/openalpr/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# OpenALPR + +``` +$ ionic cordova plugin add cordova-plugin-openalpr +$ npm install @ionic-native/plugins/openalpr +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/openalpr/) + +Plugin Repo: [https://github.com/iMicknl/cordova-plugin-openalpr](https://github.com/iMicknl/cordova-plugin-openalpr) + +This Cordova plugin adds support for the OpenALPR (Automatic License Plate Recognition) library, which provides support for retrieving the license plate from a picture. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/paytabs/README.md b/docs/plugins/paytabs/README.md new file mode 100644 index 000000000..f8bc8228f --- /dev/null +++ b/docs/plugins/paytabs/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# PayTabs + +``` +$ ionic cordova plugin add com.paytabs.cordova.plugin +$ npm install @ionic-native/plugins/paytabs +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/paytabs/) + +Plugin Repo: [https://github.com/paytabscom/paytabs-cordova](https://github.com/paytabscom/paytabs-cordova) + +A plugin that allows you to use PayTabs's Native SDKs for Android and iOS. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/pdf-generator/README.md b/docs/plugins/pdf-generator/README.md new file mode 100644 index 000000000..78a56941a --- /dev/null +++ b/docs/plugins/pdf-generator/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# PDFGenerator + +``` +$ ionic cordova plugin add cordova-pdf-generator +$ npm install @ionic-native/plugins/pdf-generator +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/pdf-generator/) + +Plugin Repo: [https://github.com/cesarvr/pdf-generator](https://github.com/cesarvr/pdf-generator) + +Simple plugin to generate (offline) pdf. The plugin transforms HTML to PDF and also provide the mechanism to share the pdf to other apps like Mail, etc. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/photo-library/README.md b/docs/plugins/photo-library/README.md new file mode 100644 index 000000000..a376dc8cc --- /dev/null +++ b/docs/plugins/photo-library/README.md @@ -0,0 +1,24 @@ + + Improve this doc + + +# Photo Library + +``` +$ ionic cordova plugin add cordova-plugin-photo-library --variable PHOTO_LIBRARY_USAGE_DESCRIPTION="To choose photos" +$ npm install @ionic-native/plugins/photo-library +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/photo-library/) + +Plugin Repo: [https://github.com/terikon/cordova-plugin-photo-library](https://github.com/terikon/cordova-plugin-photo-library) + +The PhotoLibrary plugin allows access to photos from device by url. So you can use plain img tag to display photos and their thumbnails, and different 3rd party libraries as well. +Saving photos and videos to the library is also supported. +cdvphotolibrary urls should be trusted by Angular. See plugin homepage to learn how. + +## Supported platforms + +- Android + - Browser + - iOS diff --git a/docs/plugins/photo-viewer/README.md b/docs/plugins/photo-viewer/README.md new file mode 100644 index 000000000..6f1a5e17f --- /dev/null +++ b/docs/plugins/photo-viewer/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Photo Viewer + +``` +$ ionic cordova plugin add com-sarriaroman-photoviewer +$ npm install @ionic-native/plugins/photo-viewer +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/photo-viewer/) + +Plugin Repo: [https://github.com/sarriaroman/photoviewer](https://github.com/sarriaroman/photoviewer) + +This plugin can display your image in full screen with the ability to pan, zoom, and share the image. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/play-install-referrer/README.md b/docs/plugins/play-install-referrer/README.md new file mode 100644 index 000000000..d44a7e305 --- /dev/null +++ b/docs/plugins/play-install-referrer/README.md @@ -0,0 +1,18 @@ + + Improve this doc + + +# PlayInstallReferrer + +``` +$ ionic cordova plugin add cordova-plugin-play-installreferrer +$ npm install @ionic-native/plugins/play-install-referrer +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/play-install-referrer/) + +Plugin Repo: [https://github.com/swayangjit/cordova-plugin-play-installreferrer](https://github.com/swayangjit/cordova-plugin-play-installreferrer) + +## Supported platforms + +- Android diff --git a/docs/plugins/pollfish/README.md b/docs/plugins/pollfish/README.md new file mode 100644 index 000000000..82a64cd6a --- /dev/null +++ b/docs/plugins/pollfish/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Pollfish + +``` +$ ionic cordova plugin add com.pollfish.cordova_plugin +$ npm install @ionic-native/plugins/pollfish +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/pollfish/) + +Plugin Repo: [https://github.com/pollfish/cordova-plugin-pollfish](https://github.com/pollfish/cordova-plugin-pollfish) + +Pollfish Ionic Native plugin wrapper + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/power-optimization/README.md b/docs/plugins/power-optimization/README.md new file mode 100644 index 000000000..6d193d786 --- /dev/null +++ b/docs/plugins/power-optimization/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Power Optimization + +``` +$ ionic cordova plugin add cordova-plugin-power-optimization +$ npm install @ionic-native/plugins/power-optimization +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/power-optimization/) + +Plugin Repo: [https://github.com/snt1017/cordova-plugin-power-optimization](https://github.com/snt1017/cordova-plugin-power-optimization) + +Android Custom Roms made sometimes your apps unfunctional due to being killed in the background, notification messages do not appearing or your services being killed by agressive power saving mode. +The Power Optimization plugin give you android PowerManager methods with cordova. + +## Supported platforms + +- Android diff --git a/docs/plugins/preview-any-file/README.md b/docs/plugins/preview-any-file/README.md new file mode 100644 index 000000000..213fb7b60 --- /dev/null +++ b/docs/plugins/preview-any-file/README.md @@ -0,0 +1,19 @@ + + Improve this doc + + +# PreviewAnyFile + +``` +$ '' +$ npm install @ionic-native/plugins/preview-any-file +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/preview-any-file/) + +Plugin Repo: [https://github.com/mostafa-mansour1/previewAnyFile](https://github.com/mostafa-mansour1/previewAnyFile) + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/printer/README.md b/docs/plugins/printer/README.md new file mode 100644 index 000000000..29a7158ac --- /dev/null +++ b/docs/plugins/printer/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Printer + +``` +$ ionic cordova plugin add cordova-plugin-printer +$ npm install @ionic-native/plugins/printer +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/printer/) + +Plugin Repo: [https://github.com/katzer/cordova-plugin-printer](https://github.com/katzer/cordova-plugin-printer) + +Prints documents or HTML rendered content + +## Supported platforms + +- Android + - iOS + - Windows diff --git a/docs/plugins/pspdfkit-cordova/README.md b/docs/plugins/pspdfkit-cordova/README.md new file mode 100644 index 000000000..7fb38745f --- /dev/null +++ b/docs/plugins/pspdfkit-cordova/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# PSPDFKit-Cordova + +``` +$ ionic cordova plugin add pspdfkit-cordova +$ npm install @ionic-native/plugins/pspdfkit-cordova +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/pspdfkit-cordova/) + +Plugin Repo: [https://github.com/PSPDFKit/PSPDFKit-Cordova](https://github.com/PSPDFKit/PSPDFKit-Cordova) + +The official plugin to use PSPDFKit with Cordova and Ionic. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/purchases/README.md b/docs/plugins/purchases/README.md new file mode 100644 index 000000000..c374703f8 --- /dev/null +++ b/docs/plugins/purchases/README.md @@ -0,0 +1,39 @@ + + Improve this doc + + +# Purchases + +``` +$ ionic cordova plugin add cordova-plugin-purchases@2.3.0 +$ npm install @ionic-native/plugins/purchases +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/purchases/) + +Plugin Repo: [https://github.com/RevenueCat/cordova-plugin-purchases](https://github.com/RevenueCat/cordova-plugin-purchases) + +Purchases is a cross platform solution for managing in-app subscriptions. A backend is also provided via [RevenueCat](https://www.revenuecat.com) + +## Features + +| | RevenueCat | +| --- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ✅ | Server-side receipt validation | +| ➡️ | [Webhooks](https://docs.revenuecat.com/docs/webhooks) - enhanced server-to-server communication with events for purchases, renewals, cancellations, and more | +| 🎯 | Subscription status tracking - know whether a user is subscribed whether they're on iOS, Android or web | +| 📊 | Analytics - automatic calculation of metrics like conversion, mrr, and churn | +| 📝 | [Online documentation](https://docs.revenuecat.com/docs) up to date | +| 🔀 | [Integrations](https://www.revenuecat.com/integrations) - over a dozen integrations to easily send purchase data where you need it | +| 💯 | Well maintained - [frequent releases](https://github.com/RevenueCat/cordova-plugin-purchases/releases) | +| 📮 | Great support - [Help Center](https://revenuecat.zendesk.com) | +| 🤩 | Awesome [new features](https://trello.com/b/RZRnWRbI/revenuecat-product-roadmap) | + +## Getting Started + +For more detailed information, you can view our complete documentation at [docs.revenuecat.com](https://docs.revenuecat.com/docs). + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/push/README.md b/docs/plugins/push/README.md new file mode 100644 index 000000000..c4950db7e --- /dev/null +++ b/docs/plugins/push/README.md @@ -0,0 +1,27 @@ + + Improve this doc + + +# Push + +``` +$ ionic cordova plugin add phonegap-plugin-push +$ npm install @ionic-native/plugins/push +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/push/) + +Plugin Repo: [https://github.com/phonegap/phonegap-plugin-push](https://github.com/phonegap/phonegap-plugin-push) + +Register and receive push notifications. + +Requires Cordova plugin: `phonegap-plugin-push`. For more info, please see the [Push plugin docs](https://github.com/phonegap/phonegap-plugin-push). + +For TypeScript users, see the [Push plugin docs about using TypeScript for custom notifications](https://github.com/phonegap/phonegap-plugin-push/blob/master/docs/TYPESCRIPT.md). + +## Supported platforms + +- Android + - Browser + - iOS + - Windows diff --git a/docs/plugins/pushape-push/README.md b/docs/plugins/pushape-push/README.md new file mode 100644 index 000000000..a7d91d0db --- /dev/null +++ b/docs/plugins/pushape-push/README.md @@ -0,0 +1,29 @@ + + Improve this doc + + +# PushapePush + +``` +$ ionic cordova plugin add pushape-cordova-push +$ npm install @ionic-native/plugins/pushape-push +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/pushape-push/) + +Plugin Repo: [https://github.com/gluelabs/pushape-cordova-push](https://github.com/gluelabs/pushape-cordova-push) + +Register and receive push notifications. +This plugin extends functionalities of Push native plugin in order to use it with Pushape service. + +Pushape service: @link https://glue-labs.com/pushape-invio-notifiche-push-ios-android-api-sdk + +Requires Cordova plugin: `pushape-cordova-push`. For more info, please see the [Pushape plugin docs](https://github.com/gluelabs/pushape-cordova-push). + +For TypeScript users, see the [Pushape plugin docs about using TypeScript for custom notifications](https://github.com/gluelabs/pushape-cordova-push/blob/master/docs/PUSHAPE_TYPESCRIPT.md). + +## Supported platforms + +- Android + - Browser + - iOS diff --git a/docs/plugins/safari-view-controller/README.md b/docs/plugins/safari-view-controller/README.md new file mode 100644 index 000000000..d2da666ef --- /dev/null +++ b/docs/plugins/safari-view-controller/README.md @@ -0,0 +1,23 @@ + + Improve this doc + + +# Safari View Controller + +``` +$ ionic cordova plugin add cordova-plugin-safariviewcontroller +$ npm install @ionic-native/plugins/safari-view-controller +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/safari-view-controller/) + +Plugin Repo: [https://github.com/EddyVerbruggen/cordova-plugin-safariviewcontroller](https://github.com/EddyVerbruggen/cordova-plugin-safariviewcontroller) + +For displaying read-only web content. + +Requires Cordova plugin: `cordova-plugin-safariviewcontroller`. For more info, please see the [Safari View Controller plugin docs](https://github.com/EddyVerbruggen/cordova-plugin-safariviewcontroller). + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/screen-orientation/README.md b/docs/plugins/screen-orientation/README.md new file mode 100644 index 000000000..7721c3a16 --- /dev/null +++ b/docs/plugins/screen-orientation/README.md @@ -0,0 +1,24 @@ + + Improve this doc + + +# Screen Orientation + +``` +$ ionic cordova plugin add cordova-plugin-screen-orientation +$ npm install @ionic-native/plugins/screen-orientation +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/screen-orientation/) + +Plugin Repo: [https://github.com/apache/cordova-plugin-screen-orientation](https://github.com/apache/cordova-plugin-screen-orientation) + +Cordova plugin to set/lock the screen orientation in a common way. + +Requires Cordova plugin: `cordova-plugin-screen-orientation`. For more info, please see the [Screen Orientation plugin docs](https://github.com/apache/cordova-plugin-screen-orientation). + +## Supported platforms + +- Android + - iOS + - Windows diff --git a/docs/plugins/secure-storage-echo/README.md b/docs/plugins/secure-storage-echo/README.md new file mode 100644 index 000000000..64c199b18 --- /dev/null +++ b/docs/plugins/secure-storage-echo/README.md @@ -0,0 +1,27 @@ + + Improve this doc + + +# Secure Storage Echo + +``` +$ ionic cordova plugin add cordova-plugin-secure-storage-echo +$ npm install @ionic-native/plugins/secure-storage-echo +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/secure-storage-echo/) + +Plugin Repo: [https://github.com/mibrito707/cordova-plugin-secure-storage-echo](https://github.com/mibrito707/cordova-plugin-secure-storage-echo) + +This plugin gets, sets and removes key,value pairs from a device's secure storage. + +Requires Cordova plugin: `cordova-plugin-secure-storage-echo`. For more info, please see the [Cordova Secure Storage docs](https://github.com/mibrito707/cordova-plugin-secure-storage-echo). + +The browser platform is supported as a mock only. Key/values are stored unencrypted in localStorage. + +## Supported platforms + +- Android + - Browser + - iOS + - Windows diff --git a/docs/plugins/secure-storage/README.md b/docs/plugins/secure-storage/README.md new file mode 100644 index 000000000..de3ab2acf --- /dev/null +++ b/docs/plugins/secure-storage/README.md @@ -0,0 +1,27 @@ + + Improve this doc + + +# Secure Storage + +``` +$ ionic cordova plugin add cordova-plugin-secure-storage-echo +$ npm install @ionic-native/plugins/secure-storage +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/secure-storage/) + +Plugin Repo: [https://github.com/mibrito707/cordova-plugin-secure-storage-echo](https://github.com/mibrito707/cordova-plugin-secure-storage-echo) + +This plugin gets, sets and removes key,value pairs from a device's secure storage. + +Requires Cordova plugin: `cordova-plugin-secure-storage`. For more info, please see the [Cordova Secure Storage docs](https://github.com/Crypho/cordova-plugin-secure-storage). + +The browser platform is supported as a mock only. Key/values are stored unencrypted in localStorage. + +## Supported platforms + +- Android + - Browser + - iOS + - Windows diff --git a/docs/plugins/service-discovery/README.md b/docs/plugins/service-discovery/README.md new file mode 100644 index 000000000..8b448148f --- /dev/null +++ b/docs/plugins/service-discovery/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# ServiceDiscovery + +``` +$ ionic cordova plugin add cordova-plugin-discovery +$ npm install @ionic-native/plugins/service-discovery +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/service-discovery/) + +Plugin Repo: [https://github.com/scottdermott/cordova-plugin-discovery](https://github.com/scottdermott/cordova-plugin-discovery) + +Simple plugin to get any SSDP / UPnP / DLNA service on a local network + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/shake/README.md b/docs/plugins/shake/README.md new file mode 100644 index 000000000..292ce786f --- /dev/null +++ b/docs/plugins/shake/README.md @@ -0,0 +1,20 @@ + + Improve this doc + + +# Shake + +``` +$ ionic cordova plugin add cordova-plugin-shake +$ npm install @ionic-native/plugins/shake +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/shake/) + +Plugin Repo: [https://github.com/leecrossley/cordova-plugin-shake](https://github.com/leecrossley/cordova-plugin-shake) + +Handles shake gesture + +## Supported platforms + +- iOS diff --git a/docs/plugins/sign-in-with-apple/README.md b/docs/plugins/sign-in-with-apple/README.md new file mode 100644 index 000000000..4d3f1f4c7 --- /dev/null +++ b/docs/plugins/sign-in-with-apple/README.md @@ -0,0 +1,25 @@ + + Improve this doc + + +# Sign In With Apple + +``` +$ ionic cordova plugin add cordova-plugin-sign-in-with-apple +$ npm install @ionic-native/plugins/sign-in-with-apple +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/sign-in-with-apple/) + +Plugin Repo: [https://github.com/twogate/cordova-plugin-sign-in-with-apple](https://github.com/twogate/cordova-plugin-sign-in-with-apple) + +Sign in with Apple makes it easy for users to sign in to your apps and websites using their Apple ID. +Instead of filling out forms, verifying email addresses, and choosing new passwords, +they can use Sign in with Apple to set up an account and start using your app right away. +All accounts are protected with two-factor authentication for superior security, +and Apple will not track users’ activity in your app or website. +Source:\* https://developer.apple.com/sign-in-with-apple/ + +## Supported platforms + +- iOS diff --git a/docs/plugins/smartlook/README.md b/docs/plugins/smartlook/README.md new file mode 100644 index 000000000..45530a724 --- /dev/null +++ b/docs/plugins/smartlook/README.md @@ -0,0 +1,26 @@ + + Improve this doc + + +# SmartlookGlobalEventPropertyKey + +lugin add https://github.com/smartlook/cordova-smartlook.git +$ npm install @ionic-native/plugins/smartlook + +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/smartlook/) + +Plugin Repo: [https://github.com/smartlook/cordova-smartlook.git](https://github.com/smartlook/cordova-smartlook.git) + +Official Smartlook SDK plugin. +Full documentation can be found here: https://smartlook.github.io/docs/sdk/ionic/ + +## Supported platforms + +- Android + - iOS + + + +``` diff --git a/docs/plugins/sms-retriever/README.md b/docs/plugins/sms-retriever/README.md new file mode 100644 index 000000000..2ef2fa51c --- /dev/null +++ b/docs/plugins/sms-retriever/README.md @@ -0,0 +1,20 @@ + + Improve this doc + + +# Sms Retriever + +``` +$ ionic cordova plugin add cordova-plugin-sms-retriever-manager --variable PLAY_SERVICES_VERSION="15.0.1" +$ npm install @ionic-native/plugins/sms-retriever +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/sms-retriever/) + +Plugin Repo: [https://github.com/hanatharesh2712/ionic-native-sms-retriever-plugin-master](https://github.com/hanatharesh2712/ionic-native-sms-retriever-plugin-master) + +This plugin retrives the SMS which arrive without requiring READ permissions. + +## Supported platforms + +- Android diff --git a/docs/plugins/sms/README.md b/docs/plugins/sms/README.md new file mode 100644 index 000000000..c509ca7f4 --- /dev/null +++ b/docs/plugins/sms/README.md @@ -0,0 +1,23 @@ + + Improve this doc + + +# SMS + +``` +$ ionic cordova plugin add cordova-sms-plugin +$ npm install @ionic-native/plugins/sms +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/sms/) + +Plugin Repo: [https://github.com/cordova-sms/cordova-sms-plugin](https://github.com/cordova-sms/cordova-sms-plugin) + +Requires Cordova plugin: cordova-sms-plugin. For more info, please see the [SMS plugin docs](https://github.com/cordova-sms/cordova-sms-plugin). + +## Supported platforms + +- Android + - iOS + - Windows + - Windows Phone 8 diff --git a/docs/plugins/social-sharing/README.md b/docs/plugins/social-sharing/README.md new file mode 100644 index 000000000..fe5b0362c --- /dev/null +++ b/docs/plugins/social-sharing/README.md @@ -0,0 +1,26 @@ + + Improve this doc + + +# Social Sharing + +``` +$ ionic cordova plugin add cordova-plugin-x-socialsharing +$ npm install @ionic-native/plugins/social-sharing +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/social-sharing/) + +Plugin Repo: [https://github.com/EddyVerbruggen/SocialSharing-PhoneGap-Plugin](https://github.com/EddyVerbruggen/SocialSharing-PhoneGap-Plugin) + +Share text, files, images, and links via social networks, sms, and email. + +For Browser usage check out the Web Share API docs: https://github.com/EddyVerbruggen/SocialSharing-PhoneGap-Plugin#5-web-share-api + +## Supported platforms + +- Android + - Browser + - iOS + - Windows + - Windows Phone diff --git a/docs/plugins/speech-recognition/README.md b/docs/plugins/speech-recognition/README.md new file mode 100644 index 000000000..c1a679c39 --- /dev/null +++ b/docs/plugins/speech-recognition/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Speech Recognition + +``` +$ ionic cordova plugin add cordova-plugin-speechrecognition +$ npm install @ionic-native/plugins/speech-recognition +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/speech-recognition/) + +Plugin Repo: [https://github.com/pbakondy/cordova-plugin-speechrecognition](https://github.com/pbakondy/cordova-plugin-speechrecognition) + +This plugin does speech recognition using cloud services + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/spinner-dialog/README.md b/docs/plugins/spinner-dialog/README.md new file mode 100644 index 000000000..11abc82d9 --- /dev/null +++ b/docs/plugins/spinner-dialog/README.md @@ -0,0 +1,25 @@ + + Improve this doc + + +# Spinner Dialog + +``` +$ ionic cordova plugin add cordova-plugin-native-spinner +$ npm install @ionic-native/plugins/spinner-dialog +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/spinner-dialog/) + +Plugin Repo: [https://github.com/greybax/cordova-plugin-native-spinner](https://github.com/greybax/cordova-plugin-native-spinner) + +Cordova plugin for showing a native spinner based on Paldom/SpinnerDialog. + +Requires Cordova plugin: `cordova-plugin-native-spinner`. For more info, please see the [Spinner Dialog plugin docs](https://github.com/greybax/cordova-plugin-native-spinner). + +## Supported platforms + +- Android + - iOS + - Windows Phone 8 + - Windows diff --git a/docs/plugins/splash-screen/README.md b/docs/plugins/splash-screen/README.md new file mode 100644 index 000000000..411d2699a --- /dev/null +++ b/docs/plugins/splash-screen/README.md @@ -0,0 +1,23 @@ + + Improve this doc + + +# Splash Screen + +``` +$ ionic cordova plugin add cordova-plugin-splashscreen +$ npm install @ionic-native/plugins/splash-screen +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/splash-screen/) + +Plugin Repo: [https://github.com/apache/cordova-plugin-splashscreen](https://github.com/apache/cordova-plugin-splashscreen) + +This plugin displays and hides a splash screen during application launch. The methods below allows showing and hiding the splashscreen after the app has loaded. + +## Supported platforms + +- Amazon Fire OS + - Android + - iOS + - Windows diff --git a/docs/plugins/spotify-auth/README.md b/docs/plugins/spotify-auth/README.md new file mode 100644 index 000000000..f07f8000a --- /dev/null +++ b/docs/plugins/spotify-auth/README.md @@ -0,0 +1,23 @@ + + Improve this doc + + +# Spotify Auth + +``` +$ ionic cordova plugin add cordova-spotify-oauth --variable LOCAL_STORAGE_KEY="SpotifyOAuthData" +$ npm install @ionic-native/plugins/spotify-auth +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/spotify-auth/) + +Plugin Repo: [https://github.com/Festify/cordova-spotify-oauth](https://github.com/Festify/cordova-spotify-oauth) + +Cordova plugin for authenticating with Spotify + +> https://github.com/Festify/cordova-spotify-oauth + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/sqlite-db-copy/README.md b/docs/plugins/sqlite-db-copy/README.md new file mode 100644 index 000000000..f88ff5436 --- /dev/null +++ b/docs/plugins/sqlite-db-copy/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Sqlite Db Copy + +``` +$ ionic cordova plugin add cordova-plugin-dbcopy +$ npm install @ionic-native/plugins/sqlite-db-copy +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/sqlite-db-copy/) + +Plugin Repo: [https://github.com/an-rahulpandey/cordova-plugin-dbcopy](https://github.com/an-rahulpandey/cordova-plugin-dbcopy) + +This plugin does something + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/sqlite-porter/README.md b/docs/plugins/sqlite-porter/README.md new file mode 100644 index 000000000..21dd5df7b --- /dev/null +++ b/docs/plugins/sqlite-porter/README.md @@ -0,0 +1,27 @@ + + Improve this doc + + +# SQLite Porter + +``` +$ ionic cordova plugin add uk.co.workingedge.cordova.plugin.sqliteporter +$ npm install @ionic-native/plugins/sqlite-porter +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/sqlite-porter/) + +Plugin Repo: [https://github.com/dpa99c/cordova-sqlite-porter](https://github.com/dpa99c/cordova-sqlite-porter) + +This Cordova/Phonegap plugin can be used to import/export to/from a SQLite database using either SQL or JSON. + +## Supported platforms + +- Amazon Fire OS + - Android + - BlackBerry 10 + - Browser + - iOS + - Tizen + - Windows + - Windows Phone diff --git a/docs/plugins/sqlite/README.md b/docs/plugins/sqlite/README.md new file mode 100644 index 000000000..4fc5cdd84 --- /dev/null +++ b/docs/plugins/sqlite/README.md @@ -0,0 +1,23 @@ + + Improve this doc + + +# SQLite + +``` +$ ionic cordova plugin add cordova-sqlite-storage +$ npm install @ionic-native/plugins/sqlite +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/sqlite/) + +Plugin Repo: [https://github.com/litehelpers/Cordova-sqlite-storage](https://github.com/litehelpers/Cordova-sqlite-storage) + +Access SQLite databases on the device. + +## Supported platforms + +- Android + - iOS + - macOS + - Windows diff --git a/docs/plugins/star-prnt/README.md b/docs/plugins/star-prnt/README.md new file mode 100644 index 000000000..4b2baebcc --- /dev/null +++ b/docs/plugins/star-prnt/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# StarPRNT + +``` +$ ionic cordova plugin add cordova-plugin-starprnt +$ npm install @ionic-native/plugins/star-prnt +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/star-prnt/) + +Plugin Repo: [https://github.com/auctifera-josed/starprnt](https://github.com/auctifera-josed/starprnt) + +Ionic Native wrappers for the starprnt cordova plugin for Star Micronics Bluetooth/LAN printers + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/status-bar/README.md b/docs/plugins/status-bar/README.md new file mode 100644 index 000000000..1ae6413d5 --- /dev/null +++ b/docs/plugins/status-bar/README.md @@ -0,0 +1,24 @@ + + Improve this doc + + +# Status Bar + +``` +$ ionic cordova plugin add cordova-plugin-statusbar +$ npm install @ionic-native/plugins/status-bar +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/status-bar/) + +Plugin Repo: [https://github.com/apache/cordova-plugin-statusbar](https://github.com/apache/cordova-plugin-statusbar) + +Manage the appearance of the native status bar. + +Requires Cordova plugin: `cordova-plugin-statusbar`. For more info, please see the [StatusBar plugin docs](https://github.com/apache/cordova-plugin-statusbar). + +## Supported platforms + +- Android + - iOS + - Windows diff --git a/docs/plugins/streaming-media/README.md b/docs/plugins/streaming-media/README.md new file mode 100644 index 000000000..45b18b6cb --- /dev/null +++ b/docs/plugins/streaming-media/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Streaming Media + +``` +$ ionic cordova plugin add cordova-plugin-streaming-media +$ npm install @ionic-native/plugins/streaming-media +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/streaming-media/) + +Plugin Repo: [https://github.com/nchutchind/cordova-plugin-streaming-media](https://github.com/nchutchind/cordova-plugin-streaming-media) + +This plugin allows you to stream audio and video in a fullscreen, native player on iOS and Android. + +## Supported platforms + +- Amazon Fire OS + - Android + - iOS diff --git a/docs/plugins/stripe/README.md b/docs/plugins/stripe/README.md new file mode 100644 index 000000000..ffd401cec --- /dev/null +++ b/docs/plugins/stripe/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Stripe + +``` +$ ionic cordova plugin add cordova-plugin-stripe +$ npm install @ionic-native/plugins/stripe +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/stripe/) + +Plugin Repo: [https://github.com/zyramedia/cordova-plugin-stripe](https://github.com/zyramedia/cordova-plugin-stripe) + +A plugin that allows you to use Stripe's Native SDKs for Android and iOS. + +## Supported platforms + +- Android + - Browser + - iOS diff --git a/docs/plugins/sum-up/README.md b/docs/plugins/sum-up/README.md new file mode 100644 index 000000000..b8ae06d87 --- /dev/null +++ b/docs/plugins/sum-up/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# SumUp + +``` +$ cordova plugin add cordova-sumup-plugin --variable SUMUP_API_KEY=INSERT_YOUR_KEY +$ npm install @ionic-native/plugins/sum-up +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/sum-up/) + +Plugin Repo: [https://github.com/mariusbackes/cordova-plugin-sumup](https://github.com/mariusbackes/cordova-plugin-sumup) + +Plugin to communicate with a SumUp payment terminal + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/system-alert-window-permission/README.md b/docs/plugins/system-alert-window-permission/README.md new file mode 100644 index 000000000..12440dda4 --- /dev/null +++ b/docs/plugins/system-alert-window-permission/README.md @@ -0,0 +1,20 @@ + + Improve this doc + + +# System Alert Window Permission + +``` +$ ionic cordova plugin add cordova-plugin-system-alert-window-permission +$ npm install @ionic-native/plugins/system-alert-window-permission +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/system-alert-window-permission/) + +Plugin Repo: [https://github.com/MaximBelov/cordova-plugin-system-alert-window-permission.git](https://github.com/MaximBelov/cordova-plugin-system-alert-window-permission.git) + +This plugin does something + +## Supported platforms + +- Android diff --git a/docs/plugins/taptic-engine/README.md b/docs/plugins/taptic-engine/README.md new file mode 100644 index 000000000..a3da1cc9c --- /dev/null +++ b/docs/plugins/taptic-engine/README.md @@ -0,0 +1,20 @@ + + Improve this doc + + +# Taptic Engine + +``` +$ ionic cordova plugin add cordova-plugin-taptic-engine +$ npm install @ionic-native/plugins/taptic-engine +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/taptic-engine/) + +Plugin Repo: [https://github.com/EddyVerbruggen/cordova-plugin-taptic-engine](https://github.com/EddyVerbruggen/cordova-plugin-taptic-engine) + +An Ionic plugin to use Taptic Engine API on iPhone 7, 7 Plus or newer. + +## Supported platforms + +- iOS diff --git a/docs/plugins/tealium-adidentifier/README.md b/docs/plugins/tealium-adidentifier/README.md new file mode 100644 index 000000000..d4938eb25 --- /dev/null +++ b/docs/plugins/tealium-adidentifier/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# TealiumAdIdentifier + +``` +$ '' +$ npm install @ionic-native/plugins/tealium-adidentifier +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/tealium-adidentifier/) + +Plugin Repo: [https://github.com/Tealium/cordova-plugin](https://github.com/Tealium/cordova-plugin) + +This module depends on the [Tealium Cordova Plugin](https://github.com/tealium/cordova-plugin). Without it, this module will not do anything. +Makes the IDFA and Google Ad Identifier available in the Tealium data layer. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/tealium-installreferrer/README.md b/docs/plugins/tealium-installreferrer/README.md new file mode 100644 index 000000000..6bb701cc7 --- /dev/null +++ b/docs/plugins/tealium-installreferrer/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# TealiumInstallReferrer + +``` +$ '' +$ npm install @ionic-native/plugins/tealium-installreferrer +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/tealium-installreferrer/) + +Plugin Repo: [https://github.com/Tealium/cordova-plugin](https://github.com/Tealium/cordova-plugin) + +This module depends on the [Tealium Cordova Plugin](https://github.com/tealium/cordova-plugin). Without it, this module will not do anything. +Implements a Broadcast Receiver for the INSTALL_REFERRER intent. + +## Supported platforms + +- Android diff --git a/docs/plugins/tealium/README.md b/docs/plugins/tealium/README.md new file mode 100644 index 000000000..4aa16c55d --- /dev/null +++ b/docs/plugins/tealium/README.md @@ -0,0 +1,23 @@ + + Improve this doc + + +# Tealium + +``` +$ '' +$ npm install @ionic-native/plugins/tealium +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/tealium/) + +Plugin Repo: [https://github.com/Tealium/cordova-plugin](https://github.com/Tealium/cordova-plugin) + +This plugin provides a TypeScript wrapper around the [Tealium](https://www.tealium.com) Cordova plugin for Ionic Native. + +For full documentation, see [https://community.tealiumiq.com/t5/Mobile-Libraries/Tealium-for-Cordova/ta-p/17618](https://community.tealiumiq.com/t5/Mobile-Libraries/Tealium-for-Cordova/ta-p/17618) + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/text-to-speech-advanced/README.md b/docs/plugins/text-to-speech-advanced/README.md new file mode 100644 index 000000000..788df3640 --- /dev/null +++ b/docs/plugins/text-to-speech-advanced/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Text To Speech Advanced + +``` +$ ionic cordova plugin add cordova-plugin-tts-advanced +$ npm install @ionic-native/plugins/text-to-speech-advanced +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/text-to-speech-advanced/) + +Plugin Repo: [https://github.com/spasma/cordova-plugin-tts-advanced](https://github.com/spasma/cordova-plugin-tts-advanced) + +Text to Speech plugin + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/theme-detection/README.md b/docs/plugins/theme-detection/README.md new file mode 100644 index 000000000..a47bcfae6 --- /dev/null +++ b/docs/plugins/theme-detection/README.md @@ -0,0 +1,27 @@ + + Improve this doc + + +# Theme Detection + +

+ This plugin is still in beta stage and may not work as expected. Please + submit any issues to the plugin repo. +

+ +``` +$ cordova plugin add cordova-plugin-theme-detection +$ npm install @ionic-native/plugins/theme-detection +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/theme-detection/) + +Plugin Repo: [https://github.com/mariusbackes/cordova-plugin-theme-detection](https://github.com/mariusbackes/cordova-plugin-theme-detection) + +Cordova plugin to detect whether dark mode is enabled or not + +## Supported platforms + +- iOS + - Android diff --git a/docs/plugins/three-dee-touch/README.md b/docs/plugins/three-dee-touch/README.md new file mode 100644 index 000000000..19a3cdaed --- /dev/null +++ b/docs/plugins/three-dee-touch/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# 3D Touch + +``` +$ ionic cordova plugin add cordova-plugin-3dtouch +$ npm install @ionic-native/plugins/three-dee-touch +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/three-dee-touch/) + +Plugin Repo: [https://github.com/EddyVerbruggen/cordova-plugin-3dtouch](https://github.com/EddyVerbruggen/cordova-plugin-3dtouch) + +The 3D Touch plugin adds 3D Touch capabilities to your Cordova app. + +Requires Cordova plugin: `cordova-plugin-3dtouch`. For more info, please see the [3D Touch plugin docs](https://github.com/EddyVerbruggen/cordova-plugin-3dtouch). + +## Supported platforms + +- iOS diff --git a/docs/plugins/toast/README.md b/docs/plugins/toast/README.md new file mode 100644 index 000000000..503a25cbc --- /dev/null +++ b/docs/plugins/toast/README.md @@ -0,0 +1,26 @@ + + Improve this doc + + +# Toast + +``` +$ ionic cordova plugin add cordova-plugin-x-toast +$ npm install @ionic-native/plugins/toast +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/toast/) + +Plugin Repo: [https://github.com/EddyVerbruggen/Toast-PhoneGap-Plugin](https://github.com/EddyVerbruggen/Toast-PhoneGap-Plugin) + +This plugin allows you to show a native Toast (a little text popup) on iOS, Android and WP8. It's great for showing a non intrusive native notification which is guaranteed always in the viewport of the browser. + +Requires Cordova plugin: `cordova-plugin-x-toast`. For more info, please see the [Toast plugin docs](https://github.com/EddyVerbruggen/Toast-PhoneGap-Plugin). + +## Supported platforms + +- Android + - BlackBerry 10 + - iOS + - Windows + - Windows Phone 8 diff --git a/docs/plugins/touch-id/README.md b/docs/plugins/touch-id/README.md new file mode 100644 index 000000000..e5ea7b82c --- /dev/null +++ b/docs/plugins/touch-id/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Touch ID + +``` +$ ionic cordova plugin add cordova-plugin-touch-id +$ npm install @ionic-native/plugins/touch-id +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/touch-id/) + +Plugin Repo: [https://github.com/EddyVerbruggen/cordova-plugin-touch-id](https://github.com/EddyVerbruggen/cordova-plugin-touch-id) + +Scan the fingerprint of a user with the TouchID sensor. + +Requires Cordova plugin: `cordova-plugin-touch-id`. For more info, please see the [TouchID plugin docs](https://github.com/EddyVerbruggen/cordova-plugin-touch-id). + +## Supported platforms + +- iOS diff --git a/docs/plugins/unvired-cordova-sdk/README.md b/docs/plugins/unvired-cordova-sdk/README.md new file mode 100644 index 000000000..1e56e3b1b --- /dev/null +++ b/docs/plugins/unvired-cordova-sdk/README.md @@ -0,0 +1,48 @@ + + Improve this doc + + +# AuthenticateLocalResult + +$ ionic cordova plugin add @awesome-cordova-plugins/unvired-cordova-sdk +$ npm install @ionic-native/plugins/unvired-cordova-sdk + +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/unvired-cordova-sdk/) + +Plugin Repo: [https://github.com/unvired/cordova-plugin-unvired-sdk/](https://github.com/unvired/cordova-plugin-unvired-sdk/) + +This plugin lets you build apps which connect to Unvired Mobile Platform (UMP). +- +iOS Requirements +- +Update your Cocoapods repo before you install the plugin. +``` + +$ pod repo update + +``` +- +Browser Requirements +- +After you install the plugin, for Ionic/Angular projects, please add a reference to the following JS files within section of index.html. +``` + + + + + + +``` + +## Supported platforms + +- iOS + - Android + - Windows + - Browser + + + +``` diff --git a/docs/plugins/uptime/README.md b/docs/plugins/uptime/README.md new file mode 100644 index 000000000..9bc41ad20 --- /dev/null +++ b/docs/plugins/uptime/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Uptime + +``` +$ ionic cordova plugin add cordova-plugin-uptime +$ npm install @ionic-native/plugins/uptime +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/uptime/) + +Plugin Repo: [https://github.com/s1lviu/cordova-plugin-uptime](https://github.com/s1lviu/cordova-plugin-uptime) + +This plugin provides the time spent in milliseconds since boot (uptime). + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/urbanairship/README.md b/docs/plugins/urbanairship/README.md new file mode 100644 index 000000000..bc75aa137 --- /dev/null +++ b/docs/plugins/urbanairship/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# UrbanAirShip + +``` +$ ionic cordova plugin add urbanairship-cordova +$ npm install @ionic-native/plugins/urbanairship +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/urbanairship/) + +Plugin Repo: [https://www.npmjs.com/package/urbanairship-cordova](https://www.npmjs.com/package/urbanairship-cordova) + +This plugin does something + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/usabilla-cordova-sdk/README.md b/docs/plugins/usabilla-cordova-sdk/README.md new file mode 100644 index 000000000..59bfdaf1d --- /dev/null +++ b/docs/plugins/usabilla-cordova-sdk/README.md @@ -0,0 +1,24 @@ + + Improve this doc + + +# Usabilla + +``` +$ ionic cordova plugin add usabilla-cordova +$ npm install @ionic-native/plugins/usabilla-cordova-sdk +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/usabilla-cordova-sdk/) + +Plugin Repo: [https://github.com/usabilla/usabilla-u4a-cordova](https://github.com/usabilla/usabilla-u4a-cordova) + +Usabilla SDK is designed and developed to collect feedback from your users with great ease and flexibility through your mobile application. +This document describes library integration steps for your Cordova project. + +For more info see [Cordova plugin docs](https://github.com/usabilla/usabilla-u4a-cordova) + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/vibes/README.md b/docs/plugins/vibes/README.md new file mode 100644 index 000000000..735f89f60 --- /dev/null +++ b/docs/plugins/vibes/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Vibes + +``` +$ ionic cordova plugin add vibes-cordova --variable VIBES_APP_ID=MY_APP_ID --variable VIBES_API_URL=MY_ENVIRONMENT_URL +$ npm install @ionic-native/plugins/vibes +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/vibes/) + +Plugin Repo: [https://github.com/vibes/vibes-cordova.git](https://github.com/vibes/vibes-cordova.git) + +This plugin enables integration with the Vibes Push SDK to your Cordova project with Android and iOS supported. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/vibration/README.md b/docs/plugins/vibration/README.md new file mode 100644 index 000000000..7a20c07c9 --- /dev/null +++ b/docs/plugins/vibration/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Vibration + +``` +$ ionic cordova plugin add cordova-plugin-vibration +$ npm install @ionic-native/plugins/vibration +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/vibration/) + +Plugin Repo: [https://github.com/apache/cordova-plugin-vibration](https://github.com/apache/cordova-plugin-vibration) + +Vibrates the device + +## Supported platforms + +- Android + - iOS + - Windows diff --git a/docs/plugins/video-editor/README.md b/docs/plugins/video-editor/README.md new file mode 100644 index 000000000..ef25e6543 --- /dev/null +++ b/docs/plugins/video-editor/README.md @@ -0,0 +1,23 @@ + + Improve this doc + + +# Video Editor + +``` +$ ionic cordova plugin add cordova-plugin-video-editor +$ npm install @ionic-native/plugins/video-editor +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/video-editor/) + +Plugin Repo: [https://github.com/jbavari/cordova-plugin-video-editor](https://github.com/jbavari/cordova-plugin-video-editor) + +Edit videos using native device APIs + +## Supported platforms + +- Android + - iOS + - Windows + - Windows Phone 8 diff --git a/docs/plugins/video-player/README.md b/docs/plugins/video-player/README.md new file mode 100644 index 000000000..03f4849db --- /dev/null +++ b/docs/plugins/video-player/README.md @@ -0,0 +1,22 @@ + + Improve this doc + + +# Video Player + +``` +$ ionic cordova plugin add https://github.com/moust/cordova-plugin-videoplayer.git +$ npm install @ionic-native/plugins/video-player +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/video-player/) + +Plugin Repo: [https://github.com/moust/cordova-plugin-videoplayer](https://github.com/moust/cordova-plugin-videoplayer) + +A Cordova plugin that simply allows you to immediately play a video in fullscreen mode. + +Requires Cordova plugin: `com.moust.cordova.videoplayer`. For more info, please see the [VideoPlayer plugin docs](https://github.com/moust/cordova-plugin-videoplayer). + +## Supported platforms + +- Android diff --git a/docs/plugins/web-intent/README.md b/docs/plugins/web-intent/README.md new file mode 100644 index 000000000..10eccf4b2 --- /dev/null +++ b/docs/plugins/web-intent/README.md @@ -0,0 +1,20 @@ + + Improve this doc + + +# Web Intent + +``` +$ ionic cordova plugin add com-darryncampbell-cordova-plugin-intent +$ npm install @ionic-native/plugins/web-intent +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/web-intent/) + +Plugin Repo: [https://github.com/darryncampbell/darryncampbell-cordova-plugin-intent](https://github.com/darryncampbell/darryncampbell-cordova-plugin-intent) + +This Plugin provides a general purpose shim layer for the Android intent mechanism, exposing various ways to handle sending and receiving intents. + +## Supported platforms + +- Android diff --git a/docs/plugins/web-server/README.md b/docs/plugins/web-server/README.md new file mode 100644 index 000000000..e5ff918ec --- /dev/null +++ b/docs/plugins/web-server/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Web Server + +``` +$ ionic cordova plugin add cordova-plugin-webserver2 +$ npm install @ionic-native/plugins/web-server +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/web-server/) + +Plugin Repo: [https://github.com/nguyenthanh1995/cordova-plugin-webserver2.git](https://github.com/nguyenthanh1995/cordova-plugin-webserver2.git) + +This plugin allows you to start a local dynamic content web server for android and iOS devices. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/web-socket-server/README.md b/docs/plugins/web-socket-server/README.md new file mode 100644 index 000000000..070f33890 --- /dev/null +++ b/docs/plugins/web-socket-server/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# WebSocket Server + +``` +$ ionic cordova plugin add cordova-plugin-websocket-server +$ npm install @ionic-native/plugins/web-socket-server +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/web-socket-server/) + +Plugin Repo: [https://github.com/becvert/cordova-plugin-websocket-server](https://github.com/becvert/cordova-plugin-websocket-server) + +This plugin allows you to run a single, lightweight, barebone WebSocket Server. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/webengage/README.md b/docs/plugins/webengage/README.md new file mode 100644 index 000000000..f9a7c99b9 --- /dev/null +++ b/docs/plugins/webengage/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Webengage + +``` +$ ionic cordova plugin add cordova-plugin-webengage +$ npm install @ionic-native/plugins/webengage +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/webengage/) + +Plugin Repo: [https://github.com/WebEngage/cordova-plugin](https://github.com/WebEngage/cordova-plugin) + +Awesome Cordova Plugins wrapper that wraps Webengage Cordova plugin for Android and iOS + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/wechat/README.md b/docs/plugins/wechat/README.md new file mode 100644 index 000000000..a5599872d --- /dev/null +++ b/docs/plugins/wechat/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Wechat + +``` +$ cordova plugin add cordova-plugin-wechat --variable wechatappid=YOUR_WECHAT_APPID +$ npm install @ionic-native/plugins/wechat +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/wechat/) + +Plugin Repo: [https://github.com/xu-li/cordova-plugin-wechat.git](https://github.com/xu-li/cordova-plugin-wechat.git) + +A cordova plugin, a JS version of Wechat SDK + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/wheel-selector/README.md b/docs/plugins/wheel-selector/README.md new file mode 100644 index 000000000..5b5f0a621 --- /dev/null +++ b/docs/plugins/wheel-selector/README.md @@ -0,0 +1,27 @@ + + Improve this doc + + +# WheelSelector Plugin + +

+ This plugin is still in beta stage and may not work as expected. Please + submit any issues to the plugin repo. +

+ +``` +$ ionic cordova plugin add cordova-wheel-selector-plugin +$ npm install @ionic-native/plugins/wheel-selector +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/wheel-selector/) + +Plugin Repo: [https://github.com/jasonmamy/cordova-wheel-selector-plugin](https://github.com/jasonmamy/cordova-wheel-selector-plugin) + +Native wheel selector for Cordova (Android/iOS). + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/wifi-wizard-2/README.md b/docs/plugins/wifi-wizard-2/README.md new file mode 100644 index 000000000..2c89874a8 --- /dev/null +++ b/docs/plugins/wifi-wizard-2/README.md @@ -0,0 +1,23 @@ + + Improve this doc + + +# WifiWizard2 + +``` +$ ionic cordova plugin add cordova-plugin-wifiwizard2 +$ npm install @ionic-native/plugins/wifi-wizard-2 +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/wifi-wizard-2/) + +Plugin Repo: [https://github.com/tripflex/WifiWizard2](https://github.com/tripflex/WifiWizard2) + +WifiWizard2 enables Wifi management for both Android and iOS applications within Cordova/Phonegap projects. + +This project is a fork of the WifiWizard plugin with fixes and updates, as well as patches taken from the Cordova Network Manager plugin. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/wonderpush/README.md b/docs/plugins/wonderpush/README.md new file mode 100644 index 000000000..631b5bef9 --- /dev/null +++ b/docs/plugins/wonderpush/README.md @@ -0,0 +1,30 @@ + + Improve this doc + + +# Push Notifications - WonderPush + +``` +$ ionic cordova plugin add wonderpush-cordova-sdk --variable CLIENT_ID=YOUR_CLIENT_ID --variable CLIENT_SECRET=YOUR_CLIENT_SECRET +$ npm install @ionic-native/plugins/wonderpush +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/wonderpush/) + +Plugin Repo: [https://github.com/wonderpush/wonderpush-cordova-sdk](https://github.com/wonderpush/wonderpush-cordova-sdk) + +Send unlimited push notifications to iOS and Android devices. + +Get started in minutes: [Ionic Quickstart Guide](https://docs.wonderpush.com/docs/ionic-quickstart). + +Advanced segmentation, automation and personalization of push messages for €1 per 1000 subscribers. + +Requires the Cordova plugin `wonderpush-cordova-sdk`. + +[WonderPush push notifications](https://www.wonderpush.com) are the most effective way +to retain your users and grow your audience while remaining fully GDPR compliant. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/youtube-video-player/README.md b/docs/plugins/youtube-video-player/README.md new file mode 100644 index 000000000..7902f2467 --- /dev/null +++ b/docs/plugins/youtube-video-player/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Youtube Video Player + +``` +$ ionic cordova plugin add cordova-plugin-youtube-video-player +$ npm install @ionic-native/plugins/youtube-video-player +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/youtube-video-player/) + +Plugin Repo: [https://github.com/ihadeed/CordovaYoutubeVideoPlayer](https://github.com/ihadeed/CordovaYoutubeVideoPlayer) + +Plays YouTube videos in Native YouTube App + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/zbar/README.md b/docs/plugins/zbar/README.md new file mode 100644 index 000000000..afa351299 --- /dev/null +++ b/docs/plugins/zbar/README.md @@ -0,0 +1,23 @@ + + Improve this doc + + +# ZBar + +``` +$ ionic cordova plugin add cordova-plugin-cszbar +$ npm install @ionic-native/plugins/zbar +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/zbar/) + +Plugin Repo: [https://github.com/tjwoon/csZBar](https://github.com/tjwoon/csZBar) + +The ZBar Scanner Plugin allows you to scan 2d barcodes. + +Requires Cordova plugin: `cordova-plugin-cszbar`. For more info, please see the [zBar plugin docs](https://github.com/tjwoon/csZBar). + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/zeroconf/README.md b/docs/plugins/zeroconf/README.md new file mode 100644 index 000000000..de0cb1421 --- /dev/null +++ b/docs/plugins/zeroconf/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Zeroconf + +``` +$ ionic cordova plugin add cordova-plugin-zeroconf +$ npm install @ionic-native/plugins/zeroconf +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/zeroconf/) + +Plugin Repo: [https://github.com/becvert/cordova-plugin-zeroconf](https://github.com/becvert/cordova-plugin-zeroconf) + +This plugin allows you to browse and publish Zeroconf/Bonjour/mDNS services. + +## Supported platforms + +- Android + - iOS diff --git a/docs/plugins/zoom/README.md b/docs/plugins/zoom/README.md new file mode 100644 index 000000000..0ca26e997 --- /dev/null +++ b/docs/plugins/zoom/README.md @@ -0,0 +1,21 @@ + + Improve this doc + + +# Zoom + +``` +$ ionic cordova plugin add cordova.plugin.zoom +$ npm install @ionic-native/plugins/zoom +``` + +## [Usage Documentation](https://ionicframework.com/docs/native/zoom/) + +Plugin Repo: [https://github.com/zoom/zoom-sdk-ionic](https://github.com/zoom/zoom-sdk-ionic) + +A Cordova plugin to use Zoom Video Conferencing services on Cordova applications. + +## Supported platforms + +- Android + - iOS diff --git a/scripts/docs/dgeni/dgeni-readmes-config.js b/scripts/docs/dgeni/dgeni-readmes-config.js index a14ef45f1..69fdad9e1 100644 --- a/scripts/docs/dgeni/dgeni-readmes-config.js +++ b/scripts/docs/dgeni/dgeni-readmes-config.js @@ -59,6 +59,10 @@ module.exports = (currentVersion) => { writeFilesProcessor.outputFolder = './dist/@awesome-cordova-plugins/'; }) + .config(function (writeFilesProcessor) { + writeFilesProcessor.outputFolder = './docs/'; + }) + // Configure rendering .config(function (templateFinder) { templateFinder.templateFolders.unshift(path.resolve(__dirname, 'templates')); diff --git a/scripts/docs/gulp-tasks.js b/scripts/docs/gulp-tasks.js index 66fbd8a4b..d69d40f06 100644 --- a/scripts/docs/gulp-tasks.js +++ b/scripts/docs/gulp-tasks.js @@ -26,7 +26,9 @@ module.exports = (gulp) => { try { const ionicPackage = require('./dgeni/dgeni-readmes-config')(projectPackage.version), dgeni = new Dgeni([ionicPackage]); - return dgeni.generate().then((docs) => console.log(docs.length + ' README files generated')); + return dgeni.generate().then((docs) => { + console.log(docs.length + ' README files generated'); + }); } catch (err) { console.log(err.stack); }