@eeacms/volto-description-block
Volto Description block based on volto-slate that automatically strips HTML and updates Document description metadata field.
Features
Upgrade
Upgrading to 4.x
This version requires
Volto 18orVolto 19and Node.js 22.
The block keeps the same API, so upgrading from 3.x on Volto 18 needs no code changes. The release adds Volto 19 support and moves the repository to the Volto 19 layout, where the published package lives in packages/volto-description-block.
Breaking changes
- Node.js 22 or newer is required (
engines.node >= 22), 3.x declared no engine. - React 18 is required. The package declares
reactandreact-domas^18.2.0peers, 3.x declared no peers. - The package no longer ships the Jest setup.
jest-addon.config.jsandjest.setup.jswere removed in favour of Vitest, so a Volto 18 project that still runs the Jest harness has to keep its own copy.
The published manifest declares no runtime dependency in either version: the additions are the React peers, the Node.js engine and the development toolchain for Vitest.
Requirements
Backend
Frontend
- Node.js:
>=22.0.0
Installation
Make sure you have a Plone backend up-and-running at http://localhost:8080/Plone
docker compose up backendStart Volto frontend
If you already have a volto project, just update
package.json:"dependencies": { "@eeacms/volto-description-block": "*" }and
volto.config.js:const addons = ['@eeacms/volto-description-block'];If not, create one with Cookieplone, as recommended by the official Plone documentation for Volto 18+:
uvx cookieplone project cd project-title
Install or update dependencies, then start the project:
make installFor a Cookieplone project, start the backend and frontend in separate terminals:
make backend-start make frontend-startGo to http://localhost:3000
Happy editing!
License
See LICENSE.md for details.
