-
Notifications
You must be signed in to change notification settings - Fork 3
/
readme.txt
122 lines (82 loc) · 4.1 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
=== WP CountUP JS ===
Contributors: rokumetal
Donate link: https://paypal.me/roelmagdaleno
Tags: WP CountUP JS, CountUP, CountUP JS, counters, animated
Requires at least: 5.7.4
Tested up to: 5.8.2
Stable tag: 4.2.4
Requires PHP: 7.0
License: GPLv3 or later
License URI: https://www.gnu.org/licenses/gpl-3.0.html
Display multiple animated counters into your WordPress site.
## Description ##
Display multiple animated counters into your WordPress site.
## Installation ##
1. Install the plugin via Wordpress Plugin Installer.
2. Activate the plugin through the 'Plugins' screen in WordPress.
3. Go to "Settings"->"CountUP.js" menu to configure options of the plugin.
## Gutenberg
The plugin is compatible with Gutenberg, so you can add the custom block called _**CountUp**_ to your posts and pages. [Check the wiki for more details](https://github.com/roelmagdaleno/wp-countup-js/wiki/Gutenberg-Block).
## Shortcode
It's very easy to use this plugin, you can use the shortcode after install it, but there are two ways to use the plugin:
The first way is:
`[countup start="your-value" end="your-value" decimals="your-value" duration="your-value"]`
The second way. To use this format you need to check the **_Use the end number inside the shortcode?_** setting in the plugin option page:
`[countup start="the-start-number" decimals="your-value" duration="your-value"]the-end-number[/countup]`
### Example
You can use the shortcode in two ways, as mentioned before. If you are using the first way:
`[countup start="0" end="55" decimals="2" duration="5" prefix="my_prefix" scroll="false"]`
If you are using the second way (remember to check the **_Use the end number inside the shortcode?_**):
`[countup start="0" decimals="2" duration="5"]55[/countup]`
Copy and paste any example in one of your posts and test.
## Available Attributes
The shortcode and Gutenberg block accepts the next arguments:
- decimals - Puts the desired decimals into your counter.
- delay - Set a delay in milliseconds to start the counter.
- duration - The counter duration represented by a number (seconds).
- easing - Easing the counter.
- end - A number to end (arrive) the counter.
- grouping - Groups the content into sections (eg. 1,000 vs 1000).
- prefix - A text as counter prefix.
- reset - Reset the counter after view.
- scroll - If true, start the counter when the user visualize it.
- separator - You can use a separator (default is comma).
- start - A number to start the counter.
- suffix - A text as counter suffix.
## Settings
You know how to use the plugin now, but you can still edit some options inside of the plugin settings page (Go to _**Settings->CountUP.js**_).
Inside of the settings page, you can find the next settings:
- Easing: Easing the counter.
- Grouping: Groups the content into sections (eg. 1,000 vs 1000).
- Separator: You can use a separator (default is comma).
- Decimal: Symbol to use for decimal spot (default is dot).
- Prefix: Character(s) at beginning of string.
- Suffix: Character(s) at the end of string.
## Screenshots ##
1. Screenshot-1: Output counters on the site.
2. Screenshot-2: Shortcode example.
3. Screenshot-3: Plugin options page.
4. Screenshot-4: CountUp.js Options inside shortcode.
5. Screenshot-5: Output counters on the site with individual prefix and suffix.
== Upgrade Notice ==
= 4.2.4 =
* IMPROVE: Remove Gutenberg dependencies, those aren't needed anymore.
= 4.2.3 =
* FIX: Decimal counters shows as integers instead of floats.
= 4.2.2 =
* FIX: JavaScript file wasn't loading properly in some posts and pages for shortcodes.
= 4.2.1 =
* FIX: Main script was loading as type JavaScript instead of Module.
= 4.2.0 =
* Compatible with Gutenberg. Now the plugin has its own Gutenberg Block.
== Changelog ==
= 4.2.4 =
* IMPROVE: Remove Gutenberg dependencies, those aren't needed anymore.
= 4.2.3 =
* FIX: Decimal counters shows as integers instead of floats.
= 4.2.2 =
* FIX: JavaScript file wasn't loading properly in some posts and pages for shortcodes.
= 4.2.1 =
* FIX: Main script was loading as type JavaScript instead of Module.
= 4.2.0 =
* Compatible with Gutenberg. Now the plugin has its own Gutenberg Block.