Skip to content

plone-ve/volto-block-style

 
 

Repository files navigation

volto-block-style

Releases

Pipeline Lines of Code Coverage Bugs Duplicated Lines (%)

Pipeline Lines of Code Coverage Bugs Duplicated Lines (%)

Volto add-on to style blocks and other components

Features

A generic framework to style blocks and other components.

To configure it, set settings.pluggableStylesBlocksWhitelist as a list of block types that you want to enable. By default it is enabled for all blocks.

IMPORTANT! Because of the way it works, you should always load this addon as the last addon in Volto project configuration.

Screenshot

Getting started

Try volto-block-style 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-block-style" plone/volto
    
  4. Go to http://localhost:3000

Add volto-block-style 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-block-style"
    ],
    
    "dependencies": {
        "@eeacms/volto-block-style": "^1.0.0"
    }
  • If not, create one:

    npm install -g yo @plone/generator-volto
    yo @plone/volto my-volto-project --addon @eeacms/volto-block-style
    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)

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 81.7%
  • CSS 11.9%
  • Makefile 3.5%
  • Less 2.7%
  • Dockerfile 0.2%