Load configuration from add-ons

As a convenience, an add-on can export configuration functions that can mutate in-place the overall Volto configuration registry. An add-on can export multiple configuration methods, making it possible to selectively choose which specific add-on functionality you want to load.

Some add-ons might allow the Volto project to selectively load some of their configuration, so they may offer additional configuration functions. You can load them by overloading the add-on name in the addons package.json key, as shown.

{
  "name": "my-nice-volto-project",
  "addons": [
    "acme-volto-foo-add-on:loadOptionalBlocks,overrideSomeDefaultBlock",
    "volto-ga"
  ],
}

Note

The additional comma-separated names should be exported from the add-on package's index.js. The main configuration function should be exported as the default. An add-on's default configuration method will always be loaded.

If for some reason you want to manually load the add-on, you can edit your project's config.js module:

import loadExampleAddon, { enableOptionalBlocks } from 'volto-example-add-on';
import * as voltoConfig from '@plone/volto/config';

const config = enableOptionalBlocks(loadExampleAddon(voltoConfig));

export blocks = {
  ...config.blocks,
}

Volto provides a helper method applyConfig to do the same.

import { applyConfig } from '@plone/volto/helpers';
import * as voltoConfig from '@plone/volto/config';

const config = applyConfig([
    enableOptionalBlocks,
    loadExampleAddon
], voltoConfig);

export blocks = {
  ...config.blocks,
}

The applyConfig helper ensures that each configuration method returns the configuration object, avoiding errors when developing add-ons.