{"id":13568127,"url":"https://github.com/kitconcept/volto-separator-block","last_synced_at":"2025-09-02T18:45:14.748Z","repository":{"id":38190151,"uuid":"474915062","full_name":"kitconcept/volto-separator-block","owner":"kitconcept","description":null,"archived":false,"fork":false,"pushed_at":"2025-07-23T10:42:40.000Z","size":12463,"stargazers_count":1,"open_issues_count":1,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-08-28T23:12:58.464Z","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-03-28T08:37:32.000Z","updated_at":"2025-07-23T10:40:48.000Z","dependencies_parsed_at":"2024-01-12T23:17:40.292Z","dependency_job_id":"181729b2-6304-4135-8931-c4d7574f63d3","html_url":"https://github.com/kitconcept/volto-separator-block","commit_stats":{"total_commits":57,"total_committers":6,"mean_commits":9.5,"dds":0.4035087719298246,"last_synced_commit":"a2bcd01cf2b94ffff6158a976213a51347c41444"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/kitconcept/volto-separator-block","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fvolto-separator-block","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fvolto-separator-block/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fvolto-separator-block/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fvolto-separator-block/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kitconcept","download_url":"https://codeload.github.com/kitconcept/volto-separator-block/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fvolto-separator-block/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273333425,"owners_count":25086969,"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","status":"online","status_checked_at":"2025-09-02T02:00:09.530Z","response_time":77,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-08-01T14:00:20.361Z","updated_at":"2025-09-02T18:45:14.694Z","avatar_url":"https://github.com/kitconcept.png","language":"JavaScript","funding_links":[],"categories":["Add-ons"],"sub_categories":[],"readme":"# volto-separator-block (@kitconcept/volto-separator-block)\n\nA new add-on for Volto\n\n[![npm](https://img.shields.io/npm/v/@kitconcept/volto-separator-block)](https://www.npmjs.com/package/@kitconcept/volto-separator-block)\n[![](https://img.shields.io/badge/-Storybook-ff4785?logo=Storybook\u0026logoColor=white\u0026style=flat-square)](https://kitconcept.github.io/volto-separator-block/)\n[![Code analysis checks](https://github.com/kitconcept/volto-separator-block/actions/workflows/code.yml/badge.svg)](https://github.com/kitconcept/volto-separator-block/actions/workflows/code.yml)\n[![Unit tests](https://github.com/kitconcept/volto-separator-block/actions/workflows/unit.yml/badge.svg)](https://github.com/kitconcept/volto-separator-block/actions/workflows/unit.yml)\n\n![kitconcept GmbH](https://github.com/kitconcept/volto-blocks/raw/master/kitconcept.png)\n\nThe Volto Separator Block allows editors to add a visual separator between blocks to a Volto page.\n\n## Screenshot\n\n![Separator-Block](https://github.com/kitconcept/volto-separator-block/raw/master/screenshot.png)\n\n## Screencast\n\n![Separator-Block](https://github.com/kitconcept/volto-separator-block/raw/master/screencast.gif)\n\n## Block Alignment Enhancer\n\nThis block features by default a block `schemaEnhancer` that provides an alignment option for the separator. This can be disabled by overwriting with your own `schemaEnhancer`\n\n```js\n  config.blocks.blocksConfig.separator = {\n    ...config.blocks.blocksConfig.separator,\n    schemaEnhancer: mySeparatorSchemaEnhancer,\n  }\n```\nor setting it to `null` or `undefined`:\n\n```js\n  config.blocks.blocksConfig.separator = {\n    ...config.blocks.blocksConfig.separator,\n    schemaEnhancer: null,\n  }\n```\n\nAlso, if you want to keep the default alignment but still add your own `schemaEnhancer` you can compose it along with your own:\n\n```js\nimport { composeSchema } from '@plone/volto/helpers';\nimport { SeparatorStyleEnhancer } from '@kitconcept/volto-separator-block';\n\n    config.blocks.blocksConfig.separator = {\n      ...config.blocks.blocksConfig.separator,\n      schemaEnhancer: composeSchema(mySeparatorSchemaEnhancer, defaultSeparatorEnhancer),\n    }\n```\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-separator-block\ncd my-volto-project\n```\n\nAdd `@kitconcept/volto-separator-block` to your package.json:\n\n```JSON\n\"addons\": [\n    \"@kitconcept/volto-separator-block\"\n],\n\n\"dependencies\": {\n    \"@kitconcept/volto-separator-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-separator-block` to your `package.json`:\n\n```json\n\"dependencies\": {\n    \"@kitconcept/volto-separator-block\": \"*\"\n}\n```\n\nAdd `@kitconcept/volto-separator-block` to your `volto.config.js`:\n\n```javascript\nconst addons = ['@kitconcept/volto-separator-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-separator-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\n\n\u003cimg alt=\"Forschungszentrum Jülich\" src=\"https://github.com/kitconcept/volto-blocks/raw/master/fz-juelich.svg\" width=\"200px\" /\u003e\n\nThe development of this plugin has been kindly sponsored by [Forschungszentrum Jülich](https://fz-juelich.de).\n\n# License\n\nThe project is licensed under the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitconcept%2Fvolto-separator-block","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkitconcept%2Fvolto-separator-block","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitconcept%2Fvolto-separator-block/lists"}