This component is available on GitHub.

Stimulus Animated Number

A Stimulus controller that animates a numerical value by counting to it.

Installation

$ yarn add stimulus-animated-number

And use it in your JS file:

// Probably in app/javascript/controllers/index.js

import { Application } from '@hotwired/stimulus'
import AnimatedNumber from 'stimulus-animated-number'

const application = Application.start()
application.register('animated-number', AnimatedNumber)

👀 Demo

See demo →

Usage

In your view:

<div
  data-controller="animated-number"
  data-animated-number-start-value="0"
  data-animated-number-end-value="200"
  data-animated-number-duration-value="3000"
>
  0
</div>

<div
  data-controller="animated-number"
  data-animated-number-lazy-value=""
  data-animated-number-start-value="0"
  data-animated-number-end-value="200"
  data-animated-number-duration-value="3000"
>
  This animation will start only when the element become visible thanks to Intersection Observers.
</div>

<div
  data-controller="animated-number"
  data-animated-number-lazy-value=""
  data-animated-number-lazy-root-margin-value="30px"
  data-animated-number-lazy-threshold-value="0.4"
  data-animated-number-start-value="0"
  data-animated-number-end-value="200"
  data-animated-number-duration-value="3000"
>
  You can customize the Intersection Observer options.
</div>

🛠 Configuration

Attribute	Default	Description	Optional
`data-animated-number-start-value`	`undefined`	Number, at which animation starts.	❌
`data-animated-number-end-value`	`undefined`	Number, at which animation ends.	❌
`data-animated-number-duration-value`	`undefined`	Total animation duration in milliseconds.	❌
`data-animated-number-lazy-value`	`undefined`	Fetch content when element is visible.	✅
`data-animated-number-lazy-root-margin-value`	`0px`	rootMargin option for Intersection Observer.	✅
`data-animated-number-lazy-threshold-value`	`0`	threshold option for Intersection Observer.	✅

🎛 Extending Controller

You can use inheritance to extend the functionality of any Stimulus component:

import AnimatedNumber from 'stimulus-animated-number'

export default class extends AnimatedNumber {
  connect() {
    super.connect()
    console.log('Do what you want here.')
  }
}

This controller will automatically have access to targets defined in the parent class.

If you override the connect, disconnect or any other methods from the parent, you'll want to call super.method() to make sure the parent functionality is executed.

☕️ Sponsors

Stimulus Component is an MIT licensed open source project and completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing. You can support Stimulus Components development on Github Sponsors. 🙏

👷 Contributing

Do not hesitate to contribute to the project by adapting or adding features ! Bug reports or pull requests are welcome.

Don’t forget to drop a 🌟 on Github to support the project.

📝 License

This project is released under the MIT license.