Skip to content

eea/volto-hero-block

Repository files navigation

volto-hero-block

Releases

Pipeline Lines of Code Coverage Bugs Duplicated Lines (%)

Pipeline Lines of Code Coverage Bugs Duplicated Lines (%)

Enhanced Hero Block Volto add-on

Features

Hero Block

Upgrade

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:

  1. Removed inner div that was used to add quoted-wrapper class. This class is now added on the main div alongside the other block options.
  2. Block is using BlocksForm to add more than one Slate blocks. This is useful in case you have to add some sub titles or extra paragraphs inside the Hero block. The default Slate tag is still h2 but 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 start

Go to http://localhost:3000

Add volto-hero-block to your Volto project

  1. Make sure you have a Plone backend up-and-running at http://localhost:8080/Plone

    docker compose up backend
  2. Start Volto frontend

  • If you already have a volto project, just update package.json:

    "addons": [
        "@eeacms/volto-hero-block"
    ],
    
     "dependencies": {
         "@eeacms/volto-hero-block": "*"
     }
  • If not, create one:

    npm install -g yo @plone/generator-volto
    yo @plone/volto my-volto-project --canary --addon @eeacms/volto-hero-block
    cd my-volto-project
    
  1. Install new add-ons and restart Volto:

    yarn
    yarn start
    
  2. Go to http://localhost:3000

  3. 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.

Funding

European Environment Agency (EU)