@kitconcept/volto-highlight-block

Highlight block by kitconcept

This add-on provides a block that features a big image picked from the images on the site on top and a title and description editable inline. It allows also to set colors on the background of the text area. It features five customizable colors by default.

Customizable colors

You can use CSS custom properties from your theme or add-ons:

.root {
--highlight-custom-color-1: #eee;
--highlight-custom-color-2: red;
--highlight-custom-color-3: yellow;
--highlight-custom-color-4: brown;
--highlight-custom-color-5: white;
}

or even add more via the block's config:

  const CONTENT_COLORS = [
    { name: 'highlight-custom-color-1', label: 'Medium Blue' },
    { name: 'highlight-custom-color-2', label: 'Light Orange' },
    { name: 'highlight-custom-color-3', label: 'Light Green' },
    { name: 'highlight-custom-color-4', label: 'Blue' },
    { name: 'highlight-custom-color-5', label: 'Green' },
  ];

  config.blocks.blocksConfig.highlight = {
    descriptionColors: CONTENT_COLORS,
  };

Screenshots

Prerequisites

• Docker
• Node 18 (e.g. via nvm)

Build a project

Run

make build-addon

or, alternatively for building all and start the dev instances:

Run

make dev

Start developing

Run

make start-dev

Develop locally

Developing locally you lack the node_modules folder.

Run

make install-local

It will add @plone/volto as a local dependency, and immediatelly back to the original (via git checkout). For this feature to work, your add-on needs to be versioned already. After this action, the ESlint, Prettier, stylelint will work again in your IDE.

Stop Backend (Docker)

Once you are finished, you should shut down the backend.

Run

make stop-backend-docker

Run Acceptance tests

Run

make start-test-acceptance-server

It starts both the backend and frontend in development mode.

They run in foreground, so for stopping it, press CTRL+C.

For status:

make status-test-acceptance-server

Changelog

1.0.0 (2023-06-30)

Feature

• New docker approach for testing @sneridagh #2
• Acceptance tests @sneridagh #3
• Improve README, add screenshots @sneridagh #4