volto-listing-block

Volto add-on

Features

This package aims to provide a framework for more flexible listings for the Listing Volto block. It introduces the concept of UniversalCard, which is a generic component governed by a designated "itemModel".

It provides several views and integrates with the Teaser Grid.

Upgrade

Upgrading to 1.x

This version requires: @plone/volto >= 16.0.0.alpha.15 (volto-slate part of Volto Core).

Getting started

Try volto-listing-block with Docker

1. Get the latest Docker images

   docker pull plone
   docker pull plone/volto
   

2. Start Plone backend

   docker run -d --name plone -p 8080:8080 -e SITE=Plone -e PROFILES="profile-plone.restapi:blocks" plone
   

3. Start Volto frontend

   docker run -it --rm -p 3000:3000 --link plone -e ADDONS="@eeacms/volto-listing-block" plone/volto
   

4. Go to http://localhost:3000

Add volto-listing-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-listing-block"
  ],
  
  "dependencies": {
      "@eeacms/volto-listing-block": "^1.0.0"
  }

• If not, create one:

  npm install -g yo @plone/generator-volto
  yo @plone/volto my-volto-project --addon @eeacms/volto-listing-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) eea.europa.eu)