https://github.com/eea/volto-eea-kitkat
EEA Volto Add-ons bundle: A known good set of Volto addons to be used within all EEA projects
https://github.com/eea/volto-eea-kitkat
plone react volto volto-addon volto-addons-bundle volto-addons-kit volto-bundle volto-kitkat
Last synced: 5 days ago
JSON representation
EEA Volto Add-ons bundle: A known good set of Volto addons to be used within all EEA projects
- Host: GitHub
- URL: https://github.com/eea/volto-eea-kitkat
- Owner: eea
- License: mit
- Created: 2021-08-26T14:28:03.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2025-05-28T06:36:09.000Z (22 days ago)
- Last Synced: 2025-05-28T06:46:11.705Z (22 days ago)
- Topics: plone, react, volto, volto-addon, volto-addons-bundle, volto-addons-kit, volto-bundle, volto-kitkat
- Language: JavaScript
- Homepage:
- Size: 1.08 MB
- Stars: 7
- Watchers: 30
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-volto - volto-eea-kitkat - A known good set of Volto add-ons to be used within all EEA projects and beyond, made for [European Environment Agency](https://www.eea.europa.eu/en) (Websites built with Volto / Open-source websites built with Volto)
README
# volto-eea-kitkat :chocolate_bar:
[](https://github.com/eea/volto-eea-kitkat/releases)
[](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-eea-kitkat/job/master/display/redirect)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-eea-kitkat-master)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-eea-kitkat-master)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-eea-kitkat-master)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-eea-kitkat-master)[](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-eea-kitkat/job/develop/display/redirect)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-eea-kitkat-develop)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-eea-kitkat-develop)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-eea-kitkat-develop)
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-eea-kitkat-develop)[Volto](https://github.com/plone/volto) Add-ons bundle - A known good set of Volto addons to be used within all EEA projects and beyond.
The [eea.kitkat](https://github.com/eea/eea.kitkat) Plone add-on is the backend support for volto-eea-kitkat.
## Included Volto Add-ons
1. [](https://github.com/eea/volto-chatbot/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-chatbot/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-chatbot/job/develop/display/redirect) [@eeacms/volto-chatbot](https://github.com/eea/volto-chatbot)
1. [](https://github.com/eea/volto-anchors/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-anchors/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-anchors/job/develop/display/redirect) [@eeacms/volto-anchors](https://github.com/eea/volto-anchors)
1. [](https://github.com/eea/volto-matomo/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-matomo/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-matomo/job/develop/display/redirect) [@eeacms/volto-matomo](https://github.com/eea/volto-matomo)
1. [](https://github.com/eea/volto-sentry-rancher-config/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-sentry-rancher-config/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-sentry-rancher-config/job/develop/display/redirect) [@eeacms/volto-sentry-rancher-config](https://github.com/eea/volto-sentry-rancher-config)
1. [](https://github.com/eea/volto-controlpanel/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-controlpanel/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-controlpanel/job/develop/display/redirect) [@eeacms/volto-controlpanel](https://github.com/eea/volto-controlpanel)
1. [](https://github.com/eea/volto-corsproxy/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-corsproxy/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-corsproxy/job/develop/display/redirect) [@eeacms/volto-corsproxy](https://github.com/eea/volto-corsproxy)
1. [](https://github.com/eea/volto-taxonomy/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-taxonomy/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-taxonomy/job/develop/display/redirect) [@eeacms/volto-taxonomy](https://github.com/eea/volto-taxonomy)
1. [](https://github.com/eea/volto-object-widget/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-object-widget/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-object-widget/job/develop/display/redirect) [@eeacms/volto-object-widget](https://github.com/eea/volto-object-widget)
1. [](https://github.com/eea/volto-widget-theme-picker/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-widget-theme-picker/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-widget-theme-picker/job/develop/display/redirect) [@eeacms/volto-widget-theme-picker](https://github.com/eea/volto-widget-theme-picker)
1. [](https://github.com/eea/volto-widget-toggle/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-widget-toggle/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-widget-toggle/job/develop/display/redirect) [@eeacms/volto-widget-toggle](https://github.com/eea/volto-widget-toggle)
1. [](https://github.com/eea/volto-widget-temporal-coverage/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-widget-temporal-coverage/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-widget-temporal-coverage/job/develop/display/redirect) [@eeacms/volto-widget-temporal-coverage](https://github.com/eea/volto-widget-temporal-coverage)
1. [](https://github.com/eea/volto-widget-geolocation/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-widget-geolocation/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-widget-geolocation/job/develop/display/redirect) [@eeacms/volto-widget-geolocation](https://github.com/eea/volto-widget-geolocation)
1. [](https://github.com/eea/volto-slate-metadata-mentions/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-slate-metadata-mentions/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-slate-metadata-mentions/job/develop/display/redirect) [@eeacms/volto-slate-metadata-mentions](https://github.com/eea/volto-slate-metadata-mentions)
1. [](https://github.com/eea/volto-slate-footnote/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-slate-footnote/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-slate-footnote/job/develop/display/redirect) [@eeacms/volto-slate-footnote](https://github.com/eea/volto-slate-footnote)
1. [](https://github.com/eea/volto-slate-zotero/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-slate-zotero/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-slate-zotero/job/develop/display/redirect) [@eeacms/volto-slate-zotero](https://github.com/eea/volto-slate-zotero)
1. [](https://github.com/eea/volto-accordion-block/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-accordion-block/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-accordion-block/job/develop/display/redirect) [@eeacms/volto-accordion-block](https://github.com/eea/volto-accordion-block)
1. [](https://github.com/eea/volto-block-divider/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-block-divider/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-block-divider/job/develop/display/redirect) [@eeacms/volto-block-divider](https://github.com/eea/volto-block-divider)
1. [](https://github.com/eea/volto-listing-block/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-listing-block/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-listing-block/job/develop/display/redirect) [@eeacms/volto-listing-block](https://github.com/eea/volto-listing-block)
1. [](https://github.com/eea/volto-metadata-block/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-metadata-block/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-metadata-block/job/develop/display/redirect) [@eeacms/volto-metadata-block](https://github.com/eea/volto-metadata-block)
1. [](https://github.com/eea/volto-group-block/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-group-block/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-group-block/job/develop/display/redirect) [@eeacms/volto-group-block](https://github.com/eea/volto-group-block)
1. [](https://github.com/eea/volto-columns-block/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-columns-block/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-columns-block/job/develop/display/redirect) [@eeacms/volto-columns-block](https://github.com/eea/volto-columns-block)
1. [](https://github.com/eea/volto-tabs-block/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-tabs-block/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-tabs-block/job/develop/display/redirect) [@eeacms/volto-tabs-block](https://github.com/eea/volto-tabs-block)
1. [](https://github.com/eea/volto-block-image-cards/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-block-image-cards/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-block-image-cards/job/develop/display/redirect) [@eeacms/volto-block-image-cards](https://github.com/eea/volto-block-image-cards)
1. [](https://github.com/eea/volto-nextcloud-video-block/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-nextcloud-video-block/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-nextcloud-video-block/job/develop/display/redirect) [@eeacms/volto-nextcloud-video-block](https://github.com/eea/volto-nextcloud-video-block)
1. [](https://github.com/eea/volto-banner/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-banner/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-banner/job/develop/display/redirect) [@eeacms/volto-banner](https://github.com/eea/volto-banner)
1. [](https://github.com/eea/volto-resize-helper/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-resize-helper/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-resize-helper/job/develop/display/redirect) [@eeacms/volto-resize-helper](https://github.com/eea/volto-resize-helper)
1. [](https://github.com/eea/volto-block-style/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-block-style/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-block-style/job/develop/display/redirect) [@eeacms/volto-block-style](https://github.com/eea/volto-block-style)
1. [](https://github.com/eea/volto-widget-dataprovenance/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-widget-dataprovenance/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-widget-dataprovenance/job/develop/display/redirect) [@eeacms/volto-widget-dataprovenance](https://github.com/eea/volto-widget-dataprovenance)
1. [](https://github.com/eea/volto-slate-label/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-slate-label/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-slate-label/job/develop/display/redirect) [@eeacms/volto-slate-label](https://github.com/eea/volto-slate-label)
1. [](https://github.com/eea/volto-call-to-action-block/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-call-to-action-block/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-call-to-action-block/job/develop/display/redirect) [@eeacms/volto-call-to-action-block](https://github.com/eea/volto-call-to-action-block)
1. [](https://github.com/eea/volto-description-block/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-description-block/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-description-block/job/develop/display/redirect) [@eeacms/volto-description-block](https://github.com/eea/volto-description-block)
1. [](https://github.com/eea/volto-hero-block/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-hero-block/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-hero-block/job/develop/display/redirect) [@eeacms/volto-hero-block](https://github.com/eea/volto-hero-block)
1. [](https://github.com/eea/volto-quote-block/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-quote-block/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-quote-block/job/develop/display/redirect) [@eeacms/volto-quote-block](https://github.com/eea/volto-quote-block)
1. [](https://github.com/eea/volto-statistic-block/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-statistic-block/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-statistic-block/job/develop/display/redirect) [@eeacms/volto-statistic-block](https://github.com/eea/volto-statistic-block)
1. [](https://github.com/eea/volto-tags-block/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-tags-block/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-tags-block/job/develop/display/redirect) [@eeacms/volto-tags-block](https://github.com/eea/volto-tags-block)
1. [](https://github.com/eea/volto-timeline-block/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-timeline-block/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-timeline-block/job/develop/display/redirect) [@eeacms/volto-timeline-block](https://github.com/eea/volto-timeline-block)
1. [](https://github.com/eea/volto-toolbar-actions/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-toolbar-actions/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-toolbar-actions/job/develop/display/redirect) [@eeacms/volto-toolbar-actions](https://github.com/eea/volto-toolbar-actions)
1. [](https://github.com/eea/volto-block-data-table/releases) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-block-data-table/job/master/display/redirect) [](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-block-data-table/job/develop/display/redirect) [@eeacms/volto-block-data-table](https://github.com/eea/volto-block-data-table)
1. [](https://github.com/collective/volto-sentry/releases) [@plone-collective/volto-sentry](https://github.com/collective/volto-sentry)## Upgrade
### Upgrading to 25.x
> This version adds support for `Volto 17` and it is meant to be used with `Volto 17+`. It may work with `Volto 16` but it is not fully backward compatible (especially in Teaser block, anchors, listing), thus upgrading `volto-eea-kitkat` to version `25+` implies also upgrading to `Volto 17+`.
#### Add-ons removed
1. [@kitconcept/volto-blocks-grid](https://github.com/kitconcept/volto-blocks-grid#volto-blocks-grid-by-kitconcept)
#### Add-ons added
1. [@eeacms/volto-block-toc](https://github.com/eea/volto-block-toc)
### Upgrading to 20.x
> This versions comes with `@eeacms/volto-tabs-block 17.x`. See this package [upgrade guide](https://github.com/eea/volto-tabs-block#upgrading-to-700)
### Upgrading to 10.x
> This version requires: `@plone/volto >= 16.0.0.alpha.45` (Sentry removed from Volto Core).
#### New add-ons added
1. [@plone-collective/volto-sentry](https://github.com/collective/volto-sentry#volto-sentry)
1. [@kitconcept/volto-blocks-grid](https://github.com/kitconcept/volto-blocks-grid#volto-blocks-grid-by-kitconcept)
1. [@eeacms/volto-slate-label](https://github.com/eea/volto-slate-label#volto-slate-label)
1. [@eeacms/volto-call-to-action-block](https://github.com/eea/volto-call-to-action-block#volto-call-to-action-block)
1. [@eeacms/volto-description-block](https://github.com/eea/volto-description-block#volto-description-block)
1. [@eeacms/volto-hero-block](https://github.com/eea/volto-hero-block#volto-hero-block)
1. [@eeacms/volto-quote-block](https://github.com/eea/volto-quote-block#volto-quote-block)
1. [@eeacms/volto-statistic-block](https://github.com/eea/volto-statistic-block#volto-statistic-block)
1. [@eeacms/volto-tags-block](https://github.com/eea/volto-tags-block#volto-tags-block)
1. [@eeacms/volto-timeline-block](https://github.com/eea/volto-timeline-block#volto-timeline-block)### Upgrading to 9.x
> This version requires: `@plone/volto >= 16.0.0.alpha.15` (`volto-slate` part of Volto Core).
#### Dropped dependencies (moved to Volto Core)
1. volto-slate
2. volto-block-toc## Resolutions
Volto EEA KitKat provides a set of generic Volto Add-ons and a `Known Good Set` of these add-ons versions to be used within your Volto projects without having to worry about which add-on version works best with another add-on.
While in other systems when you pin a package version to a specific number you will get that package version, in Javascript world [is not that simple](https://medium.com/swlh/welcome-to-dependency-hell-754a896f0440).
For this, Volto EEA Kitkat is using [selective dependency resolutions](https://classic.yarnpkg.com/lang/en/docs/selective-version-resolutions/). While this work as expected in most of the cases, you may still have some surprises.
### Troubleshooting
1. Make sure your Volto project `yarn.lock` is not polluted. You can always reset your Volto project `yarn.lock` with:
$ npm install -g @plone/generator-volto
$ cd my-volto-project
$ yo @plone/volto --skip-install --no-interactive /tmp/new-volto-project
$ cp /tmp/new-volto-project/yarn.lock .
$ yarn2. Add-on `resolutions` don't work with `workspaces` (development mode), thus you'll need to define `resolutions` within Volto project. To tackle this issue, this Docker image automatically extracts `resolutions` from add-on and add them also to the Volto project before running tests.
## Getting started
### Try volto-eea-kitkat with Docker
git clone https://github.com/eea/volto-eea-kitkat.git
cd volto-eea-kitkat
make
make startGo to http://localhost:3000
### Add volto-eea-kitkat 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-eea-kitkat"
],"dependencies": {
"@eeacms/volto-eea-kitkat": "*"
}
```* If not, create one:
```
npm install -g yo @plone/generator-volto
yo @plone/volto my-volto-project --canary --addon @eeacms/volto-eea-kitkat
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-eea-kitkat/blob/master/RELEASE.md).
## How to contribute
See [DEVELOP.md](https://github.com/eea/volto-eea-kitkat/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-eea-kitkat/blob/master/LICENSE.md) for details.
## Funding
[European Environment Agency (EU)](http://eea.europa.eu)