NPM Plugin Search FAQ

What is npm Plugin Search?

On April 21 2015, Cordova team announced plans to move core and 3rd party plugins to npm ecosystem. npm Plugin Search page offers an easy and user friendly way to browse plugins that have completed this transition.

What version of Cordova do I need to use npm?

To start using plugins from npm, Cordova CLI version 5.0.0 or higher is required.

How do I install plugins from npm?

Cordova team decided to change official plugin IDs from org.apache.cordova.* to cordova-plugin-* to better fit within the npm ecosystem. Developers can install a plugin using the command cordova plugin add cordova-plugin-device.

How do I know which platforms are supported for a plugin?

Plugin Search displays plugins in form of cards. Each card contains important information about the plugin. Supported platforms is represented in form of platform tags.

How can I find official core plugins?

Core plugins have a blue strip on the left side of their card.

How do I add a new plugin to Plugin Search?

If you want your Cordova Plugin to show up in search, simply add ecosystem:cordova keyword to the package.json file of your plugin and publish it to npm registry.

How can I tag supported platforms for my plugin?

Similar to ecosystem:cordova, platform support too uses keywords. Just add the platform name prefixed with "cordova-" to plugins list of keywords. E.g.

  "keywords": [
    "ecosystem:cordova",
    "cordova-android",
    "cordova-ios",
    "cordova-windows"
  ]

Can I still download plugins if I'm using Cordova CLI 4.3.0 or lower?

Yes! You can use Cordova Plugins from the old plugin registry.

What’s happening to the old plugin registry?

See Cordova blog for more details. It’s being phased out:

• Read-only after July 15th
• End of support after October 15th

I don't like X. How can I help improve the website?

You can help improving this site by opening bugs on JIRA or by sending PRs on GitHub.