volto-countup-block: Volto add-on
npm install @codesyntax/volto-countup-blockA new add-on for Volto
A simple block to show a rolling number.
Internally it supports the basic options of react-countup
It allows setting the start and end values, the duration of the counting, the start delay, decimal and thousands separator, ...
It also allows adding a title and selecting its heading and position.
You can restrict the list of allowed tags to render the title of the counter. Just modify the titleTags property of the block in your config:
``js
const applyConfig = (config) => {
// Own blocks
config.blocks.blocksConfig['countUpBlock']['titleTags'] = [
['h3', 'h3'],
['h4', 'h4'],
];
return config;
};
`
To install your project, you must choose the method appropriate to your version of Volto.
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 @codesyntax/volto-countup-block
cd my-volto-project
Add @codesyntax/volto-countup-block to your package.json:
`JSON
"addons": [
"@codesyntax/volto-countup-block"
],
"dependencies": {
"@codesyntax/volto-countup-block": "*"
}
`
Download and install the new add-on by running:
`
yarn install
Start volto with:
`
yarn start
Add @codesyntax/volto-countup-block to your package.json:
`json`
"dependencies": {
"@codesyntax/volto-countup-block": "*"
}
Add @codesyntax/volto-countup-block to your volto.config.js:
`javascript`
const addons = ['@codesyntax/volto-countup-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 = '@codesyntax/volto-countup-block';
Visit http://localhost:3000/ in a browser, login, and check the awesome new features.
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).
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
Install package requirements.
`shell`
make install
Start the backend.
`shell`
make backend-docker-start
In a separate terminal session, start the frontend.
`shell`
make start
Run ESlint, Prettier, and Stylelint in analyze mode.
`shell`
make lint
Run ESlint, Prettier, and Stylelint in fix mode.
`shell`
make format
Extract the i18n messages to locales.
`shell`
make i18n
Run unit tests.
`shell`
make test
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
The project is licensed under the MIT license.
Crafted with care by Generated using Cookieplone (0.7.1) and cookiecutter-plone (92fee80) on 2024-11-13 19:22:58.189323. A special thanks to all contributors and supporters!