Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eea/volto-columns-block

A Volto block that provides columns of blocks
https://github.com/eea/volto-columns-block

volto volto-addon volto-block volto-columns

Last synced: 3 months ago
JSON representation

A Volto block that provides columns of blocks

Host: GitHub
URL: https://github.com/eea/volto-columns-block
Owner: eea
License: mit
Created: 2020-09-17T08:43:53.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2024-04-22T17:20:12.000Z (7 months ago)
Last Synced: 2024-07-19T05:44:11.653Z (4 months ago)
Topics: volto, volto-addon, volto-block, volto-columns
Language: JavaScript
Homepage:
Size: 801 KB
Stars: 9
Watchers: 39
Forks: 4
Open Issues: 4
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

awesome-volto - volto-columns-block - Enables grouping Volto blocks as columns (Addons / Layout addons)

README

        # volto-columns-block

[![Releases](https://img.shields.io/github/v/release/eea/volto-columns-block)](https://github.com/eea/volto-columns-block/releases)

[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-columns-block%2Fmaster&subject=master)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-columns-block/job/master/display/redirect)

[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-columns-block-master&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-columns-block-master)

[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-columns-block-master&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-columns-block-master)

[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-columns-block-master&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-columns-block-master)

[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-columns-block-master&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-columns-block-master)

[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-columns-block%2Fdevelop&subject=develop)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-columns-block/job/develop/display/redirect)

[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-columns-block-develop&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-columns-block-develop)

[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-columns-block-develop&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-columns-block-develop)

[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-columns-block-develop&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-columns-block-develop)

[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-columns-block-develop&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-columns-block-develop)

[Volto](https://github.com/plone/volto) add-on

## Features

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

blocks container.

![Initializing Columns Layout](https://raw.githubusercontent.com/eea/volto-columns-block/master/docs/initialize.png)

![Columns Edit Example](https://raw.githubusercontent.com/eea/volto-columns-block/master/docs/edit.png)

![Columns Sidebar](https://raw.githubusercontent.com/eea/volto-columns-block/master/docs/columns-sidebar.png)

![Single Column Sidebar](https://raw.githubusercontent.com/eea/volto-columns-block/master/docs/single-column-sidebar.png)

![Columns View Example](https://raw.githubusercontent.com/eea/volto-columns-block/master/docs/view.png)

## 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

### Add volto-columns-block to your Volto project

1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone

   ```Bash

   docker compose up backend

   ```

1. Start Volto frontend

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

   ```JSON

   "addons": [

       "@eeacms/volto-columns-block"

   ],

   "dependencies": {

       "@eeacms/volto-columns-block": "*"

   }

   ```

* If not, create one:

   ```

   npm install -g yo @plone/generator-volto

   yo @plone/volto my-volto-project --canary --addon @eeacms/volto-columns-block

   cd my-volto-project

   ```

1. Install new add-ons and restart Volto:

   ```

   yarn

   yarn start

   ```

1. Go to http://localhost:3000

1. Happy editing!

## Release

See [RELEASE.md](https://github.com/eea/volto-columns-block/blob/master/RELEASE.md).

## How to contribute

See [DEVELOP.md](https://github.com/eea/volto-columns-block/blob/master/DEVELOP.md).

## Copyright and license

The Initial Owner of the Original Code is European Environment Agency (EEA).

All Rights Reserved.

See [LICENSE.md](https://github.com/eea/volto-columns-block/blob/master/LICENSE.md) for details.

## Funding

[European Environment Agency (EU)](http://eea.europa.eu)