{"id":13568137,"url":"https://github.com/kitconcept/volto-button-block","last_synced_at":"2025-05-15T11:32:21.186Z","repository":{"id":38251896,"uuid":"473518282","full_name":"kitconcept/volto-button-block","owner":"kitconcept","description":null,"archived":false,"fork":false,"pushed_at":"2024-11-25T17:11:06.000Z","size":4863,"stargazers_count":2,"open_issues_count":5,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-11T12:11:34.040Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kitconcept.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","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-24T08:30:31.000Z","updated_at":"2024-11-25T17:11:09.000Z","dependencies_parsed_at":"2024-01-14T03:47:36.729Z","dependency_job_id":"bc2ee719-5303-46c1-ae00-1ee2678156cc","html_url":"https://github.com/kitconcept/volto-button-block","commit_stats":{"total_commits":47,"total_committers":4,"mean_commits":11.75,"dds":0.4042553191489362,"last_synced_commit":"a2cd17bb7832b9bf11dcf0f2796461ed3de865c1"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fvolto-button-block","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fvolto-button-block/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fvolto-button-block/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fvolto-button-block/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kitconcept","download_url":"https://codeload.github.com/kitconcept/volto-button-block/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254330807,"owners_count":22053052,"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-08-01T14:00:20.494Z","updated_at":"2025-05-15T11:32:21.154Z","avatar_url":"https://github.com/kitconcept.png","language":"JavaScript","funding_links":[],"categories":["Add-ons"],"sub_categories":[],"readme":"# Volto Button Block\n\n[![BlockModelv3 Ready](https://github.com/kitconcept/volto-light-theme/blob/main/BMv3-ready.svg)](https://github.com/kitconcept/volto-light-theme/blob/91039fcab0f7709fd28ea8b8a8f9e7c86291a8dd/BLOCK-MODEL-V3.md)\n[![NPM](https://img.shields.io/npm/v/@kitconcept/volto-button-block.svg)](https://www.npmjs.com/package/@kitconcept/volto-button-block)\n[![Build Status](https://github.com/kitconcept/volto-button-block/actions/workflows/code.yml/badge.svg)](https://github.com/kitconcept/volto-button-block/actions)\n[![Build Status](https://github.com/kitconcept/volto-button-block/actions/workflows/unit.yml/badge.svg)](https://github.com/kitconcept/volto-button-block/actions)\n[![Build Status](https://github.com/kitconcept/volto-button-block/actions/workflows/acceptance.yml/badge.svg)](https://github.com/kitconcept/volto-button-block/actions)\n\n![kitconcept GmbH](https://github.com/kitconcept/volto-blocks/raw/master/kitconcept.png)\n\nThe Volto Button Block allows editors to add a configurable button to a Volto page.\n\n## Screenshot\n\n![Button-Block](https://github.com/kitconcept/volto-button-block/raw/main/screenshot.png)\n\n## Screencast\n\n![Button-Block](https://github.com/kitconcept/volto-button-block/raw/main/screencast.gif)\n\n## Upgrade Guide\n\n### Support for Block Model v3\n\nA new block model it's being developed by the community.\nThis block model will change some internal structures in the Volto Block Engine.\nThe new Block Model v3 will be implemented and supported initially by `@kitconcept/volto-light-theme` in its next major release.\nLater on, when it's a reality and it's polished and tested, it might be ported to Volto core.\nRead more about the [Block Model v3](https://github.com/kitconcept/volto-light-theme/blob/91039fcab0f7709fd28ea8b8a8f9e7c86291a8dd/BLOCK-MODEL-V3.md).\nThis add-on is compatible with the Block Model v3 from 3.x series on, via an opt-in flag (`blockModel`).\nThe flag will be opt-in during the 3.x series of this package.\nAfter 4.x is released, the Block Model v3 will be the default for this add-on and the flag will be removed (no opt-out configuration option will exist).\n\nExample of the usage of the flag:\n\n```js\nconfig.blocks.blocksConfig.__button.blockModel = 3;\n```\n\n### SemanticUI support\n\nThe 3.x series will be the last one to support a SemanticUI button.\nThe 4.x version will support `@plone/components` `Button` component only.\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-button-block\ncd my-volto-project\n```\n\nAdd `@kitconcept/volto-button-block`to your package.json:\n\n```JSON\n\"addons\": [\n    \"@kitconcept/volto-button-block\"\n],\n\n\"dependencies\": {\n    \"@kitconcept/volto-button-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-button-block` to your `package.json`:\n\n```json\n\"dependencies\": {\n    \"@kitconcept/volto-button-block\": \"*\"\n}\n```\n\nAdd `@kitconcept/volto-button-block` to your `volto.config.js`:\n\n```javascript\nconst addons = ['@kitconcept/volto-button-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-button-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\nCrafted with care by **This was generated by [cookiecutter-volto](https://github.com/plone/cookiecutter-volto/frontend_addon) on 2024-06-10 14:31:29**. A special thanks to all contributors and supporters!\n\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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitconcept%2Fvolto-button-block","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkitconcept%2Fvolto-button-block","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitconcept%2Fvolto-button-block/lists"}