Skip to content

This is a lightweight Vue 3 component made with TypeScript to quickly create an animation that shows an automatic count of any quantity in any duration, counting up or down.

License

Notifications You must be signed in to change notification settings

ps-cristopher/vue3-autocounter

Repository files navigation

Vue3 Autocounter

View Demo | Full Docs

Description

A lightweight Vue 3 component made with TypeScript, you can use it to create an animation that shows an automatic count for any quantity with a specified duration, it can be used for counting up and down.

Installation

You can install it easily with NPM.

npm install vue3-autocounter

Usage

Add the vue3-autocounter to your main.js for a global import:

import { createApp } from 'vue';
import Vue3Autocounter from 'vue3-autocounter';
import App from './App.vue';

createApp(App)
.component('vue3-autocounter', Vue3Autocounter)
.mount('#app'); 

If you prefer yo can import it directly in your Single File Component:

import { defineComponent } from 'vue';
import Vue3autocounter from 'vue3-autocounter';

export default defineComponent({
  name: 'Demo',
  components: {
    'vue3-autocounter': Vue3autocounter
  }
});   

Finally you can use it on your template:

<template>
  <vue3-autocounter ref='counter' :startAmount='0' :endAmount='2021' :duration='3' prefix='$' suffix='USD' separator=',' decimalSeparator='.' :decimals='2' :autoinit='true' @finished='alert(`Counting finished!`)'/>
</template>

Go to full documentation with properties, events and methods specifications.

Support

Send me an email to [email protected] You can also send me a direct message on Twitter @ps_cristopher

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Contributors

Made with contributors-img.

License

MIT License © 2021 Cristopher PS