@kitconcept/volto-highlight-block
Version:
volto-highlight-block: Volto add-on
246 lines (167 loc) • 7.01 kB
Markdown
# Highlight block by kitconcept
[](https://www.npmjs.com/package/@kitconcept/volto-highlight-block)
[](https://kitconcept.github.io/volto-highlight-block/)
[](https://github.com/kitconcept/volto-highlight-block/actions/workflows/code.yml)
[](https://github.com/kitconcept/volto-highlight-block/actions/workflows/unit.yml)
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. See the block in action: [www.dlr.de](https://www.dlr.de/de/das-dlr).
## Compatibility
| volto-highlight-block version | Volto version |
|-------------|---------------|
| 3.x.x | >= Volto 17.0.0 |
| 4.x.x | >= Volto 17.18.0 or >=Volto 18.0.0-alpha.36 |
## 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
## Installation
To install your project, you must choose the method appropriate to your version of Volto.
### Volto 17 and earlier
Create a new Volto project (you can skip this step if you already have one):
```
npm install -g yo @plone/generator-volto
yo @plone/volto my-volto-project --addon @kitconcept/volto-highlight-block
cd my-volto-project
```
Add `@kitconcept/volto-highlight-block` to your package.json:
```JSON
"addons": [
"@kitconcept/volto-highlight-block"
],
"dependencies": {
"@kitconcept/volto-highlight-block": "*"
}
```
Download and install the new add-on by running:
```
yarn install
```
Start volto with:
```
yarn start
```
### Volto 18 and later
Add `@kitconcept/volto-highlight-block` to your `package.json`:
```json
"dependencies": {
"@kitconcept/volto-highlight-block": "*"
}
```
Add `@kitconcept/volto-highlight-block` to your `volto.config.js`:
```javascript
const addons = ['@kitconcept/volto-highlight-block'];
```
If this package provides a Volto theme, and you want to activate it, then add the following to your `volto.config.js`:
```javascript
const theme = '@kitconcept/volto-highlight-block';
```
## Test installation
Visit http://localhost:3000/ in a browser, login, and check the awesome new features.
## Development
The development of this add-on is done in isolation using a new approach using pnpm workspaces and latest `mrs-developer` and other Volto core improvements.
For this reason, it only works with pnpm and Volto 18 (currently in alpha).
### Pre-requisites
- [Node.js](https://6.docs.plone.org/install/create-project.html#node-js)
- [Make](https://6.docs.plone.org/install/create-project.html#make)
- [Docker](https://6.docs.plone.org/install/create-project.html#docker)
### Make convenience commands
Run `make help` to list the available commands.
```text
help Show this help
install Installs the add-on in a development environment
start Starts Volto, allowing reloading of the add-on during development
build Build a production bundle for distribution of the project with the add-on
i18n Sync i18n
ci-i18n Check if i18n is not synced
format Format codebase
lint Lint, or catch and remove problems, in code base
release Release the add-on on npmjs.org
release-dry-run Dry-run the release of the add-on on npmjs.org
test Run unit tests
ci-test Run unit tests in CI
backend-docker-start Starts a Docker-based backend for development
storybook-start Start Storybook server on port 6006
storybook-build Build Storybook
acceptance-frontend-dev-start Start acceptance frontend in development mode
acceptance-frontend-prod-start Start acceptance frontend in production mode
acceptance-backend-start Start backend acceptance server
ci-acceptance-backend-start Start backend acceptance server in headless mode for CI
acceptance-test Start Cypress in interactive mode
ci-acceptance-test Run cypress tests in headless mode for CI
```
### Development environment set up
Install package requirements.
```shell
make install
```
### Start developing
Start the backend.
```shell
make backend-docker-start
```
In a separate terminal session, start the frontend.
```shell
make start
```
### Lint code
Run ESlint, Prettier, and Stylelint in analyze mode.
```shell
make lint
```
### Format code
Run ESlint, Prettier, and Stylelint in fix mode.
```shell
make format
```
### i18n
Extract the i18n messages to locales.
```shell
make i18n
```
### Unit tests
Run unit tests.
```shell
make test
```
### Run Cypress tests
Run each of these steps in separate terminal sessions.
In the first session, start the frontend in development mode.
```shell
make acceptance-frontend-dev-start
```
In the second session, start the backend acceptance server.
```shell
make acceptance-backend-start
```
In the third session, start the Cypress interactive test runner.
```shell
make acceptance-test
```
## License
The project is licensed under the MIT license.
## Credits and Acknowledgements 🙏
Crafted with care by **Generated using [Cookieplone (0.7.1)](https://github.com/plone/cookieplone) and [cookiecutter-plone (5979a0b)](https://github.com/plone/cookiecutter-plone/commit/5979a0be9457d6a7b542a8b1e5890a0ec58cb7c1) on 2024-07-03 12:26:33.002571**. A special thanks to all contributors and supporters!