Install an add-on in Volto

This document describes how to install an add-on in Volto.

You can install an add-on just like any other JavaScript package from the npm Registry.

If the add-on is not published on the npm Registry, you can install it directly from GitHub.

Next, you need to add the add-on to the addons key of your Plone project's package.json.

{
  "name": "my-volto-project",
  "addons": [
    "name-of-add-on"
  ]
}

See also

Alternatively, you can use volto.config.js to declare add-ons in your Plone project. See Programmatically define the active add-ons and theme.