@eeacms/volto-hero-block
v9.0.2
Published
@eeacms/volto-hero-block: Volto add-on
Readme
volto-hero-block
Enhanced Hero Block Volto add-on
Features

Upgrade
Upgrading to 9.x
This version requires
Volto >= 17.18orVolto 18+. It removes the customEditBlockWrapperusage in favor of Volto's built-in block chrome provided byBlocksForm.
Breaking changes
- Removed
EditBlockWrapperrender prop fromBlocksForm. TheBlocksFormchildren render prop that wrapped each inner block in<EditBlockWrapper>has been removed.BlocksFormnow handles block chrome internally via Volto core'sEditBlockWrapper. Any code that relied on the children render prop pattern in the hero block'sEditcomponent will need to be updated. disableInnerButtonscontinues to work via the existing CSS rules inedit.cssrather than the previously useddisabledprop onEditBlockWrapper.
Upgrading to 2.x
This version requires: @plone/volto >= 16.0.0.alpha.46 (schemaEnhancer / addStyling).
Upgrading to 6.x
Starting with version 6.0.0 we have the following breaking changes from version 5.x.x:
- Removed inner
divthat was used to addquoted-wrapperclass. Thisclassis now added on the maindivalongside the otherblockoptions. - Block is using
BlocksFormto add more than oneSlateblocks. This is useful in case you have to add some sub titles or extra paragraphs inside theHero block. The defaultSlatetag is stillh2but you can change it using the rich text options toolbar.
Getting started
Try volto-hero-block with Docker
git clone https://github.com/eea/volto-hero-block.git
cd volto-hero-block
make
make startGo to http://localhost:3000
make start now defaults to Volto 18. To run the same setup against Volto 17, use:
VOLTO_VERSION=17 make
VOLTO_VERSION=17 make startAdd volto-hero-block to your Volto project
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-hero-block": "*" }and
volto.config.js:const addons = ['@eeacms/volto-hero-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-startFor a legacy Volto 17 project, install the package with
yarnand restart the frontend as usual.Go to http://localhost:3000
Happy editing!
Release
See RELEASE.md.
How to contribute
See DEVELOP.md.
Copyright and license
The Initial Owner of the Original Code is European Environment Agency (EEA). All Rights Reserved.
See LICENSE.md for details.
