volto-banner

Volto add-on

Features

A customizable banner to highlight to the user that the website is in demo, dev or staging state.

It is configurable through /controlpanel/banner.

Upgrades

Upgrade to 2.x.x

• Version 2.x.x requires eea.banner Plone add-on to be installed on backend.

Getting started

Try volto-banner with Docker

  git clone https://github.com/eea/volto-banner.git
  cd volto-banner
  make
  make start

Go 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 start

To reproduce the Volto Light Theme integration, set VLT_ENABLED to any non-empty value, for example:

  VLT_ENABLED=1 make
  VLT_ENABLED=1 make start

Add volto-banner 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:

  "dependencies": {
      "@eeacms/volto-banner": "*"
  }

  and volto.config.js:

  const addons = ['@eeacms/volto-banner'];

• If not, create one with Cookieplone, as recommended by the official Plone documentation for Volto 18+:

  uvx cookieplone project
  cd project-title

1. Install or update dependencies, then start the project:

   make install

   For a Cookieplone project, start the backend and frontend in separate terminals:

   make backend-start
   make frontend-start

   For a legacy Volto 17 project, install the package with yarn and restart the frontend as usual.

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)