History: PluginCountup
Preview of version: 27 (current)
- «
- »
Plugin Countup
Introduced in Tiki25, use this plugin to make a counter on a wiki page. You can add one or multiple counters on the same page and each counter starts to count when it becomes visible in the viewport. Each counter has its own custom settings (Title, ending number, custom counting (animation) speed, custom CSS (color, font size, font family, background, ...), etc.).
It is powered by Anime.js (https://github.com/juliangarnier/anime) which offers many nice tools which will be progressively used in other Tiki features.
See also PluginCountdown
1. Parameters
Make a counter on a wiki pageIntroduced in Tiki 25. Required parameters are in
bold.Go to the source code
Preferences required: wikiplugin_countup
| Parameters | Accepted Values | Description | Default | Since |
|---|---|---|---|---|
endingNumber |
int | The number to which the counter will stop to count. | 25.0 | |
delay |
float | The delay time in seconds after which the counter will start to count when it becomes visible in the viewport. | 1 | 25.0 |
description |
string | Short description of the counter | 25.0 | |
height |
int | Counter height in pixels. For instance, use 200 for 200 pixels |
300 | 25.0 |
icon |
int | Numeric ID of an icon in a file gallery. This will be set as the counter icon | 0 | 25.0 |
prefix |
text | Letter, number or symbol to use as prefix of the number counter (the number that is displayed in the counter at certain time). | 25.0 | |
speed |
float | The counting(animation) speed of the counter in seconds. | 0.2 | 25.0 |
startingNumber |
int | The number from which the counter will start to count. | 0 | 25.0 |
suffix |
text | Letter, number or symbol to use as suffix of the number counter (the number that is displayed in the counter at certain time). | 25.0 | |
title |
string | Counter title | 25.0 | |
width |
int | Counter width in pixels. For instance, use 200 for 200 pixels |
400 | 25.0 |
backgroundColor |
alhpa | Counter background colorYou can use the color name, the hexadecimal rgb code or the rgba syntax to specify the color. |
white | 25.0 |
backgroundImage |
int | Numeric ID of an icon in a file gallery. This will be set as the counter background image | 0 | 25.0 |
descriptionFontColor |
alpha | Counter description font color. For instnace, use blue for blue color. You can also use the hexadecimal rgb code or the rgba syntax to specify the color. |
black | 25.0 |
descriptionFontFamily |
(blank)| sans serif| serif| monospace| Arial| Century Gothic| Comic Sans MS| Courier New| Tahoma| Times New Roman| Verdana | Counter description font family. | 25.0 | |
descriptionFontSize |
float | Counter decription font size in pixels. For instance, use 16 for 16 pixels. |
12 | 25.0 |
iconHeight |
int | Icon height size. The default value is 64 |
64 | 25.0 |
iconWidth |
int | Icon width size. The default value is 64 |
64 | 25.0 |
numberFontColor |
alpha | This is the font color of the displayed number of counter at a certain time. For instance, use blue for blue color.You can also use the hexadecimal rgb code or the rgba syntax to specify the color. |
black | 25.0 |
numberFontFamily |
(blank)| sans serif| serif| monospace| Arial| Century Gothic| Comic Sans MS| Courier New| Tahoma| Times New Roman| Verdana | This is the font family of the displayed number in the counter at a certain time. | 25.0 | |
numberFontSize |
float | This is the font size of the displayed number at a certain time in pixels. For instance, use 16 for 16 pixels. |
32 | 25.0 |
shadow |
string | This property adds shadows to the counter via a comma separated list of shadows. A shadow is defined with horizontal and vertical offsets from the element (in our case, the counter),with blur and spread radius and with a color. For instance, use inset 2000px 0px 0px 0px #24a2c09cfor 2000px horizontal offset, 0px vertical offset, 0px blur radius, 0px spread radius and with a light blue color. The inset keyword reverses the shadow inside. For the color value, you can use the color name, the hexadecimal rgb code or the rgba syntax. For more details See here. Please be sure to respect the syntax given in the documentation to see the effect. |
25.0 | |
titleFontColor |
alpha | Counter title font color. For instance, use blue for blue color.You can also use the hexadecimal rgb code or the rgba syntax to specify the color. |
black | 25.0 |
titleFontFamily |
(blank)| sans serif| serif| monospace| Arial| Century Gothic| Comic Sans MS| Courier New| Tahoma| Times New Roman| Verdana | Counter title font family | 25.0 | |
titleFontSize |
float | Counter title font size in pixels. For instance, use 16 for 16 pixels. |
32 | 25.0 |
descriptionFontStyle |
(blank) normal italic oblique |
Counter description font style. | normal | 25.0 |
descriptionFontWeight |
(blank)| normal| bold| lighter| 100| 200| 300| 400| 500| 600| 700| 800| 900 | Counter description font weight. | normal | 25.0 |
numberFontStyle |
(blank) normal italic oblique |
Displayed number font style. | normal | 25.0 |
numberFontWeight |
(blank)| normal| bold| lighter| 100| 200| 300| 400| 500| 600| 700| 800| 900 | Displayed number font weight. | normal | 25.0 |
titleFontStyle |
(blank) normal italic oblique |
Counter title font style. | normal | 25.0 |
titleFontWeight |
(blank)| normal| bold| lighter| 100| 200| 300| 400| 500| 600| 700| 800| 900 | Counter title font weight. | normal | 25.0 |
2. Examples of use
Example 1 :
In this example, we have one counter on the page and we are counting the number of registered students with a counting speed of 1 second.
The following code:
Copy to clipboard
{countup title="Students" titleFontWeight="bold" titleFontStyle="italic" titleFontColor="white" icon="2002" description="Registered Students" descriptionFontStyle="italic" descriptionFontColor="white" endingNumber="10" numberFontWeight="800" numberFontSize="70" numberFontColor="white" speed="1" delay="1" suffix="+" backgroundImage="1998" shadow="inset 2000px 0px 0px 0px #24a2c09c"}
produces on this site:
0+
Students
Registered Students
Example 2 :
In this example we have two counters on the same page and each counter has its own custom settings (counting speed, font style, font color,etc) and starts to count when it becomes visible in the viewport.
The following code:
Copy to clipboard
{countup title="Students" titleFontWeight="bold" titleFontStyle="italic" titleFontColor="white" description="Registered Students" descriptionFontStyle="italic" descriptionFontColor="white" endingNumber="15" numberFontWeight="800" numberFontSize="70" numberFontColor="white" speed="1" delay="1" suffix="+" backgroundImage="1998" shadow="inset 2000px 0px 0px 0px #24a2c09c"} {countup title="Countries" titleFontWeight="bold" titleFontColor="black" icon="2000" endingNumber="195" numberFontWeight="bold" numberFontSize="70" numberFontColor="black" speed="0.02" shadow="inset 2000px 0px 0px 0px #24a2c09c"}
Produces on this site:
0+
Students
Registered Students
0
Countries