Skip to content

README.md

Latest commit

 

History

History
104 lines (77 loc) · 3.7 KB

README.md

File metadata and controls

104 lines (77 loc) · 3.7 KB

Documentation SimpleMaskMoney 3.x.x (deprecated)

The SimpleMaskMoney class hosts three methods for formatting the values and one property to configure the formatting.

SimpleMaskMoney.args

.args is the property, of type object that sets the formatting:

// Default args
SimpleMaskMoney.args = {
  afterFormat(e) { console.log('afterFormat', e); },
  allowNegative: false,
  beforeFormat(e) { console.log('beforeFormat', e); },
  negativeSignAfter: false,
  prefix: '',
  suffix: '',
  fixed: true,
  fractionDigits: 2,
  decimalSeparator: ',',
  thousandsSeparator: '.',
  cursor: 'move'
};

The args they are:

  • afterFormat: function > This function will be called always after value formated
  • allowNegative: boolean > This boolean define if allow values ​​below zero
  • beforeFormat: function > This function will be called always before value formated
  • negativeSignAfter: boolean > This boolean define if negative sign stay after the number
  • prefix: string > This string always precedes its value
  • suffix: string > This string always procedes its value
  • fixed: boolean > This boolean define if your value can be empty or always should have value
  • fractionDigits: number > This number define the quantity of decimals digits
  • decimalSeparator: string > This string define the separator of decimals digits
  • thousandsSeparator: string > This string define the separator of thousands digits
  • cursor: string > This string define how the cursor will move. Can be move, end, or start.

SimpleMaskMoney.formatToCurrency(...)

.formatToCurrency(...) have three arguments, the value, args(optional):

// With default args
SimpleMaskMoney.formatToCurrency('123456789'); // 1.234.567,89
// With custom args
SimpleMaskMoney.formatToCurrency('123456789', { prefix: 'R$' }); // R$1.234.567,89

The arguments they are:

  • value: string > The value of your input or value that will be formatted
  • args: object > This is the configurations of the formattation. If this argument is omitted the arguments defined in SimpleMaskMoney.args = {} will be used

SimpleMaskMoney.formatToMask(...)

.formatToMask(...) have three arguments, the value, args(optional), is very similar to formatToCurrency however this method contains the suffix delete logic:

// With default args
SimpleMaskMoney.formatToMask('123456789.', { suffix: '.' }); // 1.234.567,8.
// Without suffix on end this method remove last character
SimpleMaskMoney.formatToMask('123456789'); // 123.456,7.

The arguments they are:

  • value: string > The value of your input or value that will be formatted
  • args: object > This is the configurations of the formattation. If this argument is omitted the arguments defined in SimpleMaskMoney.args = {} will be used

SimpleMaskMoney.formatToNumber(...)

.formatToNumber(...) have one argument, the value, args(optional) that will be formatted to number:

// With default args
SimpleMaskMoney.formatToNumber('$ 1.234.567,89'); // 1234567.89

SimpleMaskMoney.setMask(...)

.setMask(...) have two arguments, the input or input selector and args. This method get the input and implements the mask with this args:

<!-- With default args -->
<input type="text" inputmode="numeric" id="#myInput">

Use the query selector

// With default args
SimpleMaskMoney.setMask('#myInput', args); // 1.234.567,89

Or if you prefer pass the input element

const element = document.getElementById('#myInput');

SimpleMaskMoney.setMask(element, args); // 1.234.567,89