DynamicNumber

A flexible modern dynamic-number js plugin.

Samples

Introduction

Installation

Yarn

yarn add @pluginjs/dynamic-number

NPM

npm i @pluginjs/dynamic-number

Getting Started

CDN:

Development:

<script src="https://unpkg.com/@pluginjs/dynamic-number/dist/dynamic-number.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/dynamic-number/dist/dynamic-number.css">

Production:

<script src="https://unpkg.com/@pluginjs/dynamic-number/dist/dynamic-number.min.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/dynamic-number/dist/dynamic-number.min.css">

Initialize

HTML:

<div class="element"></div>

ECMAScript Module:

import DynamicNumber from "@pluginjs/dynamic-number"
import "@pluginjs/dynamic-number/dist/dynamic-number.css"

DynamicNumber.of(document.querySelector('.element'), options)

CommonJS:

require("@pluginjs/dynamic-number/dist/dynamic-number.css")
const DynamicNumber = require("@pluginjs/dynamic-number")

DynamicNumber.of(document.querySelector('.element'), options)

Browser:

<link rel="stylesheet" href="https://unpkg.com/@pluginjs/dynamic-number/dist/dynamic-number.css">
<script src="https://unpkg.com/@pluginjs/dynamic-number/dist/dynamic-number.js"></script>
<script>
  Pj.dynamicNumber('.element', options)
</script>

API

Options

Options are called on dynamicNumber instances through the dynamicNumber options itself. You can also save the instances to variable for further use.

Name | Description | Default --|--|-- "from" | Set smallest number | 0 "to" | Set the largest number | 100 "duration" | Set duration | 1000 "decimals" | Set decimals value | 0 "format" | Set format callback | function() {...} "percentage" | Set percentage config | {"decimals":0} "currency" | Set currency config | {"indicator":"$","size":3,"decimals":"2","separator":",","decimalsPoint":"."} "group" | Set group config | {"size":3,"decimals":"2","separator":",","decimalsPoint":"."}

Events

Events are called on dynamicNumber instances through the dynamicNumber events itself. You can also save the instances to variable for further use.

Name | Description --|-- "ready" | Gets fired when plugin is ready "start" | Gets fired when plugin is started "stop" | Gets fired when plugin is stop "finish" | Gets fired when plugin is finish "reset" | Gets fired when plugin has be reset "destroy" | Gets fired when plugin is destroy

Methods

Methods are called on dynamicNumber instances through the dynamicNumber method itself. You can also save the instances to variable for further use.

Name | Description --|-- "start" | Start plugin "stop" | Stop plugin "finish" | Finish plugin "reset" | Reset plugin "destroy" | Destroy plugin "go" | Move the number to the specified value

Browser support

Tested on all major browsers.

| IE / Edge | Firefox | Chrome | Safari | Opera | | --------- | --------- | --------- | --------- | --------- | | IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions|

License

@pluginjs/dynamic-number is Licensed under the GPL-v3 license.

If you want to use @pluginjs/dynamic-number project to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary.

For purchase an Commercial License, contact us [email protected].

Copyright

Copyright (C) 2022 Creation Studio Limited.