danielsogl / awesome-cordova-plugins

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 mobile app easy. Awesome Cordova Plugins wraps plugin callbacks in a Promise or Observable, providing a common interface for all plugins and making it easy to use plugins with Angular change detection. To learn more about the reasons why Ionic Native was renamed to Awesome Cordova Plugins, read the official Ionic blog post by Max Lyncht. Capacitor Support In addition to Cordova, Awesome Cordova Plugins also works with Capacitor, Ionic's official native runtime. Basic usage below. For complete details, see the Capacitor documentation. Installation Run following command to install Awesome Cordova Plugins in your project. You also need to install the Awesome Cordova Plugins package for each plugin you want to add. Please see the Awesome Cordova Plugins documentation for complete instructions on how to add and use the plugins. Documentation For the full Awesome Cordova Plugins documentation, please visit https://ionicframework.com/docs/native/. Basic Usage Ionic/Angular apps (Standalone) Angular v14+ uses standalone components by default. To use a plugin, register it as a provider in your application bootstrap and inject it using Angular's function. Make sure to import the injectable class from the directory as shown in the following examples: Ionic/React apps React apps must use Capacitor to build native mobile apps. However, Awesome Cordova Plugins (and therefore, Cordova plugins) can still be used. Import the plugin object then use its static methods: ES2015+/TypeScript (without Angular) These modules can also be used without Angular by calling static methods directly: Mocking and Browser Development (Ionic/Angular apps only) Awesome Cordova Plugins makes it possible to mock plugins and develop nearly the entirety of your app in the browser or in . To do this, you need to provide a mock implementation of the plugins you wish to use. Here's an example of mocking the plugin to return a stock image while in development: First create a mock class that extends the class: Then override the provider in your application bootstrap: Runtime Diagnostics Spent way too long diagnosing an issue only to realize a plugin wasn't firing or installed? Awesome Cordova Plugins lets you know what the issue is and how you can resolve it. Plugin Missing? Let us know or submit a PR! Take a look at the Developer Guide for more on how to contribute. :heart: Credits Ibby Hadeed - @ihadeed Daniel Sogl - LinkedIn Tim Lancina - @timlancina Mike Hartington - @mhartington Max Lynch - @maxlynch Rob Wormald - @robwormald