npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@codesyntax/volto-countup-block

v2.0.0

Published

volto-countup-block: Volto add-on

Downloads

81

Readme

Volto Count up block (@codesyntax/volto-countup-block)

A new add-on for Volto

npm Code analysis checks Unit tests

Features

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.

Customization

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:

const applyConfig = (config) => {
  // Own blocks
  config.blocks.blocksConfig['countUpBlock']['titleTags'] = [
      ['h3', 'h3'],
      ['h4', 'h4'],
  ];

  return config;
};

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 @codesyntax/volto-countup-block
cd my-volto-project

Add @codesyntax/volto-countup-block to your package.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

Volto 18 and later

Add @codesyntax/volto-countup-block to your package.json:

"dependencies": {
    "@codesyntax/volto-countup-block": "*"
}

Add @codesyntax/volto-countup-block to your volto.config.js:

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:

const theme = '@codesyntax/volto-countup-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

Make convenience commands

Run make help to list the available commands.

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.

make install

Start developing

Start the backend.

make backend-docker-start

In a separate terminal session, start the frontend.

make start

Lint code

Run ESlint, Prettier, and Stylelint in analyze mode.

make lint

Format code

Run ESlint, Prettier, and Stylelint in fix mode.

make format

i18n

Extract the i18n messages to locales.

make i18n

Unit tests

Run unit tests.

make test

Run Cypress tests

Run each of these steps in separate terminal sessions.

In the first session, start the frontend in development mode.

make acceptance-frontend-dev-start

In the second session, start the backend acceptance server.

make acceptance-backend-start

In the third session, start the Cypress interactive test runner.

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) and cookiecutter-plone (92fee80) on 2024-11-13 19:22:58.189323. A special thanks to all contributors and supporters!