npm.io
3.0.1 • Published 7 months ago

@eeacms/countup

Licence
MIT
Version
3.0.1
Deps
0
Vulns
0
Weekly
0

EEA countup

Releases

Pipeline Lines of Code Coverage Bugs Duplicated Lines (%)

Pipeline Lines of Code Coverage Bugs Duplicated Lines (%)

This is a React countup library with visibility observer support. The repository keeps lightweight Volto-oriented CI wiring so it can be tested in the same frontend pipeline as the other EEA packages, but consumers should use it as a regular dependency rather than as a Volto addon.

Installation

yarn add @eeacms/countup

Development

Local development uses the bundled example app, not a Volto/Plone docker stack.

make install
make start

Go to http://localhost:8888

If port 8888 is busy in your workspace, run SERVE_PORT=8899 make start.

To consume @eeacms/countup from Volto 17 or Volto 18, add it as a regular dependency. Do not add it to the Volto addons list.

Props

The component and the hook accept the same props. They are fully interchangeable.

Prop Name Type Default Description
isCounting boolean false Play and pause counting animation
start number 0 Initial value
end number - Target value
duration number - Animation duration in seconds. Defaults to 2 seconds if end is set
decimalPlaces number - Number of decimal places after the decimal separator.
decimalSeparator string - Decimal separator character
thousandsSeparator string - Thousands separator character
formatter function - Type: (value: number) => number | string | node
A function that formats the output value. It has the highest priority so all other formatting options are ignored
updateInterval number 0 Update interval in seconds. Determines how often the animated value will change. When set to 0 the value will update on each key frame
children function - Type: ({ value: number, reset: () => void }) => number | string | node
CountUp component - children prop
onComplete function - Type: () => void | {shouldRepeat: boolean, delay: number}
On complete handler. Repeat animation by returning an object with shouldRepeat equals true and delay in seconds.
onUpdate function - Type: (currentValue: number | string | node) => void
On value update event handler

Return values

The hook returns the current count up value and reset method to reset the animation.

import { useCountUp } from 'use-count-up';

const { value, reset } = useCountUp({ isCounting: true });

Release

See RELEASE.md.

How to contribute

See DEVELOP.md.

The Initial Owner of the Original Code is European Environment Agency (EEA). All Rights Reserved.

See LICENSE.md for details.

Funding

European Environment Agency (EU)

Keywords