Cordova Management Tips
1) Use the Ionic CLI to add/update/delete plugins.
Instead of directly editing
ionic in front of Cordova commands for a better experience and additional functionality (
ionic cordova build ios instead of
cordova build ios).
2) Upgrade plugins by removing, then re-adding them.
$ ionic cordova plugin remove cordova-plugin-camera
$ ionic cordova plugin add cordova-plugin-camera
3) Install explicit versions.
To ensure that the same version of a plugin is always installed via
npm install, specify the version number:
ionic cordova plugin add email@example.com
4) Restore Cordova in an existing Ionic project
Useful when adding new developers to a project.
ionic cordova prepare restores platforms and plugins from
config.xml. The version to be installed is taken from
config.xml, if found in those files. In case of conflicts,
package.json is given precedence over
5) Troubleshoot Cordova issues with Ionic CLI commands
ionic doctor list: Detects common issues and suggests steps to fix them
ionic repair: Remove, then regenerate all dependencies
Understanding Version Numbers
For any given Ionic Native plugin, the Ionic Native (TypeScript code) and Cordova (native code) version numbers will not match. The Ionic Native version number is found in
The Cordova plugin version number is found in both
<plugin name="cordova-plugin-camera" spec="4.0.3" />
When checking for new native functionality or bug fixes, look for new versions on the Cordova plugin GitHub page itself (here's the Camera one, for example).
To check for new Ionic Native releases (may include exposing methods recently added by the Cordova plugin, etc.), see here.
Troubleshooting Failed Builds
Research the build error(s) by checking out these resources:
- Google & StackOverflow: Many issues are documented online
- Ask the Ionic Community Ionic Forum (see the Ionic Native category)
- See the Ionic Customer Success Knowledge Base
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
The most Ionic 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 a new feature/bug is released: Run
npm outdatedto see a list of available updates.
- When new major versions are released: Official blogs, such as the Cordova blog and Ionic blog, will publish announcements and news.
- Evaluate the nature of the update: is it a shiny new feature or critical security fix?
- Timing: Where does it fit in against your team's project goals?