Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@eeacms/countup

Package Overview
Dependencies
Maintainers
9
Versions
29
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@eeacms/countup

React component and hook to animate counting up or down to a number

  • 2.0.6
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
9
Created
Source

EEA countup

Releases

Pipeline Lines of Code Coverage Bugs Duplicated Lines (%)

Pipeline Lines of Code Coverage Bugs Duplicated Lines (%)

This is a countup react library with the visibility observer already in it Also it has support for Volto addons pipeline, it is basically as an empty addon with tests

Installation

yarn add @eeacms/countup

Props

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

Prop NameTypeDefaultDescription
isCountingbooleanfalsePlay and pause counting animation
startnumber0Initial value
endnumber-Target value
durationnumber-Animation duration in seconds. Defaults to 2 seconds if end is set
decimalPlacesnumber-Number of decimal places after the decimal separator.
decimalSeparatorstring-Decimal separator character
thousandsSeparatorstring-Thousands separator character
formatterfunction-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
updateIntervalnumber0Update interval in seconds. Determines how often the animated value will change. When set to 0 the value will update on each key frame
childrenfunction-Type: ({ value: number, reset: () => void }) => number | string | node
CountUp component - children prop
onCompletefunction-Type: () => void | {shouldRepeat: boolean, delay: number}
On complete handler. Repeat animation by returning an object with shouldRepeat equals true and delay in seconds.
onUpdatefunction-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

FAQs

Package last updated on 29 Sep 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc