@capacitor/create-plugin

Create a new Capacitor plugin ⚡️

Showing:

Popularity

Downloads/wk

204

GitHub Stars

21

Maintenance

Last Commit

19d ago

Contributors

8

Package

Dependencies

7

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Create Capacitor Plugin

Generate a new Capacitor plugin.

Usage

npm init @capacitor/plugin [<path>] [options]

📝 npm init <pkg> requires npm 6+

You can also try the following methods to use this package:

  • npx @capacitor/create-plugin
  • yarn create @capacitor/plugin
  • npm install -g @capacitor/create-plugin && create-capacitor-plugin

Options

--name <name> ............. npm package name (e.g. "capacitor-plugin-example")
--package-id <id> ......... Unique plugin ID in reverse-DNS notation (e.g. "com.mycompany.plugins.example")
--class-name <name> ....... Plugin class name (e.g. "Example")
--repo <url> .............. URL to git repository (e.g. "https://github.com/example/repo")
--author <author> ......... Author name and email (e.g. "Name <name@example.com>")
--license <id> ............ SPDX License ID (e.g. "MIT")
--description <text> ...... Short description of plugin features

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100