diff --git a/docs/README.md b/docs/README.md index 51d042424..59b2af714 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,12 +1,19 @@ +--- +description: >- + Awesome Cordova Plugins provides TypeScript wrappers for Cordova and Ionic + native plugins with Promise and Observable support for Angular, React, and + Capacitor apps. +--- + # Awesome Cordova Plugins -Awesome Cordova Plugins is a curated set of wrappers for Cordova plugins that make adding any native functionality you need to your [Ionic](https://ionicframework.com/) mobile app easy. +Awesome Cordova Plugins is a curated set of TypeScript wrappers for Cordova plugins that make adding native functionality to your [Ionic](https://ionicframework.com/) mobile app easy. -Awesome Cordova Plugins wraps plugin callbacks in a Promise or Observable, providing a common interface for all plugins and making it easy to use plugins with Angular change detection. +Every Cordova plugin callback is wrapped in a Promise or Observable, providing a common interface and seamless integration with Angular change detection. ## Features -- **TypeScript wrappers** for all major Cordova plugins +- **TypeScript wrappers** for over 250 Cordova plugins - **Promise and Observable** support for modern async patterns - **Angular integration** with automatic change detection via `/ngx` imports - **Framework-agnostic** — works with Angular, React, or plain TypeScript diff --git a/docs/faq.md b/docs/faq.md index d5e2b09f3..35ed51eae 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,6 +1,12 @@ +--- +description: >- + Frequently asked questions about Awesome Cordova Plugins — troubleshooting + builds, resolving plugin conflicts, and recommended upgrade strategies. +--- + # FAQ -### Cordova Management Tips +## Cordova Management Tips **1) Use the [Ionic CLI](https://ionicframework.com/docs/cli) to add/update/delete plugins.** @@ -30,7 +36,7 @@ Useful when adding new developers to a project. `ionic cordova prepare` restores * `ionic doctor list`: Detects [common issues](https://ionicframework.com/docs/cli/commands/doctor-list) and suggests steps to fix them * `ionic repair`: Remove, then [regenerate](https://ionicframework.com/docs/cli/commands/repair) all dependencies -### Understanding Version Numbers +## Understanding Version Numbers For any given plugin, the Awesome Cordova Plugins (TypeScript code) and Cordova (native code) version numbers will not match. The Awesome Cordova Plugins version number is found in `package.json`: @@ -52,7 +58,7 @@ When checking for new native functionality or bug fixes, look for new versions o To check for new Awesome Cordova Plugins releases (may include exposing methods recently added by the Cordova plugin, etc.), see the [releases page](https://github.com/danielsogl/awesome-cordova-plugins/releases). -### Troubleshooting Failed Builds +## Troubleshooting Failed Builds Research the build error(s) by checking out these resources: @@ -60,19 +66,19 @@ Research the build error(s) by checking out these resources: * Ask the [Ionic Community Forum](https://forum.ionicframework.com/) * Check the plugin's GitHub issues page -#### Cordova Plugin Conflicts +### Cordova Plugin Conflicts Plugins can conflict with each other when they share the same underlying native dependencies or when more than one plugin tries to access the same native code at once. For example, common libraries like the Google Play Services version (Google Maps is using GPS v24.2 but Firebase wants GPS v27.1). Keeping these plugins updated regularly can help with this. Another tip is to ensure that your app uses only one plugin per specific feature/functionality (example: Push Notifications). -### Recommended Upgrade Strategy +## Recommended Upgrade Strategy The most stable apps are routinely updated, especially at the native layer. Keeping native plugins up to date ensures your project has the latest security fixes, new features, and improved performance. Update your project's plugins one at a time, ideally in separate code branches. This reduces the surface area that issues can arise from — if you update everything in your project at once, it's sometimes hard to tell where the problem stems from. -#### When should I update? +### When should I update? * When a new feature/bug fix is released: Run `npm outdated` to see a list of available updates. * When new major versions are released: Official blogs, such as the [Cordova blog](https://cordova.apache.org/blog/) and [Ionic blog](https://ionicframework.com/blog/), will publish announcements and news. diff --git a/docs/installation.md b/docs/installation.md index 72762152c..e298c522a 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,18 +1,24 @@ +--- +description: >- + How to install Awesome Cordova Plugins in Angular, React, and TypeScript + projects using Cordova or Capacitor. +--- + # Installation [Apache Cordova](https://cordova.apache.org/) is an open source native runtime that allows developers to build native mobile apps with HTML, CSS, and JavaScript. Similar to [Capacitor](https://capacitorjs.com/), Ionic's own native runtime, Cordova allows developers to access native device features, such as camera, keyboard, and geolocation, using a system of plugins. A plugin is a small amount of add-on code that provides JavaScript interface to native components. They allow your app to use native device capabilities beyond what is available to pure web apps. These plugins are submitted and maintained by the community. While community members are generally quick to find and fix issues, certain plugins may not function properly. -### Capacitor Support +## Capacitor Support In addition to Cordova, Awesome Cordova Plugins also works with [Capacitor](https://capacitorjs.com/), Ionic's official native runtime. Basic usage below. For complete details, [see the Capacitor documentation](https://capacitorjs.com/docs/cordova/using-cordova-plugins). -### Usage +## Usage -All plugins have two components - the native code (Cordova) and the TypeScript code (Awesome Cordova Plugins). Cordova plugins are also wrapped in a `Promise` or `Observable` in order to provide a common plugin interface and modernized development approach. +All plugins have two components — the native code (Cordova) and the TypeScript code (Awesome Cordova Plugins). Cordova plugins are also wrapped in a `Promise` or `Observable` in order to provide a common plugin interface and modernized development approach. -Using the [Camera plugin](plugins/camera.md) as an example, first install it: +Using the [Camera plugin](plugins/camera/README.md) as an example, first install it: ```bash # Install Cordova plugin @@ -27,7 +33,7 @@ npm install @awesome-cordova-plugins/core Next, begin using the plugin, following the various framework usage options below. For FAQ, see [here](faq.md). -### Angular (Standalone) +## Angular (Standalone) Angular apps can use either Cordova or Capacitor to build native mobile apps. Register the plugin as a provider in your application bootstrap. For Angular, the import path should end with `/ngx`. Angular's change detection is automatically handled. @@ -76,7 +82,7 @@ export class PhotoService { } ``` -### React +## React React apps must use Capacitor to build native mobile apps. However, Awesome Cordova Plugins (and therefore, Cordova plugins) can still be used. @@ -119,7 +125,7 @@ const Tab1: React.FC = () => { }; ``` -### ES2015+/TypeScript +## ES2015+/TypeScript ES2015+ and TypeScript apps can use either Cordova or Capacitor to build native mobile apps. To use any plugin, import the class from the appropriate package and use its static methods: diff --git a/docs/plugins/README.md b/docs/plugins/README.md index 38045c371..8d3c4ab19 100644 --- a/docs/plugins/README.md +++ b/docs/plugins/README.md @@ -1,3 +1,10 @@ +--- +description: >- + Browse over 250 Cordova plugin wrappers for Ionic with TypeScript support. + Each plugin includes installation instructions, supported platforms, and usage + documentation. +--- + # Plugins Browse the full list of available plugin wrappers in the sidebar. Each plugin page includes: diff --git a/docs/plugins/abbyy-rtr/README.md b/docs/plugins/abbyy-rtr/README.md index cdd525fa4..dd5e8edbc 100644 --- a/docs/plugins/abbyy-rtr/README.md +++ b/docs/plugins/abbyy-rtr/README.md @@ -1,19 +1,28 @@ +--- +description: >- + ABBYY Real-Time Recognition plugin for Cordova and Ionic. This plugin allows to use the Text Capture and Data Capture features of ABBYY Real-Time Recognition… +--- + # ABBYY Real-Time Recognition -``` -$ ionic cordova plugin add cordova-plugin-abbyy-rtr-sdk -$ npm install @awesome-cordova-plugins/abbyy-rtr -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-abbyy-rtr-sdk +npm install @awesome-cordova-plugins/abbyy-rtr +``` + +**Plugin Repo:** [https://github.com/abbyysdk/RTR-SDK.Cordova](https://github.com/abbyysdk/RTR-SDK.Cordova) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/action-sheet/README.md b/docs/plugins/action-sheet/README.md index facbbbfd6..acdf41bb3 100644 --- a/docs/plugins/action-sheet/README.md +++ b/docs/plugins/action-sheet/README.md @@ -1,19 +1,24 @@ +--- +description: >- + Action Sheet plugin for Cordova and Ionic. The ActionSheet plugin shows a native list of options the user can choose from. Requires Cordova plugin:… +--- + # Action Sheet -``` -$ ionic cordova plugin add cordova-plugin-actionsheet -$ npm install @awesome-cordova-plugins/action-sheet -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-actionsheet +npm install @awesome-cordova-plugins/action-sheet +``` + +**Plugin Repo:** [https://github.com/EddyVerbruggen/cordova-plugin-actionsheet](https://github.com/EddyVerbruggen/cordova-plugin-actionsheet) + +## Supported Platforms - Android - Browser @@ -21,3 +26,7 @@ Requires Cordova plugin: `cordova-plugin-actionsheet`. For more info, please see - Windows - Windows Phone 8 +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/adjust/README.md b/docs/plugins/adjust/README.md index 0a483500b..b64a027c5 100644 --- a/docs/plugins/adjust/README.md +++ b/docs/plugins/adjust/README.md @@ -1,20 +1,29 @@ +--- +description: >- + Adjust plugin for Cordova and Ionic. This is the Ionic Cordova SDK of Adjust™. You can read more about Adjust™ at adjust.com. Requires Cordova plugin:… +--- + # Adjust -``` -$ ionic cordova plugin add com.adjust.sdk -$ npm install @awesome-cordova-plugins/adjust -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add com.adjust.sdk +npm install @awesome-cordova-plugins/adjust +``` + +**Plugin Repo:** [https://github.com/adjust/cordova_sdk](https://github.com/adjust/cordova_sdk) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/admob-plus/README.md b/docs/plugins/admob-plus/README.md index 76b0168ca..016708eef 100644 --- a/docs/plugins/admob-plus/README.md +++ b/docs/plugins/admob-plus/README.md @@ -1,18 +1,27 @@ +--- +description: >- + AdMob Plus plugin for Cordova and Ionic. AdMob Plus is the successor of cordova-plugin-admob-free, which provides a cleaner API and build with modern tools. +--- + # AdMob Plus -``` -$ ionic cordova plugin add cordova-admob-plus -$ npm install @awesome-cordova-plugins/admob-plus -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/admob-plus/) - -Plugin Repo: [https://github.com/admob-plus/admob-plus](https://github.com/admob-plus/admob-plus) - AdMob Plus is the successor of cordova-plugin-admob-free, which provides a cleaner API and build with modern tools. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-admob-plus +npm install @awesome-cordova-plugins/admob-plus +``` + +**Plugin Repo:** [https://github.com/admob-plus/admob-plus](https://github.com/admob-plus/admob-plus) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/admob-pro/README.md b/docs/plugins/admob-pro/README.md index dac68991b..6ef2fb86b 100644 --- a/docs/plugins/admob-pro/README.md +++ b/docs/plugins/admob-pro/README.md @@ -1,21 +1,30 @@ +--- +description: >- + AdMob Pro plugin for Cordova and Ionic. Plugin for Google Ads, including AdMob / DFP (DoubleClick for publisher) and mediations to other Ad networks.… +--- + # AdMob Pro -``` -$ ionic cordova plugin add cordova-plugin-admobpro -$ npm install @awesome-cordova-plugins/admob-pro -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-admobpro +npm install @awesome-cordova-plugins/admob-pro +``` + +**Plugin Repo:** [https://github.com/floatinghotpot/cordova-admob-pro](https://github.com/floatinghotpot/cordova-admob-pro) + +## Supported Platforms - Android - iOS - Windows Phone 8 +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/admob/README.md b/docs/plugins/admob/README.md index ccd1c355e..cbb21ed4f 100644 --- a/docs/plugins/admob/README.md +++ b/docs/plugins/admob/README.md @@ -1,14 +1,10 @@ +--- +description: >- + AdMob plugin for Cordova and Ionic. Most complete Admob plugin with support for [Tappx](http://www.tappx.com/?h=dec334d63287772de859bdb4e977fce6) ads.… +--- + # AdMob -``` -$ ionic cordova plugin add cordova-admob -$ npm install @awesome-cordova-plugins/admob -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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! @@ -18,9 +14,22 @@ Supports:** - Rewarded ads - [Tappx](http://www.tappx.com/?h=dec334d63287772de859bdb4e977fce6) ads -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-admob +npm install @awesome-cordova-plugins/admob +``` + +**Plugin Repo:** [https://github.com/appfeel/admob-google-cordova](https://github.com/appfeel/admob-google-cordova) + +## Supported Platforms - Android - iOS - Browser +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/advanced-image-picker/README.md b/docs/plugins/advanced-image-picker/README.md index 0440427e0..ccb867a4d 100644 --- a/docs/plugins/advanced-image-picker/README.md +++ b/docs/plugins/advanced-image-picker/README.md @@ -1,18 +1,27 @@ +--- +description: >- + AdvancedImagePicker plugin for Cordova and Ionic. This Cordova Plugin is for a better (multiple) ImagePicker with more options. +--- + # AdvancedImagePicker -``` -$ ionic cordova plugin add cordova-plugin-advanced-imagepicker -$ npm install @awesome-cordova-plugins/advanced-image-picker -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/advanced-image-picker/) - -Plugin Repo: [https://github.com/EinfachHans/cordova-plugin-advanced-imagepicker](https://github.com/EinfachHans/cordova-plugin-advanced-imagepicker) - This Cordova Plugin is for a better (multiple) ImagePicker with more options. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-advanced-imagepicker +npm install @awesome-cordova-plugins/advanced-image-picker +``` + +**Plugin Repo:** [https://github.com/EinfachHans/cordova-plugin-advanced-imagepicker](https://github.com/EinfachHans/cordova-plugin-advanced-imagepicker) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/aes-256/README.md b/docs/plugins/aes-256/README.md index 2c2607bec..a28e37a11 100644 --- a/docs/plugins/aes-256/README.md +++ b/docs/plugins/aes-256/README.md @@ -1,20 +1,29 @@ +--- +description: >- + AES256 plugin for Cordova and Ionic. This cordova ionic plugin allows you to perform AES 256 encryption and decryption on the plain text. It's a… +--- + # AES256 -``` -$ ionic cordova plugin add cordova-plugin-aes256-encryption -$ npm install @awesome-cordova-plugins/aes-256 -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-aes256-encryption +npm install @awesome-cordova-plugins/aes-256 +``` + +**Plugin Repo:** [https://github.com/Ideas2IT/cordova-aes256](https://github.com/Ideas2IT/cordova-aes256) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/airship/README.md b/docs/plugins/airship/README.md index fee42999e..d5167eadb 100644 --- a/docs/plugins/airship/README.md +++ b/docs/plugins/airship/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Airship plugin for Cordova and Ionic. This plugin does something +--- + # Airship -``` -$ ionic cordova plugin add @ua/cordova-airship -$ npm install @awesome-cordova-plugins/airship -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/airship/) - -Plugin Repo: [https://www.npmjs.com/package/@ua/cordova-airship](https://www.npmjs.com/package/@ua/cordova-airship) - This plugin does something -## Supported platforms +## Installation + +```bash +ionic cordova plugin add @ua/cordova-airship +npm install @awesome-cordova-plugins/airship +``` + +**Plugin Repo:** [https://www.npmjs.com/package/@ua/cordova-airship](https://www.npmjs.com/package/@ua/cordova-airship) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/all-in-one-sdk/README.md b/docs/plugins/all-in-one-sdk/README.md index c6721a95c..a709a4202 100644 --- a/docs/plugins/all-in-one-sdk/README.md +++ b/docs/plugins/all-in-one-sdk/README.md @@ -1,21 +1,30 @@ +--- +description: >- + AllInOneSDK plugin for Cordova and Ionic. Paytm All-in-One SDK plugin for Cordova/Ionic Applications Paytm All-in-One SDK provides a swift, secure and… +--- + # AllInOneSDK -``` -$ ionic cordova plugin add cordova-paytm-allinonesdk -$ npm install @awesome-cordova-plugins/all-in-one-sdk -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-paytm-allinonesdk +npm install @awesome-cordova-plugins/all-in-one-sdk +``` + +**Plugin Repo:** [https://github.com/paytm/paytm-allinonesdk-ionic-cordova.git](https://github.com/paytm/paytm-allinonesdk-ionic-cordova.git) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/analytics-firebase/README.md b/docs/plugins/analytics-firebase/README.md index de2e1625a..692c76742 100644 --- a/docs/plugins/analytics-firebase/README.md +++ b/docs/plugins/analytics-firebase/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Analytics Firebase plugin for Cordova and Ionic. Google Analytics Firebase plugin for Ionic Native apps. +--- + # Analytics Firebase -``` -$ ionic cordova plugin add cordova-plugin-analytics -$ npm install @awesome-cordova-plugins/analytics-firebase -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-analytics +npm install @awesome-cordova-plugins/analytics-firebase +``` + +**Plugin Repo:** [https://github.com/appfeel/analytics-google](https://github.com/appfeel/analytics-google) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/android-exoplayer/README.md b/docs/plugins/android-exoplayer/README.md index 90c6ab738..8a3134985 100644 --- a/docs/plugins/android-exoplayer/README.md +++ b/docs/plugins/android-exoplayer/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Android ExoPlayer plugin for Cordova and Ionic. Cordova media player plugin using Google's ExoPlayer framework. https://github.com/google/ExoPlayer +--- + # Android ExoPlayer -``` -$ ionic cordova plugin add cordova-plugin-exoplayer -$ npm install @awesome-cordova-plugins/android-exoplayer -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-exoplayer +npm install @awesome-cordova-plugins/android-exoplayer +``` + +**Plugin Repo:** [https://github.com/frontyard/cordova-plugin-exoplayer](https://github.com/frontyard/cordova-plugin-exoplayer) + +## Supported Platforms - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/android-full-screen/README.md b/docs/plugins/android-full-screen/README.md index 49cbdb7d7..2cb9235ad 100644 --- a/docs/plugins/android-full-screen/README.md +++ b/docs/plugins/android-full-screen/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Android Full Screen plugin for Cordova and Ionic. This plugin enables developers to offer users a true full screen experience in their Cordova and PhoneGap… +--- + # Android Full Screen -``` -$ ionic cordova plugin add cordova-plugin-fullscreen -$ npm install @awesome-cordova-plugins/android-full-screen -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-fullscreen +npm install @awesome-cordova-plugins/android-full-screen +``` + +**Plugin Repo:** [https://github.com/mesmotronic/cordova-plugin-fullscreen](https://github.com/mesmotronic/cordova-plugin-fullscreen) + +## Supported Platforms - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/android-notch/README.md b/docs/plugins/android-notch/README.md index 84ecb8ea2..0505dd925 100644 --- a/docs/plugins/android-notch/README.md +++ b/docs/plugins/android-notch/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Android Notch plugin for Cordova and Ionic. This plugin enables developers to get the cutout and android devices inset sizes It is based on the cordova plugin… +--- + # Android Notch -``` -$ ionic cordova plugin add cordova-plugin-android-notch -$ npm install @awesome-cordova-plugins/android-notch -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-android-notch +npm install @awesome-cordova-plugins/android-notch +``` + +**Plugin Repo:** [https://github.com/tobspr/cordova-plugin-android-notch.git](https://github.com/tobspr/cordova-plugin-android-notch.git) + +## Supported Platforms - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/android-permissions/README.md b/docs/plugins/android-permissions/README.md index 0a4266a82..36f0ad9a2 100644 --- a/docs/plugins/android-permissions/README.md +++ b/docs/plugins/android-permissions/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Android Permissions plugin for Cordova and Ionic. This plugin is designed to support Android new permissions checking mechanism. You can find all permissions… +--- + # Android Permissions -``` -$ ionic cordova plugin add cordova-plugin-android-permissions -$ npm install @awesome-cordova-plugins/android-permissions -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-android-permissions +npm install @awesome-cordova-plugins/android-permissions +``` + +**Plugin Repo:** [https://github.com/NeoLSN/cordova-plugin-android-permissions](https://github.com/NeoLSN/cordova-plugin-android-permissions) + +## Supported Platforms - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/anyline/README.md b/docs/plugins/anyline/README.md index 185bf97b1..6d8120e40 100644 --- a/docs/plugins/anyline/README.md +++ b/docs/plugins/anyline/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Anyline plugin for Cordova and Ionic. Anyline provides an easy-to-use SDK for applications to enable Optical Character Recognition (OCR) on mobile devices. +--- + # Anyline -``` -$ ionic cordova plugin add io-anyline-cordova -$ npm install @awesome-cordova-plugins/anyline -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add io-anyline-cordova +npm install @awesome-cordova-plugins/anyline +``` + +**Plugin Repo:** [https://github.com/Anyline/anyline-ocr-cordova-module](https://github.com/Anyline/anyline-ocr-cordova-module) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/app-availability/README.md b/docs/plugins/app-availability/README.md index 737472b48..37b59fb5e 100644 --- a/docs/plugins/app-availability/README.md +++ b/docs/plugins/app-availability/README.md @@ -1,20 +1,29 @@ +--- +description: >- + App Availability plugin for Cordova and Ionic. This plugin allows you to check if an app is installed on the user's device. It requires an URI Scheme (e.g.… +--- + # App Availability -``` -$ ionic cordova plugin add cordova-plugin-appavailability -$ npm install @awesome-cordova-plugins/app-availability -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-appavailability +npm install @awesome-cordova-plugins/app-availability +``` + +**Plugin Repo:** [https://github.com/ohh2ahh/AppAvailability](https://github.com/ohh2ahh/AppAvailability) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/app-center-analytics/README.md b/docs/plugins/app-center-analytics/README.md index af29ee6a8..11dbfd208 100644 --- a/docs/plugins/app-center-analytics/README.md +++ b/docs/plugins/app-center-analytics/README.md @@ -1,14 +1,10 @@ +--- +description: >- + App Center Analytics plugin for Cordova and Ionic. App Center Analytics helps you understand user behavior and customer engagement to improve your app. The… +--- + # App Center Analytics -``` -$ ionic cordova plugin add cordova-plugin-appcenter-analytics -$ npm install @awesome-cordova-plugins/app-center-analytics -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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. @@ -16,8 +12,21 @@ All the information captured is available in the App Center portal for you to an For more info, please see https://docs.microsoft.com/en-us/appcenter/sdk/analytics/cordova -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-appcenter-analytics +npm install @awesome-cordova-plugins/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) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/app-center-crashes/README.md b/docs/plugins/app-center-crashes/README.md index be6441aea..2dd6bbb1b 100644 --- a/docs/plugins/app-center-crashes/README.md +++ b/docs/plugins/app-center-crashes/README.md @@ -1,14 +1,10 @@ +--- +description: >- + App Center Crashes plugin for Cordova and Ionic. App Center Analytics helps you understand user behavior and customer engagement to improve your app. The SDK… +--- + # App Center Crashes -``` -$ ionic cordova plugin add cordova-plugin-appcenter-crashes -$ npm install @awesome-cordova-plugins/app-center-crashes -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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. @@ -16,8 +12,21 @@ All the information captured is available in the App Center portal for you to an For more info, please see https://docs.microsoft.com/en-us/appcenter/sdk/crashes/cordova -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-appcenter-crashes +npm install @awesome-cordova-plugins/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) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/app-center-low-memory/README.md b/docs/plugins/app-center-low-memory/README.md index 340df885a..cb46c1ed4 100644 --- a/docs/plugins/app-center-low-memory/README.md +++ b/docs/plugins/app-center-low-memory/README.md @@ -1,19 +1,28 @@ +--- +description: >- + App Center Low Memory plugin for Cordova and Ionic. Generates a low memory warning. For more info, please see:… +--- + # 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 @awesome-cordova-plugins/app-center-low-memory -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add https://github.com/Microsoft/appcenter-sdk-cordova/tree/master/cordova-plugin-appcenter-generate-low-memory +npm install @awesome-cordova-plugins/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) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/app-center-push/README.md b/docs/plugins/app-center-push/README.md index 2eab3f2b1..f9e7085a8 100644 --- a/docs/plugins/app-center-push/README.md +++ b/docs/plugins/app-center-push/README.md @@ -1,18 +1,27 @@ +--- +description: >- + App Center Push plugin for Cordova and Ionic. For more info, please see https://docs.microsoft.com/en-us/appcenter/sdk/push/cordova +--- + # App Center Push -``` -$ ionic cordova plugin add cordova-plugin-appcenter-push -$ npm install @awesome-cordova-plugins/app-center-push -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-appcenter-push +npm install @awesome-cordova-plugins/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) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/app-center-shared/README.md b/docs/plugins/app-center-shared/README.md index a84db09e9..b16e9b3a3 100644 --- a/docs/plugins/app-center-shared/README.md +++ b/docs/plugins/app-center-shared/README.md @@ -1,20 +1,29 @@ +--- +description: >- + App Center Shared plugin for Cordova and Ionic. Exposes additional shared APIs for App Center. For more info, please see… +--- + # App Center Shared -``` -$ ionic cordova plugin add cordova-plugin-appcenter-shared -$ npm install @awesome-cordova-plugins/app-center-shared -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-appcenter-shared +npm install @awesome-cordova-plugins/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) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/app-preferences/README.md b/docs/plugins/app-preferences/README.md index 8793412c2..752207ea4 100644 --- a/docs/plugins/app-preferences/README.md +++ b/docs/plugins/app-preferences/README.md @@ -1,17 +1,22 @@ +--- +description: >- + App Preferences plugin for Cordova and Ionic. This plugin allows you to read and write app preferences +--- + # App Preferences -``` -$ ionic cordova plugin add cordova-plugin-app-preferences -$ npm install @awesome-cordova-plugins/app-preferences -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-app-preferences +npm install @awesome-cordova-plugins/app-preferences +``` + +**Plugin Repo:** [https://github.com/apla/me.apla.cordova.app-preferences](https://github.com/apla/me.apla.cordova.app-preferences) + +## Supported Platforms - Android - BlackBerry 10 @@ -21,3 +26,7 @@ This plugin allows you to read and write app preferences - Windows 8 - Windows Phone +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/app-rate/README.md b/docs/plugins/app-rate/README.md index 8b1b8eb05..8d525cf54 100644 --- a/docs/plugins/app-rate/README.md +++ b/docs/plugins/app-rate/README.md @@ -1,22 +1,31 @@ +--- +description: >- + App Rate plugin for Cordova and Ionic. The AppRate plugin makes it easy to prompt the user to rate your app, either now, later, or never. Requires Cordova… +--- + # App Rate -``` -$ ionic cordova plugin add cordova-plugin-apprate -$ npm install @awesome-cordova-plugins/app-rate -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-apprate +npm install @awesome-cordova-plugins/app-rate +``` + +**Plugin Repo:** [https://github.com/pushandplay/cordova-plugin-apprate](https://github.com/pushandplay/cordova-plugin-apprate) + +## Supported Platforms - Android - BlackBerry 10 - iOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/app-review/README.md b/docs/plugins/app-review/README.md index 04d6a3736..d9983d5eb 100644 --- a/docs/plugins/app-review/README.md +++ b/docs/plugins/app-review/README.md @@ -1,18 +1,27 @@ +--- +description: >- + App Review plugin for Cordova and Ionic. Cordova plugin to review app +--- + # App Review -``` -$ ionic cordova plugin add cordova-plugin-app-review -$ npm install @awesome-cordova-plugins/app-review -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/app-review/) - -Plugin Repo: [https://github.com/chemerisuk/cordova-plugin-app-review](https://github.com/chemerisuk/cordova-plugin-app-review) - Cordova plugin to review app -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-app-review +npm install @awesome-cordova-plugins/app-review +``` + +**Plugin Repo:** [https://github.com/chemerisuk/cordova-plugin-app-review](https://github.com/chemerisuk/cordova-plugin-app-review) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/app-version/README.md b/docs/plugins/app-version/README.md index f7df80c79..e0f5d11c7 100644 --- a/docs/plugins/app-version/README.md +++ b/docs/plugins/app-version/README.md @@ -1,21 +1,30 @@ +--- +description: >- + App Version plugin for Cordova and Ionic. Reads the version of your app from the target build settings. Requires Cordova plugin:… +--- + # App Version -``` -$ ionic cordova plugin add cordova-plugin-app-version -$ npm install @awesome-cordova-plugins/app-version -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-app-version +npm install @awesome-cordova-plugins/app-version +``` + +**Plugin Repo:** [https://github.com/whiteoctober/cordova-plugin-app-version](https://github.com/whiteoctober/cordova-plugin-app-version) + +## Supported Platforms - Android - iOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/apple-wallet/README.md b/docs/plugins/apple-wallet/README.md index 2efc89fc7..7c260cc84 100644 --- a/docs/plugins/apple-wallet/README.md +++ b/docs/plugins/apple-wallet/README.md @@ -1,17 +1,26 @@ +--- +description: >- + Apple Wallet plugin for Cordova and Ionic. A Cordova plugin that enables users from Add Payment Cards to their Apple Wallet. +--- + # Apple Wallet -``` -$ ionic cordova plugin add cordova-apple-wallet -$ npm install @awesome-cordova-plugins/apple-wallet -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-apple-wallet +npm install @awesome-cordova-plugins/apple-wallet +``` + +**Plugin Repo:** [https://github.com/tomavic/cordova-apple-wallet](https://github.com/tomavic/cordova-apple-wallet) + +## Supported Platforms - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/applovin/README.md b/docs/plugins/applovin/README.md index b7c08f096..79d58bbb7 100644 --- a/docs/plugins/applovin/README.md +++ b/docs/plugins/applovin/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Applovin plugin for Cordova and Ionic. This plugin allows you to easily configure, integrate and interact with Applovin ads. +--- + # Applovin -``` -$ ionic cordova plugin add cordova-plugin-applovin-max -$ npm install @awesome-cordova-plugins/applovin -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/applovin/) - -Plugin Repo: [https://github.com/AppLovin/AppLovin-MAX-Cordova](https://github.com/AppLovin/AppLovin-MAX-Cordova) - This plugin allows you to easily configure, integrate and interact with Applovin ads. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-applovin-max +npm install @awesome-cordova-plugins/applovin +``` + +**Plugin Repo:** [https://github.com/AppLovin/AppLovin-MAX-Cordova](https://github.com/AppLovin/AppLovin-MAX-Cordova) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/approov-advanced-http/README.md b/docs/plugins/approov-advanced-http/README.md index a3d5a3496..c5713d1ca 100644 --- a/docs/plugins/approov-advanced-http/README.md +++ b/docs/plugins/approov-advanced-http/README.md @@ -1,14 +1,10 @@ +--- +description: >- + HTTP plugin for Cordova and Ionic. Cordova / Phonegap plugin for communicating with HTTP servers. Supports iOS and Android. Advantages over Javascript… +--- + # HTTP -``` -$ ionic cordova plugin add @approov/cordova-plugin-advanced-http -$ npm install @awesome-cordova-plugins/approov-advanced-http -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/approov-advanced-http/) - -Plugin Repo: [https://github.com/approov/quickstart-cordova-advancedhttp](https://github.com/approov/quickstart-cordova-advancedhttp) - Cordova / Phonegap plugin for communicating with HTTP servers. Supports iOS and Android. Advantages over Javascript requests: @@ -19,8 +15,21 @@ Advantages over Javascript requests: 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 +## Installation + +```bash +ionic cordova plugin add @approov/cordova-plugin-advanced-http +npm install @awesome-cordova-plugins/approov-advanced-http +``` + +**Plugin Repo:** [https://github.com/approov/quickstart-cordova-advancedhttp](https://github.com/approov/quickstart-cordova-advancedhttp) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/appsflyer/README.md b/docs/plugins/appsflyer/README.md index 863d1bba0..febc8d56c 100644 --- a/docs/plugins/appsflyer/README.md +++ b/docs/plugins/appsflyer/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Appsflyer plugin for Cordova and Ionic. Appsflyer Cordova SDK support for Attribution +--- + # Appsflyer -``` -$ Add to config.xml like stated on github and then start -$ npm install @awesome-cordova-plugins/appsflyer -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +Add to config.xml like stated on github and then start +npm install @awesome-cordova-plugins/appsflyer +``` + +**Plugin Repo:** [https://github.com/AppsFlyerSDK/cordova-plugin-appsflyer-sdk](https://github.com/AppsFlyerSDK/cordova-plugin-appsflyer-sdk) + +## Supported Platforms - iOS - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/audio-management/README.md b/docs/plugins/audio-management/README.md index 4de48a74f..b0e9fac20 100644 --- a/docs/plugins/audio-management/README.md +++ b/docs/plugins/audio-management/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Audio Management plugin for Cordova and Ionic. A Cordova plugin to manage volume of audio streams for: ring, music, notification and system. Possible ringer… +--- + # Audio Management -``` -$ ionic cordova plugin add clovelced-plugin-audiomanagement -$ npm install @awesome-cordova-plugins/audio-management -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/audio-management/) - -Plugin Repo: [https://github.com/clovelCed/cordova-plugin-audiomanagement](https://github.com/clovelCed/cordova-plugin-audiomanagement) - A Cordova plugin to manage volume of audio streams for: ring, music, notification and system. Possible ringer values for those streams are: silent, vibrate and normal. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add clovelced-plugin-audiomanagement +npm install @awesome-cordova-plugins/audio-management +``` + +**Plugin Repo:** [https://github.com/clovelCed/cordova-plugin-audiomanagement](https://github.com/clovelCed/cordova-plugin-audiomanagement) + +## Supported Platforms - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/background-fetch/README.md b/docs/plugins/background-fetch/README.md index 004f14beb..51685ec6d 100644 --- a/docs/plugins/background-fetch/README.md +++ b/docs/plugins/background-fetch/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Background Fetch plugin for Cordova and Ionic. iOS Background Fetch Implementation. See: https://developer.apple.com/reference/uikit/uiapplication#1657399 iOS… +--- + # Background Fetch -``` -$ ionic cordova plugin add cordova-plugin-background-fetch -$ npm install @awesome-cordova-plugins/background-fetch -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-background-fetch +npm install @awesome-cordova-plugins/background-fetch +``` + +**Plugin Repo:** [https://github.com/transistorsoft/cordova-plugin-background-fetch](https://github.com/transistorsoft/cordova-plugin-background-fetch) + +## Supported Platforms - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/background-geolocation/README.md b/docs/plugins/background-geolocation/README.md index aa3ae5ee1..706bb5019 100644 --- a/docs/plugins/background-geolocation/README.md +++ b/docs/plugins/background-geolocation/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Background Geolocation plugin for Cordova and Ionic. This plugin provides foreground and background geolocation with battery-saving "circular region… +--- + # Background Geolocation -``` -$ ionic cordova plugin add @mauron85/cordova-plugin-background-geolocation -$ npm install @awesome-cordova-plugins/background-geolocation -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add @mauron85/cordova-plugin-background-geolocation +npm install @awesome-cordova-plugins/background-geolocation +``` + +**Plugin Repo:** [https://github.com/mauron85/cordova-plugin-background-geolocation](https://github.com/mauron85/cordova-plugin-background-geolocation) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/background-mode/README.md b/docs/plugins/background-mode/README.md index fc237cc8f..820e7d6d6 100644 --- a/docs/plugins/background-mode/README.md +++ b/docs/plugins/background-mode/README.md @@ -1,18 +1,23 @@ +--- +description: >- + Background Mode plugin for Cordova and Ionic. Cordova plugin to prevent the app from going to sleep while in background. Requires Cordova plugin:… +--- + # Background Mode -``` -$ ionic cordova plugin add cordova-plugin-background-mode -$ npm install @awesome-cordova-plugins/background-mode -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-background-mode +npm install @awesome-cordova-plugins/background-mode +``` + +**Plugin Repo:** [https://github.com/katzer/cordova-plugin-background-mode](https://github.com/katzer/cordova-plugin-background-mode) + +## Supported Platforms - AmazonFire OS - Android @@ -20,3 +25,7 @@ Requires Cordova plugin: cordova-plugin-background-mode. For more info about plu - iOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/background-upload/README.md b/docs/plugins/background-upload/README.md index 4a8f3a869..9f88e3f6c 100644 --- a/docs/plugins/background-upload/README.md +++ b/docs/plugins/background-upload/README.md @@ -1,18 +1,27 @@ +--- +description: >- + BackgroundUpload plugin for Cordova and Ionic. This plugin does something +--- + # BackgroundUpload -``` -$ ionic cordova plugin add @spoonconsulting/cordova-plugin-background-upload -$ npm install @awesome-cordova-plugins/background-upload -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add @spoonconsulting/cordova-plugin-background-upload +npm install @awesome-cordova-plugins/background-upload +``` + +**Plugin Repo:** [https://github.com/spoonconsulting/cordova-plugin-background-upload](https://github.com/spoonconsulting/cordova-plugin-background-upload) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/badge/README.md b/docs/plugins/badge/README.md index 8c6448d14..1e7af2e62 100644 --- a/docs/plugins/badge/README.md +++ b/docs/plugins/badge/README.md @@ -1,24 +1,33 @@ +--- +description: >- + Badge plugin for Cordova and Ionic. The essential purpose of badge numbers is to enable an application to inform its users that it has something for them —… +--- + # Badge -``` -$ ionic cordova plugin add cordova-plugin-badge -$ npm install @awesome-cordova-plugins/badge -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-badge +npm install @awesome-cordova-plugins/badge +``` + +**Plugin Repo:** [https://github.com/katzer/cordova-plugin-badge](https://github.com/katzer/cordova-plugin-badge) + +## Supported Platforms - Android - Browser - iOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/barcode-scanner/README.md b/docs/plugins/barcode-scanner/README.md index b560b1071..7fabe3873 100644 --- a/docs/plugins/barcode-scanner/README.md +++ b/docs/plugins/barcode-scanner/README.md @@ -1,19 +1,24 @@ +--- +description: >- + Barcode Scanner plugin for Cordova and Ionic. The Barcode Scanner Plugin opens a camera view and automatically scans a barcode, returning the data back to… +--- + # Barcode Scanner -``` -$ ionic cordova plugin add phonegap-plugin-barcodescanner -$ npm install @awesome-cordova-plugins/barcode-scanner -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add phonegap-plugin-barcodescanner +npm install @awesome-cordova-plugins/barcode-scanner +``` + +**Plugin Repo:** [https://github.com/phonegap/phonegap-plugin-barcodescanner](https://github.com/phonegap/phonegap-plugin-barcodescanner) + +## Supported Platforms - Android - BlackBerry 10 @@ -21,3 +26,7 @@ Requires Cordova plugin: `phonegap-plugin-barcodescanner`. For more info, please - iOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/barkoder/README.md b/docs/plugins/barkoder/README.md index 04e5708b9..0b0f8f1b5 100644 --- a/docs/plugins/barkoder/README.md +++ b/docs/plugins/barkoder/README.md @@ -1,16 +1,25 @@ +--- +description: >- + Barkoder plugin for Cordova and Ionic. The barKoder Barcode Scanner SDK cordova plugin grants an easy to use solution with a great and completely customizable… +--- + # Barkoder -``` -$ ionic cordova plugin add barkoder-cordova -$ npm install @awesome-cordova-plugins/barkoder -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/barkoder/) - The barKoder Barcode Scanner SDK cordova plugin grants an easy to use solution with a great and completely customizable interface that can be instantly integrated in both iOS and Android apps. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add barkoder-cordova +npm install @awesome-cordova-plugins/barkoder +``` + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/battery-status/README.md b/docs/plugins/battery-status/README.md index 0a66c2b68..9023c3048 100644 --- a/docs/plugins/battery-status/README.md +++ b/docs/plugins/battery-status/README.md @@ -1,20 +1,29 @@ +--- +description: >- + Battery Status plugin for Cordova and Ionic. Requires Cordova plugin: cordova-plugin-batterystatus. For more info, please see the [BatteryStatus plugin… +--- + # Battery Status -``` -$ ionic cordova plugin add cordova-plugin-battery-status -$ npm install @awesome-cordova-plugins/battery-status -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-battery-status +npm install @awesome-cordova-plugins/battery-status +``` + +**Plugin Repo:** [https://github.com/apache/cordova-plugin-battery-status](https://github.com/apache/cordova-plugin-battery-status) + +## Supported Platforms - iOS - Android - Windows - Browser +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/biocatch/README.md b/docs/plugins/biocatch/README.md index 80dcefe78..09b50b760 100644 --- a/docs/plugins/biocatch/README.md +++ b/docs/plugins/biocatch/README.md @@ -1,18 +1,27 @@ +--- +description: >- + BioCatch plugin for Cordova and Ionic. BioCatch SDK Cordova support +--- + # BioCatch -``` -$ ionic cordova plugin add cordova-plugin-biocatch -$ npm install @awesome-cordova-plugins/biocatch -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/biocatch/) - -Plugin Repo: [https://bitbucket.org/carlos_orellana/ionic-plugin](https://bitbucket.org/carlos_orellana/ionic-plugin) - BioCatch SDK Cordova support -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-biocatch +npm install @awesome-cordova-plugins/biocatch +``` + +**Plugin Repo:** [https://bitbucket.org/carlos_orellana/ionic-plugin](https://bitbucket.org/carlos_orellana/ionic-plugin) + +## Supported Platforms - iOS - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/biometric-wrapper/README.md b/docs/plugins/biometric-wrapper/README.md index b8b740c83..e27cba4c3 100644 --- a/docs/plugins/biometric-wrapper/README.md +++ b/docs/plugins/biometric-wrapper/README.md @@ -1,16 +1,25 @@ +--- +description: >- + BiometricWrapper plugin for Cordova and Ionic. This plugin capture biometric(Iris and Fingerprint) and validate the user. May be used in Banking domain +--- + # BiometricWrapper -``` -$ -$ npm install @awesome-cordova-plugins/biometric-wrapper -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/biometric-wrapper/) - This plugin capture biometric(Iris and Fingerprint) and validate the user. May be used in Banking domain -## Supported platforms +## Installation + +```bash + +npm install @awesome-cordova-plugins/biometric-wrapper +``` + +## Supported Platforms - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/ble/README.md b/docs/plugins/ble/README.md index 1ff1047b7..9d7a83f7a 100644 --- a/docs/plugins/ble/README.md +++ b/docs/plugins/ble/README.md @@ -1,14 +1,10 @@ +--- +description: >- + BLE plugin for Cordova and Ionic. This plugin enables communication between a phone and Bluetooth Low Energy (BLE) peripherals. The plugin provides a simple… +--- + # BLE -``` -$ ionic cordova plugin add cordova-plugin-ble-central -$ npm install @awesome-cordova-plugins/ble -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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. @@ -23,8 +19,21 @@ Advertising information is returned when scanning for peripherals. Service, char Simultaneous connections to multiple peripherals are supported. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-ble-central +npm install @awesome-cordova-plugins/ble +``` + +**Plugin Repo:** [https://github.com/don/cordova-plugin-ble-central](https://github.com/don/cordova-plugin-ble-central) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/blinkid/README.md b/docs/plugins/blinkid/README.md index 1c12f16fa..0a147f600 100644 --- a/docs/plugins/blinkid/README.md +++ b/docs/plugins/blinkid/README.md @@ -1,19 +1,28 @@ +--- +description: >- + BlinkId plugin for Cordova and Ionic. Microblink SDK wrapper for barcode and document scanning. See the blinkid-phonegap repository for available recognizers… +--- + # 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 @awesome-cordova-plugins/blinkid -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +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 @awesome-cordova-plugins/blinkid +``` + +**Plugin Repo:** [https://github.com/BlinkID/blinkid-phonegap](https://github.com/BlinkID/blinkid-phonegap) + +## Supported Platforms - iOS - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/bluetooth-classic-serial-port/README.md b/docs/plugins/bluetooth-classic-serial-port/README.md index 5c0a21343..ddf335ea0 100644 --- a/docs/plugins/bluetooth-classic-serial-port/README.md +++ b/docs/plugins/bluetooth-classic-serial-port/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Bluetooth Classic Serial Port plugin for Cordova and Ionic. This plugin is written using the iOS Accessory Framework (MFi) to support Classic Bluetooth on iOS. +--- + # Bluetooth Classic Serial Port -``` -$ ionic cordova plugin add cordova-plugin-bluetooth-classic-serial-port -$ npm install @awesome-cordova-plugins/bluetooth-classic-serial-port -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-bluetooth-classic-serial-port +npm install @awesome-cordova-plugins/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) + +## Supported Platforms - Android - iOS - Browser +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/bluetooth-le/README.md b/docs/plugins/bluetooth-le/README.md index 3fd723af9..7c5127e8d 100644 --- a/docs/plugins/bluetooth-le/README.md +++ b/docs/plugins/bluetooth-le/README.md @@ -1,20 +1,29 @@ +--- +description: >- + BluetoothLE plugin for Cordova and Ionic. This plugin has the most complete implementation for interacting with Bluetooth LE devices on Android, iOS and… +--- + # BluetoothLE -``` -$ ionic cordova plugin add cordova-plugin-bluetoothle -$ npm install @awesome-cordova-plugins/bluetooth-le -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-bluetoothle +npm install @awesome-cordova-plugins/bluetooth-le +``` + +**Plugin Repo:** [https://github.com/randdusing/cordova-plugin-bluetoothle](https://github.com/randdusing/cordova-plugin-bluetoothle) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/bluetooth-serial/README.md b/docs/plugins/bluetooth-serial/README.md index d49a1c65d..4fe255617 100644 --- a/docs/plugins/bluetooth-serial/README.md +++ b/docs/plugins/bluetooth-serial/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Bluetooth Serial plugin for Cordova and Ionic. This plugin enables serial communication over Bluetooth. It was written for communicating between Android or… +--- + # Bluetooth Serial -``` -$ ionic cordova plugin add cordova-plugin-bluetooth-serial -$ npm install @awesome-cordova-plugins/bluetooth-serial -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-bluetooth-serial +npm install @awesome-cordova-plugins/bluetooth-serial +``` + +**Plugin Repo:** [https://github.com/don/BluetoothSerial](https://github.com/don/BluetoothSerial) + +## Supported Platforms - Android - iOS - Windows Phone 8 +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/branch-io/README.md b/docs/plugins/branch-io/README.md index d23e3b318..aa0080e11 100644 --- a/docs/plugins/branch-io/README.md +++ b/docs/plugins/branch-io/README.md @@ -1,18 +1,27 @@ +--- +description: >- + BranchIo plugin for Cordova and Ionic. Branch.io is an attribution service for deeplinking and invitation links +--- + # BranchIo -``` -$ ionic cordova plugin add branch-cordova-sdk -$ npm install @awesome-cordova-plugins/branch-io -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add branch-cordova-sdk +npm install @awesome-cordova-plugins/branch-io +``` + +**Plugin Repo:** [https://github.com/BranchMetrics/cordova-ionic-phonegap-branch-deep-linking](https://github.com/BranchMetrics/cordova-ionic-phonegap-branch-deep-linking) + +## Supported Platforms - iOS - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/brightness/README.md b/docs/plugins/brightness/README.md index 58efa7829..0cada7756 100644 --- a/docs/plugins/brightness/README.md +++ b/docs/plugins/brightness/README.md @@ -1,20 +1,29 @@ +--- +description: >- + Brightness plugin for Cordova and Ionic. The Brightness plugin let you control the display brightness of your device. Requires Cordova plugin:… +--- + # Brightness -``` -$ ionic cordova plugin add cordova-plugin-brightness -$ npm install @awesome-cordova-plugins/brightness -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/brightness/) - -Plugin Repo: [https://github.com/mgcrea/cordova-plugin-brightness](https://github.com/mgcrea/cordova-plugin-brightness) - The Brightness plugin let you control the display brightness of your device. Requires Cordova plugin: `cordova-plugin-brightness`. For more info, please see the [Brightness plugin docs](https://github.com/mgcrea/cordova-plugin-brightness). -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-brightness +npm install @awesome-cordova-plugins/brightness +``` + +**Plugin Repo:** [https://github.com/mgcrea/cordova-plugin-brightness](https://github.com/mgcrea/cordova-plugin-brightness) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/broadcaster/README.md b/docs/plugins/broadcaster/README.md index d2469831f..3ffe0fd36 100644 --- a/docs/plugins/broadcaster/README.md +++ b/docs/plugins/broadcaster/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Broadcaster plugin for Cordova and Ionic. This plugin adds exchanging events between native code and your app. +--- + # Broadcaster -``` -$ ionic cordova plugin add cordova-plugin-broadcaster -$ npm install @awesome-cordova-plugins/broadcaster -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-broadcaster +npm install @awesome-cordova-plugins/broadcaster +``` + +**Plugin Repo:** [https://github.com/bsorrentino/cordova-broadcaster](https://github.com/bsorrentino/cordova-broadcaster) + +## Supported Platforms - Android - iOS - Browser +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/browser-tab/README.md b/docs/plugins/browser-tab/README.md index 3aff2cec6..a96a0349e 100644 --- a/docs/plugins/browser-tab/README.md +++ b/docs/plugins/browser-tab/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Browser Tab plugin for Cordova and Ionic. This plugin provides an interface to in-app browser tabs that exist on some mobile platforms, specifically [Custom… +--- + # Browser Tab -``` -$ ionic cordova plugin add cordova-plugin-browsertab -$ npm install @awesome-cordova-plugins/browser-tab -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/browser-tab/) - -Plugin Repo: [https://github.com/google/cordova-plugin-browsertab](https://github.com/google/cordova-plugin-browsertab) - This plugin provides an interface to in-app browser tabs that exist on some mobile platforms, specifically [Custom Tabs](http://developer.android.com/tools/support-library/features.html#custom-tabs) on Android (including the [Chrome Custom Tabs](https://developer.chrome.com/multidevice/android/customtabs) implementation), and [SFSafariViewController](https://developer.apple.com/library/ios/documentation/SafariServices/Reference/SFSafariViewController_Ref/) on iOS. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-browsertab +npm install @awesome-cordova-plugins/browser-tab +``` + +**Plugin Repo:** [https://github.com/google/cordova-plugin-browsertab](https://github.com/google/cordova-plugin-browsertab) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/build-info/README.md b/docs/plugins/build-info/README.md index 31b36dfa1..a64b7f54b 100644 --- a/docs/plugins/build-info/README.md +++ b/docs/plugins/build-info/README.md @@ -1,17 +1,22 @@ +--- +description: >- + Build Info plugin for Cordova and Ionic. This plugin provides build information. +--- + # Build Info -``` -$ ionic cordova plugin add cordova-plugin-buildinfo -$ npm install @awesome-cordova-plugins/build-info -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-buildinfo +npm install @awesome-cordova-plugins/build-info +``` + +**Plugin Repo:** [https://github.com/lynrin/cordova-plugin-buildinfo](https://github.com/lynrin/cordova-plugin-buildinfo) + +## Supported Platforms - Android - iOS @@ -20,3 +25,7 @@ This plugin provides build information. - browser - Electron +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/calendar/README.md b/docs/plugins/calendar/README.md index a36807cf1..906f23a53 100644 --- a/docs/plugins/calendar/README.md +++ b/docs/plugins/calendar/README.md @@ -1,20 +1,29 @@ +--- +description: >- + Calendar plugin for Cordova and Ionic. This plugin allows you to add events to the Calendar of the mobile device. Requires Cordova plugin:… +--- + # Calendar -``` -$ ionic cordova plugin add cordova-plugin-calendar -$ npm install @awesome-cordova-plugins/calendar -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-calendar +npm install @awesome-cordova-plugins/calendar +``` + +**Plugin Repo:** [https://github.com/EddyVerbruggen/Calendar-PhoneGap-Plugin](https://github.com/EddyVerbruggen/Calendar-PhoneGap-Plugin) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/call-directory/README.md b/docs/plugins/call-directory/README.md index 7690bd09a..5d0121dca 100644 --- a/docs/plugins/call-directory/README.md +++ b/docs/plugins/call-directory/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Call Directory plugin for Cordova and Ionic. This plugin can add phone numbers to an Callkit call directory extension. Call `reloadExtension` after using… +--- + # Call Directory -``` -$ cordova plugin add cordova-plugin-call-directory --variable EXT_NAME="Cordova-Directory" --variable ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES="NO" -$ npm install @awesome-cordova-plugins/call-directory -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +cordova plugin add cordova-plugin-call-directory --variable EXT_NAME="Cordova-Directory" --variable ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES="NO" +npm install @awesome-cordova-plugins/call-directory +``` + +**Plugin Repo:** [https://github.com/GEDYSIntraWare/cordova-plugin-call-directory](https://github.com/GEDYSIntraWare/cordova-plugin-call-directory) + +## Supported Platforms - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/call-number/README.md b/docs/plugins/call-number/README.md index a0c0330ea..5165197a6 100644 --- a/docs/plugins/call-number/README.md +++ b/docs/plugins/call-number/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Call Number plugin for Cordova and Ionic. Call a number directly from your Cordova/Ionic application. NOTE**: The iOS Simulator (and maybe Android Simulators)… +--- + # Call Number -``` -$ ionic cordova plugin add call-number -$ npm install @awesome-cordova-plugins/call-number -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add call-number +npm install @awesome-cordova-plugins/call-number +``` + +**Plugin Repo:** [https://github.com/Rohfosho/CordovaCallNumberPlugin](https://github.com/Rohfosho/CordovaCallNumberPlugin) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/camera-preview/README.md b/docs/plugins/camera-preview/README.md index 25acf2f91..02447d3d3 100644 --- a/docs/plugins/camera-preview/README.md +++ b/docs/plugins/camera-preview/README.md @@ -1,20 +1,29 @@ +--- +description: >- + Camera Preview plugin for Cordova and Ionic. Showing camera preview in HTML Requires Cordova plugin:… +--- + # Camera Preview -``` -$ ionic cordova plugin add cordova-plugin-camera-preview -$ npm install @awesome-cordova-plugins/camera-preview -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-camera-preview +npm install @awesome-cordova-plugins/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) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/camera/README.md b/docs/plugins/camera/README.md index 67c5bca1c..a3005ac44 100644 --- a/docs/plugins/camera/README.md +++ b/docs/plugins/camera/README.md @@ -1,14 +1,10 @@ +--- +description: >- + Camera plugin for Cordova and Ionic. Take a photo or capture video. Requires the Cordova plugin: `cordova-plugin-camera`. For more info, please see the… +--- + # Camera -``` -$ ionic cordova plugin add cordova-plugin-camera -$ npm install @awesome-cordova-plugins/camera -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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). @@ -21,10 +17,23 @@ Requires the Cordova plugin: `cordova-plugin-camera`. For more info, please see ``` inside of the `- + CustomUISDK plugin for Cordova and Ionic. This plugin is used to access Paytm's native CustomUISDK framework's apis. +--- + # CustomUISDK -``` -$ -$ npm install @awesome-cordova-plugins/custom-uisdk -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash + +npm install @awesome-cordova-plugins/custom-uisdk +``` + +**Plugin Repo:** [https://github.com/paytm/paytm-customuisdk-cordova](https://github.com/paytm/paytm-customuisdk-cordova) + +## Supported Platforms - Android, iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/deeplinks/README.md b/docs/plugins/deeplinks/README.md index 5ae2e470c..8339fe41f 100644 --- a/docs/plugins/deeplinks/README.md +++ b/docs/plugins/deeplinks/README.md @@ -1,23 +1,32 @@ +--- +description: >- + Deeplinks plugin for Cordova and Ionic. This plugin handles deeplinks on iOS and Android for both custom URL scheme links and Universal App Links. Please… +--- + # 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 @awesome-cordova-plugins/deeplinks -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +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 @awesome-cordova-plugins/deeplinks +``` + +**Plugin Repo:** [https://github.com/ionic-team/ionic-plugin-deeplinks](https://github.com/ionic-team/ionic-plugin-deeplinks) + +## Supported Platforms - Android - Browser - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/device-accounts/README.md b/docs/plugins/device-accounts/README.md index 593194b88..d4b156f55 100644 --- a/docs/plugins/device-accounts/README.md +++ b/docs/plugins/device-accounts/README.md @@ -1,17 +1,26 @@ +--- +description: >- + Device Accounts plugin for Cordova and Ionic. Gets the Google accounts associated with the Android device +--- + # Device Accounts -``` -$ ionic cordova plugin add cordova-device-accounts-v2 -$ npm install @awesome-cordova-plugins/device-accounts -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-device-accounts-v2 +npm install @awesome-cordova-plugins/device-accounts +``` + +**Plugin Repo:** [https://github.com/xUnholy/cordova-device-accounts-v2](https://github.com/xUnholy/cordova-device-accounts-v2) + +## Supported Platforms - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/device-motion/README.md b/docs/plugins/device-motion/README.md index cd92b2f07..67da688a6 100644 --- a/docs/plugins/device-motion/README.md +++ b/docs/plugins/device-motion/README.md @@ -1,17 +1,22 @@ +--- +description: >- + Device Motion plugin for Cordova and Ionic. Requires Cordova plugin: `cordova-plugin-device-motion`. For more info, please see the [Device Motion… +--- + # Device Motion -``` -$ ionic cordova plugin add cordova-plugin-device-motion -$ npm install @awesome-cordova-plugins/device-motion -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-device-motion +npm install @awesome-cordova-plugins/device-motion +``` + +**Plugin Repo:** [https://github.com/apache/cordova-plugin-device-motion](https://github.com/apache/cordova-plugin-device-motion) + +## Supported Platforms - Android - BlackBerry 10 @@ -23,3 +28,7 @@ Requires Cordova plugin: `cordova-plugin-device-motion`. For more info, please s - Windows - Windows Phone 8 +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/device-orientation/README.md b/docs/plugins/device-orientation/README.md index a90e540d0..363030dcc 100644 --- a/docs/plugins/device-orientation/README.md +++ b/docs/plugins/device-orientation/README.md @@ -1,17 +1,22 @@ +--- +description: >- + Device Orientation plugin for Cordova and Ionic. Requires Cordova plugin: `cordova-plugin-device-orientation`. For more info, please see the [Device… +--- + # Device Orientation -``` -$ ionic cordova plugin add cordova-plugin-device-orientation -$ npm install @awesome-cordova-plugins/device-orientation -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-device-orientation +npm install @awesome-cordova-plugins/device-orientation +``` + +**Plugin Repo:** [https://github.com/apache/cordova-plugin-device-orientation](https://github.com/apache/cordova-plugin-device-orientation) + +## Supported Platforms - Amazon Fire OS - Android @@ -24,3 +29,7 @@ Requires Cordova plugin: `cordova-plugin-device-orientation`. For more info, ple - Windows - Windows Phone +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/device/README.md b/docs/plugins/device/README.md index 5530b65ca..855674797 100644 --- a/docs/plugins/device/README.md +++ b/docs/plugins/device/README.md @@ -1,17 +1,22 @@ +--- +description: >- + Device plugin for Cordova and Ionic. Access information about the underlying device and platform. +--- + # Device -``` -$ ionic cordova plugin add cordova-plugin-device -$ npm install @awesome-cordova-plugins/device -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-device +npm install @awesome-cordova-plugins/device +``` + +**Plugin Repo:** [https://github.com/apache/cordova-plugin-device](https://github.com/apache/cordova-plugin-device) + +## Supported Platforms - Android - Browser @@ -19,3 +24,7 @@ Access information about the underlying device and platform. - macOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/dfu-update/README.md b/docs/plugins/dfu-update/README.md index 364cfc889..110e2bb77 100644 --- a/docs/plugins/dfu-update/README.md +++ b/docs/plugins/dfu-update/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Dfu Update plugin for Cordova and Ionic. This plugin is a Wrapper to use Nordic Semiconductor's Device Firmware Update (DFU) service to update a Bluetooth LE… +--- + # Dfu Update -``` -$ ionic cordova plugin add cordova-plugin-dfu-update --variable ANDROID_NORDIC_VERSION="1.11.0" -$ npm install @awesome-cordova-plugins/dfu-update -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-dfu-update --variable ANDROID_NORDIC_VERSION="1.11.0" +npm install @awesome-cordova-plugins/dfu-update +``` + +**Plugin Repo:** [https://github.com/EinfachHans/cordova-plugin-dfu-update](https://github.com/EinfachHans/cordova-plugin-dfu-update) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/diagnostic/README.md b/docs/plugins/diagnostic/README.md index 7e7aee797..55701faaa 100644 --- a/docs/plugins/diagnostic/README.md +++ b/docs/plugins/diagnostic/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Diagnostic plugin for Cordova and Ionic. Checks whether device hardware features are enabled or available to the app, e.g. camera, GPS, wifi +--- + # Diagnostic -``` -$ ionic cordova plugin add cordova.plugins.diagnostic -$ npm install @awesome-cordova-plugins/diagnostic -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova.plugins.diagnostic +npm install @awesome-cordova-plugins/diagnostic +``` + +**Plugin Repo:** [https://github.com/dpa99c/cordova-diagnostic-plugin](https://github.com/dpa99c/cordova-diagnostic-plugin) + +## Supported Platforms - Android - iOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/dialogs/README.md b/docs/plugins/dialogs/README.md index 69d804490..23c62d094 100644 --- a/docs/plugins/dialogs/README.md +++ b/docs/plugins/dialogs/README.md @@ -1,19 +1,24 @@ +--- +description: >- + Dialogs plugin for Cordova and Ionic. This plugin gives you ability to access and customize the device native dialogs. Requires Cordova plugin:… +--- + # Dialogs -``` -$ ionic cordova plugin add cordova-plugin-dialogs -$ npm install @awesome-cordova-plugins/dialogs -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-dialogs +npm install @awesome-cordova-plugins/dialogs +``` + +**Plugin Repo:** [https://github.com/apache/cordova-plugin-dialogs](https://github.com/apache/cordova-plugin-dialogs) + +## Supported Platforms - Amazon Fire OS - Android @@ -21,3 +26,7 @@ Requires Cordova plugin: `cordova-plugin-dialogs`. For more info, please see the - iOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/dns/README.md b/docs/plugins/dns/README.md index f48d02456..f87a22c5e 100644 --- a/docs/plugins/dns/README.md +++ b/docs/plugins/dns/README.md @@ -1,17 +1,26 @@ +--- +description: >- + DNS plugin for Cordova and Ionic. A plugin for Apache Cordova that enables applications to manually resolve hostnames into an underlying network address. This… +--- + # DNS -``` -$ ionic cordova plugin add cordova-plugin-dns -$ npm install @awesome-cordova-plugins/dns -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-dns +npm install @awesome-cordova-plugins/dns +``` + +**Plugin Repo:** [https://bitbucket.org/zegeba/cordova-plugin-dns](https://bitbucket.org/zegeba/cordova-plugin-dns) + +## Supported Platforms - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/document-picker/README.md b/docs/plugins/document-picker/README.md index 869626410..32b9ff0e3 100644 --- a/docs/plugins/document-picker/README.md +++ b/docs/plugins/document-picker/README.md @@ -1,18 +1,27 @@ +--- +description: >- + iOS DocumentPicker plugin for Cordova and Ionic. Opens the file picker on iOS for the user to select a file, returns a file URI. Allows the user to upload… +--- + # iOS DocumentPicker -``` -$ ionic cordova plugin add cordova-plugin-documentpicker.DocumentPicker -$ npm install @awesome-cordova-plugins/document-picker -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-documentpicker.DocumentPicker +npm install @awesome-cordova-plugins/document-picker +``` + +**Plugin Repo:** [https://github.com/iampossible/Cordova-DocPicker](https://github.com/iampossible/Cordova-DocPicker) + +## Supported Platforms - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/document-scanner/README.md b/docs/plugins/document-scanner/README.md index fed5dc007..f7868a87c 100644 --- a/docs/plugins/document-scanner/README.md +++ b/docs/plugins/document-scanner/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Document Scanner plugin for Cordova and Ionic. This plugin processes images of documents, compensating for perspective. +--- + # Document Scanner -``` -$ ionic cordova plugin add cordova-plugin-document-scanner -$ npm install @awesome-cordova-plugins/document-scanner -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-document-scanner +npm install @awesome-cordova-plugins/document-scanner +``` + +**Plugin Repo:** [https://github.com/NeutrinosPlatform/cordova-plugin-document-scanner](https://github.com/NeutrinosPlatform/cordova-plugin-document-scanner) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/document-viewer/README.md b/docs/plugins/document-viewer/README.md index 97a080757..919aedfa5 100644 --- a/docs/plugins/document-viewer/README.md +++ b/docs/plugins/document-viewer/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Document Viewer plugin for Cordova and Ionic. This plugin offers a slim API to view PDF files which are either stored in the apps assets folder (/www/*) or in… +--- + # Document Viewer -``` -$ ionic cordova plugin add cordova-plugin-document-viewer -$ npm install @awesome-cordova-plugins/document-viewer -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-document-viewer +npm install @awesome-cordova-plugins/document-viewer +``` + +**Plugin Repo:** [https://github.com/sitewaerts/cordova-plugin-document-viewer](https://github.com/sitewaerts/cordova-plugin-document-viewer) + +## Supported Platforms - Android - iOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/downloader/README.md b/docs/plugins/downloader/README.md index 59b3549b1..e64be1929 100644 --- a/docs/plugins/downloader/README.md +++ b/docs/plugins/downloader/README.md @@ -1,17 +1,26 @@ +--- +description: >- + Document Downloader plugin for Cordova and Ionic. This plugin is designed to support downloading files using Android DownloadManager. +--- + # Document Downloader -``` -$ ionic cordova plugin add integrator-cordova-plugin-downloader -$ npm install @awesome-cordova-plugins/downloader -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/downloader/) - -Plugin Repo: [https://github.com/Luka313/integrator-cordova-plugin-downloader.git](https://github.com/Luka313/integrator-cordova-plugin-downloader.git) - This plugin is designed to support downloading files using Android DownloadManager. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add integrator-cordova-plugin-downloader +npm install @awesome-cordova-plugins/downloader +``` + +**Plugin Repo:** [https://github.com/Luka313/integrator-cordova-plugin-downloader.git](https://github.com/Luka313/integrator-cordova-plugin-downloader.git) + +## Supported Platforms - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/dynamsoft-barcode-scanner/README.md b/docs/plugins/dynamsoft-barcode-scanner/README.md index 720b892be..8fc348560 100755 --- a/docs/plugins/dynamsoft-barcode-scanner/README.md +++ b/docs/plugins/dynamsoft-barcode-scanner/README.md @@ -1,18 +1,27 @@ +--- +description: >- + dynamsoft-barcode-scanner plugin for Cordova and Ionic. This plugin scans barcodes using Dynamsoft Barcode Reader +--- + # dynamsoft-barcode-scanner -``` -$ -$ npm install @awesome-cordova-plugins/dynamsoft-barcode-scanner -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/dynamsoft-barcode-scanner/) - -Plugin Repo: [https://github.com/xulihang/cordova-plugin-dynamsoft-barcode-reader](https://github.com/xulihang/cordova-plugin-dynamsoft-barcode-reader) - This plugin scans barcodes using Dynamsoft Barcode Reader -## Supported platforms +## Installation + +```bash + +npm install @awesome-cordova-plugins/dynamsoft-barcode-scanner +``` + +**Plugin Repo:** [https://github.com/xulihang/cordova-plugin-dynamsoft-barcode-reader](https://github.com/xulihang/cordova-plugin-dynamsoft-barcode-reader) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/email-composer/README.md b/docs/plugins/email-composer/README.md index 4742307a9..b43317f83 100644 --- a/docs/plugins/email-composer/README.md +++ b/docs/plugins/email-composer/README.md @@ -1,17 +1,22 @@ +--- +description: >- + Email Composer plugin for Cordova and Ionic. Requires Cordova plugin: cordova-plugin-email-composer. For more info, please see the [Email Composer plugin… +--- + # Email Composer -``` -$ ionic cordova plugin add cordova-plugin-email-composer -$ npm install @awesome-cordova-plugins/email-composer -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-email-composer +npm install @awesome-cordova-plugins/email-composer +``` + +**Plugin Repo:** [https://github.com/katzer/cordova-plugin-email-composer](https://github.com/katzer/cordova-plugin-email-composer) + +## Supported Platforms - Amazon Fire OS - Android @@ -20,3 +25,7 @@ Requires Cordova plugin: cordova-plugin-email-composer. For more info, please se - Windows - macOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/fabric/README.md b/docs/plugins/fabric/README.md index 5d8ab82d2..8279d6f53 100644 --- a/docs/plugins/fabric/README.md +++ b/docs/plugins/fabric/README.md @@ -1,20 +1,29 @@ +--- +description: >- + Crashlytics plugin for Cordova and Ionic. API for interacting with the Crashlytics kit. https://docs.fabric.io/crashlytics/index.html +--- + # Crashlytics -``` -$ ionic cordova plugin add cordova-fabric-plugin --variable FABRIC_API_KEY=XXX --variable FABRIC_API_SECRET=xxx -$ npm install @awesome-cordova-plugins/fabric -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/fabric/) - -Plugin Repo: [https://www.npmjs.com/package/cordova-fabric-plugin](https://www.npmjs.com/package/cordova-fabric-plugin) - API for interacting with the Crashlytics kit. https://docs.fabric.io/crashlytics/index.html -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-fabric-plugin --variable FABRIC_API_KEY=XXX --variable FABRIC_API_SECRET=xxx +npm install @awesome-cordova-plugins/fabric +``` + +**Plugin Repo:** [https://www.npmjs.com/package/cordova-fabric-plugin](https://www.npmjs.com/package/cordova-fabric-plugin) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/facebook/README.md b/docs/plugins/facebook/README.md index b17b361ce..2fd8b773d 100644 --- a/docs/plugins/facebook/README.md +++ b/docs/plugins/facebook/README.md @@ -1,14 +1,10 @@ +--- +description: >- + Facebook plugin for Cordova and Ionic. Use the Facebook Connect plugin to obtain access to the native FB application on iOS and Android. Requires Cordova… +--- + # Facebook -``` -$ ionic cordova plugin add cordova-plugin-facebook-connect --variable APP_ID="123456789" --variable APP_NAME="myApplication" -$ npm install @awesome-cordova-plugins/facebook -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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). @@ -74,9 +70,22 @@ Events are listed on the [insights page](https://www.facebook.com/insights/). For tracking events, see `logEvent` and `logPurchase`. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-facebook-connect --variable APP_ID="123456789" --variable APP_NAME="myApplication" +npm install @awesome-cordova-plugins/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) + +## Supported Platforms - Android - iOS - Browser +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/fbsdk/README.md b/docs/plugins/fbsdk/README.md index 41b9ce648..5f3ae1f00 100644 --- a/docs/plugins/fbsdk/README.md +++ b/docs/plugins/fbsdk/README.md @@ -1,14 +1,10 @@ +--- +description: >- + FbSdk plugin for Cordova and Ionic. Use the Facebook SDK plugin to obtain access to the native FB application on iOS and Android. Requires Cordova plugin:… +--- + # FbSdk -``` -$ ionic cordova plugin add cordova-plugin-fbsdk --variable APP_ID="123456789" --variable APP_NAME="myApplication" --variable CLIENT_TOKEN="abcd1234" -$ npm install @awesome-cordova-plugins/fbsdk -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/fbsdk/) - -Plugin Repo: [https://github.com/MaximBelov/cordova-plugin-fbsdk](https://github.com/MaximBelov/cordova-plugin-fbsdk) - Use the Facebook SDK plugin to obtain access to the native FB application on iOS and Android. Requires Cordova plugin: `cordova-plugin-fbsdk`. For more info, please see the [Facebook SDK](https://github.com/MaximBelov/cordova-plugin-fbsdk). @@ -79,9 +75,22 @@ Events are listed on the [insights page](https://www.facebook.com/insights/). For tracking events, see `logEvent` and `logPurchase`. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-fbsdk --variable APP_ID="123456789" --variable APP_NAME="myApplication" --variable CLIENT_TOKEN="abcd1234" +npm install @awesome-cordova-plugins/fbsdk +``` + +**Plugin Repo:** [https://github.com/MaximBelov/cordova-plugin-fbsdk](https://github.com/MaximBelov/cordova-plugin-fbsdk) + +## Supported Platforms - Android - iOS - Browser +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/fcm/README.md b/docs/plugins/fcm/README.md index ee3fa6c7b..1defc2602 100644 --- a/docs/plugins/fcm/README.md +++ b/docs/plugins/fcm/README.md @@ -1,18 +1,27 @@ +--- +description: >- + FCM plugin for Cordova and Ionic. Provides basic functionality for Firebase Cloud Messaging +--- + # FCM -``` -$ ionic cordova plugin add cordova-plugin-fcm-with-dependecy-updated -$ npm install @awesome-cordova-plugins/fcm -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-fcm-with-dependecy-updated +npm install @awesome-cordova-plugins/fcm +``` + +**Plugin Repo:** [https://github.com/andrehtissot/cordova-plugin-fcm-with-dependecy-updated](https://github.com/andrehtissot/cordova-plugin-fcm-with-dependecy-updated) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/ffmpeg/README.md b/docs/plugins/ffmpeg/README.md index 66a8b93b3..17a69e4e5 100644 --- a/docs/plugins/ffmpeg/README.md +++ b/docs/plugins/ffmpeg/README.md @@ -1,18 +1,27 @@ +--- +description: >- + FFMpeg plugin for Cordova and Ionic. Simple plugin that binds mobile ffmpeg to execute ffmpeg commands +--- + # FFMpeg -``` -$ ionic cordova plugin add cordova-plugin-ffmpeg -$ npm install @awesome-cordova-plugins/ffmpeg -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/ffmpeg/) - -Plugin Repo: [https://github.com/MaximBelov/cordova-plugin-ffmpeg](https://github.com/MaximBelov/cordova-plugin-ffmpeg) - Simple plugin that binds mobile ffmpeg to execute ffmpeg commands -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-ffmpeg +npm install @awesome-cordova-plugins/ffmpeg +``` + +**Plugin Repo:** [https://github.com/MaximBelov/cordova-plugin-ffmpeg](https://github.com/MaximBelov/cordova-plugin-ffmpeg) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/file-chooser/README.md b/docs/plugins/file-chooser/README.md index 51171718e..d7f877bb2 100644 --- a/docs/plugins/file-chooser/README.md +++ b/docs/plugins/file-chooser/README.md @@ -1,17 +1,26 @@ +--- +description: >- + FileChooser Plugin plugin for Cordova and Ionic. Cordova FileChooser Plugin +--- + # FileChooser Plugin -``` -$ ionic cordova plugin add cordova-plugin-filechooser -$ npm install @awesome-cordova-plugins/file-chooser -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/file-chooser/) - -Plugin Repo: [https://github.com/ihadeed/cordova-filechooser](https://github.com/ihadeed/cordova-filechooser) - Cordova FileChooser Plugin -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-filechooser +npm install @awesome-cordova-plugins/file-chooser +``` + +**Plugin Repo:** [https://github.com/ihadeed/cordova-filechooser](https://github.com/ihadeed/cordova-filechooser) + +## Supported Platforms - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/file-md5/README.md b/docs/plugins/file-md5/README.md index 1538c0a96..23195e1ad 100644 --- a/docs/plugins/file-md5/README.md +++ b/docs/plugins/file-md5/README.md @@ -1,18 +1,27 @@ +--- +description: >- + File MD5 plugin for Cordova and Ionic. This plugin reads large files in chunks and build the md5sum incrementally. +--- + # File MD5 -``` -$ ionic cordova plugin add cordova-plugin-file-md5 -$ npm install @awesome-cordova-plugins/file-md5 -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/file-md5/) - -Plugin Repo: [https://github.com/mramonlopez/cordova-plugin-file-md5](https://github.com/mramonlopez/cordova-plugin-file-md5) - This plugin reads large files in chunks and build the md5sum incrementally. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-file-md5 +npm install @awesome-cordova-plugins/file-md5 +``` + +**Plugin Repo:** [https://github.com/mramonlopez/cordova-plugin-file-md5](https://github.com/mramonlopez/cordova-plugin-file-md5) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/file-opener/README.md b/docs/plugins/file-opener/README.md index 034428477..8799b495c 100644 --- a/docs/plugins/file-opener/README.md +++ b/docs/plugins/file-opener/README.md @@ -1,20 +1,29 @@ +--- +description: >- + File Opener plugin for Cordova and Ionic. This plugin will open a file on your device file system with its default application. +--- + # File Opener -``` -$ ionic cordova plugin add cordova-plugin-file-opener2 -$ npm install @awesome-cordova-plugins/file-opener -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-file-opener2 +npm install @awesome-cordova-plugins/file-opener +``` + +**Plugin Repo:** [https://github.com/pwlin/cordova-plugin-file-opener2](https://github.com/pwlin/cordova-plugin-file-opener2) + +## Supported Platforms - Android - iOS - Windows - Windows Phone 8 +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/file-path/README.md b/docs/plugins/file-path/README.md index 15cb28a52..6f5842cfa 100644 --- a/docs/plugins/file-path/README.md +++ b/docs/plugins/file-path/README.md @@ -1,17 +1,26 @@ +--- +description: >- + File Path plugin for Cordova and Ionic. This plugin allows you to resolve the native filesystem path for Android content URIs and is based on code in the… +--- + # File Path -``` -$ ionic cordova plugin add cordova-plugin-filepath -$ npm install @awesome-cordova-plugins/file-path -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-filepath +npm install @awesome-cordova-plugins/file-path +``` + +**Plugin Repo:** [https://github.com/hiddentao/cordova-plugin-filepath](https://github.com/hiddentao/cordova-plugin-filepath) + +## Supported Platforms - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/file-transfer/README.md b/docs/plugins/file-transfer/README.md index b94f6be57..9e77e5a9b 100644 --- a/docs/plugins/file-transfer/README.md +++ b/docs/plugins/file-transfer/README.md @@ -1,17 +1,22 @@ +--- +description: >- + File Transfer plugin for Cordova and Ionic. This plugin allows you to upload and download files. +--- + # File Transfer -``` -$ ionic cordova plugin add cordova-plugin-file-transfer -$ npm install @awesome-cordova-plugins/file-transfer -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-file-transfer +npm install @awesome-cordova-plugins/file-transfer +``` + +**Plugin Repo:** [https://github.com/apache/cordova-plugin-file-transfer](https://github.com/apache/cordova-plugin-file-transfer) + +## Supported Platforms - Amazon Fire OS - Android @@ -21,3 +26,7 @@ This plugin allows you to upload and download files. - Windows - Windows Phone +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/file/README.md b/docs/plugins/file/README.md index 5156ccfe1..c6d17ff1c 100644 --- a/docs/plugins/file/README.md +++ b/docs/plugins/file/README.md @@ -1,14 +1,10 @@ +--- +description: >- + File plugin for Cordova and Ionic. This plugin implements a File API allowing read/write access to files residing on the device. The File class implements… +--- + # File -``` -$ ionic cordova plugin add cordova-plugin-file -$ npm install @awesome-cordova-plugins/file -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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. @@ -32,7 +28,16 @@ this.file.checkDir(this.file.dataDirectory, 'mydir').then(_ => console.log('Dire //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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-file +npm install @awesome-cordova-plugins/file +``` + +**Plugin Repo:** [https://github.com/apache/cordova-plugin-file](https://github.com/apache/cordova-plugin-file) + +## Supported Platforms - Android - Browser @@ -40,3 +45,7 @@ this.file.checkDir(this.file.dataDirectory, 'mydir').then(_ => console.log('Dire - macOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/fingerprint-aio/README.md b/docs/plugins/fingerprint-aio/README.md index b82529aed..25f0abd02 100644 --- a/docs/plugins/fingerprint-aio/README.md +++ b/docs/plugins/fingerprint-aio/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Fingerprint AIO plugin for Cordova and Ionic. Use simple fingerprint authentication on Android and iOS. Requires Cordova plugin:… +--- + # Fingerprint AIO -``` -$ ionic cordova plugin add cordova-plugin-fingerprint-aio -$ npm install @awesome-cordova-plugins/fingerprint-aio -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-fingerprint-aio +npm install @awesome-cordova-plugins/fingerprint-aio +``` + +**Plugin Repo:** [https://github.com/NiklasMerz/cordova-plugin-fingerprint-aio](https://github.com/NiklasMerz/cordova-plugin-fingerprint-aio) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/firebase-analytics/README.md b/docs/plugins/firebase-analytics/README.md index 9d2dc7cad..0116f5c82 100644 --- a/docs/plugins/firebase-analytics/README.md +++ b/docs/plugins/firebase-analytics/README.md @@ -1,14 +1,10 @@ +--- +description: >- + Firebase Analytics plugin for Cordova and Ionic. Cordova plugin for Firebase Analytics Go to firebase console and export google-services.json and… +--- + # Firebase Analytics -``` -$ ionic cordova plugin add cordova-plugin-firebase-analytics -$ npm install @awesome-cordova-plugins/firebase-analytics -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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. @@ -31,8 +27,21 @@ For Android you'll have to add in __android/app/src/main/AndroidManifest.xml__ u And in the same file, you'll have to add `xmlns:tools="http://schemas.android.com/tools"` to your _manifest_ tag. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-firebase-analytics +npm install @awesome-cordova-plugins/firebase-analytics +``` + +**Plugin Repo:** [https://github.com/chemerisuk/cordova-plugin-firebase-analytics](https://github.com/chemerisuk/cordova-plugin-firebase-analytics) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/firebase-authentication/README.md b/docs/plugins/firebase-authentication/README.md index 1ebb3d360..8b5bd1df0 100644 --- a/docs/plugins/firebase-authentication/README.md +++ b/docs/plugins/firebase-authentication/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Firebase Authentication plugin for Cordova and Ionic. Cordova plugin for Firebase Authentication +--- + # Firebase Authentication -``` -$ ionic cordova plugin add cordova-plugin-firebase-authentication --variable FIREBASE_AUTH_VERSION=version -$ npm install @awesome-cordova-plugins/firebase-authentication -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-firebase-authentication --variable FIREBASE_AUTH_VERSION=version +npm install @awesome-cordova-plugins/firebase-authentication +``` + +**Plugin Repo:** [https://github.com/chemerisuk/cordova-plugin-firebase-authentication](https://github.com/chemerisuk/cordova-plugin-firebase-authentication) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/firebase-config/README.md b/docs/plugins/firebase-config/README.md index a25b52c13..c821ff3d9 100644 --- a/docs/plugins/firebase-config/README.md +++ b/docs/plugins/firebase-config/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Firebase Config plugin for Cordova and Ionic. Cordova plugin for Firebase Config +--- + # Firebase Config -``` -$ ionic cordova plugin add cordova-plugin-firebase-config -$ npm install @awesome-cordova-plugins/firebase-config -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-firebase-config +npm install @awesome-cordova-plugins/firebase-config +``` + +**Plugin Repo:** [https://github.com/chemerisuk/cordova-plugin-firebase-config](https://github.com/chemerisuk/cordova-plugin-firebase-config) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/firebase-crash/README.md b/docs/plugins/firebase-crash/README.md index 99b56790f..243558625 100644 --- a/docs/plugins/firebase-crash/README.md +++ b/docs/plugins/firebase-crash/README.md @@ -1,18 +1,27 @@ +--- +description: >- + FirebaseCrash plugin for Cordova and Ionic. This plugin brings crash reporting from Google Firebase to your Cordova project! Android and iOS supported. +--- + # FirebaseCrash -``` -$ ionic cordova plugin add cordova-plugin-firebase-crash -$ npm install @awesome-cordova-plugins/firebase-crash -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-firebase-crash +npm install @awesome-cordova-plugins/firebase-crash +``` + +**Plugin Repo:** [https://github.com/chemerisuk/cordova-plugin-firebase-crash](https://github.com/chemerisuk/cordova-plugin-firebase-crash) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/firebase-crashlytics/README.md b/docs/plugins/firebase-crashlytics/README.md index b68d69cf5..8e41afa7c 100644 --- a/docs/plugins/firebase-crashlytics/README.md +++ b/docs/plugins/firebase-crashlytics/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Firebase Crashlytics plugin for Cordova and Ionic. A Google Firebase Crashlytics plugin to enable capture of crash reports. +--- + # Firebase Crashlytics -``` -$ ionic cordova plugin add cordova-plugin-firebase-crashlytics --variable ANDROID_FIREBASE_CORE_VERSION=16.0.0 -$ npm install @awesome-cordova-plugins/firebase-crashlytics -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-firebase-crashlytics --variable ANDROID_FIREBASE_CORE_VERSION=16.0.0 +npm install @awesome-cordova-plugins/firebase-crashlytics +``` + +**Plugin Repo:** [https://github.com/ReallySmallSoftware/cordova-plugin-firebase-crashlytics](https://github.com/ReallySmallSoftware/cordova-plugin-firebase-crashlytics) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/firebase-dynamic-links/README.md b/docs/plugins/firebase-dynamic-links/README.md index b3e1f9802..9a89ddcff 100644 --- a/docs/plugins/firebase-dynamic-links/README.md +++ b/docs/plugins/firebase-dynamic-links/README.md @@ -1,14 +1,10 @@ +--- +description: >- + Firebase Dynamic Links plugin for Cordova and Ionic. Cordova plugin for Firebase Dynamic Links Variables APP_DOMAIN and APP_PATH specify web URL where your… +--- + # Firebase Dynamic Links -``` -$ ionic cordova plugin add cordova-plugin-firebase-dynamiclinks --save --variable APP_DOMAIN="example.com" --variable APP_PATH="/" -$ npm install @awesome-cordova-plugins/firebase-dynamic-links -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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. @@ -29,8 +25,21 @@ config.xml: ``` -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-firebase-dynamiclinks --save --variable APP_DOMAIN="example.com" --variable APP_PATH="/" +npm install @awesome-cordova-plugins/firebase-dynamic-links +``` + +**Plugin Repo:** [https://github.com/chemerisuk/cordova-plugin-firebase-dynamiclinks](https://github.com/chemerisuk/cordova-plugin-firebase-dynamiclinks) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/firebase-messaging/README.md b/docs/plugins/firebase-messaging/README.md index 13b466721..e35d58fd2 100644 --- a/docs/plugins/firebase-messaging/README.md +++ b/docs/plugins/firebase-messaging/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Firebase Messaging plugin for Cordova and Ionic. Cordova plugin for Firebase Messaging +--- + # Firebase Messaging -``` -$ ionic cordova plugin add cordova-plugin-firebase-messaging -$ npm install @awesome-cordova-plugins/firebase-messaging -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-firebase-messaging +npm install @awesome-cordova-plugins/firebase-messaging +``` + +**Plugin Repo:** [https://github.com/chemerisuk/cordova-plugin-firebase-messaging](https://github.com/chemerisuk/cordova-plugin-firebase-messaging) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/firebase-model/README.md b/docs/plugins/firebase-model/README.md index 182529d8b..c0495b704 100644 --- a/docs/plugins/firebase-model/README.md +++ b/docs/plugins/firebase-model/README.md @@ -1,12 +1,10 @@ +--- +description: >- + Firebase Model plugin for Cordova and Ionic. This plugin downloads the TensorFlow model from firebase and classify the images. ```typescript import {… +--- + # Firebase Model -``` -$ ionic cordova plugin add cordova-plugin-firebase-model -$ npm install @awesome-cordova-plugins/firebase-model -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/firebase-model/) - This plugin downloads the TensorFlow model from firebase and classify the images. ```typescript @@ -35,7 +33,18 @@ catch (e) { ``` -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-firebase-model +npm install @awesome-cordova-plugins/firebase-model +``` + +## Supported Platforms - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/firebase-vision/README.md b/docs/plugins/firebase-vision/README.md index 763e61755..df1230cfb 100644 --- a/docs/plugins/firebase-vision/README.md +++ b/docs/plugins/firebase-vision/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Firebase Vision plugin for Cordova and Ionic. Cordova plugin for Firebase MLKit Vision +--- + # Firebase Vision -``` -$ ionic cordova plugin add cordova-plugin-firebase-mlvision -$ npm install @awesome-cordova-plugins/firebase-vision -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-firebase-mlvision +npm install @awesome-cordova-plugins/firebase-vision +``` + +**Plugin Repo:** [https://github.com/alon22/cordova-plugin-firebase-mlvision](https://github.com/alon22/cordova-plugin-firebase-mlvision) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/firebase-x/README.md b/docs/plugins/firebase-x/README.md index fa0c50153..5a8baccfe 100644 --- a/docs/plugins/firebase-x/README.md +++ b/docs/plugins/firebase-x/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Firebase X plugin for Cordova and Ionic. This plugin brings push notifications, analytics, event tracking, crash reporting and more from Google Firebase to… +--- + # Firebase X -``` -$ ionic cordova plugin add cordova-plugin-firebasex -$ npm install @awesome-cordova-plugins/firebase-x -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-firebasex +npm install @awesome-cordova-plugins/firebase-x +``` + +**Plugin Repo:** [https://github.com/dpa99c/cordova-plugin-firebasex](https://github.com/dpa99c/cordova-plugin-firebasex) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/firebase/README.md b/docs/plugins/firebase/README.md index ca130b873..575c24083 100644 --- a/docs/plugins/firebase/README.md +++ b/docs/plugins/firebase/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Firebase plugin for Cordova and Ionic. This plugin brings push notifications, analytics, event tracking, crash reporting and more from Google Firebase to your… +--- + # Firebase -``` -$ ionic cordova plugin add cordova-plugin-firebase -$ npm install @awesome-cordova-plugins/firebase -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-firebase +npm install @awesome-cordova-plugins/firebase +``` + +**Plugin Repo:** [https://github.com/arnesson/cordova-plugin-firebase](https://github.com/arnesson/cordova-plugin-firebase) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/flashlight/README.md b/docs/plugins/flashlight/README.md index b05a90a32..ba4771330 100644 --- a/docs/plugins/flashlight/README.md +++ b/docs/plugins/flashlight/README.md @@ -1,21 +1,30 @@ +--- +description: >- + Flashlight plugin for Cordova and Ionic. This plugin allows you to switch the flashlight / torch of the device on and off. Requires Cordova plugin:… +--- + # Flashlight -``` -$ ionic cordova plugin add cordova-plugin-flashlight -$ npm install @awesome-cordova-plugins/flashlight -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-flashlight +npm install @awesome-cordova-plugins/flashlight +``` + +**Plugin Repo:** [https://github.com/EddyVerbruggen/Flashlight-PhoneGap-Plugin](https://github.com/EddyVerbruggen/Flashlight-PhoneGap-Plugin) + +## Supported Platforms - Android - iOS - Windows Phone 8 +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/foreground-service/README.md b/docs/plugins/foreground-service/README.md index 7bf15d204..e4075f970 100644 --- a/docs/plugins/foreground-service/README.md +++ b/docs/plugins/foreground-service/README.md @@ -1,14 +1,10 @@ +--- +description: >- + Foreground Service plugin for Cordova and Ionic. This plugin allows for android devices to continue running services in the background, using a foreground… +--- + # Foreground Service -``` -$ ionic cordova plugin add cordova-plugin-foreground-service -$ npm install @awesome-cordova-plugins/foreground-service -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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+. @@ -24,7 +20,20 @@ For android API 28+, the following xml snippet should be inserted into ```config ... ``` -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-foreground-service +npm install @awesome-cordova-plugins/foreground-service +``` + +**Plugin Repo:** [https://github.com/DavidBriglio/cordova-plugin-foreground-service](https://github.com/DavidBriglio/cordova-plugin-foreground-service) + +## Supported Platforms - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/ftp/README.md b/docs/plugins/ftp/README.md index c53359fa6..78203d7cd 100644 --- a/docs/plugins/ftp/README.md +++ b/docs/plugins/ftp/README.md @@ -1,18 +1,27 @@ +--- +description: >- + FTP plugin for Cordova and Ionic. This cordova plugin is created to use ftp (client) in web/js. +--- + # FTP -``` -$ ionic cordova plugin add cordova-plugin-ftp -$ npm install @awesome-cordova-plugins/ftp -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-ftp +npm install @awesome-cordova-plugins/ftp +``` + +**Plugin Repo:** [https://github.com/xfally/cordova-plugin-ftp](https://github.com/xfally/cordova-plugin-ftp) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/gao-de-location/README.md b/docs/plugins/gao-de-location/README.md index 3360bfad4..348b587e1 100644 --- a/docs/plugins/gao-de-location/README.md +++ b/docs/plugins/gao-de-location/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Gao De Location plugin for Cordova and Ionic. Because the original GPS positioning uses Google Browser positioning, and Google withdraws from China, resulting… +--- + # 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 @awesome-cordova-plugins/gao-de-location -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-gaodelocation-chenyu --variable ANDROID_API_KEY=your android key --variable IOS_API_KEY=your ios key +npm install @awesome-cordova-plugins/gao-de-location +``` + +**Plugin Repo:** [https://github.com/waliu/cordova-plugin-gaodelocation-chenyu.git](https://github.com/waliu/cordova-plugin-gaodelocation-chenyu.git) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/gcdwebserver/README.md b/docs/plugins/gcdwebserver/README.md index 3c1de1538..50b40a85e 100755 --- a/docs/plugins/gcdwebserver/README.md +++ b/docs/plugins/gcdwebserver/README.md @@ -1,17 +1,26 @@ +--- +description: >- + gcdwebserver plugin for Cordova and Ionic. This plugin can start an HTTP server using GCDWebServer +--- + # gcdwebserver -``` -$ -$ npm install @awesome-cordova-plugins/gcdwebserver -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/gcdwebserver/) - -Plugin Repo: [https://github.com/xulihang/cordova-plugin-gcdwebserver](https://github.com/xulihang/cordova-plugin-gcdwebserver) - This plugin can start an HTTP server using GCDWebServer -## Supported platforms +## Installation + +```bash + +npm install @awesome-cordova-plugins/gcdwebserver +``` + +**Plugin Repo:** [https://github.com/xulihang/cordova-plugin-gcdwebserver](https://github.com/xulihang/cordova-plugin-gcdwebserver) + +## Supported Platforms - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/ge-tui-sdk-plugin/README.md b/docs/plugins/ge-tui-sdk-plugin/README.md index 5d773bb57..a10b8e893 100644 --- a/docs/plugins/ge-tui-sdk-plugin/README.md +++ b/docs/plugins/ge-tui-sdk-plugin/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Ge Tui Sdk Plugin plugin for Cordova and Ionic. This plugin does something +--- + # 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 @awesome-cordova-plugins/ge-tui-sdk-plugin -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +cordova plugin add cordova-plugin-getuisdk --variable PUSH_APPID=your appid --variable PUSH_APPKEY=your appkey --variable PUSH_APPSECRET=your appsecret +npm install @awesome-cordova-plugins/ge-tui-sdk-plugin +``` + +**Plugin Repo:** [git@github.com:GetuiLaboratory/cordova-plugin-getuisdk.git](git@github.com:GetuiLaboratory/cordova-plugin-getuisdk.git) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/genius-scan/README.md b/docs/plugins/genius-scan/README.md index b4ddabcae..4caa043e1 100644 --- a/docs/plugins/genius-scan/README.md +++ b/docs/plugins/genius-scan/README.md @@ -1,16 +1,25 @@ +--- +description: >- + Genius Scan plugin for Cordova and Ionic. Plugin allows you to access the Genius Scan SDK core features from a Ionic application +--- + # Genius Scan -``` -$ ionic cordova plugin add @thegrizzlylabs/cordova-plugin-genius-scan -$ npm install @awesome-cordova-plugins/genius-scan -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/genius-scan/) - Plugin allows you to access the Genius Scan SDK core features from a Ionic application -## Supported platforms +## Installation + +```bash +ionic cordova plugin add @thegrizzlylabs/cordova-plugin-genius-scan +npm install @awesome-cordova-plugins/genius-scan +``` + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/geolocation/README.md b/docs/plugins/geolocation/README.md index 965f64710..a8420d53d 100644 --- a/docs/plugins/geolocation/README.md +++ b/docs/plugins/geolocation/README.md @@ -1,14 +1,10 @@ +--- +description: >- + Geolocation plugin for Cordova and Ionic. This plugin provides information about the device's location, such as latitude and longitude. Common sources of… +--- + # Geolocation -``` -$ ionic cordova plugin add cordova-plugin-geolocation --variable GEOLOCATION_USAGE_DESCRIPTION="To locate you" -$ npm install @awesome-cordova-plugins/geolocation -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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. @@ -20,7 +16,16 @@ For iOS you have to add this configuration to your configuration.xml file ``` -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-geolocation --variable GEOLOCATION_USAGE_DESCRIPTION="To locate you" +npm install @awesome-cordova-plugins/geolocation +``` + +**Plugin Repo:** [https://github.com/apache/cordova-plugin-geolocation](https://github.com/apache/cordova-plugin-geolocation) + +## Supported Platforms - Amazon Fire OS - Android @@ -28,3 +33,7 @@ For iOS you have to add this configuration to your configuration.xml file - iOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/globalization/README.md b/docs/plugins/globalization/README.md index 6f0db4985..b1ea09e5a 100644 --- a/docs/plugins/globalization/README.md +++ b/docs/plugins/globalization/README.md @@ -1,17 +1,22 @@ +--- +description: >- + Globalization plugin for Cordova and Ionic. This plugin obtains information and performs operations specific to the user's locale, language, and timezone. +--- + # Globalization -``` -$ ionic cordova plugin add cordova-plugin-globalization -$ npm install @awesome-cordova-plugins/globalization -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-globalization +npm install @awesome-cordova-plugins/globalization +``` + +**Plugin Repo:** [https://github.com/apache/cordova-plugin-globalization](https://github.com/apache/cordova-plugin-globalization) + +## Supported Platforms - Amazon Fire OS - Android @@ -19,3 +24,7 @@ This plugin obtains information and performs operations specific to the user's l - iOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/google-analytics/README.md b/docs/plugins/google-analytics/README.md index 191b3ad13..31520dc27 100644 --- a/docs/plugins/google-analytics/README.md +++ b/docs/plugins/google-analytics/README.md @@ -1,24 +1,33 @@ +--- +description: >- + Google Analytics plugin for Cordova and Ionic. This plugin connects to Google's native Universal Analytics SDK Prerequisites: - A Cordova 3.0+ project for iOS… +--- + # Google Analytics -``` -$ ionic cordova plugin add cordova-plugin-google-analytics -$ npm install @awesome-cordova-plugins/google-analytics -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-google-analytics +npm install @awesome-cordova-plugins/google-analytics +``` + +**Plugin Repo:** [https://github.com/danwilson/google-analytics-plugin](https://github.com/danwilson/google-analytics-plugin) + +## Supported Platforms - Android - Browser - iOS - Windows Phone 8 +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/google-nearby/README.md b/docs/plugins/google-nearby/README.md index 2d21e68e0..3bbb27f6f 100644 --- a/docs/plugins/google-nearby/README.md +++ b/docs/plugins/google-nearby/README.md @@ -1,17 +1,26 @@ +--- +description: >- + Google Nearby plugin for Cordova and Ionic. This plugin adds support for the Google Nearby Messages API. +--- + # Google Nearby -``` -$ ionic cordova plugin add cordova-plugin-google-nearby --variable API_KEY="123456789" -$ npm install @awesome-cordova-plugins/google-nearby -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-google-nearby --variable API_KEY="123456789" +npm install @awesome-cordova-plugins/google-nearby +``` + +**Plugin Repo:** [https://github.com/hahahannes/cordova-plugin-google-nearby](https://github.com/hahahannes/cordova-plugin-google-nearby) + +## Supported Platforms - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/google-plus/README.md b/docs/plugins/google-plus/README.md index 611d01fc4..bf579203c 100644 --- a/docs/plugins/google-plus/README.md +++ b/docs/plugins/google-plus/README.md @@ -1,16 +1,25 @@ +--- +description: >- + Google Plus — Awesome Cordova Plugins wrapper for Ionic and Cordova apps. +--- + # Google Plus -``` -$ ionic cordova plugin add cordova-plugin-googleplus --variable REVERSED_CLIENT_ID=myreversedclientid -$ npm install @awesome-cordova-plugins/google-plus +## Installation + +```bash +ionic cordova plugin add cordova-plugin-googleplus --variable REVERSED_CLIENT_ID=myreversedclientid +npm install @awesome-cordova-plugins/google-plus ``` -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/google-plus/) +**Plugin Repo:** [https://github.com/EddyVerbruggen/cordova-plugin-googleplus](https://github.com/EddyVerbruggen/cordova-plugin-googleplus) -Plugin Repo: [https://github.com/EddyVerbruggen/cordova-plugin-googleplus](https://github.com/EddyVerbruggen/cordova-plugin-googleplus) - -## Supported platforms +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/header-color/README.md b/docs/plugins/header-color/README.md index 4be58fdf3..86adab024 100644 --- a/docs/plugins/header-color/README.md +++ b/docs/plugins/header-color/README.md @@ -1,17 +1,26 @@ +--- +description: >- + Header Color plugin for Cordova and Ionic. Cordova plugin to change color of header in Android Multitask View +--- + # Header Color -``` -$ ionic cordova plugin add cordova-plugin-headercolor -$ npm install @awesome-cordova-plugins/header-color -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-headercolor +npm install @awesome-cordova-plugins/header-color +``` + +**Plugin Repo:** [https://github.com/tomloprod/cordova-plugin-headercolor](https://github.com/tomloprod/cordova-plugin-headercolor) + +## Supported Platforms - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/health-kit/README.md b/docs/plugins/health-kit/README.md index 95562faf9..254d180ba 100644 --- a/docs/plugins/health-kit/README.md +++ b/docs/plugins/health-kit/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Health Kit plugin for Cordova and Ionic. The HealthKit plugin allows you to read data from and write data to the iOS 8+ HealthKit framework. Any data saved… +--- + # Health Kit -``` -$ ionic cordova plugin add com.telerik.plugins.healthkit -$ npm install @awesome-cordova-plugins/health-kit -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add com.telerik.plugins.healthkit +npm install @awesome-cordova-plugins/health-kit +``` + +**Plugin Repo:** [https://github.com/Telerik-Verified-Plugins/HealthKit](https://github.com/Telerik-Verified-Plugins/HealthKit) + +## Supported Platforms - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/health/README.md b/docs/plugins/health/README.md index 97b5b0a72..7347cab9e 100644 --- a/docs/plugins/health/README.md +++ b/docs/plugins/health/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Health plugin for Cordova and Ionic. A plugin that abstracts fitness and health repositories like Apple HealthKit or Google Fit. +--- + # Health -``` -$ ionic cordova plugin add cordova-plugin-health -$ npm install @awesome-cordova-plugins/health -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-health +npm install @awesome-cordova-plugins/health +``` + +**Plugin Repo:** [https://github.com/dariosalvi78/cordova-plugin-health](https://github.com/dariosalvi78/cordova-plugin-health) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/http/README.md b/docs/plugins/http/README.md index b78eed033..81d8af9f2 100644 --- a/docs/plugins/http/README.md +++ b/docs/plugins/http/README.md @@ -1,14 +1,10 @@ +--- +description: >- + HTTP plugin for Cordova and Ionic. Cordova / Phonegap plugin for communicating with HTTP servers. Supports iOS and Android. Advantages over Javascript… +--- + # HTTP -``` -$ ionic cordova plugin add cordova-plugin-advanced-http -$ npm install @awesome-cordova-plugins/http -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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: @@ -16,8 +12,21 @@ Advantages over Javascript requests: - 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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-advanced-http +npm install @awesome-cordova-plugins/http +``` + +**Plugin Repo:** [https://github.com/silkimen/cordova-plugin-advanced-http](https://github.com/silkimen/cordova-plugin-advanced-http) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/hyper-track/README.md b/docs/plugins/hyper-track/README.md index 4fe273c1f..b77fa346e 100644 --- a/docs/plugins/hyper-track/README.md +++ b/docs/plugins/hyper-track/README.md @@ -1,15 +1,24 @@ +--- +description: >- + cordova-plugin-hypertrack-v3 — Awesome Cordova Plugins wrapper for Ionic and Cordova apps. +--- + # cordova-plugin-hypertrack-v3 -``` -$ ionic cordova plugin add cordova-plugin-hypertrack-v3 -$ npm install @awesome-cordova-plugins/hyper-track +## Installation + +```bash +ionic cordova plugin add cordova-plugin-hypertrack-v3 +npm install @awesome-cordova-plugins/hyper-track ``` -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/hyper-track/) +**Plugin Repo:** [https://github.com/hypertrack/cordova-plugin-hypertrack.git](https://github.com/hypertrack/cordova-plugin-hypertrack.git) -Plugin Repo: [https://github.com/hypertrack/cordova-plugin-hypertrack.git](https://github.com/hypertrack/cordova-plugin-hypertrack.git) - -## Supported platforms +## Supported Platforms - Android, iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/i-root/README.md b/docs/plugins/i-root/README.md index b6a7cf0fb..986b1f3b6 100644 --- a/docs/plugins/i-root/README.md +++ b/docs/plugins/i-root/README.md @@ -1,18 +1,27 @@ +--- +description: >- + IRoot plugin for Cordova and Ionic. Use this plugin to add an extra layer of security for your app by detecting if the device was rooted (on android) or… +--- + # IRoot -``` -$ ionic cordova plugin add cordova-plugin-IRoot -$ npm install @awesome-cordova-plugins/i-root -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/i-root/) - -Plugin Repo: [https://github.com/WuglyakBolgoink/cordova-plugin-IRoot](https://github.com/WuglyakBolgoink/cordova-plugin-IRoot) - Use this plugin to add an extra layer of security for your app by detecting if the device was rooted (on android) or jailbreaked (on iOS). -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-IRoot +npm install @awesome-cordova-plugins/i-root +``` + +**Plugin Repo:** [https://github.com/WuglyakBolgoink/cordova-plugin-IRoot](https://github.com/WuglyakBolgoink/cordova-plugin-IRoot) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/iamport-cordova/README.md b/docs/plugins/iamport-cordova/README.md index 4d1976bed..9b839350c 100644 --- a/docs/plugins/iamport-cordova/README.md +++ b/docs/plugins/iamport-cordova/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Iamport Cordova plugin for Cordova and Ionic. This plugin does something +--- + # Iamport Cordova -``` -$ ionic cordova plugin add iamport-cordova -$ npm install @awesome-cordova-plugins/iamport-cordova -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/iamport-cordova/) - -Plugin Repo: [https://github.com/iamport/iamport-cordova](https://github.com/iamport/iamport-cordova) - This plugin does something -## Supported platforms +## Installation + +```bash +ionic cordova plugin add iamport-cordova +npm install @awesome-cordova-plugins/iamport-cordova +``` + +**Plugin Repo:** [https://github.com/iamport/iamport-cordova](https://github.com/iamport/iamport-cordova) + +## Supported Platforms - ios - android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/ibeacon/README.md b/docs/plugins/ibeacon/README.md index ad25a3d81..7a8d8035b 100644 --- a/docs/plugins/ibeacon/README.md +++ b/docs/plugins/ibeacon/README.md @@ -1,20 +1,29 @@ +--- +description: >- + IBeacon plugin for Cordova and Ionic. This plugin provides functions for working with iBeacons. The plugin's API closely mimics the one exposed through the… +--- + # IBeacon -``` -$ ionic cordova plugin add cordova-plugin-ibeacon -$ npm install @awesome-cordova-plugins/ibeacon -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-ibeacon +npm install @awesome-cordova-plugins/ibeacon +``` + +**Plugin Repo:** [https://github.com/petermetz/cordova-plugin-ibeacon](https://github.com/petermetz/cordova-plugin-ibeacon) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/image-picker/README.md b/docs/plugins/image-picker/README.md index cfd15f186..0ea3eeb28 100644 --- a/docs/plugins/image-picker/README.md +++ b/docs/plugins/image-picker/README.md @@ -1,21 +1,30 @@ +--- +description: >- + Image Picker plugin for Cordova and Ionic. Cordova Plugin For Multiple Image Selection Requires Cordova plugin: `cordova-plugin-image-picker`. For more info,… +--- + # Image Picker -``` -$ ionic cordova plugin add cordova-plugin-telerik-imagepicker --variable PHOTO_LIBRARY_USAGE_DESCRIPTION="your usage message" -$ npm install @awesome-cordova-plugins/image-picker -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-telerik-imagepicker --variable PHOTO_LIBRARY_USAGE_DESCRIPTION="your usage message" +npm install @awesome-cordova-plugins/image-picker +``` + +**Plugin Repo:** [https://github.com/Telerik-Verified-Plugins/ImagePicker](https://github.com/Telerik-Verified-Plugins/ImagePicker) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/image-resizer/README.md b/docs/plugins/image-resizer/README.md index 8eb399248..9ca19fb2e 100644 --- a/docs/plugins/image-resizer/README.md +++ b/docs/plugins/image-resizer/README.md @@ -1,18 +1,27 @@ +--- +description: >- + ImageResizer plugin for Cordova and Ionic. Cordova Plugin For Image Resize +--- + # ImageResizer -``` -$ ionic cordova plugin add cordova-plugin-image-resizer -$ npm install @awesome-cordova-plugins/image-resizer -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/image-resizer/) - -Plugin Repo: [https://github.com/JoschkaSchulz/cordova-plugin-image-resizer](https://github.com/JoschkaSchulz/cordova-plugin-image-resizer) - Cordova Plugin For Image Resize -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-image-resizer +npm install @awesome-cordova-plugins/image-resizer +``` + +**Plugin Repo:** [https://github.com/JoschkaSchulz/cordova-plugin-image-resizer](https://github.com/JoschkaSchulz/cordova-plugin-image-resizer) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/imap/README.md b/docs/plugins/imap/README.md index 3bab511a8..a4730c9b5 100644 --- a/docs/plugins/imap/README.md +++ b/docs/plugins/imap/README.md @@ -1,20 +1,29 @@ +--- +description: >- + Imap plugin for Cordova and Ionic. This plugin will enable a Cordova application to use the IMAP (Internet Message Access Protocol) features The plugin offers… +--- + # Imap -``` -$ ionic cordova plugin add cordova-plugin-imap -$ npm install @awesome-cordova-plugins/imap -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/imap/) - -Plugin Repo: [https://github.com/aleksandar888/cordova-plugin-imap.git](https://github.com/aleksandar888/cordova-plugin-imap.git) - This plugin will enable a Cordova application to use the IMAP (Internet Message Access Protocol) features The plugin offers support for Android and iOS. To enable the IMAP features on Android, this plugin uses the framework [Java Mail API](https://javaee.github.io/javamail/) and for iOS, it uses the [MailCore 2](http://libmailcore.com/) library. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-imap +npm install @awesome-cordova-plugins/imap +``` + +**Plugin Repo:** [https://github.com/aleksandar888/cordova-plugin-imap.git](https://github.com/aleksandar888/cordova-plugin-imap.git) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/in-app-browser/README.md b/docs/plugins/in-app-browser/README.md index f9bc43f34..777d82a6c 100644 --- a/docs/plugins/in-app-browser/README.md +++ b/docs/plugins/in-app-browser/README.md @@ -1,17 +1,22 @@ +--- +description: >- + In App Browser plugin for Cordova and Ionic. Launches in app Browser +--- + # In App Browser -``` -$ ionic cordova plugin add cordova-plugin-inappbrowser -$ npm install @awesome-cordova-plugins/in-app-browser -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-inappbrowser +npm install @awesome-cordova-plugins/in-app-browser +``` + +**Plugin Repo:** [https://github.com/apache/cordova-plugin-inappbrowser](https://github.com/apache/cordova-plugin-inappbrowser) + +## Supported Platforms - AmazonFire OS - Android @@ -20,3 +25,7 @@ Launches in app Browser - macOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/in-app-purchase-2/README.md b/docs/plugins/in-app-purchase-2/README.md index af69b12f7..b424a9a58 100644 --- a/docs/plugins/in-app-purchase-2/README.md +++ b/docs/plugins/in-app-purchase-2/README.md @@ -1,14 +1,10 @@ +--- +description: >- + In App Purchase 2 plugin for Cordova and Ionic. In-App Purchase on iOS, Android, Windows, macOS and XBox. ## Features | | ios | android | win-8 |… +--- + # In App Purchase 2 -``` -$ ionic cordova plugin add cordova-plugin-purchase --variable BILLING_KEY="" -$ npm install @awesome-cordova-plugins/in-app-purchase-2 -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 @@ -35,9 +31,22 @@ Supports: - (and any platform supporting Microsoft's UWP) - **cordova-plugin-purchase** version 12 or lower. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-purchase --variable BILLING_KEY="" +npm install @awesome-cordova-plugins/in-app-purchase-2 +``` + +**Plugin Repo:** [https://github.com/j3k0/cordova-plugin-purchase](https://github.com/j3k0/cordova-plugin-purchase) + +## Supported Platforms - iOS - Android - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/in-app-purchase-3/README.md b/docs/plugins/in-app-purchase-3/README.md index ea68500e7..a8020c381 100644 --- a/docs/plugins/in-app-purchase-3/README.md +++ b/docs/plugins/in-app-purchase-3/README.md @@ -1,14 +1,10 @@ +--- +description: >- + "In App Purchase 3" plugin for Cordova and Ionic. In-App Purchase on iOS, Android, Windows, macOS and XBox. This plugin replace the previous InAppPurchase2,… +--- + # "In App Purchase 3" -``` -$ ionic cordova plugin add cordova-plugin-purchase --variable BILLING_KEY="" -$ npm install @awesome-cordova-plugins/in-app-purchase-3 -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/in-app-purchase-3/) - -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. This plugin replace the previous InAppPurchase2, due to backward compatibility issue with the wrapped @@ -37,9 +33,22 @@ Supports: - (and any platform supporting Microsoft's UWP) - **cordova-plugin-purchase** version 13.0 or higher -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-purchase --variable BILLING_KEY="" +npm install @awesome-cordova-plugins/in-app-purchase-3 +``` + +**Plugin Repo:** [https://github.com/j3k0/cordova-plugin-purchase](https://github.com/j3k0/cordova-plugin-purchase) + +## Supported Platforms - iOS - Android - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/in-app-review/README.md b/docs/plugins/in-app-review/README.md index 730511f99..a877082f3 100644 --- a/docs/plugins/in-app-review/README.md +++ b/docs/plugins/in-app-review/README.md @@ -1,19 +1,28 @@ +--- +description: >- + In App Review plugin for Cordova and Ionic. This plugin does use the iOS class SKStore​Review​Controller to open the inApp review popup available since iOS… +--- + # In App Review -``` -$ ionic cordova plugin add com.omarben.inappreview -$ npm install @awesome-cordova-plugins/in-app-review -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add com.omarben.inappreview +npm install @awesome-cordova-plugins/in-app-review +``` + +**Plugin Repo:** [https://github.com/omaxlive/com.omarben.inappreview](https://github.com/omaxlive/com.omarben.inappreview) + +## Supported Platforms - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/in-app-update/README.md b/docs/plugins/in-app-update/README.md index 0a38f2305..d0c23acce 100644 --- a/docs/plugins/in-app-update/README.md +++ b/docs/plugins/in-app-update/README.md @@ -1,17 +1,26 @@ +--- +description: >- + In App Update plugin for Cordova and Ionic. This pluging enabels In app update For cordova. +--- + # In App Update -``` -$ ionic cordova plugin add cordova-in-app-update -$ npm install @awesome-cordova-plugins/in-app-update -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-in-app-update +npm install @awesome-cordova-plugins/in-app-update +``` + +**Plugin Repo:** [https://github.com/itsLucario/cordova-app-update-plugin](https://github.com/itsLucario/cordova-app-update-plugin) + +## Supported Platforms - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/insomnia/README.md b/docs/plugins/insomnia/README.md index 4f5174097..bf911d59a 100644 --- a/docs/plugins/insomnia/README.md +++ b/docs/plugins/insomnia/README.md @@ -1,17 +1,22 @@ +--- +description: >- + Insomnia plugin for Cordova and Ionic. Prevent the screen of the mobile device from falling asleep. +--- + # Insomnia -``` -$ ionic cordova plugin add cordova-plugin-insomnia -$ npm install @awesome-cordova-plugins/insomnia -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-insomnia +npm install @awesome-cordova-plugins/insomnia +``` + +**Plugin Repo:** [https://github.com/EddyVerbruggen/Insomnia-PhoneGap-Plugin](https://github.com/EddyVerbruggen/Insomnia-PhoneGap-Plugin) + +## Supported Platforms - Android - Browser @@ -20,3 +25,7 @@ Prevent the screen of the mobile device from falling asleep. - Windows - Windows Phone 8 +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/instagram/README.md b/docs/plugins/instagram/README.md index 4ecf2abe8..4a0ecae39 100644 --- a/docs/plugins/instagram/README.md +++ b/docs/plugins/instagram/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Instagram plugin for Cordova and Ionic. Share a photo with the instagram app +--- + # Instagram -``` -$ ionic cordova plugin add cordova-instagram-plugin -$ npm install @awesome-cordova-plugins/instagram -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/instagram/) - -Plugin Repo: [https://github.com/vstirbu/InstagramPlugin](https://github.com/vstirbu/InstagramPlugin) - Share a photo with the instagram app -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-instagram-plugin +npm install @awesome-cordova-plugins/instagram +``` + +**Plugin Repo:** [https://github.com/vstirbu/InstagramPlugin](https://github.com/vstirbu/InstagramPlugin) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/intercom/README.md b/docs/plugins/intercom/README.md index 6acb1b065..05881d161 100644 --- a/docs/plugins/intercom/README.md +++ b/docs/plugins/intercom/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Intercom plugin for Cordova and Ionic. This is a plugin that allows your Ionic app to use Intercom for iOS and/or Intercom for Android. Follow the offical… +--- + # Intercom -``` -$ ionic cordova plugin add cordova-plugin-intercom -$ npm install @awesome-cordova-plugins/intercom -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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/installing-intercom/cordova-phonegap/installation -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-intercom +npm install @awesome-cordova-plugins/intercom +``` + +**Plugin Repo:** [https://github.com/intercom/intercom-cordova](https://github.com/intercom/intercom-cordova) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/ionic-webview/README.md b/docs/plugins/ionic-webview/README.md index 0004c7221..0304c4d3c 100644 --- a/docs/plugins/ionic-webview/README.md +++ b/docs/plugins/ionic-webview/README.md @@ -1,20 +1,29 @@ +--- +description: >- + Ionic Webview plugin for Cordova and Ionic. Access Web View utilities. Requires the Cordova plugin: `cordova-plugin-ionic-webview` > 2.0. For more info,… +--- + # Ionic Webview -``` -$ ionic cordova plugin add cordova-plugin-ionic-webview -$ npm install @awesome-cordova-plugins/ionic-webview -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-ionic-webview +npm install @awesome-cordova-plugins/ionic-webview +``` + +**Plugin Repo:** [https://github.com/ionic-team/cordova-plugin-ionic-webview](https://github.com/ionic-team/cordova-plugin-ionic-webview) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/ios-aswebauthenticationsession-api/README.md b/docs/plugins/ios-aswebauthenticationsession-api/README.md index 59f230cec..d6fd8b6a1 100644 --- a/docs/plugins/ios-aswebauthenticationsession-api/README.md +++ b/docs/plugins/ios-aswebauthenticationsession-api/README.md @@ -1,17 +1,26 @@ +--- +description: >- + ios-aswebauthenticationsession-api plugin for Cordova and Ionic. Plugin for iOS 12 ASWebAuthenticationSession API +--- + # ios-aswebauthenticationsession-api -``` -$ ionic cordova plugin add cordova-plugin-ios-aswebauthenticationsession-api -$ npm install @awesome-cordova-plugins/ios-aswebauthenticationsession-api -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-ios-aswebauthenticationsession-api +npm install @awesome-cordova-plugins/ios-aswebauthenticationsession-api +``` + +**Plugin Repo:** [https://github.com/jwelker110/cordova-plugin-ios-aswebauthenticationsession-api](https://github.com/jwelker110/cordova-plugin-ios-aswebauthenticationsession-api) + +## Supported Platforms - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/is-debug/README.md b/docs/plugins/is-debug/README.md index af2922955..6bd4f472e 100644 --- a/docs/plugins/is-debug/README.md +++ b/docs/plugins/is-debug/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Is Debug plugin for Cordova and Ionic. Detect if the app is running in debug mode or not. Debug mode is when the app is built and installed locally via xcode… +--- + # Is Debug -``` -$ ionic cordova plugin add cordova-plugin-is-debug -$ npm install @awesome-cordova-plugins/is-debug -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-is-debug +npm install @awesome-cordova-plugins/is-debug +``` + +**Plugin Repo:** [https://github.com/mattlewis92/cordova-plugin-is-debug](https://github.com/mattlewis92/cordova-plugin-is-debug) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/keyboard/README.md b/docs/plugins/keyboard/README.md index dd5fee778..51b99576f 100644 --- a/docs/plugins/keyboard/README.md +++ b/docs/plugins/keyboard/README.md @@ -1,20 +1,29 @@ +--- +description: >- + Keyboard plugin for Cordova and Ionic. Keyboard plugin for Cordova. Requires Cordova plugin: `cordova-plugin-ionic-keyboard`. For more info, please see the… +--- + # Keyboard -``` -$ ionic cordova plugin add cordova-plugin-ionic-keyboard -$ npm install @awesome-cordova-plugins/keyboard -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-ionic-keyboard +npm install @awesome-cordova-plugins/keyboard +``` + +**Plugin Repo:** [https://github.com/ionic-team/cordova-plugin-ionic-keyboard](https://github.com/ionic-team/cordova-plugin-ionic-keyboard) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/keychain/README.md b/docs/plugins/keychain/README.md index 619963407..91c19d160 100644 --- a/docs/plugins/keychain/README.md +++ b/docs/plugins/keychain/README.md @@ -1,21 +1,30 @@ +--- +description: >- + Keychain plugin for Cordova and Ionic. Get and set data in the iOS Keychain Requires Cordova plugin: `cordova-plugin-ios-keychain`. For more info, please see… +--- + # Keychain -``` -$ ionic cordova plugin add cordova-plugin-ios-keychain -$ npm install @awesome-cordova-plugins/keychain -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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://ionic.io/docs/secure-storage) for more supported platforms. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-ios-keychain +npm install @awesome-cordova-plugins/keychain +``` + +**Plugin Repo:** [https://github.com/ionic-team/cordova-plugin-ios-keychain](https://github.com/ionic-team/cordova-plugin-ios-keychain) + +## Supported Platforms - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/kommunicate/README.md b/docs/plugins/kommunicate/README.md index de66d2815..314cf20c9 100644 --- a/docs/plugins/kommunicate/README.md +++ b/docs/plugins/kommunicate/README.md @@ -1,22 +1,31 @@ +--- +description: >- + Kommunicate plugin for Cordova and Ionic. The plugin for the Kommunicate SDK. With the help of this plugin, you can easily add human + bot chat support… +--- + # Kommunicate -``` -$ ionic cordova plugin add kommunicate-cordova-plugin -$ npm install @awesome-cordova-plugins/kommunicate -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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: https://www.kommunicate.io/ For documentation: https://docs.kommunicate.io/ -## Supported platforms +## Installation + +```bash +ionic cordova plugin add kommunicate-cordova-plugin +npm install @awesome-cordova-plugins/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) + +## Supported Platforms - Android - Browser - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/launch-navigator/README.md b/docs/plugins/launch-navigator/README.md index 655a7698e..87f009976 100644 --- a/docs/plugins/launch-navigator/README.md +++ b/docs/plugins/launch-navigator/README.md @@ -1,20 +1,29 @@ +--- +description: >- + Launch Navigator plugin for Cordova and Ionic. Requires Cordova plugin: uk.co.workingedge.phonegap.plugin.launchnavigator. For more info, please see the… +--- + # Launch Navigator -``` -$ ionic cordova plugin add uk.co.workingedge.phonegap.plugin.launchnavigator -$ npm install @awesome-cordova-plugins/launch-navigator -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add uk.co.workingedge.phonegap.plugin.launchnavigator +npm install @awesome-cordova-plugins/launch-navigator +``` + +**Plugin Repo:** [https://github.com/dpa99c/phonegap-launch-navigator](https://github.com/dpa99c/phonegap-launch-navigator) + +## Supported Platforms - Android - iOS - Windows - Windows Phone 8 +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/launch-review/README.md b/docs/plugins/launch-review/README.md index 86c3a85a4..81c5a5308 100644 --- a/docs/plugins/launch-review/README.md +++ b/docs/plugins/launch-review/README.md @@ -1,20 +1,29 @@ +--- +description: >- + Launch Review plugin for Cordova and Ionic. Assists in leaving user reviews/ratings in the App Stores. - Launches the platform's App Store page for the… +--- + # Launch Review -``` -$ ionic cordova plugin add cordova-launch-review -$ npm install @awesome-cordova-plugins/launch-review -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-launch-review +npm install @awesome-cordova-plugins/launch-review +``` + +**Plugin Repo:** [https://github.com/dpa99c/cordova-launch-review](https://github.com/dpa99c/cordova-launch-review) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/lets-cooee/README.md b/docs/plugins/lets-cooee/README.md index 8e343568f..8b2869c55 100644 --- a/docs/plugins/lets-cooee/README.md +++ b/docs/plugins/lets-cooee/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Lets Cooee plugin for Cordova and Ionic. AI driven Personalised Notifications for Better Customer Engagement +--- + # Lets Cooee -``` -$ ionic cordova plugin add @letscooee/cordova-plugin --variable COOEE_APP_ID=appId -$ npm install @awesome-cordova-plugins/lets-cooee -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/lets-cooee/) - -Plugin Repo: [https://github.com/letscooee/cordova-plugin-cooee](https://github.com/letscooee/cordova-plugin-cooee) - AI driven Personalised Notifications for Better Customer Engagement -## Supported platforms +## Installation + +```bash +ionic cordova plugin add @letscooee/cordova-plugin --variable COOEE_APP_ID=appId +npm install @awesome-cordova-plugins/lets-cooee +``` + +**Plugin Repo:** [https://github.com/letscooee/cordova-plugin-cooee](https://github.com/letscooee/cordova-plugin-cooee) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/line-login/README.md b/docs/plugins/line-login/README.md index a0ef91759..33138df94 100644 --- a/docs/plugins/line-login/README.md +++ b/docs/plugins/line-login/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Line Login plugin for Cordova and Ionic. The function login, logs out, acquires, verifies, and refreshes the access token. The version of LineSDK you are… +--- + # 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 @awesome-cordova-plugins/line-login -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add https://github.com/nrikiji/cordova-line-login-plugin.git --variable LINE_CHANNEL_ID="your_line_channel_id" +npm install @awesome-cordova-plugins/line-login +``` + +**Plugin Repo:** [https://github.com/nrikiji/cordova-line-login-plugin](https://github.com/nrikiji/cordova-line-login-plugin) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/local-backup/README.md b/docs/plugins/local-backup/README.md index bd28140e9..e704e1f45 100644 --- a/docs/plugins/local-backup/README.md +++ b/docs/plugins/local-backup/README.md @@ -1,18 +1,27 @@ +--- +description: >- + LocalBackup plugin for Cordova and Ionic. This plugin to create local backup +--- + # LocalBackup -``` -$ ionic cordova plugin add cordova-plugin-local-backup -$ npm install @awesome-cordova-plugins/local-backup -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-local-backup +npm install @awesome-cordova-plugins/local-backup +``` + +**Plugin Repo:** [https://github.com/MaximBelov/cordova-plugin-local-backup](https://github.com/MaximBelov/cordova-plugin-local-backup) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/local-notifications/README.md b/docs/plugins/local-notifications/README.md index c096dccb6..260d1d6ae 100644 --- a/docs/plugins/local-notifications/README.md +++ b/docs/plugins/local-notifications/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Local Notifications plugin for Cordova and Ionic. This plugin allows you to display local notifications on the device +--- + # Local Notifications -``` -$ ionic cordova plugin add cordova-plugin-local-notification -$ npm install @awesome-cordova-plugins/local-notifications -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-local-notification +npm install @awesome-cordova-plugins/local-notifications +``` + +**Plugin Repo:** [https://github.com/katzer/cordova-plugin-local-notifications](https://github.com/katzer/cordova-plugin-local-notifications) + +## Supported Platforms - Android - iOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/location-accuracy/README.md b/docs/plugins/location-accuracy/README.md index ad95e0f88..b24e65231 100644 --- a/docs/plugins/location-accuracy/README.md +++ b/docs/plugins/location-accuracy/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Location Accuracy plugin for Cordova and Ionic. This Cordova/Phonegap plugin for Android and iOS to request enabling/changing of Location Services by… +--- + # Location Accuracy -``` -$ ionic cordova plugin add cordova-plugin-request-location-accuracy -$ npm install @awesome-cordova-plugins/location-accuracy -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-request-location-accuracy +npm install @awesome-cordova-plugins/location-accuracy +``` + +**Plugin Repo:** [https://github.com/dpa99c/cordova-plugin-request-location-accuracy](https://github.com/dpa99c/cordova-plugin-request-location-accuracy) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/lottie-splash-screen/README.md b/docs/plugins/lottie-splash-screen/README.md index 63299c935..1bac4462c 100644 --- a/docs/plugins/lottie-splash-screen/README.md +++ b/docs/plugins/lottie-splash-screen/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Lottie Splash Screen plugin for Cordova and Ionic. Cordova plugin to show bodymovin/Lottie animations as the splash screen with Airbnb's Lottie wrapper +--- + # Lottie Splash Screen -``` -$ -$ npm install @awesome-cordova-plugins/lottie-splash-screen -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash + +npm install @awesome-cordova-plugins/lottie-splash-screen +``` + +**Plugin Repo:** [https://github.com/timbru31/cordova-plugin-lottie-splashscreen](https://github.com/timbru31/cordova-plugin-lottie-splashscreen) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/magnetometer/README.md b/docs/plugins/magnetometer/README.md index 0bdae01b1..e7f5f2f12 100644 --- a/docs/plugins/magnetometer/README.md +++ b/docs/plugins/magnetometer/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Device eMagnetometer plugin for Cordova and Ionic. Requires Cordova plugin: `cordova-plugin-magnetometer`. For more info, please see the [Device Orientation… +--- + # Device eMagnetometer -``` -$ ionic cordova plugin add cordova-plugin-magnetometer -$ npm install @awesome-cordova-plugins/magnetometer -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/magnetometer/) - -Plugin Repo: [https://github.com/sdesalas/cordova-plugin-magnetometer](https://github.com/sdesalas/cordova-plugin-magnetometer) - Requires Cordova plugin: `cordova-plugin-magnetometer`. For more info, please see the [Device Orientation docs](https://github.com/sdesalas/cordova-plugin-magnetometer). -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-magnetometer +npm install @awesome-cordova-plugins/magnetometer +``` + +**Plugin Repo:** [https://github.com/sdesalas/cordova-plugin-magnetometer](https://github.com/sdesalas/cordova-plugin-magnetometer) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/market/README.md b/docs/plugins/market/README.md index 6cf5f5df8..61e0ecdc7 100644 --- a/docs/plugins/market/README.md +++ b/docs/plugins/market/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Market plugin for Cordova and Ionic. Opens an app's page in the market place (Google Play, App Store) +--- + # Market -``` -$ ionic cordova plugin add cordova-plugin-market -$ npm install @awesome-cordova-plugins/market -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/market/) - -Plugin Repo: [https://github.com/xmartlabs/cordova-plugin-market](https://github.com/xmartlabs/cordova-plugin-market) - Opens an app's page in the market place (Google Play, App Store) -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-market +npm install @awesome-cordova-plugins/market +``` + +**Plugin Repo:** [https://github.com/xmartlabs/cordova-plugin-market](https://github.com/xmartlabs/cordova-plugin-market) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/media-capture/README.md b/docs/plugins/media-capture/README.md index d9ac63597..c2efebbf2 100644 --- a/docs/plugins/media-capture/README.md +++ b/docs/plugins/media-capture/README.md @@ -1,22 +1,31 @@ +--- +description: >- + Media Capture plugin for Cordova and Ionic. This plugin provides access to the device's audio, image, and video capture capabilities. Requires Cordova… +--- + # Media Capture -``` -$ ionic cordova plugin add cordova-plugin-media-capture -$ npm install @awesome-cordova-plugins/media-capture -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-media-capture +npm install @awesome-cordova-plugins/media-capture +``` + +**Plugin Repo:** [https://github.com/apache/cordova-plugin-media-capture](https://github.com/apache/cordova-plugin-media-capture) + +## Supported Platforms - Android - Browser - iOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/media/README.md b/docs/plugins/media/README.md index 554786c46..c982c5130 100644 --- a/docs/plugins/media/README.md +++ b/docs/plugins/media/README.md @@ -1,20 +1,29 @@ +--- +description: >- + Media plugin for Cordova and Ionic. This plugin provides the ability to record and play back audio files on a device. +--- + # Media -``` -$ ionic cordova plugin add cordova-plugin-media -$ npm install @awesome-cordova-plugins/media -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-media +npm install @awesome-cordova-plugins/media +``` + +**Plugin Repo:** [https://github.com/apache/cordova-plugin-media](https://github.com/apache/cordova-plugin-media) + +## Supported Platforms - Android - Browser - iOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/metrix/README.md b/docs/plugins/metrix/README.md index a249eeca2..fd686633b 100644 --- a/docs/plugins/metrix/README.md +++ b/docs/plugins/metrix/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Metrix plugin for Cordova and Ionic. This is the Ionic Cordova SDK of Metrix™. You can read more about Metrix™ at metrix.ir. Requires Cordova plugin:… +--- + # Metrix -``` -$ ionic cordova plugin add ir.metrix.sdk -$ npm install @awesome-cordova-plugins/metrix -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add ir.metrix.sdk +npm install @awesome-cordova-plugins/metrix +``` + +**Plugin Repo:** [https://github.com/metrixorg/MetrixSDK-CordovaPlugin](https://github.com/metrixorg/MetrixSDK-CordovaPlugin) + +## Supported Platforms - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/mixpanel/README.md b/docs/plugins/mixpanel/README.md index 092ad90fd..635ede347 100644 --- a/docs/plugins/mixpanel/README.md +++ b/docs/plugins/mixpanel/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Mixpanel plugin for Cordova and Ionic. Cordova Plugin that wraps Mixpanel SDK for Android and iOS +--- + # Mixpanel -``` -$ ionic cordova plugin add cordova-plugin-mixpanel -$ npm install @awesome-cordova-plugins/mixpanel -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-mixpanel +npm install @awesome-cordova-plugins/mixpanel +``` + +**Plugin Repo:** [https://github.com/samzilverberg/cordova-mixpanel-plugin](https://github.com/samzilverberg/cordova-mixpanel-plugin) + +## Supported Platforms - Android - Browser - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/mlkit-translate/README.md b/docs/plugins/mlkit-translate/README.md index 755a16aae..f0581ec07 100644 --- a/docs/plugins/mlkit-translate/README.md +++ b/docs/plugins/mlkit-translate/README.md @@ -1,18 +1,27 @@ +--- +description: >- + MLKitTranslate plugin for Cordova and Ionic. Plugin that implements MLKit Translation and Language Identification features. +--- + # MLKitTranslate -``` -$ ionic cordova plugin add cordova-plugin-mlkit-translate -$ npm install @awesome-cordova-plugins/mlkit-translate -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-mlkit-translate +npm install @awesome-cordova-plugins/mlkit-translate +``` + +**Plugin Repo:** [https://github.com/rigelglen/cordova-plugin-mlkit-translate](https://github.com/rigelglen/cordova-plugin-mlkit-translate) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/mobile-accessibility/README.md b/docs/plugins/mobile-accessibility/README.md index 9c85154f4..80b13bc68 100644 --- a/docs/plugins/mobile-accessibility/README.md +++ b/docs/plugins/mobile-accessibility/README.md @@ -1,20 +1,29 @@ +--- +description: >- + Mobile Accessibility plugin for Cordova and Ionic. This plugin exposes information on the status of various accessibility features of mobile operating… +--- + # Mobile Accessibility -``` -$ -$ npm install @awesome-cordova-plugins/mobile-accessibility -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/mobile-accessibility/) - -Plugin Repo: [https://github.com/phonegap/phonegap-mobile-accessibility](https://github.com/phonegap/phonegap-mobile-accessibility) - This plugin exposes information on the status of various accessibility features of mobile operating systems, including, for example, whether a screen reader is running, invert colors is enabled, and the preferred scaling for text. It also allows an application to send a string to be spoken by the screen reader, or a command to stop the screen reader from speaking. -## Supported platforms +## Installation + +```bash + +npm install @awesome-cordova-plugins/mobile-accessibility +``` + +**Plugin Repo:** [https://github.com/phonegap/phonegap-mobile-accessibility](https://github.com/phonegap/phonegap-mobile-accessibility) + +## Supported Platforms - Android - iOS - Amazon Fire OS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/mobile-messaging/README.md b/docs/plugins/mobile-messaging/README.md index 190201132..478b26ed6 100644 --- a/docs/plugins/mobile-messaging/README.md +++ b/docs/plugins/mobile-messaging/README.md @@ -1,22 +1,31 @@ +--- +description: >- + Mobile Messaging plugin for Cordova and Ionic. Mobile Messaging SDK is designed and developed to easily enable push notification channel in your mobile… +--- + # Mobile Messaging -``` -$ ionic cordova plugin add com-infobip-plugins-mobilemessaging -$ npm install @awesome-cordova-plugins/mobile-messaging -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add com-infobip-plugins-mobilemessaging +npm install @awesome-cordova-plugins/mobile-messaging +``` + +**Plugin Repo:** [https://github.com/infobip/mobile-messaging-cordova-plugin](https://github.com/infobip/mobile-messaging-cordova-plugin) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/multiple-document-picker/README.md b/docs/plugins/multiple-document-picker/README.md index f28a08371..89dd64612 100644 --- a/docs/plugins/multiple-document-picker/README.md +++ b/docs/plugins/multiple-document-picker/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Multiple Documents Picker plugin for Cordova and Ionic. This plugin allows users to pick multiple documents/images at once +--- + # Multiple Documents Picker -``` -$ ionic cordova plugin add cordova-plugin-multiple-documents-picker -$ npm install @awesome-cordova-plugins/multiple-document-picker -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-multiple-documents-picker +npm install @awesome-cordova-plugins/multiple-document-picker +``` + +**Plugin Repo:** [https://github.com/akeotech/cordova-plugin-multiple-documents-picker](https://github.com/akeotech/cordova-plugin-multiple-documents-picker) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/music-controls/README.md b/docs/plugins/music-controls/README.md index 4dcb3fe39..599266b7c 100644 --- a/docs/plugins/music-controls/README.md +++ b/docs/plugins/music-controls/README.md @@ -1,21 +1,30 @@ +--- +description: >- + Music Controls plugin for Cordova and Ionic. Music controls for Cordova applications. Display a 'media' notification with play/pause, previous, next buttons,… +--- + # Music Controls -``` -$ ionic cordova plugin add cordova-plugin-music-controls2 -$ npm install @awesome-cordova-plugins/music-controls -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-music-controls2 +npm install @awesome-cordova-plugins/music-controls +``` + +**Plugin Repo:** [https://github.com/ghenry22/cordova-plugin-music-controls2](https://github.com/ghenry22/cordova-plugin-music-controls2) + +## Supported Platforms - Android - iOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/native-audio/README.md b/docs/plugins/native-audio/README.md index b17a359bf..c4bca8672 100644 --- a/docs/plugins/native-audio/README.md +++ b/docs/plugins/native-audio/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Native Audio plugin for Cordova and Ionic. Native Audio Playback +--- + # Native Audio -``` -$ ionic cordova plugin add cordova-plugin-nativeaudio -$ npm install @awesome-cordova-plugins/native-audio -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/native-audio/) - -Plugin Repo: [https://github.com/floatinghotpot/cordova-plugin-nativeaudio](https://github.com/floatinghotpot/cordova-plugin-nativeaudio) - Native Audio Playback -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-nativeaudio +npm install @awesome-cordova-plugins/native-audio +``` + +**Plugin Repo:** [https://github.com/floatinghotpot/cordova-plugin-nativeaudio](https://github.com/floatinghotpot/cordova-plugin-nativeaudio) + +## Supported Platforms - Android - Browser - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/native-geocoder/README.md b/docs/plugins/native-geocoder/README.md index 993b7385c..da852233f 100644 --- a/docs/plugins/native-geocoder/README.md +++ b/docs/plugins/native-geocoder/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Native Geocoder plugin for Cordova and Ionic. Cordova plugin for native forward and reverse geocoding +--- + # Native Geocoder -``` -$ ionic cordova plugin add cordova-plugin-nativegeocoder -$ npm install @awesome-cordova-plugins/native-geocoder -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-nativegeocoder +npm install @awesome-cordova-plugins/native-geocoder +``` + +**Plugin Repo:** [https://github.com/sebastianbaar/cordova-plugin-nativegeocoder](https://github.com/sebastianbaar/cordova-plugin-nativegeocoder) + +## Supported Platforms - iOS - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/native-keyboard/README.md b/docs/plugins/native-keyboard/README.md index 4c1f54874..1141f9d7a 100644 --- a/docs/plugins/native-keyboard/README.md +++ b/docs/plugins/native-keyboard/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Native Keyboard plugin for Cordova and Ionic. A cross platform WhatsApp / Messenger / Slack -style keyboard even. For your Cordova app. +--- + # Native Keyboard -``` -$ ionic cordova plugin add cordova-plugin-native-keyboard -$ npm install @awesome-cordova-plugins/native-keyboard -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-native-keyboard +npm install @awesome-cordova-plugins/native-keyboard +``` + +**Plugin Repo:** [https://github.com/EddyVerbruggen/cordova-plugin-native-keyboard](https://github.com/EddyVerbruggen/cordova-plugin-native-keyboard) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/native-page-transitions/README.md b/docs/plugins/native-page-transitions/README.md index e48074639..c162edf31 100644 --- a/docs/plugins/native-page-transitions/README.md +++ b/docs/plugins/native-page-transitions/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Native Page Transitions plugin for Cordova and Ionic. The Native Page Transitions plugin uses native hardware acceleration to animate your transitions between… +--- + # Native Page Transitions -``` -$ ionic cordova plugin add com.telerik.plugins.nativepagetransitions -$ npm install @awesome-cordova-plugins/native-page-transitions -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add com.telerik.plugins.nativepagetransitions +npm install @awesome-cordova-plugins/native-page-transitions +``` + +**Plugin Repo:** [https://github.com/Telerik-Verified-Plugins/NativePageTransitions](https://github.com/Telerik-Verified-Plugins/NativePageTransitions) + +## Supported Platforms - Android - iOS - Windows Phone 8 +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/native-storage/README.md b/docs/plugins/native-storage/README.md index 65642c601..91cafd62c 100644 --- a/docs/plugins/native-storage/README.md +++ b/docs/plugins/native-storage/README.md @@ -1,17 +1,22 @@ +--- +description: >- + Native Storage plugin for Cordova and Ionic. Native storage of variables in Android and iOS +--- + # Native Storage -``` -$ ionic cordova plugin add cordova-plugin-nativestorage -$ npm install @awesome-cordova-plugins/native-storage -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-nativestorage +npm install @awesome-cordova-plugins/native-storage +``` + +**Plugin Repo:** [https://github.com/TheCocoaProject/cordova-plugin-nativestorage](https://github.com/TheCocoaProject/cordova-plugin-nativestorage) + +## Supported Platforms - Android - Browser @@ -19,3 +24,7 @@ Native storage of variables in Android and iOS - macOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/native-view/README.md b/docs/plugins/native-view/README.md index 0021cce65..458ee35ee 100644 --- a/docs/plugins/native-view/README.md +++ b/docs/plugins/native-view/README.md @@ -1,16 +1,25 @@ +--- +description: >- + NativeView — Awesome Cordova Plugins wrapper for Ionic and Cordova apps. +--- + # NativeView -``` -$ ionic cordova plugin add cordova-plugin-nativeview -$ npm install @awesome-cordova-plugins/native-view +## Installation + +```bash +ionic cordova plugin add cordova-plugin-nativeview +npm install @awesome-cordova-plugins/native-view ``` -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/native-view/) +**Plugin Repo:** [https://github.com/mfdeveloper/cordova-plugin-nativeview](https://github.com/mfdeveloper/cordova-plugin-nativeview) -Plugin Repo: [https://github.com/mfdeveloper/cordova-plugin-nativeview](https://github.com/mfdeveloper/cordova-plugin-nativeview) - -## Supported platforms +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/network-interface/README.md b/docs/plugins/network-interface/README.md index 18db8ba61..86708e723 100644 --- a/docs/plugins/network-interface/README.md +++ b/docs/plugins/network-interface/README.md @@ -1,17 +1,22 @@ +--- +description: >- + Network Interface plugin for Cordova and Ionic. Network interface information plugin for Cordova/PhoneGap that supports Android, Blackberry 10, Browser, iOS,… +--- + # Network Interface -``` -$ ionic cordova plugin add cordova-plugin-networkinterface -$ npm install @awesome-cordova-plugins/network-interface -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-networkinterface +npm install @awesome-cordova-plugins/network-interface +``` + +**Plugin Repo:** [https://github.com/salbahra/cordova-plugin-networkinterface](https://github.com/salbahra/cordova-plugin-networkinterface) + +## Supported Platforms - Android - BlackBerry 10 @@ -20,3 +25,7 @@ Network interface information plugin for Cordova/PhoneGap that supports Android, - Windows - Windows Phone +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/network-permission/README.md b/docs/plugins/network-permission/README.md index 02f3e570f..27a90e438 100644 --- a/docs/plugins/network-permission/README.md +++ b/docs/plugins/network-permission/README.md @@ -1,17 +1,26 @@ +--- +description: >- + Network Permission plugin for Cordova and Ionic. Requires Cordova plugin: cordova-plugin-network-permission. For more info, please see the [Network permission… +--- + # Network Permission -``` -$ ionic cordova plugin add cordova-plugin-network-permission -$ npm install @awesome-cordova-plugins/network-permission -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/network-permission/) - -Plugin Repo: [https://github.com/j5int/cordova-plugin-network-permission](https://github.com/j5int/cordova-plugin-network-permission) - Requires Cordova plugin: cordova-plugin-network-permission. For more info, please see the [Network permission plugin docs](https://github.com/j5int/cordova-plugin-network-permission). -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-network-permission +npm install @awesome-cordova-plugins/network-permission +``` + +**Plugin Repo:** [https://github.com/j5int/cordova-plugin-network-permission](https://github.com/j5int/cordova-plugin-network-permission) + +## Supported Platforms - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/network/README.md b/docs/plugins/network/README.md index 239a0ab8c..d29867f94 100644 --- a/docs/plugins/network/README.md +++ b/docs/plugins/network/README.md @@ -1,17 +1,22 @@ +--- +description: >- + Network plugin for Cordova and Ionic. Requires Cordova plugin: cordova-plugin-network-information. For more info, please see the [Network plugin… +--- + # Network -``` -$ ionic cordova plugin add cordova-plugin-network-information -$ npm install @awesome-cordova-plugins/network -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-network-information +npm install @awesome-cordova-plugins/network +``` + +**Plugin Repo:** [https://github.com/apache/cordova-plugin-network-information](https://github.com/apache/cordova-plugin-network-information) + +## Supported Platforms - Amazon Fire OS - Android @@ -19,3 +24,7 @@ Requires Cordova plugin: cordova-plugin-network-information. For more info, plea - iOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/newrelic/README.md b/docs/plugins/newrelic/README.md index 68e9b4ef9..adefff2fa 100644 --- a/docs/plugins/newrelic/README.md +++ b/docs/plugins/newrelic/README.md @@ -1,18 +1,27 @@ +--- +description: >- + newrelic mobile plugin for Cordova and Ionic. This NewRelic plugin collect crashes, network traffic, and other information for hybrid apps using native… +--- + # newrelic mobile -``` -$ ionic cordova plugin add https://github.com/newrelic/newrelic-cordova-plugin.git --variable IOS_APP_TOKEN="{ios-app-token}" --variable ANDROID_APP_TOKEN="{android-app-token}" -$ npm install @awesome-cordova-plugins/newrelic -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/newrelic/) - -Plugin Repo: [https://github.com/newrelic/newrelic-cordova-plugin](https://github.com/newrelic/newrelic-cordova-plugin) - This NewRelic plugin collect crashes, network traffic, and other information for hybrid apps using native components. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add https://github.com/newrelic/newrelic-cordova-plugin.git --variable IOS_APP_TOKEN="{ios-app-token}" --variable ANDROID_APP_TOKEN="{android-app-token}" +npm install @awesome-cordova-plugins/newrelic +``` + +**Plugin Repo:** [https://github.com/newrelic/newrelic-cordova-plugin](https://github.com/newrelic/newrelic-cordova-plugin) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/nfc/README.md b/docs/plugins/nfc/README.md index 191a485c1..f4972ed8c 100644 --- a/docs/plugins/nfc/README.md +++ b/docs/plugins/nfc/README.md @@ -1,14 +1,10 @@ +--- +description: >- + NFC plugin for Cordova and Ionic. The NFC plugin allows you to read and write NFC tags. You can also beam to, and receive from, other NFC enabled devices.… +--- + # NFC -``` -$ ionic cordova plugin add phonegap-nfc -$ npm install @awesome-cordova-plugins/nfc -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 @@ -19,9 +15,22 @@ Use to This plugin uses NDEF (NFC Data Exchange Format) for maximum compatibilty between NFC devices, tag types, and operating systems. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add phonegap-nfc +npm install @awesome-cordova-plugins/nfc +``` + +**Plugin Repo:** [https://github.com/chariotsolutions/phonegap-nfc](https://github.com/chariotsolutions/phonegap-nfc) + +## Supported Platforms - Android - iOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/ocr/README.md b/docs/plugins/ocr/README.md index 351c930b5..856363f76 100644 --- a/docs/plugins/ocr/README.md +++ b/docs/plugins/ocr/README.md @@ -1,21 +1,30 @@ +--- +description: >- + OCR plugin for Cordova and Ionic. This plugin attempts to identify and extract text from an image. Please note: This plugin depends on the GoogleMobileVision… +--- + # OCR -``` -$ ionic cordova plugin add cordova-plugin-mobile-ocr -$ npm install @awesome-cordova-plugins/ocr -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-mobile-ocr +npm install @awesome-cordova-plugins/ocr +``` + +**Plugin Repo:** [https://github.com/NeutrinosPlatform/cordova-plugin-mobile-ocr](https://github.com/NeutrinosPlatform/cordova-plugin-mobile-ocr) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/onesignal/README.md b/docs/plugins/onesignal/README.md index 37a874f08..284303837 100644 --- a/docs/plugins/onesignal/README.md +++ b/docs/plugins/onesignal/README.md @@ -1,14 +1,10 @@ +--- +description: >- + OneSignal plugin for Cordova and Ionic. The OneSignal plugin is an client implementation for using the [OneSignal](https://onesignal.com/) Service. OneSignal… +--- + # OneSignal -``` -$ ionic cordova plugin add onesignal-cordova-plugin -$ npm install @awesome-cordova-plugins/onesignal -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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. @@ -77,10 +73,23 @@ module.exports = function(context) { 3. From the root of your project make the file executable: `$ chmod +x hooks/copy_android_notification_icons.js` -## Supported platforms +## Installation + +```bash +ionic cordova plugin add onesignal-cordova-plugin +npm install @awesome-cordova-plugins/onesignal +``` + +**Plugin Repo:** [https://github.com/OneSignal/OneSignal-Cordova-SDK](https://github.com/OneSignal/OneSignal-Cordova-SDK) + +## Supported Platforms - Amazon Fire OS - Android - iOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/open-native-settings/README.md b/docs/plugins/open-native-settings/README.md index 42140509a..0ce164ad5 100644 --- a/docs/plugins/open-native-settings/README.md +++ b/docs/plugins/open-native-settings/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Open Native Settings plugin for Cordova and Ionic. Plugin to open native screens of iOS/android settings +--- + # Open Native Settings -``` -$ ionic cordova plugin add cordova-open-native-settings -$ npm install @awesome-cordova-plugins/open-native-settings -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-open-native-settings +npm install @awesome-cordova-plugins/open-native-settings +``` + +**Plugin Repo:** [https://github.com/guyromb/Cordova-open-native-settings](https://github.com/guyromb/Cordova-open-native-settings) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/openalpr/README.md b/docs/plugins/openalpr/README.md index 93a2f668d..56289194c 100644 --- a/docs/plugins/openalpr/README.md +++ b/docs/plugins/openalpr/README.md @@ -1,18 +1,27 @@ +--- +description: >- + OpenALPR plugin for Cordova and Ionic. This Cordova plugin adds support for the OpenALPR (Automatic License Plate Recognition) library, which provides support… +--- + # OpenALPR -``` -$ ionic cordova plugin add cordova-plugin-openalpr -$ npm install @awesome-cordova-plugins/openalpr -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-openalpr +npm install @awesome-cordova-plugins/openalpr +``` + +**Plugin Repo:** [https://github.com/iMicknl/cordova-plugin-openalpr](https://github.com/iMicknl/cordova-plugin-openalpr) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/openinstall/README.md b/docs/plugins/openinstall/README.md index 5b264990a..ef08218c8 100644 --- a/docs/plugins/openinstall/README.md +++ b/docs/plugins/openinstall/README.md @@ -1,16 +1,25 @@ +--- +description: >- + OpenInstall — Awesome Cordova Plugins wrapper for Ionic and Cordova apps. +--- + # OpenInstall -``` -$ ionic cordova plugin add cordova-plugin-openinstall -$ npm install @awesome-cordova-plugins/openinstall +## Installation + +```bash +ionic cordova plugin add cordova-plugin-openinstall +npm install @awesome-cordova-plugins/openinstall ``` -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/openinstall/) +**Plugin Repo:** [https://github.com/openinstall/cordova-plugin-openinstall](https://github.com/openinstall/cordova-plugin-openinstall) -Plugin Repo: [https://github.com/openinstall/cordova-plugin-openinstall](https://github.com/openinstall/cordova-plugin-openinstall) - -## Supported platforms +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/paytabs/README.md b/docs/plugins/paytabs/README.md index df627da37..3e2e0aad3 100644 --- a/docs/plugins/paytabs/README.md +++ b/docs/plugins/paytabs/README.md @@ -1,18 +1,27 @@ +--- +description: >- + PayTabs plugin for Cordova and Ionic. A plugin that allows you to use PayTabs's Native SDKs for Android and iOS. +--- + # PayTabs -``` -$ ionic cordova plugin add com.paytabs.cordova.plugin -$ npm install @awesome-cordova-plugins/paytabs -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add com.paytabs.cordova.plugin +npm install @awesome-cordova-plugins/paytabs +``` + +**Plugin Repo:** [https://github.com/paytabscom/paytabs-cordova](https://github.com/paytabscom/paytabs-cordova) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/pdf-generator/README.md b/docs/plugins/pdf-generator/README.md index 4de0e7540..187e14ee5 100644 --- a/docs/plugins/pdf-generator/README.md +++ b/docs/plugins/pdf-generator/README.md @@ -1,18 +1,27 @@ +--- +description: >- + PDFGenerator plugin for Cordova and Ionic. Simple plugin to generate (offline) pdf. The plugin transforms HTML to PDF and also provide the mechanism to share… +--- + # PDFGenerator -``` -$ ionic cordova plugin add cordova-pdf-generator -$ npm install @awesome-cordova-plugins/pdf-generator -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-pdf-generator +npm install @awesome-cordova-plugins/pdf-generator +``` + +**Plugin Repo:** [https://github.com/cesarvr/pdf-generator](https://github.com/cesarvr/pdf-generator) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/photo-library/README.md b/docs/plugins/photo-library/README.md index 0d3eb913c..278992d4b 100644 --- a/docs/plugins/photo-library/README.md +++ b/docs/plugins/photo-library/README.md @@ -1,21 +1,30 @@ +--- +description: >- + Photo Library plugin for Cordova and Ionic. The PhotoLibrary plugin allows access to photos from device by url. So you can use plain img tag to display photos… +--- + # Photo Library -``` -$ ionic cordova plugin add cordova-plugin-photo-library --variable PHOTO_LIBRARY_USAGE_DESCRIPTION="To choose photos" -$ npm install @awesome-cordova-plugins/photo-library -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-photo-library --variable PHOTO_LIBRARY_USAGE_DESCRIPTION="To choose photos" +npm install @awesome-cordova-plugins/photo-library +``` + +**Plugin Repo:** [https://github.com/terikon/cordova-plugin-photo-library](https://github.com/terikon/cordova-plugin-photo-library) + +## Supported Platforms - Android - Browser - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/photo-viewer/README.md b/docs/plugins/photo-viewer/README.md index dbf6ef36e..2d133ae8b 100644 --- a/docs/plugins/photo-viewer/README.md +++ b/docs/plugins/photo-viewer/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Photo Viewer plugin for Cordova and Ionic. This plugin can display your image in full screen with the ability to pan, zoom, and share the image. +--- + # Photo Viewer -``` -$ ionic cordova plugin add com-sarriaroman-photoviewer -$ npm install @awesome-cordova-plugins/photo-viewer -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add com-sarriaroman-photoviewer +npm install @awesome-cordova-plugins/photo-viewer +``` + +**Plugin Repo:** [https://github.com/sarriaroman/photoviewer](https://github.com/sarriaroman/photoviewer) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/play-install-referrer/README.md b/docs/plugins/play-install-referrer/README.md index 999c515b2..65821333c 100644 --- a/docs/plugins/play-install-referrer/README.md +++ b/docs/plugins/play-install-referrer/README.md @@ -1,15 +1,24 @@ +--- +description: >- + PlayInstallReferrer — Awesome Cordova Plugins wrapper for Ionic and Cordova apps. +--- + # PlayInstallReferrer -``` -$ ionic cordova plugin add cordova-plugin-play-installreferrer -$ npm install @awesome-cordova-plugins/play-install-referrer +## Installation + +```bash +ionic cordova plugin add cordova-plugin-play-installreferrer +npm install @awesome-cordova-plugins/play-install-referrer ``` -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/play-install-referrer/) +**Plugin Repo:** [https://github.com/swayangjit/cordova-plugin-play-installreferrer](https://github.com/swayangjit/cordova-plugin-play-installreferrer) -Plugin Repo: [https://github.com/swayangjit/cordova-plugin-play-installreferrer](https://github.com/swayangjit/cordova-plugin-play-installreferrer) - -## Supported platforms +## Supported Platforms - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/pollfish/README.md b/docs/plugins/pollfish/README.md index d619f592d..900f25f22 100644 --- a/docs/plugins/pollfish/README.md +++ b/docs/plugins/pollfish/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Pollfish plugin for Cordova and Ionic. Pollfish Ionic Native plugin wrapper +--- + # Pollfish -``` -$ ionic cordova plugin add com.pollfish.cordova_plugin -$ npm install @awesome-cordova-plugins/pollfish -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/pollfish/) - -Plugin Repo: [https://github.com/pollfish/cordova-plugin-pollfish](https://github.com/pollfish/cordova-plugin-pollfish) - Pollfish Ionic Native plugin wrapper -## Supported platforms +## Installation + +```bash +ionic cordova plugin add com.pollfish.cordova_plugin +npm install @awesome-cordova-plugins/pollfish +``` + +**Plugin Repo:** [https://github.com/pollfish/cordova-plugin-pollfish](https://github.com/pollfish/cordova-plugin-pollfish) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/power-management/README.md b/docs/plugins/power-management/README.md index 678a77f08..33987ea00 100644 --- a/docs/plugins/power-management/README.md +++ b/docs/plugins/power-management/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Power Management plugin for Cordova and Ionic. The PowerManagement plugin offers access to the devices power-management functionality. It should be used for… +--- + # Power Management -``` -$ ionic cordova plugin add cordova-plugin-powermanagement-orig -$ npm install @awesome-cordova-plugins/power-management -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/power-management/) - -Plugin Repo: [https://github.com/Viras-/cordova-plugin-powermanagement](https://github.com/Viras-/cordova-plugin-powermanagement) - The PowerManagement plugin offers access to the devices power-management functionality. It should be used for applications which keep running for a long time without any user interaction. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-powermanagement-orig +npm install @awesome-cordova-plugins/power-management +``` + +**Plugin Repo:** [https://github.com/Viras-/cordova-plugin-powermanagement](https://github.com/Viras-/cordova-plugin-powermanagement) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/power-optimization/README.md b/docs/plugins/power-optimization/README.md index 72ba37f06..ce7412f69 100644 --- a/docs/plugins/power-optimization/README.md +++ b/docs/plugins/power-optimization/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Power Optimization plugin for Cordova and Ionic. Android Custom Roms made sometimes your apps unfunctional due to being killed in the background, notification… +--- + # Power Optimization -``` -$ ionic cordova plugin add cordova-plugin-power-optimization -$ npm install @awesome-cordova-plugins/power-optimization -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-power-optimization +npm install @awesome-cordova-plugins/power-optimization +``` + +**Plugin Repo:** [https://github.com/snt1017/cordova-plugin-power-optimization](https://github.com/snt1017/cordova-plugin-power-optimization) + +## Supported Platforms - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/preview-any-file/README.md b/docs/plugins/preview-any-file/README.md index beae94d02..e702ff9ae 100644 --- a/docs/plugins/preview-any-file/README.md +++ b/docs/plugins/preview-any-file/README.md @@ -1,16 +1,25 @@ +--- +description: >- + Preview/Open Any File — Awesome Cordova Plugins wrapper for Ionic and Cordova apps. +--- + # Preview/Open Any File -``` -$ -$ npm install @awesome-cordova-plugins/preview-any-file +## Installation + +```bash + +npm install @awesome-cordova-plugins/preview-any-file ``` -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/preview-any-file/) +**Plugin Repo:** [https://github.com/mostafa-mansour1/previewAnyFile](https://github.com/mostafa-mansour1/previewAnyFile) -Plugin Repo: [https://github.com/mostafa-mansour1/previewAnyFile](https://github.com/mostafa-mansour1/previewAnyFile) - -## Supported platforms +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/printer/README.md b/docs/plugins/printer/README.md index 564ced9b0..f4a55aa8b 100644 --- a/docs/plugins/printer/README.md +++ b/docs/plugins/printer/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Printer plugin for Cordova and Ionic. Prints documents or HTML rendered content +--- + # Printer -``` -$ ionic cordova plugin add cordova-plugin-printer -$ npm install @awesome-cordova-plugins/printer -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-printer +npm install @awesome-cordova-plugins/printer +``` + +**Plugin Repo:** [https://github.com/katzer/cordova-plugin-printer](https://github.com/katzer/cordova-plugin-printer) + +## Supported Platforms - Android - iOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/pspdfkit-cordova/README.md b/docs/plugins/pspdfkit-cordova/README.md index 1d01d851d..a44752608 100644 --- a/docs/plugins/pspdfkit-cordova/README.md +++ b/docs/plugins/pspdfkit-cordova/README.md @@ -1,18 +1,27 @@ +--- +description: >- + PSPDFKit-Cordova plugin for Cordova and Ionic. The official plugin to use PSPDFKit with Cordova and Ionic. +--- + # PSPDFKit-Cordova -``` -$ ionic cordova plugin add pspdfkit-cordova -$ npm install @awesome-cordova-plugins/pspdfkit-cordova -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add pspdfkit-cordova +npm install @awesome-cordova-plugins/pspdfkit-cordova +``` + +**Plugin Repo:** [https://github.com/PSPDFKit/PSPDFKit-Cordova](https://github.com/PSPDFKit/PSPDFKit-Cordova) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/purchases/README.md b/docs/plugins/purchases/README.md index 108a0f768..c7ef78943 100644 --- a/docs/plugins/purchases/README.md +++ b/docs/plugins/purchases/README.md @@ -1,14 +1,10 @@ +--- +description: >- + Purchases plugin for Cordova and Ionic. *Purchases* is a client for the [RevenueCat](https://www.revenuecat.com/) subscription and purchase tracking system.… +--- + # Purchases -``` -$ ionic cordova plugin add cordova-plugin-purchases@5.0.0 -$ npm install @awesome-cordova-plugins/purchases -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/purchases/) - -Plugin Repo: [https://github.com/RevenueCat/cordova-plugin-purchases](https://github.com/RevenueCat/cordova-plugin-purchases) - *Purchases* is a client for the [RevenueCat](https://www.revenuecat.com/) subscription and purchase tracking system. It is an open source framework that provides a wrapper around `BillingClient`, `StoreKit` and the RevenueCat backend to make implementing in-app subscriptions easy - receipt validation and status tracking included! @@ -45,8 +41,21 @@ If your app supports product changes using [DEFERRED replacement mode](https://w then you can either stick with the previous major version until support for DEFERRED is re-introduced in this major version, or you can remove DEFERRED replacement options from your app. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-purchases@5.0.0 +npm install @awesome-cordova-plugins/purchases +``` + +**Plugin Repo:** [https://github.com/RevenueCat/cordova-plugin-purchases](https://github.com/RevenueCat/cordova-plugin-purchases) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/push/README.md b/docs/plugins/push/README.md index 05cfa182a..804f70bdb 100644 --- a/docs/plugins/push/README.md +++ b/docs/plugins/push/README.md @@ -1,24 +1,33 @@ +--- +description: >- + Push plugin for Cordova and Ionic. Register and receive push notifications. Requires Cordova plugin: `phonegap-plugin-push`. For more info, please see the… +--- + # Push -``` -$ ionic cordova plugin add phonegap-plugin-push -$ npm install @awesome-cordova-plugins/push -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add phonegap-plugin-push +npm install @awesome-cordova-plugins/push +``` + +**Plugin Repo:** [https://github.com/phonegap/phonegap-plugin-push](https://github.com/phonegap/phonegap-plugin-push) + +## Supported Platforms - Android - Browser - iOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/pushape-push/README.md b/docs/plugins/pushape-push/README.md index c75b49666..7bb4e0244 100644 --- a/docs/plugins/pushape-push/README.md +++ b/docs/plugins/pushape-push/README.md @@ -1,22 +1,31 @@ +--- +description: >- + PushapePush plugin for Cordova and Ionic. Register and receive push notifications. This plugin extends functionalities of Push native plugin in order to use… +--- + # PushapePush -``` -$ ionic cordova plugin add pushape-cordova-push -$ npm install @awesome-cordova-plugins/pushape-push -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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: -## Supported platforms +## Installation + +```bash +ionic cordova plugin add pushape-cordova-push +npm install @awesome-cordova-plugins/pushape-push +``` + +**Plugin Repo:** [https://github.com/gluelabs/pushape-cordova-push](https://github.com/gluelabs/pushape-cordova-push) + +## Supported Platforms - Android - Browser - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/safari-view-controller/README.md b/docs/plugins/safari-view-controller/README.md index cf791593a..943f4608c 100644 --- a/docs/plugins/safari-view-controller/README.md +++ b/docs/plugins/safari-view-controller/README.md @@ -1,20 +1,29 @@ +--- +description: >- + Safari View Controller plugin for Cordova and Ionic. For displaying read-only web content. Requires Cordova plugin: `cordova-plugin-safariviewcontroller`.… +--- + # Safari View Controller -``` -$ ionic cordova plugin add cordova-plugin-safariviewcontroller -$ npm install @awesome-cordova-plugins/safari-view-controller -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-safariviewcontroller +npm install @awesome-cordova-plugins/safari-view-controller +``` + +**Plugin Repo:** [https://github.com/EddyVerbruggen/cordova-plugin-safariviewcontroller](https://github.com/EddyVerbruggen/cordova-plugin-safariviewcontroller) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/save-dialog/README.md b/docs/plugins/save-dialog/README.md index 3fa721d63..216f045db 100644 --- a/docs/plugins/save-dialog/README.md +++ b/docs/plugins/save-dialog/README.md @@ -1,18 +1,27 @@ +--- +description: >- + SaveDialog plugin for Cordova and Ionic. Plugin displays the native Save dialog which allows users to store a file in the selected location. +--- + # SaveDialog -``` -$ ionic cordova plugin add cordova-plugin-save-dialog -$ npm install @awesome-cordova-plugins/save-dialog -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/save-dialog/) - -Plugin Repo: [https://github.com/Amphiluke/cordova-plugin-save-dialog](https://github.com/Amphiluke/cordova-plugin-save-dialog) - Plugin displays the native Save dialog which allows users to store a file in the selected location. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-save-dialog +npm install @awesome-cordova-plugins/save-dialog +``` + +**Plugin Repo:** [https://github.com/Amphiluke/cordova-plugin-save-dialog](https://github.com/Amphiluke/cordova-plugin-save-dialog) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/screen-orientation/README.md b/docs/plugins/screen-orientation/README.md index c2319df76..126fbe5b1 100644 --- a/docs/plugins/screen-orientation/README.md +++ b/docs/plugins/screen-orientation/README.md @@ -1,21 +1,30 @@ +--- +description: >- + Screen Orientation plugin for Cordova and Ionic. Cordova plugin to set/lock the screen orientation in a common way. Requires Cordova plugin:… +--- + # Screen Orientation -``` -$ ionic cordova plugin add cordova-plugin-screen-orientation -$ npm install @awesome-cordova-plugins/screen-orientation -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-screen-orientation +npm install @awesome-cordova-plugins/screen-orientation +``` + +**Plugin Repo:** [https://github.com/apache/cordova-plugin-screen-orientation](https://github.com/apache/cordova-plugin-screen-orientation) + +## Supported Platforms - Android - iOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/screenshot/README.md b/docs/plugins/screenshot/README.md index f3ed92464..1bd75df24 100644 --- a/docs/plugins/screenshot/README.md +++ b/docs/plugins/screenshot/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Screenshot plugin for Cordova and Ionic. Captures a screen shot +--- + # Screenshot -``` -$ ionic cordova plugin add @herdwatch/cordova-plugin-screenshot -$ npm install @awesome-cordova-plugins/screenshot -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/screenshot/) - -Plugin Repo: [https://github.com/herdwatch-apps/cordova-plugin-screenshot](https://github.com/herdwatch-apps/cordova-plugin-screenshot) - Captures a screen shot -## Supported platforms +## Installation + +```bash +ionic cordova plugin add @herdwatch/cordova-plugin-screenshot +npm install @awesome-cordova-plugins/screenshot +``` + +**Plugin Repo:** [https://github.com/herdwatch-apps/cordova-plugin-screenshot](https://github.com/herdwatch-apps/cordova-plugin-screenshot) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/secure-storage-echo/README.md b/docs/plugins/secure-storage-echo/README.md index 1481edd26..aff9844c2 100644 --- a/docs/plugins/secure-storage-echo/README.md +++ b/docs/plugins/secure-storage-echo/README.md @@ -1,24 +1,33 @@ +--- +description: >- + Secure Storage Echo plugin for Cordova and Ionic. This plugin gets, sets and removes key,value pairs from a device's secure storage. Requires Cordova plugin:… +--- + # Secure Storage Echo -``` -$ ionic cordova plugin add cordova-plugin-secure-storage-echo -$ npm install @awesome-cordova-plugins/secure-storage-echo -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-secure-storage-echo +npm install @awesome-cordova-plugins/secure-storage-echo +``` + +**Plugin Repo:** [https://github.com/mibrito707/cordova-plugin-secure-storage-echo](https://github.com/mibrito707/cordova-plugin-secure-storage-echo) + +## Supported Platforms - Android - Browser - iOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/secure-storage/README.md b/docs/plugins/secure-storage/README.md index 9a0134b48..c54c9aa74 100644 --- a/docs/plugins/secure-storage/README.md +++ b/docs/plugins/secure-storage/README.md @@ -1,24 +1,33 @@ +--- +description: >- + Secure Storage plugin for Cordova and Ionic. This plugin gets, sets and removes key,value pairs from a device's secure storage. Requires Cordova plugin:… +--- + # Secure Storage -``` -$ ionic cordova plugin add cordova-plugin-secure-storage-echo -$ npm install @awesome-cordova-plugins/secure-storage -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-secure-storage-echo +npm install @awesome-cordova-plugins/secure-storage +``` + +**Plugin Repo:** [https://github.com/mibrito707/cordova-plugin-secure-storage-echo](https://github.com/mibrito707/cordova-plugin-secure-storage-echo) + +## Supported Platforms - Android - Browser - iOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/service-discovery/README.md b/docs/plugins/service-discovery/README.md index 55034e221..183304552 100644 --- a/docs/plugins/service-discovery/README.md +++ b/docs/plugins/service-discovery/README.md @@ -1,18 +1,27 @@ +--- +description: >- + ServiceDiscovery plugin for Cordova and Ionic. Simple plugin to get any SSDP / UPnP / DLNA service on a local network +--- + # ServiceDiscovery -``` -$ ionic cordova plugin add cordova-plugin-discovery -$ npm install @awesome-cordova-plugins/service-discovery -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-discovery +npm install @awesome-cordova-plugins/service-discovery +``` + +**Plugin Repo:** [https://github.com/scottdermott/cordova-plugin-discovery](https://github.com/scottdermott/cordova-plugin-discovery) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/shake/README.md b/docs/plugins/shake/README.md index bf79fdf85..a1ca3e913 100644 --- a/docs/plugins/shake/README.md +++ b/docs/plugins/shake/README.md @@ -1,17 +1,26 @@ +--- +description: >- + Shake plugin for Cordova and Ionic. Handles shake gesture +--- + # Shake -``` -$ ionic cordova plugin add cordova-plugin-shake -$ npm install @awesome-cordova-plugins/shake -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/shake/) - -Plugin Repo: [https://github.com/leecrossley/cordova-plugin-shake](https://github.com/leecrossley/cordova-plugin-shake) - Handles shake gesture -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-shake +npm install @awesome-cordova-plugins/shake +``` + +**Plugin Repo:** [https://github.com/leecrossley/cordova-plugin-shake](https://github.com/leecrossley/cordova-plugin-shake) + +## Supported Platforms - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/shortcuts-android/README.md b/docs/plugins/shortcuts-android/README.md index 776d7c31f..3e4e90550 100644 --- a/docs/plugins/shortcuts-android/README.md +++ b/docs/plugins/shortcuts-android/README.md @@ -1,21 +1,30 @@ +--- +description: >- + ShortcutsAndroid plugin for Cordova and Ionic. Use this plugin to create shortcuts in Android. Use this plugin to handle Intents on your application. For more… +--- + # ShortcutsAndroid -``` -$ ionic cordova plugin add cordova-plugin-shortcuts-android -$ npm install @awesome-cordova-plugins/shortcuts-android -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/shortcuts-android/) - -Plugin Repo: [https://github.com/avargaskun/cordova-plugin-shortcuts-android](https://github.com/avargaskun/cordova-plugin-shortcuts-android) - Use this plugin to create shortcuts in Android. Use this plugin to handle Intents on your application. For more information on Android App Shortcuts: https://developer.android.com/guide/topics/ui/shortcuts.html For more information on Android Intents: https://developer.android.com/guide/components/intents-filters.html The work that went into creating this plug-in was inspired by the existing plugins: cordova-plugin-shortcut and cordova-plugin-webintent2. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-shortcuts-android +npm install @awesome-cordova-plugins/shortcuts-android +``` + +**Plugin Repo:** [https://github.com/avargaskun/cordova-plugin-shortcuts-android](https://github.com/avargaskun/cordova-plugin-shortcuts-android) + +## Supported Platforms - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/sign-in-with-apple/README.md b/docs/plugins/sign-in-with-apple/README.md index 01807eb44..5b285eb33 100644 --- a/docs/plugins/sign-in-with-apple/README.md +++ b/docs/plugins/sign-in-with-apple/README.md @@ -1,14 +1,10 @@ +--- +description: >- + Sign In With Apple plugin for Cordova and Ionic. Sign in with Apple makes it easy for users to sign in to your apps and websites using their Apple ID. Instead… +--- + # Sign In With Apple -``` -$ ionic cordova plugin add cordova-plugin-sign-in-with-apple -$ npm install @awesome-cordova-plugins/sign-in-with-apple -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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. @@ -16,7 +12,20 @@ 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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-sign-in-with-apple +npm install @awesome-cordova-plugins/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) + +## Supported Platforms - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/smartlook/README.md b/docs/plugins/smartlook/README.md index b54abab82..ee23d5443 100644 --- a/docs/plugins/smartlook/README.md +++ b/docs/plugins/smartlook/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Smartlook plugin for Cordova and Ionic. Official Smartlook SDK plugin. Full documentation can be found here:… +--- + # Smartlook -``` -$ ionic cordova plugin add https://github.com/smartlook/cordova-smartlook.git -$ npm install @awesome-cordova-plugins/smartlook -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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://mobile.developer.smartlook.com/reference/ionic-sdk-installation -## Supported platforms +## Installation + +```bash +ionic cordova plugin add https://github.com/smartlook/cordova-smartlook.git +npm install @awesome-cordova-plugins/smartlook +``` + +**Plugin Repo:** [https://github.com/smartlook/cordova-smartlook.git](https://github.com/smartlook/cordova-smartlook.git) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/sms-retriever-api/README.md b/docs/plugins/sms-retriever-api/README.md index 19e53d158..82b0618b4 100644 --- a/docs/plugins/sms-retriever-api/README.md +++ b/docs/plugins/sms-retriever-api/README.md @@ -1,17 +1,26 @@ +--- +description: >- + SmsRetrieverApi plugin for Cordova and Ionic. This plugin retries the SMS which arrive without requiring READ permissions. +--- + # SmsRetrieverApi -``` -$ ionic cordova plugin add cordova-plugin-sms-retriever --variable PLAY_SERVICES_VERSION="18.0.1" -$ npm install @awesome-cordova-plugins/sms-retriever-api -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/sms-retriever-api/) - -Plugin Repo: [https://github.com/andreszs/cordova-plugin-sms-retriever](https://github.com/andreszs/cordova-plugin-sms-retriever) - This plugin retries the SMS which arrive without requiring READ permissions. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-sms-retriever --variable PLAY_SERVICES_VERSION="18.0.1" +npm install @awesome-cordova-plugins/sms-retriever-api +``` + +**Plugin Repo:** [https://github.com/andreszs/cordova-plugin-sms-retriever](https://github.com/andreszs/cordova-plugin-sms-retriever) + +## Supported Platforms - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/sms-retriever/README.md b/docs/plugins/sms-retriever/README.md index 089461fe3..5aa2e87bb 100644 --- a/docs/plugins/sms-retriever/README.md +++ b/docs/plugins/sms-retriever/README.md @@ -1,17 +1,26 @@ +--- +description: >- + Sms Retriever plugin for Cordova and Ionic. This plugin retrives the SMS which arrive without requiring READ permissions. +--- + # Sms Retriever -``` -$ ionic cordova plugin add cordova-plugin-sms-retriever-manager --variable PLAY_SERVICES_VERSION="15.0.1" -$ npm install @awesome-cordova-plugins/sms-retriever -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-sms-retriever-manager --variable PLAY_SERVICES_VERSION="15.0.1" +npm install @awesome-cordova-plugins/sms-retriever +``` + +**Plugin Repo:** [https://github.com/hanatharesh2712/ionic-native-sms-retriever-plugin-master](https://github.com/hanatharesh2712/ionic-native-sms-retriever-plugin-master) + +## Supported Platforms - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/sms/README.md b/docs/plugins/sms/README.md index 1bfb9a2db..056e221fc 100644 --- a/docs/plugins/sms/README.md +++ b/docs/plugins/sms/README.md @@ -1,20 +1,29 @@ +--- +description: >- + SMS plugin for Cordova and Ionic. Requires Cordova plugin: cordova-sms-plugin. For more info, please see the [SMS plugin… +--- + # SMS -``` -$ ionic cordova plugin add cordova-sms-plugin -$ npm install @awesome-cordova-plugins/sms -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-sms-plugin +npm install @awesome-cordova-plugins/sms +``` + +**Plugin Repo:** [https://github.com/cordova-sms/cordova-sms-plugin](https://github.com/cordova-sms/cordova-sms-plugin) + +## Supported Platforms - Android - iOS - Windows - Windows Phone 8 +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/smtp-client/README.md b/docs/plugins/smtp-client/README.md index 380f81dc1..84e1b865d 100644 --- a/docs/plugins/smtp-client/README.md +++ b/docs/plugins/smtp-client/README.md @@ -1,16 +1,25 @@ +--- +description: >- + Smtp Client — Awesome Cordova Plugins wrapper for Ionic and Cordova apps. +--- + # Smtp Client -``` -$ ionic cordova plugin add cordova-plugin-smtp-client -$ npm install @awesome-cordova-plugins/smtp-client +## Installation + +```bash +ionic cordova plugin add cordova-plugin-smtp-client +npm install @awesome-cordova-plugins/smtp-client ``` -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/smtp-client/) +**Plugin Repo:** [https://github.com/CWBudde/cordova-plugin-smtp-client](https://github.com/CWBudde/cordova-plugin-smtp-client) -Plugin Repo: [https://github.com/CWBudde/cordova-plugin-smtp-client](https://github.com/CWBudde/cordova-plugin-smtp-client) - -## Supported platforms +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/social-sharing/README.md b/docs/plugins/social-sharing/README.md index f13fb4ddd..57d043f47 100644 --- a/docs/plugins/social-sharing/README.md +++ b/docs/plugins/social-sharing/README.md @@ -1,19 +1,24 @@ +--- +description: >- + Social Sharing plugin for Cordova and Ionic. Share text, files, images, and links via social networks, sms, and email. For Browser usage check out the Web… +--- + # Social Sharing -``` -$ ionic cordova plugin add cordova-plugin-x-socialsharing -$ npm install @awesome-cordova-plugins/social-sharing -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-x-socialsharing +npm install @awesome-cordova-plugins/social-sharing +``` + +**Plugin Repo:** [https://github.com/EddyVerbruggen/SocialSharing-PhoneGap-Plugin](https://github.com/EddyVerbruggen/SocialSharing-PhoneGap-Plugin) + +## Supported Platforms - Android - Browser @@ -21,3 +26,7 @@ For Browser usage check out the Web Share API docs: https://github.com/EddyVerbr - Windows - Windows Phone +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/sockets-tcp/README.md b/docs/plugins/sockets-tcp/README.md index 7c75017a9..b7385f1dc 100644 --- a/docs/plugins/sockets-tcp/README.md +++ b/docs/plugins/sockets-tcp/README.md @@ -1,18 +1,27 @@ +--- +description: >- + SocketsTcp plugin for Cordova and Ionic. This plugin provides TCP client sockets for Android and iOS. +--- + # SocketsTcp -``` -$ ionic cordova plugin add https://github.com/KoenLav/cordova-plugin-chrome-apps-sockets-tcp -$ npm install @awesome-cordova-plugins/sockets-tcp -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/sockets-tcp/) - -Plugin Repo: [https://github.com/KoenLav/cordova-plugin-chrome-apps-sockets-tcp](https://github.com/KoenLav/cordova-plugin-chrome-apps-sockets-tcp) - This plugin provides TCP client sockets for Android and iOS. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add https://github.com/KoenLav/cordova-plugin-chrome-apps-sockets-tcp +npm install @awesome-cordova-plugins/sockets-tcp +``` + +**Plugin Repo:** [https://github.com/KoenLav/cordova-plugin-chrome-apps-sockets-tcp](https://github.com/KoenLav/cordova-plugin-chrome-apps-sockets-tcp) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/sockets-udp/README.md b/docs/plugins/sockets-udp/README.md index dcdb8eb8a..48e2940a6 100644 --- a/docs/plugins/sockets-udp/README.md +++ b/docs/plugins/sockets-udp/README.md @@ -1,18 +1,27 @@ +--- +description: >- + SocketsUdp plugin for Cordova and Ionic. This plugin provides UDP sockets for Android and iOS. +--- + # SocketsUdp -``` -$ ionic cordova plugin add cordova-plugin-chrome-apps-sockets-udp -$ npm install @awesome-cordova-plugins/sockets-udp -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/sockets-udp/) - -Plugin Repo: [https://github.com/herdwatch-apps/cordova-plugin-chrome-apps-sockets-udp](https://github.com/herdwatch-apps/cordova-plugin-chrome-apps-sockets-udp) - This plugin provides UDP sockets for Android and iOS. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-chrome-apps-sockets-udp +npm install @awesome-cordova-plugins/sockets-udp +``` + +**Plugin Repo:** [https://github.com/herdwatch-apps/cordova-plugin-chrome-apps-sockets-udp](https://github.com/herdwatch-apps/cordova-plugin-chrome-apps-sockets-udp) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/speech-recognition/README.md b/docs/plugins/speech-recognition/README.md index 4decd2046..bad05f1ef 100644 --- a/docs/plugins/speech-recognition/README.md +++ b/docs/plugins/speech-recognition/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Speech Recognition plugin for Cordova and Ionic. This plugin does speech recognition using cloud services +--- + # Speech Recognition -``` -$ ionic cordova plugin add cordova-plugin-speechrecognition -$ npm install @awesome-cordova-plugins/speech-recognition -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-speechrecognition +npm install @awesome-cordova-plugins/speech-recognition +``` + +**Plugin Repo:** [https://github.com/pbakondy/cordova-plugin-speechrecognition](https://github.com/pbakondy/cordova-plugin-speechrecognition) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/spinner-dialog/README.md b/docs/plugins/spinner-dialog/README.md index e3b499efc..5166ba03b 100644 --- a/docs/plugins/spinner-dialog/README.md +++ b/docs/plugins/spinner-dialog/README.md @@ -1,22 +1,31 @@ +--- +description: >- + Spinner Dialog plugin for Cordova and Ionic. Cordova plugin for showing a native spinner based on Paldom/SpinnerDialog. Requires Cordova plugin:… +--- + # Spinner Dialog -``` -$ ionic cordova plugin add cordova-plugin-native-spinner -$ npm install @awesome-cordova-plugins/spinner-dialog -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-native-spinner +npm install @awesome-cordova-plugins/spinner-dialog +``` + +**Plugin Repo:** [https://github.com/greybax/cordova-plugin-native-spinner](https://github.com/greybax/cordova-plugin-native-spinner) + +## Supported Platforms - Android - iOS - Windows Phone 8 - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/splash-screen/README.md b/docs/plugins/splash-screen/README.md index a1b204aae..a3cc67fef 100644 --- a/docs/plugins/splash-screen/README.md +++ b/docs/plugins/splash-screen/README.md @@ -1,20 +1,29 @@ +--- +description: >- + Splash Screen plugin for Cordova and Ionic. This plugin displays and hides a splash screen during application launch. The methods below allows showing and… +--- + # Splash Screen -``` -$ ionic cordova plugin add cordova-plugin-splashscreen -$ npm install @awesome-cordova-plugins/splash-screen -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-splashscreen +npm install @awesome-cordova-plugins/splash-screen +``` + +**Plugin Repo:** [https://github.com/apache/cordova-plugin-splashscreen](https://github.com/apache/cordova-plugin-splashscreen) + +## Supported Platforms - Amazon Fire OS - Android - iOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/spotify-auth/README.md b/docs/plugins/spotify-auth/README.md index 37c309eb4..f57fbb04a 100644 --- a/docs/plugins/spotify-auth/README.md +++ b/docs/plugins/spotify-auth/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Spotify Auth plugin for Cordova and Ionic. Cordova plugin for authenticating with Spotify > https://github.com/Festify/cordova-spotify-oauth +--- + # Spotify Auth -``` -$ ionic cordova plugin add cordova-spotify-oauth --variable LOCAL_STORAGE_KEY="SpotifyOAuthData" -$ npm install @awesome-cordova-plugins/spotify-auth -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-spotify-oauth --variable LOCAL_STORAGE_KEY="SpotifyOAuthData" +npm install @awesome-cordova-plugins/spotify-auth +``` + +**Plugin Repo:** [https://github.com/Festify/cordova-spotify-oauth](https://github.com/Festify/cordova-spotify-oauth) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/sqlite-db-copy/README.md b/docs/plugins/sqlite-db-copy/README.md index 7141cb98b..fb3f5e14f 100644 --- a/docs/plugins/sqlite-db-copy/README.md +++ b/docs/plugins/sqlite-db-copy/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Sqlite Db Copy plugin for Cordova and Ionic. This plugin does something +--- + # Sqlite Db Copy -``` -$ ionic cordova plugin add cordova-plugin-dbcopy -$ npm install @awesome-cordova-plugins/sqlite-db-copy -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-dbcopy +npm install @awesome-cordova-plugins/sqlite-db-copy +``` + +**Plugin Repo:** [https://github.com/an-rahulpandey/cordova-plugin-dbcopy](https://github.com/an-rahulpandey/cordova-plugin-dbcopy) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/sqlite-porter/README.md b/docs/plugins/sqlite-porter/README.md index ee56cf0f4..15ab1b8b3 100644 --- a/docs/plugins/sqlite-porter/README.md +++ b/docs/plugins/sqlite-porter/README.md @@ -1,17 +1,22 @@ +--- +description: >- + SQLite Porter plugin for Cordova and Ionic. This Cordova/Phonegap plugin can be used to import/export to/from a SQLite database using either SQL or JSON. +--- + # SQLite Porter -``` -$ ionic cordova plugin add uk.co.workingedge.cordova.plugin.sqliteporter -$ npm install @awesome-cordova-plugins/sqlite-porter -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add uk.co.workingedge.cordova.plugin.sqliteporter +npm install @awesome-cordova-plugins/sqlite-porter +``` + +**Plugin Repo:** [https://github.com/dpa99c/cordova-sqlite-porter](https://github.com/dpa99c/cordova-sqlite-porter) + +## Supported Platforms - Amazon Fire OS - Android @@ -22,3 +27,7 @@ This Cordova/Phonegap plugin can be used to import/export to/from a SQLite datab - Windows - Windows Phone +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/sqlite/README.md b/docs/plugins/sqlite/README.md index bdfa4a08c..4681d5d49 100644 --- a/docs/plugins/sqlite/README.md +++ b/docs/plugins/sqlite/README.md @@ -1,20 +1,29 @@ +--- +description: >- + SQLite plugin for Cordova and Ionic. Access SQLite databases on the device. +--- + # SQLite -``` -$ ionic cordova plugin add cordova-sqlite-storage -$ npm install @awesome-cordova-plugins/sqlite -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-sqlite-storage +npm install @awesome-cordova-plugins/sqlite +``` + +**Plugin Repo:** [https://github.com/litehelpers/Cordova-sqlite-storage](https://github.com/litehelpers/Cordova-sqlite-storage) + +## Supported Platforms - Android - iOS - macOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/ssl-certificate-checker/README.md b/docs/plugins/ssl-certificate-checker/README.md index b2c065dd2..3eaba7b97 100644 --- a/docs/plugins/ssl-certificate-checker/README.md +++ b/docs/plugins/ssl-certificate-checker/README.md @@ -1,18 +1,27 @@ +--- +description: >- + SSLCertificateChecker plugin for Cordova and Ionic. Cordova plugin to check SSL certificates on Android and iOS. +--- + # SSLCertificateChecker -``` -$ ionic cordova plugin add SSLCertificateChecker-PhoneGap-Plugin -$ npm install @awesome-cordova-plugins/ssl-certificate-checker -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/ssl-certificate-checker/) - -Plugin Repo: [https://github.com/EddyVerbruggen/SSLCertificateChecker-PhoneGap-Plugin](https://github.com/EddyVerbruggen/SSLCertificateChecker-PhoneGap-Plugin) - Cordova plugin to check SSL certificates on Android and iOS. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add SSLCertificateChecker-PhoneGap-Plugin +npm install @awesome-cordova-plugins/ssl-certificate-checker +``` + +**Plugin Repo:** [https://github.com/EddyVerbruggen/SSLCertificateChecker-PhoneGap-Plugin](https://github.com/EddyVerbruggen/SSLCertificateChecker-PhoneGap-Plugin) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/star-prnt/README.md b/docs/plugins/star-prnt/README.md index 7c6421a06..f412332db 100644 --- a/docs/plugins/star-prnt/README.md +++ b/docs/plugins/star-prnt/README.md @@ -1,18 +1,27 @@ +--- +description: >- + StarPRNT plugin for Cordova and Ionic. Ionic Native wrappers for the starprnt cordova plugin for Star Micronics Bluetooth/LAN printers +--- + # StarPRNT -``` -$ ionic cordova plugin add cordova-plugin-starprnt -$ npm install @awesome-cordova-plugins/star-prnt -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-starprnt +npm install @awesome-cordova-plugins/star-prnt +``` + +**Plugin Repo:** [https://github.com/auctifera-josed/starprnt](https://github.com/auctifera-josed/starprnt) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/status-bar/README.md b/docs/plugins/status-bar/README.md index 120c02fb8..9d6757956 100644 --- a/docs/plugins/status-bar/README.md +++ b/docs/plugins/status-bar/README.md @@ -1,21 +1,30 @@ +--- +description: >- + Status Bar plugin for Cordova and Ionic. Manage the appearance of the native status bar. Requires Cordova plugin: `cordova-plugin-statusbar`. For more info,… +--- + # Status Bar -``` -$ ionic cordova plugin add cordova-plugin-statusbar -$ npm install @awesome-cordova-plugins/status-bar -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-statusbar +npm install @awesome-cordova-plugins/status-bar +``` + +**Plugin Repo:** [https://github.com/apache/cordova-plugin-statusbar](https://github.com/apache/cordova-plugin-statusbar) + +## Supported Platforms - Android - iOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/streaming-media/README.md b/docs/plugins/streaming-media/README.md index 3692e3722..c8cae943b 100644 --- a/docs/plugins/streaming-media/README.md +++ b/docs/plugins/streaming-media/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Streaming Media plugin for Cordova and Ionic. This plugin allows you to stream audio and video in a fullscreen, native player on iOS and Android. +--- + # Streaming Media -``` -$ ionic cordova plugin add cordova-plugin-streaming-media -$ npm install @awesome-cordova-plugins/streaming-media -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-streaming-media +npm install @awesome-cordova-plugins/streaming-media +``` + +**Plugin Repo:** [https://github.com/nchutchind/cordova-plugin-streaming-media](https://github.com/nchutchind/cordova-plugin-streaming-media) + +## Supported Platforms - Amazon Fire OS - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/stripe/README.md b/docs/plugins/stripe/README.md index 909628525..6534a0644 100644 --- a/docs/plugins/stripe/README.md +++ b/docs/plugins/stripe/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Stripe plugin for Cordova and Ionic. A plugin that allows you to use Stripe's Native SDKs for Android and iOS. +--- + # Stripe -``` -$ ionic cordova plugin add cordova-plugin-stripe -$ npm install @awesome-cordova-plugins/stripe -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-stripe +npm install @awesome-cordova-plugins/stripe +``` + +**Plugin Repo:** [https://github.com/zyramedia/cordova-plugin-stripe](https://github.com/zyramedia/cordova-plugin-stripe) + +## Supported Platforms - Android - Browser - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/sum-up/README.md b/docs/plugins/sum-up/README.md index 635bf653c..d6a2250f6 100644 --- a/docs/plugins/sum-up/README.md +++ b/docs/plugins/sum-up/README.md @@ -1,18 +1,27 @@ +--- +description: >- + SumUp plugin for Cordova and Ionic. Plugin to communicate with a SumUp payment terminal +--- + # SumUp -``` -$ cordova plugin add cordova-sumup-plugin --variable SUMUP_API_KEY=INSERT_YOUR_KEY -$ npm install @awesome-cordova-plugins/sum-up -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +cordova plugin add cordova-sumup-plugin --variable SUMUP_API_KEY=INSERT_YOUR_KEY +npm install @awesome-cordova-plugins/sum-up +``` + +**Plugin Repo:** [https://github.com/mariusbackes/cordova-plugin-sumup](https://github.com/mariusbackes/cordova-plugin-sumup) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/system-alert-window-permission/README.md b/docs/plugins/system-alert-window-permission/README.md index 923627816..84bbb9a98 100644 --- a/docs/plugins/system-alert-window-permission/README.md +++ b/docs/plugins/system-alert-window-permission/README.md @@ -1,17 +1,26 @@ +--- +description: >- + System Alert Window Permission plugin for Cordova and Ionic. This plugin does something +--- + # System Alert Window Permission -``` -$ ionic cordova plugin add cordova-plugin-system-alert-window-permission -$ npm install @awesome-cordova-plugins/system-alert-window-permission -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-system-alert-window-permission +npm install @awesome-cordova-plugins/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) + +## Supported Platforms - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/taptic-engine/README.md b/docs/plugins/taptic-engine/README.md index 40102c490..095034cc8 100644 --- a/docs/plugins/taptic-engine/README.md +++ b/docs/plugins/taptic-engine/README.md @@ -1,17 +1,26 @@ +--- +description: >- + Taptic Engine plugin for Cordova and Ionic. An Ionic plugin to use Taptic Engine API on iPhone 7, 7 Plus or newer. +--- + # Taptic Engine -``` -$ ionic cordova plugin add cordova-plugin-taptic-engine -$ npm install @awesome-cordova-plugins/taptic-engine -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-taptic-engine +npm install @awesome-cordova-plugins/taptic-engine +``` + +**Plugin Repo:** [https://github.com/EddyVerbruggen/cordova-plugin-taptic-engine](https://github.com/EddyVerbruggen/cordova-plugin-taptic-engine) + +## Supported Platforms - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/tealium-adidentifier/README.md b/docs/plugins/tealium-adidentifier/README.md index ebd46b6bb..1d7bdde49 100644 --- a/docs/plugins/tealium-adidentifier/README.md +++ b/docs/plugins/tealium-adidentifier/README.md @@ -1,19 +1,28 @@ +--- +description: >- + TealiumAdIdentifier plugin for Cordova and Ionic. This module depends on the [Tealium Cordova Plugin](https://github.com/tealium/cordova-plugin). Without it,… +--- + # TealiumAdIdentifier -``` -$ -$ npm install @awesome-cordova-plugins/tealium-adidentifier -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash + +npm install @awesome-cordova-plugins/tealium-adidentifier +``` + +**Plugin Repo:** [https://github.com/Tealium/cordova-plugin](https://github.com/Tealium/cordova-plugin) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/tealium-installreferrer/README.md b/docs/plugins/tealium-installreferrer/README.md index c3da33062..48f666f17 100644 --- a/docs/plugins/tealium-installreferrer/README.md +++ b/docs/plugins/tealium-installreferrer/README.md @@ -1,18 +1,27 @@ +--- +description: >- + TealiumInstallReferrer plugin for Cordova and Ionic. This module depends on the [Tealium Cordova Plugin](https://github.com/tealium/cordova-plugin). Without… +--- + # TealiumInstallReferrer -``` -$ -$ npm install @awesome-cordova-plugins/tealium-installreferrer -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash + +npm install @awesome-cordova-plugins/tealium-installreferrer +``` + +**Plugin Repo:** [https://github.com/Tealium/cordova-plugin](https://github.com/Tealium/cordova-plugin) + +## Supported Platforms - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/tealium/README.md b/docs/plugins/tealium/README.md index 0764c009a..f223f42b6 100644 --- a/docs/plugins/tealium/README.md +++ b/docs/plugins/tealium/README.md @@ -1,20 +1,29 @@ +--- +description: >- + Tealium plugin for Cordova and Ionic. This plugin does provides a wrapper around the Tealium Cordova Plugin for Ionic Native. For full documentation, see… +--- + # Tealium -``` -$ -$ npm install @awesome-cordova-plugins/tealium -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/tealium/) - -Plugin Repo: [https://github.com/Tealium/cordova-plugin](https://github.com/Tealium/cordova-plugin) - This plugin does provides a wrapper around the Tealium Cordova Plugin for Ionic Native. For full documentation, see [https://docs.tealium.com/platforms/cordova/](https://docs.tealium.com/platforms/cordova/) -## Supported platforms +## Installation + +```bash + +npm install @awesome-cordova-plugins/tealium +``` + +**Plugin Repo:** [https://github.com/Tealium/cordova-plugin](https://github.com/Tealium/cordova-plugin) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/text-to-speech-advanced/README.md b/docs/plugins/text-to-speech-advanced/README.md index ffbbfbe5e..f3aa53573 100644 --- a/docs/plugins/text-to-speech-advanced/README.md +++ b/docs/plugins/text-to-speech-advanced/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Text To Speech Advanced plugin for Cordova and Ionic. Text to Speech plugin +--- + # Text To Speech Advanced -``` -$ ionic cordova plugin add cordova-plugin-tts-advanced -$ npm install @awesome-cordova-plugins/text-to-speech-advanced -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-tts-advanced +npm install @awesome-cordova-plugins/text-to-speech-advanced +``` + +**Plugin Repo:** [https://github.com/spasma/cordova-plugin-tts-advanced](https://github.com/spasma/cordova-plugin-tts-advanced) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/theme-detection/README.md b/docs/plugins/theme-detection/README.md index 5a7d4b731..052ba0909 100644 --- a/docs/plugins/theme-detection/README.md +++ b/docs/plugins/theme-detection/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Theme Detection plugin for Cordova and Ionic. Cordova plugin to detect whether dark mode is enabled or not +--- + # Theme Detection -``` -$ cordova plugin add cordova-plugin-theme-detection -$ npm install @awesome-cordova-plugins/theme-detection -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +cordova plugin add cordova-plugin-theme-detection +npm install @awesome-cordova-plugins/theme-detection +``` + +**Plugin Repo:** [https://github.com/mariusbackes/cordova-plugin-theme-detection](https://github.com/mariusbackes/cordova-plugin-theme-detection) + +## Supported Platforms - iOS - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/three-dee-touch/README.md b/docs/plugins/three-dee-touch/README.md index ec7a8557c..ea87c95f1 100644 --- a/docs/plugins/three-dee-touch/README.md +++ b/docs/plugins/three-dee-touch/README.md @@ -1,19 +1,28 @@ +--- +description: >- + 3D Touch plugin for Cordova and Ionic. The 3D Touch plugin adds 3D Touch capabilities to your Cordova app. Requires Cordova plugin: `cordova-plugin-3dtouch`.… +--- + # 3D Touch -``` -$ ionic cordova plugin add @herdwatch/cordova-plugin-3dtouch -$ npm install @awesome-cordova-plugins/three-dee-touch -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/three-dee-touch/) - -Plugin Repo: [https://github.com/herdwatch-apps/cordova-plugin-3dtouch](https://github.com/herdwatch-apps/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 +## Installation + +```bash +ionic cordova plugin add @herdwatch/cordova-plugin-3dtouch +npm install @awesome-cordova-plugins/three-dee-touch +``` + +**Plugin Repo:** [https://github.com/herdwatch-apps/cordova-plugin-3dtouch](https://github.com/herdwatch-apps/cordova-plugin-3dtouch) + +## Supported Platforms - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/toast/README.md b/docs/plugins/toast/README.md index 34e322c40..977cd43e0 100644 --- a/docs/plugins/toast/README.md +++ b/docs/plugins/toast/README.md @@ -1,19 +1,24 @@ +--- +description: >- + Toast plugin for Cordova and Ionic. 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… +--- + # Toast -``` -$ ionic cordova plugin add cordova-plugin-x-toast -$ npm install @awesome-cordova-plugins/toast -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-x-toast +npm install @awesome-cordova-plugins/toast +``` + +**Plugin Repo:** [https://github.com/EddyVerbruggen/Toast-PhoneGap-Plugin](https://github.com/EddyVerbruggen/Toast-PhoneGap-Plugin) + +## Supported Platforms - Android - BlackBerry 10 @@ -21,3 +26,7 @@ Requires Cordova plugin: `cordova-plugin-x-toast`. For more info, please see the - Windows - Windows Phone 8 +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/touch-id/README.md b/docs/plugins/touch-id/README.md index f7ab072ea..165ed8253 100644 --- a/docs/plugins/touch-id/README.md +++ b/docs/plugins/touch-id/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Touch ID plugin for Cordova and Ionic. Scan the fingerprint of a user with the TouchID sensor. Requires Cordova plugin: `cordova-plugin-touch-id`. For more… +--- + # Touch ID -``` -$ ionic cordova plugin add cordova-plugin-touch-id -$ npm install @awesome-cordova-plugins/touch-id -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-touch-id +npm install @awesome-cordova-plugins/touch-id +``` + +**Plugin Repo:** [https://github.com/EddyVerbruggen/cordova-plugin-touch-id](https://github.com/EddyVerbruggen/cordova-plugin-touch-id) + +## Supported Platforms - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/unique-device-id/README.md b/docs/plugins/unique-device-id/README.md index 0270c4f6a..0db6aeff6 100644 --- a/docs/plugins/unique-device-id/README.md +++ b/docs/plugins/unique-device-id/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Unique Device ID plugin for Cordova and Ionic. This plugin produces a unique, cross-install, app-specific device id. +--- + # Unique Device ID -``` -$ -$ npm install @awesome-cordova-plugins/unique-device-id -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/unique-device-id/) - -Plugin Repo: [https://github.com/Paldom/UniqueDeviceID](https://github.com/Paldom/UniqueDeviceID) - This plugin produces a unique, cross-install, app-specific device id. -## Supported platforms +## Installation + +```bash + +npm install @awesome-cordova-plugins/unique-device-id +``` + +**Plugin Repo:** [https://github.com/Paldom/UniqueDeviceID](https://github.com/Paldom/UniqueDeviceID) + +## Supported Platforms - Android - iOS - Windows Phone 8 +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/unvired-cordova-sdk/README.md b/docs/plugins/unvired-cordova-sdk/README.md index e192072f6..9859c1478 100644 --- a/docs/plugins/unvired-cordova-sdk/README.md +++ b/docs/plugins/unvired-cordova-sdk/README.md @@ -1,14 +1,10 @@ +--- +description: >- + Unvired Cordova SDK plugin for Cordova and Ionic. This plugin lets you build apps which connect to Unvired Mobile Platform (UMP). - iOS Requirements - Update… +--- + # Unvired Cordova SDK -``` -$ ionic cordova plugin add @awesome-cordova-plugins/unvired-cordova-sdk -$ npm install @awesome-cordova-plugins/unvired-cordova-sdk -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 @@ -28,10 +24,23 @@ After you install the plugin, for Ionic/Angular projects, please add a reference ``` -## Supported platforms +## Installation + +```bash +ionic cordova plugin add @awesome-cordova-plugins/unvired-cordova-sdk +npm install @awesome-cordova-plugins/unvired-cordova-sdk +``` + +**Plugin Repo:** [https://github.com/unvired/cordova-plugin-unvired-sdk/](https://github.com/unvired/cordova-plugin-unvired-sdk/) + +## Supported Platforms - iOS - Android - Windows - Browser +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/uptime/README.md b/docs/plugins/uptime/README.md index ed69dae31..533360a55 100644 --- a/docs/plugins/uptime/README.md +++ b/docs/plugins/uptime/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Uptime plugin for Cordova and Ionic. This plugin provides the time spent in milliseconds since boot (uptime). +--- + # Uptime -``` -$ ionic cordova plugin add cordova-plugin-uptime -$ npm install @awesome-cordova-plugins/uptime -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-uptime +npm install @awesome-cordova-plugins/uptime +``` + +**Plugin Repo:** [https://github.com/s1lviu/cordova-plugin-uptime](https://github.com/s1lviu/cordova-plugin-uptime) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/urbanairship/README.md b/docs/plugins/urbanairship/README.md index 364a554f1..b6960cfa2 100644 --- a/docs/plugins/urbanairship/README.md +++ b/docs/plugins/urbanairship/README.md @@ -1,18 +1,27 @@ +--- +description: >- + UrbanAirShip plugin for Cordova and Ionic. This plugin does something +--- + # UrbanAirShip -``` -$ ionic cordova plugin add urbanairship-cordova -$ npm install @awesome-cordova-plugins/urbanairship -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/urbanairship/) - -Plugin Repo: [https://www.npmjs.com/package/urbanairship-cordova](https://www.npmjs.com/package/urbanairship-cordova) - This plugin does something -## Supported platforms +## Installation + +```bash +ionic cordova plugin add urbanairship-cordova +npm install @awesome-cordova-plugins/urbanairship +``` + +**Plugin Repo:** [https://www.npmjs.com/package/urbanairship-cordova](https://www.npmjs.com/package/urbanairship-cordova) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/usabilla-cordova-sdk/README.md b/docs/plugins/usabilla-cordova-sdk/README.md index c126a3368..f380db368 100644 --- a/docs/plugins/usabilla-cordova-sdk/README.md +++ b/docs/plugins/usabilla-cordova-sdk/README.md @@ -1,21 +1,30 @@ +--- +description: >- + Usabilla plugin for Cordova and Ionic. Usabilla SDK is designed and developed to collect feedback from your users with great ease and flexibility through your… +--- + # Usabilla -``` -$ ionic cordova plugin add usabilla-cordova -$ npm install @awesome-cordova-plugins/usabilla-cordova-sdk -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add usabilla-cordova +npm install @awesome-cordova-plugins/usabilla-cordova-sdk +``` + +**Plugin Repo:** [https://github.com/usabilla/usabilla-u4a-cordova](https://github.com/usabilla/usabilla-u4a-cordova) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/vibes/README.md b/docs/plugins/vibes/README.md index 7188f765f..8f6b43bad 100644 --- a/docs/plugins/vibes/README.md +++ b/docs/plugins/vibes/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Vibes plugin for Cordova and Ionic. This plugin enables integration with the Vibes Push SDK to your Cordova project with Android and iOS supported. +--- + # Vibes -``` -$ ionic cordova plugin add vibes-cordova --variable VIBES_APP_ID=MY_APP_ID --variable VIBES_API_URL=MY_ENVIRONMENT_URL -$ npm install @awesome-cordova-plugins/vibes -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add vibes-cordova --variable VIBES_APP_ID=MY_APP_ID --variable VIBES_API_URL=MY_ENVIRONMENT_URL +npm install @awesome-cordova-plugins/vibes +``` + +**Plugin Repo:** [https://github.com/vibes/vibes-cordova.git](https://github.com/vibes/vibes-cordova.git) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/vibration/README.md b/docs/plugins/vibration/README.md index 5fa858be7..1edfb4681 100644 --- a/docs/plugins/vibration/README.md +++ b/docs/plugins/vibration/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Vibration plugin for Cordova and Ionic. Vibrates the device +--- + # Vibration -``` -$ ionic cordova plugin add cordova-plugin-vibration -$ npm install @awesome-cordova-plugins/vibration -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/vibration/) - -Plugin Repo: [https://github.com/apache/cordova-plugin-vibration](https://github.com/apache/cordova-plugin-vibration) - Vibrates the device -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-vibration +npm install @awesome-cordova-plugins/vibration +``` + +**Plugin Repo:** [https://github.com/apache/cordova-plugin-vibration](https://github.com/apache/cordova-plugin-vibration) + +## Supported Platforms - Android - iOS - Windows +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/video-editor/README.md b/docs/plugins/video-editor/README.md index 288f89530..ca620ad00 100644 --- a/docs/plugins/video-editor/README.md +++ b/docs/plugins/video-editor/README.md @@ -1,20 +1,29 @@ +--- +description: >- + Video Editor plugin for Cordova and Ionic. Edit videos using native device APIs +--- + # Video Editor -``` -$ ionic cordova plugin add cordova-plugin-video-editor -$ npm install @awesome-cordova-plugins/video-editor -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-video-editor +npm install @awesome-cordova-plugins/video-editor +``` + +**Plugin Repo:** [https://github.com/jbavari/cordova-plugin-video-editor](https://github.com/jbavari/cordova-plugin-video-editor) + +## Supported Platforms - Android - iOS - Windows - Windows Phone 8 +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/video-player/README.md b/docs/plugins/video-player/README.md index 88cb3e6d5..ae9e12a5c 100644 --- a/docs/plugins/video-player/README.md +++ b/docs/plugins/video-player/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Video Player plugin for Cordova and Ionic. A Cordova plugin that simply allows you to immediately play a video in fullscreen mode. Requires Cordova plugin:… +--- + # Video Player -``` -$ ionic cordova plugin add https://github.com/moust/cordova-plugin-videoplayer.git -$ npm install @awesome-cordova-plugins/video-player -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add https://github.com/moust/cordova-plugin-videoplayer.git +npm install @awesome-cordova-plugins/video-player +``` + +**Plugin Repo:** [https://github.com/moust/cordova-plugin-videoplayer](https://github.com/moust/cordova-plugin-videoplayer) + +## Supported Platforms - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/we-cap-inbox/README.md b/docs/plugins/we-cap-inbox/README.md index 78aee16aa..8f61e3872 100644 --- a/docs/plugins/we-cap-inbox/README.md +++ b/docs/plugins/we-cap-inbox/README.md @@ -1,18 +1,27 @@ +--- +description: >- + WE Cap Inbox plugin for Cordova and Ionic. This plugin provides functionalities to manage notifications in your app. +--- + # WE Cap Inbox -``` -$ ionic cordova plugin add we-notificationinbox-cordova -$ npm install @awesome-cordova-plugins/we-cap-inbox -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/we-cap-inbox/) - -Plugin Repo: [https://github.com/WebEngage/we-ionic-notification-inbox](https://github.com/WebEngage/we-ionic-notification-inbox) - This plugin provides functionalities to manage notifications in your app. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add we-notificationinbox-cordova +npm install @awesome-cordova-plugins/we-cap-inbox +``` + +**Plugin Repo:** [https://github.com/WebEngage/we-ionic-notification-inbox](https://github.com/WebEngage/we-ionic-notification-inbox) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/web-intent/README.md b/docs/plugins/web-intent/README.md index 7cbe8b1fa..f5872b65d 100644 --- a/docs/plugins/web-intent/README.md +++ b/docs/plugins/web-intent/README.md @@ -1,17 +1,26 @@ +--- +description: >- + Web Intent plugin for Cordova and Ionic. This Plugin provides a general purpose shim layer for the Android intent mechanism, exposing various ways to handle… +--- + # Web Intent -``` -$ ionic cordova plugin add com-darryncampbell-cordova-plugin-intent -$ npm install @awesome-cordova-plugins/web-intent -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add com-darryncampbell-cordova-plugin-intent +npm install @awesome-cordova-plugins/web-intent +``` + +**Plugin Repo:** [https://github.com/darryncampbell/darryncampbell-cordova-plugin-intent](https://github.com/darryncampbell/darryncampbell-cordova-plugin-intent) + +## Supported Platforms - Android +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/web-server/README.md b/docs/plugins/web-server/README.md index 8f68db310..caa84476d 100644 --- a/docs/plugins/web-server/README.md +++ b/docs/plugins/web-server/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Web Server plugin for Cordova and Ionic. This plugin allows you to start a local dynamic content web server for android and iOS devices. +--- + # Web Server -``` -$ ionic cordova plugin add cordova-plugin-webserver2 -$ npm install @awesome-cordova-plugins/web-server -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-webserver2 +npm install @awesome-cordova-plugins/web-server +``` + +**Plugin Repo:** [https://github.com/nguyenthanh1995/cordova-plugin-webserver2.git](https://github.com/nguyenthanh1995/cordova-plugin-webserver2.git) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/web-socket-server/README.md b/docs/plugins/web-socket-server/README.md index 7d6829b63..8babbc383 100644 --- a/docs/plugins/web-socket-server/README.md +++ b/docs/plugins/web-socket-server/README.md @@ -1,18 +1,27 @@ +--- +description: >- + WebSocket Server plugin for Cordova and Ionic. This plugin allows you to run a single, lightweight, barebone WebSocket Server. +--- + # WebSocket Server -``` -$ ionic cordova plugin add cordova-plugin-websocket-server -$ npm install @awesome-cordova-plugins/web-socket-server -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-websocket-server +npm install @awesome-cordova-plugins/web-socket-server +``` + +**Plugin Repo:** [https://github.com/becvert/cordova-plugin-websocket-server](https://github.com/becvert/cordova-plugin-websocket-server) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/webengage/README.md b/docs/plugins/webengage/README.md index 1f591b962..e5f84951c 100644 --- a/docs/plugins/webengage/README.md +++ b/docs/plugins/webengage/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Webengage plugin for Cordova and Ionic. Awesome Cordova Plugins wrapper that wraps Webengage Cordova plugin for Android and iOS +--- + # Webengage -``` -$ ionic cordova plugin add cordova-plugin-webengage -$ npm install @awesome-cordova-plugins/webengage -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-webengage +npm install @awesome-cordova-plugins/webengage +``` + +**Plugin Repo:** [https://github.com/WebEngage/cordova-plugin](https://github.com/WebEngage/cordova-plugin) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/webim/README.md b/docs/plugins/webim/README.md index 19b8e1425..84d7a09b3 100644 --- a/docs/plugins/webim/README.md +++ b/docs/plugins/webim/README.md @@ -1,19 +1,28 @@ +--- +description: >- + Webim plugin for Cordova and Ionic. A cordova plugin, a JS version of Webim SDK +--- + # Webim -``` -$ cordova plugin add https://github.com/webim/webim-cordova-plugin.git -$ npm install @awesome-cordova-plugins/webim -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/webim/) - -Plugin Repo: [https://github.com/webim/webim-cordova-plugin.git](https://github.com/webim/webim-cordova-plugin.git) - A cordova plugin, a JS version of Webim SDK -## Supported platforms +## Installation + +```bash +cordova plugin add https://github.com/webim/webim-cordova-plugin.git +npm install @awesome-cordova-plugins/webim +``` + +**Plugin Repo:** [https://github.com/webim/webim-cordova-plugin.git](https://github.com/webim/webim-cordova-plugin.git) + +## Supported Platforms - Android - iOS - Browser +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/wechat/README.md b/docs/plugins/wechat/README.md index b5fc5487f..f0540c626 100644 --- a/docs/plugins/wechat/README.md +++ b/docs/plugins/wechat/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Wechat plugin for Cordova and Ionic. A cordova plugin, a JS version of Wechat SDK +--- + # Wechat -``` -$ cordova plugin add cordova-plugin-wechat --variable wechatappid=YOUR_WECHAT_APPID -$ npm install @awesome-cordova-plugins/wechat -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +cordova plugin add cordova-plugin-wechat --variable wechatappid=YOUR_WECHAT_APPID +npm install @awesome-cordova-plugins/wechat +``` + +**Plugin Repo:** [https://github.com/xu-li/cordova-plugin-wechat.git](https://github.com/xu-li/cordova-plugin-wechat.git) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/wheel-selector/README.md b/docs/plugins/wheel-selector/README.md index 9b5a71531..009669c02 100644 --- a/docs/plugins/wheel-selector/README.md +++ b/docs/plugins/wheel-selector/README.md @@ -1,18 +1,27 @@ +--- +description: >- + WheelSelector Plugin plugin for Cordova and Ionic. Native wheel selector for Cordova (Android/iOS). +--- + # WheelSelector Plugin -``` -$ ionic cordova plugin add cordova-wheel-selector-plugin -$ npm install @awesome-cordova-plugins/wheel-selector -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-wheel-selector-plugin +npm install @awesome-cordova-plugins/wheel-selector +``` + +**Plugin Repo:** [https://github.com/jasonmamy/cordova-wheel-selector-plugin](https://github.com/jasonmamy/cordova-wheel-selector-plugin) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/wifi-wizard-2/README.md b/docs/plugins/wifi-wizard-2/README.md index 80ace4c13..141cf0392 100644 --- a/docs/plugins/wifi-wizard-2/README.md +++ b/docs/plugins/wifi-wizard-2/README.md @@ -1,20 +1,29 @@ +--- +description: >- + WifiWizard2 plugin for Cordova and Ionic. WifiWizard2 enables Wifi management for both Android and iOS applications within Cordova/Phonegap projects. This… +--- + # WifiWizard2 -``` -$ ionic cordova plugin add cordova-plugin-wifiwizard2 -$ npm install @awesome-cordova-plugins/wifi-wizard-2 -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-wifiwizard2 +npm install @awesome-cordova-plugins/wifi-wizard-2 +``` + +**Plugin Repo:** [https://github.com/tripflex/WifiWizard2](https://github.com/tripflex/WifiWizard2) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/wonderpush/README.md b/docs/plugins/wonderpush/README.md index bbdcfab9c..8d88a190c 100644 --- a/docs/plugins/wonderpush/README.md +++ b/docs/plugins/wonderpush/README.md @@ -1,14 +1,10 @@ +--- +description: >- + Push Notifications - WonderPush plugin for Cordova and Ionic. Send unlimited push notifications to iOS and Android devices. Get started in minutes: [Ionic… +--- + # Push Notifications - WonderPush -``` -$ ionic cordova plugin add wonderpush-cordova-sdk --variable CLIENT_ID=YOUR_CLIENT_ID --variable CLIENT_SECRET=YOUR_CLIENT_SECRET -$ npm install @awesome-cordova-plugins/wonderpush -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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). @@ -20,8 +16,21 @@ 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 +## Installation + +```bash +ionic cordova plugin add wonderpush-cordova-sdk --variable CLIENT_ID=YOUR_CLIENT_ID --variable CLIENT_SECRET=YOUR_CLIENT_SECRET +npm install @awesome-cordova-plugins/wonderpush +``` + +**Plugin Repo:** [https://github.com/wonderpush/wonderpush-cordova-sdk](https://github.com/wonderpush/wonderpush-cordova-sdk) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/youtube-video-player/README.md b/docs/plugins/youtube-video-player/README.md index e3fe1549e..958811844 100644 --- a/docs/plugins/youtube-video-player/README.md +++ b/docs/plugins/youtube-video-player/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Youtube Video Player plugin for Cordova and Ionic. Plays YouTube videos in Native YouTube App +--- + # Youtube Video Player -``` -$ ionic cordova plugin add cordova-plugin-youtube-video-player -$ npm install @awesome-cordova-plugins/youtube-video-player -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/youtube-video-player/) - -Plugin Repo: [https://github.com/ihadeed/CordovaYoutubeVideoPlayer](https://github.com/ihadeed/CordovaYoutubeVideoPlayer) - Plays YouTube videos in Native YouTube App -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-youtube-video-player +npm install @awesome-cordova-plugins/youtube-video-player +``` + +**Plugin Repo:** [https://github.com/ihadeed/CordovaYoutubeVideoPlayer](https://github.com/ihadeed/CordovaYoutubeVideoPlayer) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/zbar/README.md b/docs/plugins/zbar/README.md index 297872647..c8d38f0bb 100644 --- a/docs/plugins/zbar/README.md +++ b/docs/plugins/zbar/README.md @@ -1,20 +1,29 @@ +--- +description: >- + ZBar plugin for Cordova and Ionic. The ZBar Scanner Plugin allows you to scan 2d barcodes. Requires Cordova plugin: `cordova-plugin-cszbar`. For more info,… +--- + # ZBar -``` -$ ionic cordova plugin add cordova-plugin-cszbar -$ npm install @awesome-cordova-plugins/zbar -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-cszbar +npm install @awesome-cordova-plugins/zbar +``` + +**Plugin Repo:** [https://github.com/tjwoon/csZBar](https://github.com/tjwoon/csZBar) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/zeroconf/README.md b/docs/plugins/zeroconf/README.md index 450c6d56c..a0ae3eb2f 100644 --- a/docs/plugins/zeroconf/README.md +++ b/docs/plugins/zeroconf/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Zeroconf plugin for Cordova and Ionic. This plugin allows you to browse and publish Zeroconf/Bonjour/mDNS services. +--- + # Zeroconf -``` -$ ionic cordova plugin add cordova-plugin-zeroconf -$ npm install @awesome-cordova-plugins/zeroconf -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova-plugin-zeroconf +npm install @awesome-cordova-plugins/zeroconf +``` + +**Plugin Repo:** [https://github.com/becvert/cordova-plugin-zeroconf](https://github.com/becvert/cordova-plugin-zeroconf) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/zip/README.md b/docs/plugins/zip/README.md index af6a46caa..bb072538e 100644 --- a/docs/plugins/zip/README.md +++ b/docs/plugins/zip/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Zip plugin for Cordova and Ionic. A Cordova plugin to unzip files in Android and iOS. +--- + # Zip -``` -$ ionic cordova plugin add cordova-plugin-zip -$ npm install @awesome-cordova-plugins/zip -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/zip/) - -Plugin Repo: [https://github.com/MobileChromeApps/cordova-plugin-zip](https://github.com/MobileChromeApps/cordova-plugin-zip) - A Cordova plugin to unzip files in Android and iOS. -## Supported platforms +## Installation + +```bash +ionic cordova plugin add cordova-plugin-zip +npm install @awesome-cordova-plugins/zip +``` + +**Plugin Repo:** [https://github.com/MobileChromeApps/cordova-plugin-zip](https://github.com/MobileChromeApps/cordova-plugin-zip) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/docs/plugins/zoom/README.md b/docs/plugins/zoom/README.md index 65c154872..d87f8d5f1 100644 --- a/docs/plugins/zoom/README.md +++ b/docs/plugins/zoom/README.md @@ -1,18 +1,27 @@ +--- +description: >- + Zoom plugin for Cordova and Ionic. A Cordova plugin to use Zoom Video Conferencing services on Cordova applications. +--- + # Zoom -``` -$ ionic cordova plugin add cordova.plugin.zoom -$ npm install @awesome-cordova-plugins/zoom -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/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 +## Installation + +```bash +ionic cordova plugin add cordova.plugin.zoom +npm install @awesome-cordova-plugins/zoom +``` + +**Plugin Repo:** [https://github.com/zoom/zoom-sdk-ionic](https://github.com/zoom/zoom-sdk-ionic) + +## Supported Platforms - Android - iOS +## Further Information + +- [Installation Guide](../../installation.md) +- [FAQ](../../faq.md) diff --git a/scripts/docs/generate-readmes.ts b/scripts/docs/generate-readmes.ts index 60fb4c529..c96c3b146 100644 --- a/scripts/docs/generate-readmes.ts +++ b/scripts/docs/generate-readmes.ts @@ -124,35 +124,50 @@ function getTagValue(reflection: DeclarationReflection, tagName: string): string .trim(); } +function truncate(text: string, maxLen: number): string { + if (text.length <= maxLen) return text; + return text.slice(0, maxLen - 1).replace(/\s+\S*$/, '') + '…'; +} + function generateReadme(name: string, pluginSlug: string, description: string, meta: PluginMeta): string { const installCmd = meta.install ?? `ionic cordova plugin add ${meta.plugin ?? 'PLUGIN_NAME'}`; const npmPkg = `@awesome-cordova-plugins/${pluginSlug}`; - let readme = `# ${name}\n\n`; + const metaDescription = description + ? truncate(`${name} plugin for Cordova and Ionic. ${description.replace(/\n/g, ' ')}`, 160) + : `${name} — Awesome Cordova Plugins wrapper for Ionic and Cordova apps.`; - readme += '```\n'; - readme += `$ ${installCmd}\n`; - readme += `$ npm install ${npmPkg}\n`; - readme += '```\n\n'; + // GitBook YAML frontmatter for SEO meta description + let readme = `---\ndescription: >-\n ${metaDescription}\n---\n\n`; - readme += `## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/${pluginSlug}/)\n\n`; - - if (meta.repo) { - readme += `Plugin Repo: [${meta.repo}](${meta.repo})\n\n`; - } + readme += `# ${name}\n\n`; if (description) { readme += `${description}\n\n`; } + readme += '## Installation\n\n'; + readme += '```bash\n'; + readme += `${installCmd}\n`; + readme += `npm install ${npmPkg}\n`; + readme += '```\n\n'; + + if (meta.repo) { + readme += `**Plugin Repo:** [${meta.repo}](${meta.repo})\n\n`; + } + if (meta.platforms && meta.platforms.length > 0) { - readme += '## Supported platforms\n\n'; + readme += '## Supported Platforms\n\n'; for (const platform of meta.platforms) { readme += `- ${platform}\n`; } readme += '\n'; } + readme += '## Further Information\n\n'; + readme += `- [Installation Guide](../../installation.md)\n`; + readme += `- [FAQ](../../faq.md)\n`; + return readme; }