volto-accordion-block

Volto accordions block.

Features

• Accordion Component Storybook.

Getting started

Try volto-accordion-block with Docker

  git clone https://github.com/eea/volto-accordion-block.git
  cd volto-accordion-block
  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

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

  "dependencies": {
      "@eeacms/volto-accordion-block": "*"
  }

  and volto.config.js:

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

• 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!

Upgrade

Upgrading to 13.x

This version requires Volto >= 17.18 or Volto 18+. It removes the custom EditBlockWrapper and NewBlockAddButton components in favor of Volto's built-in block chrome provided by BlocksForm.

Breaking changes

• Removed the "Section help" button. The ? icon that appeared in the inner block toolbar and opened the sidebar to display editing instructions has been removed. The instructions field is still available in the accordion schema and still rendered in the sidebar panel, but there is no longer a per-block shortcut button to reveal it.
• Removed EditBlockWrapper.jsx and NewBlockAddButton.jsx. Any code importing these from @eeacms/volto-accordion-block will break. Use Volto's built-in EditBlockWrapper from @plone/volto/components/manage/Blocks/Block/EditBlockWrapper if you need a custom wrapper.
• disableInnerButtons is now implemented via a CSS class (.disable-inner-buttons) instead of a JS-level disabled prop on the removed wrapper.

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)