Skip to content
On this page

Npm Compatibility

Using NodeJS project

We strongly recommend that you to use NodeJS project to build your plugins.

With TypeScript or other languages that require transpilation, you need a build tool to build them, Webpack, Rollup or Vite is the best choice.

You can also use any front-end library to build custom UI, e.g. React, Preact, Vue, Svelte, SolidJS, etc. With front-end tooling, its hot-reload/HMR will help you to do faster.


Note that npm packages those are designed to run only in NodeJS cannot be used to build plugins.


With the build tool, the output of your bundled assets may have incorrect paths. Please refer to the Asset Handling to make correct them.

Example plugins

Webpack 📦

Vite ⚡

Released under the WTF License.