This is an Angular directive wrapper around the core functionality of CountUp which is maintained in the CountUp.js repo. MIT License.
Or see this angular version work by cloning this project and running ng serve
.
Install the package in your project:
yarn add countup.js-angular2
or npm i countup.js-angular2
In app.module.ts
, import the module:
import { CountUpModule } from 'countup.js-angular2';
@NgModule({
imports: [
...
CountUpModule
],
...
})
Use it in your markup. Since it's a directive, it can be added to any element:
<h1 [countUp]="345" (complete)="doSomethingOnComplete()">0</h1>
Bind the endVal to some property. Leave it undefined and the animation won't start until endVal
has a value.
<h1 [countUp]="myEndVal" [options]="myOpts">0</h1>
Inputs:
countUp
: number to count tooptions
: CountUpOptions - fine-grain control over CountUpreanimateOnClick
: pass false to disable (defaults to true)
Outputs:
complete
: emits when the animation completes
Before you make a pull request, please follow these instructions:
- Make your edits to
./projects/count-up/src/lib/count-up.directive.ts
. - Run
ng s
and test your changes in the demo app.
Publishing (you don't need to do this, it’s for my own reference):
- Increment the version number if necessary (and
install-tarball
script). - Commit changes.
- Run
yarn package:countup
which builds and packs a tarball. - Install the tarball in the test app:
yarn install-tarball
. - Make app.module import from newly installed package.
- Run the test app with AOT compiler and make sure the demo works:
ng serve --prod
. - Run
npm publish dist/count-up
- Discard changes.