This guide will help you get started creating a shareable Capacitor plugin which will be published on npm. You can also create Capacitor plugins local to your app. See the custom native code guides for iOS and Android.
If your plugin is intended for the public, we have a few philosophies about Capacitor plugins to share before you get started.
We believe cooperation is going to yield higher quality plugins than competition. This is one of the reasons we created the Capacitor Community GitHub organization, which facilitates easier cooperation among the community than if plugins were hosted in personal repositories.
If a plugin exists for a particular topic within the Capacitor Community, please consider contributing to it! If a plugin is missing a primary maintainer, the Capacitor team would be happy to consider adding you to the GitHub organization.
We believe Capacitor plugins should be reasonably small in scope. Capacitor plugins add native code to apps that may or may not be used. By keeping the scope of plugins small, we can ensure apps have a minimal amount of native code that they need. This avoids unnecessary app bloat and warnings/rejections from the App Store due to APIs without usage descriptions, etc.
Of course, having a small scope yields other benefits such as quicker deployment, easier cooperation, maintainability, etc.
Here are a few guidelines with examples to demonstrate how to create a unified and idiomatic experience:
nulland other nonvalues. Example: If an Android API returns
0.0to denote “no value”, then the value should be coerced to
Datefrom a string like
Ready to begin? Capacitor has a plugin generator that you can use to begin working on your plugin.
Before continuing, you may want to make sure you’re using the latest Node LTS version and npm 6+.
In a new terminal, run the following:
npm init @capacitor/plugin
The generator will prompt you for input. You can also supply command-line options (see the GitHub repo).