Skip to content

eea/volto-columns-block

Repository files navigation

volto-columns-block

Releases

Pipeline Lines of Code Coverage Bugs Duplicated Lines (%)

Pipeline Lines of Code Coverage Bugs Duplicated Lines (%)

Volto add-on

Features

This package gives you a block with columns. Each column is its own separate blocks container.

Initializing Columns Layout Columns Edit Example Columns Sidebar Single Column Sidebar Columns View Example

Getting started

Try volto-columns-block with Docker

  git clone https://github.com/eea/volto-columns-block.git
  cd volto-columns-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-columns-block to your Volto project

For Volto 18 and newer, create projects with Cookieplone. See the official Plone documentation: Install Plone with Cookieplone and Install an add-on in Volto 18 and 19.

  1. If you do not already have a project, create one:

    uvx cookieplone project
    cd project-title
    make install
    
  2. Install the add-on in your Volto project:

    pnpm --filter <name-of-your-policy-add-on> add @eeacms/volto-columns-block
    
  3. Add the add-on to volto.config.js:

    const addons = ['@eeacms/volto-columns-block'];
  4. Start Plone:

    make backend-start
    make frontend-start
    
  5. Go to http://localhost:3000

  6. Happy editing!

For legacy Volto 17 projects, keep using the yarn-based Volto 17 workflow.

Upgrade

Upgrading to 9.x

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

Breaking changes

  • Removed EditBlockWrapper.jsx. Any code importing EditBlockWrapper from @eeacms/volto-columns-block will break. Use Volto's built-in EditBlockWrapper from @plone/volto/components/manage/Blocks/Block/EditBlockWrapper if you need a custom wrapper.
  • Moved the column-settings button into the block sidebar. The floating column.svg icon button that appeared over each column in edit mode has been removed. Column settings are now accessible directly from the block sidebar via the ColumnsWidget.
  • ColumnsBlockSchema signature changed. ColumnsBlockSchema now receives a single object { intl, formData } instead of just intl. Any code calling ColumnsBlockSchema(intl) must be updated to ColumnsBlockSchema({ intl, formData }).

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)

About

A Volto block that provides columns of blocks

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Generated from eea/volto-addon-template