@tadashi/currency NPM

Currency

The simple and tiny script for currency input mask

Install

$ npm i @tadashi/currency

API

new Currency(input [, opts])

Constructs a new Currency instance for a given input element.

parameter	type	required	default	description
input	HTMLElement	yes	-	The input element
opts	Object	no	see below	Optional settings

opts

parameter	type	required	default	description
keyEvent	String	no	input	The event type for input
triggerOnBlur	Boolean	no	false	Trigger event on blur
init	Boolean	no	false	Initialize masking on instance creation
backspace	Boolean	no	false	Handle backspace
maskOpts	Object	no	see below	Masking options

maskOpts

parameter	type	required	default	description
digits	Number	no	2	The number of digits after the decimal point
empty	Boolean	no	false	Allow empty value
locales	String or Array	no	pt-BR	The locales to use for formatting - Intl.NumberFormat()
options	Object	no	-	Additional options for formatting - Intl.NumberFormat()
viaInput	Boolean	no	false	Specify if the value is coming directly from an input

getUnmasked()

Get the unmasked value of the input.

Static methods

Currency.data(input)

Check if input has a Currency instance.

parameter	type	required	default	description
input	HTMLInputElement	yes	-	The input element

Currency.masking(v [, opts])

Formats a numeric value as a currency string with masking.

parameter	type	required	default	description
v	String	Number	yes	-
opts	Object	no	see above	Masking options

Currency.unmasking(v)

Convert a masked value into an unmasked numeric value.

parameter	type	required	default	description
v	String	yes	-	The masked input value.
digits	Number	no	2	The number of digits after the decimal point.

Usage

Codepen example: https://codepen.io/lagden/pen/jOrZVjg?editors=1010

<input id="money" type="text" inputmode="numeric">

<script type="module">
  import Currency from 'https://unpkg.com/@tadashi/currency@{version}/src/currency.js'

  // Instance
  const mask = new Currency(money)

  // Static mode
  Currency.masking(1100) // => 1.100,00
</script>