mirror of
https://github.com/tabler/tabler.git
synced 2026-10-20 23:04:20 +04:00
110 lines
4.0 KiB
Plaintext
110 lines
4.0 KiB
Plaintext
---
|
|
title: Countup
|
|
summary: A countup element is used to display numerical data in an interesting way and make the interface more interactive.
|
|
docs-libs: countup
|
|
description: Display numbers dynamically with a countup.
|
|
layout: '@layouts/DocsMdxLayout.astro'
|
|
---
|
|
import Example from '@components/Example.astro';
|
|
import CodeDocs from '@components/CodeDocs.astro';
|
|
|
|
The countup component is used to display numbers dynamically. It is a great way to make the interface more interactive and engaging. The countup component is a simple and easy way to animate numbers in your application.
|
|
|
|
To be able to use the countup in your application you will need to install the countup.js dependency with `npm install countup.js`.
|
|
|
|
For more advanced features of countups, see the demo on the [countUp.js website](https://inorganik.github.io/countUp.js/).
|
|
|
|
## Basic usage
|
|
|
|
To create a countup, add `data-countup` to any HTML text tag and specify the number which is to be reached. The animation will be triggered as soon as the number enters the viewport.
|
|
|
|
```html
|
|
<h1 data-countup>30000</h1>
|
|
```
|
|
|
|
The results can be seen in the example below.
|
|
|
|
<Example centered>
|
|
<h1 data-countup>30000</h1>
|
|
</Example>
|
|
|
|
## Duration
|
|
|
|
Set the `duration` to determine how long the animation should take. By default, the duration is set to 2 seconds, but you can modify it as you wish.
|
|
|
|
<Example vertical separated>
|
|
<h1 data-countup>30000</h1> <h1 data-countup='{"duration":4}'>30000</h1> <h1 data-countup='{"duration":6}'>30000</h1>
|
|
</Example>
|
|
|
|
## Starting value
|
|
|
|
By default the countup will start from zero. If you want to set a different start value use `startVal`.
|
|
You can also set the start value to be greater than the final value, so that it counts down instead of up.
|
|
To see how the starting value affects the animation, look at the example below.
|
|
|
|
<Example vertical separated>
|
|
<h1 data-countup='{"startVal":12345}'>30000</h1> <h1 data-countup='{"startVal":47655}'>30000</h1>
|
|
</Example>
|
|
|
|
## Decimal places
|
|
|
|
Set how many decimal numbers should be displayed using `decimalPlaces`. By default, the number of decimal places is set to 0.
|
|
|
|
<Example vertical separated>
|
|
<h1 data-countup>3.123</h1> <h1 data-countup='{"decimalPlaces":1}'>3.123</h1> <h1 data-countup='{"decimalPlaces":2}'>3.123</h1> <h1 data-countup='{"decimalPlaces":3}'>3.123</h1>
|
|
</Example>
|
|
|
|
## Easing
|
|
|
|
Disable easing using `"useEasing": false`. Easing is set to `true` by default, so that the animation speed changes over the course of its duration. Easing can be disabled to make the animation linear.
|
|
|
|
<Example vertical separated>
|
|
<h1 data-countup>30000</h1> <h1 data-countup='{"useEasing": false}'>30000</h1>
|
|
</Example>
|
|
|
|
## Use grouping
|
|
|
|
Disable grouping using `"useGrouping": false`. Grouping is set to `true` by default, so that the number is displayed with a separator.
|
|
|
|
<Example vertical separated>
|
|
<h1 data-countup>30000</h1> <h1 data-countup='{"useGrouping": false}'>30000</h1>
|
|
</Example>
|
|
|
|
## Separator
|
|
|
|
You can change the default separator using `separator` and specifying the one you wish to use.
|
|
|
|
<Example vertical separated>
|
|
<h1 data-countup>3000000</h1> <h1 data-countup='{"separator":" "}'>3000000</h1>
|
|
</Example>
|
|
|
|
## Decimal separator
|
|
|
|
You can change the default decimal separator using `decimal` and specifying the one you wish to use.
|
|
|
|
<Example vertical separated>
|
|
<h1 data-countup='{"decimalPlaces":2}'>3.12</h1> <h1 data-countup='{"decimalPlaces":2,"decimal":","}'>3.12</h1>
|
|
</Example>
|
|
|
|
## Prefix
|
|
|
|
Set the countup prefix using `prefix` and specifying the prefix you want to add, for instance a currency symbol.
|
|
|
|
<Example vertical separated>
|
|
<h1 data-countup='{"prefix":"$"}'>30000</h1> <h1 data-countup='{"prefix":"€"}'>30000</h1>
|
|
</Example>
|
|
|
|
## Suffix
|
|
|
|
Set the countup suffix using `suffix` and specifying the suffix you want to add, for instance a percentage symbol.
|
|
|
|
<Example vertical separated>
|
|
<h1 data-countup='{"suffix":"%"}'>300</h1> <h1 data-countup='{"suffix":"‰"}'>300</h1>
|
|
</Example>
|
|
|
|
## JavaScript
|
|
|
|
Tabler automatically initializes all elements with `data-countup` on page load. This is the code that runs:
|
|
|
|
<CodeDocs name="countup-init" file="core/js/src/countup.ts" />
|