Skip to content

This add-on enables ad-hoc grouping of Volto blocks under sections and tabs

License

Notifications You must be signed in to change notification settings

eea/volto-tabs-block

Repository files navigation

volto-tabs-block

Releases

Pipeline Lines of Code Coverage Bugs Duplicated Lines (%)

Pipeline Lines of Code Coverage Bugs Duplicated Lines (%)

Volto add-on

Features

IMPORTANT! Because this depends on @eeacms/volto-block-style, you should always load this addon as the last addon in Volto project configuration or after @eeacms/volto-block-style.

Tabs Block

Getting started

Try volto-tabs-block with Docker

  git clone https://github.com/eea/volto-tabs-block.git
  cd volto-tabs-block
  make
  make start

Go to http://localhost:3000

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

    npm install -g yo @plone/generator-volto
    yo @plone/volto my-volto-project --canary --addon @eeacms/volto-tabs-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!

Upgrade

Upgrading to 7.0.0

Version 7 introduces the following breaking changes:

  • The templates are now variations of the default template, so if you have custom templates, you need to update them to be variations of the default template.
  • All variations have schema enhancers, see https://github.com/eea/volto-eea-website-theme/blob/develop/src/index.js#L40 for example on how to customize the variation schema.
  • Some defaults have been changed, see the schema.js files for any default values.
  • Tabs now have the ability to reference an Image or use a Semantic UI icon within the tab title, even allowing the hiding of the text title.
  • Responsive template no longer uses react-responsive-tabs styles but use accordion classes when it's transformed into accordion. Bring your own style for the accordion if you want to customize it.
  • Cleaned up styling in favor of Semantic UI styling and to bring your own styling.
  • Better i18n support for the block especially in edit mode.

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)