{"id":21029893,"url":"https://github.com/kitconcept/volto-highlight-block","last_synced_at":"2025-04-12T13:12:30.790Z","repository":{"id":75201889,"uuid":"578647048","full_name":"kitconcept/volto-highlight-block","owner":"kitconcept","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-21T09:18:33.000Z","size":13696,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-12T13:12:22.140Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kitconcept.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-12-15T14:50:29.000Z","updated_at":"2025-03-21T09:19:04.000Z","dependencies_parsed_at":"2025-02-26T16:29:53.546Z","dependency_job_id":"c3c50049-1e23-46d0-859a-69c2d6895759","html_url":"https://github.com/kitconcept/volto-highlight-block","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fvolto-highlight-block","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fvolto-highlight-block/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fvolto-highlight-block/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fvolto-highlight-block/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kitconcept","download_url":"https://codeload.github.com/kitconcept/volto-highlight-block/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248571878,"owners_count":21126522,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-19T12:14:54.509Z","updated_at":"2025-04-12T13:12:30.782Z","avatar_url":"https://github.com/kitconcept.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cpicture\u003e\n  \u003csource align=\"right\" media=\"(prefers-color-scheme: dark)\" srcset=\"https://kitconcept.com/kitconcept-white.svg\"\u003e\n  \u003cimg align=\"right\" width=\"300\" alt=\"kitconcept, GmbH\" src=\"https://kitconcept.com/kitconcept-black.svg\"\u003e\n\u003c/picture\u003e\n\n# Highlight block\n\n[![npm](https://img.shields.io/npm/v/@kitconcept/volto-highlight-block)](https://www.npmjs.com/package/@kitconcept/volto-highlight-block)\n[![](https://img.shields.io/badge/-Storybook-ff4785?logo=Storybook\u0026logoColor=white\u0026style=flat-square)](https://kitconcept.github.io/volto-highlight-block/)\n[![Code analysis checks](https://github.com/kitconcept/volto-highlight-block/actions/workflows/code.yml/badge.svg)](https://github.com/kitconcept/volto-highlight-block/actions/workflows/code.yml)\n[![Unit tests](https://github.com/kitconcept/volto-highlight-block/actions/workflows/unit.yml/badge.svg)](https://github.com/kitconcept/volto-highlight-block/actions/workflows/unit.yml)\n\nThis 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.\nIt 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).\n\n## Compatibility\n\n| volto-highlight-block version | Volto version |\n|-------------|---------------|\n|   3.x.x  |   \u003e= Volto 17.0.0 |\n|   4.x.x  |   \u003e= Volto 17.18.0 or \u003e=Volto 18.0.0-alpha.36  |\n\n## Customizable colors\n\nYou can use CSS custom properties from your theme or add-ons:\n\n```\n.root {\n--highlight-custom-color-1: #eee;\n--highlight-custom-color-2: red;\n--highlight-custom-color-3: yellow;\n--highlight-custom-color-4: brown;\n--highlight-custom-color-5: white;\n}\n```\n\nor even add more via the block's config:\n\n```\n  const CONTENT_COLORS = [\n    { name: 'highlight-custom-color-1', label: 'Medium Blue' },\n    { name: 'highlight-custom-color-2', label: 'Light Orange' },\n    { name: 'highlight-custom-color-3', label: 'Light Green' },\n    { name: 'highlight-custom-color-4', label: 'Blue' },\n    { name: 'highlight-custom-color-5', label: 'Green' },\n  ];\n\n  config.blocks.blocksConfig.highlight = {\n    descriptionColors: CONTENT_COLORS,\n  };\n```\n\n## Screenshots\n\n![Highlight block](https://github.com/kitconcept/volto-highlight-block/raw/main/screenshot.jpg)\n\n![Highlight block - edit mode](https://github.com/kitconcept/volto-highlight-block/raw/main/screenshot-edit.jpg)\n\n## Installation\n\nTo install your project, you must choose the method appropriate to your version of Volto.\n\n\n### Volto 17 and earlier\n\nCreate a new Volto project (you can skip this step if you already have one):\n\n```\nnpm install -g yo @plone/generator-volto\nyo @plone/volto my-volto-project --addon @kitconcept/volto-highlight-block\ncd my-volto-project\n```\n\nAdd `@kitconcept/volto-highlight-block` to your package.json:\n\n```JSON\n\"addons\": [\n    \"@kitconcept/volto-highlight-block\"\n],\n\n\"dependencies\": {\n    \"@kitconcept/volto-highlight-block\": \"*\"\n}\n```\n\nDownload and install the new add-on by running:\n\n```\nyarn install\n```\n\nStart volto with:\n\n```\nyarn start\n```\n\n### Volto 18 and later\n\nAdd `@kitconcept/volto-highlight-block` to your `package.json`:\n\n```json\n\"dependencies\": {\n    \"@kitconcept/volto-highlight-block\": \"*\"\n}\n```\n\nAdd `@kitconcept/volto-highlight-block` to your `volto.config.js`:\n\n```javascript\nconst addons = ['@kitconcept/volto-highlight-block'];\n```\n\nIf this package provides a Volto theme, and you want to activate it, then add the following to your `volto.config.js`:\n\n```javascript\nconst theme = '@kitconcept/volto-highlight-block';\n```\n\n## Test installation\n\nVisit http://localhost:3000/ in a browser, login, and check the awesome new features.\n\n\n## Development\n\nThe 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.\nFor this reason, it only works with pnpm and Volto 18 (currently in alpha).\n\n\n### Pre-requisites\n\n-   [Node.js](https://6.docs.plone.org/install/create-project.html#node-js)\n-   [Make](https://6.docs.plone.org/install/create-project.html#make)\n-   [Docker](https://6.docs.plone.org/install/create-project.html#docker)\n\n\n### Make convenience commands\n\nRun `make help` to list the available commands.\n\n```text\nhelp                             Show this help\ninstall                          Installs the add-on in a development environment\nstart                            Starts Volto, allowing reloading of the add-on during development\nbuild                            Build a production bundle for distribution of the project with the add-on\ni18n                             Sync i18n\nci-i18n                          Check if i18n is not synced\nformat                           Format codebase\nlint                             Lint, or catch and remove problems, in code base\nrelease                          Release the add-on on npmjs.org\nrelease-dry-run                  Dry-run the release of the add-on on npmjs.org\ntest                             Run unit tests\nci-test                          Run unit tests in CI\nbackend-docker-start             Starts a Docker-based backend for development\nstorybook-start                  Start Storybook server on port 6006\nstorybook-build                  Build Storybook\nacceptance-frontend-dev-start    Start acceptance frontend in development mode\nacceptance-frontend-prod-start   Start acceptance frontend in production mode\nacceptance-backend-start         Start backend acceptance server\nci-acceptance-backend-start      Start backend acceptance server in headless mode for CI\nacceptance-test                  Start Cypress in interactive mode\nci-acceptance-test               Run cypress tests in headless mode for CI\n```\n\n### Development environment set up\n\nInstall package requirements.\n\n```shell\nmake install\n```\n\n### Start developing\n\nStart the backend.\n\n```shell\nmake backend-docker-start\n```\n\nIn a separate terminal session, start the frontend.\n\n```shell\nmake start\n```\n\n### Lint code\n\nRun ESlint, Prettier, and Stylelint in analyze mode.\n\n```shell\nmake lint\n```\n\n### Format code\n\nRun ESlint, Prettier, and Stylelint in fix mode.\n\n```shell\nmake format\n```\n\n### i18n\n\nExtract the i18n messages to locales.\n\n```shell\nmake i18n\n```\n\n### Unit tests\n\nRun unit tests.\n\n```shell\nmake test\n```\n\n### Run Cypress tests\n\nRun each of these steps in separate terminal sessions.\n\nIn the first session, start the frontend in development mode.\n\n```shell\nmake acceptance-frontend-dev-start\n```\n\nIn the second session, start the backend acceptance server.\n\n```shell\nmake acceptance-backend-start\n```\n\nIn the third session, start the Cypress interactive test runner.\n\n```shell\nmake acceptance-test\n```\n\n## License\n\nThe project is licensed under the MIT license.\n\n## Credits and Acknowledgements 🙏\n\nThis package is developed and maintained by [kitconcept GmbH](https://kitconcept.com) ❤️.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitconcept%2Fvolto-highlight-block","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkitconcept%2Fvolto-highlight-block","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitconcept%2Fvolto-highlight-block/lists"}