patron-money3 v3.21.4

Money Mask for Vue 3

View Demo

Disclaimer

The old v-money library seems to be abandoned! Since I use it in many projects and part of then will be upgraded to Vue3, I needed it to work after the upgrades.

Feel free to open an issue or post a pull request!

Features

• Arbitrary Precision with BigInt
• Lightweight (<4KB gzipped)
• Dependency free
• Mobile support
• Component or Directive flavors
• Accept copy/paste
• Editable
• Min / Max Limits

Arbitrary precision

Arbitrary precision is only supported with v-model. It expects to receive a string representation of a number. '12345.67'

Some break changes where introduced in this release. Let's follow a train of thought:
If your precision is set to 2 and you set a default model value of '55', it will be interpreted as '0.55'. To instruct the correct format on setup you need to pass in '55.00' when using v-model. The same is true for '5.5'. It will be interpreted as '0.55'. Another example: '55.5' => '5.55'. Arbitrary precision is supported by using string and BigInt with v-model.

For the majority of users, it will make sense to use float numbers and stay within the boundaries of Number. If you fit this instance, you need to use v-model with the number modifier, or v-model.number. But than, you are stuck with numbers smaller than 2^53 - 1 or 9007199254740991 or 9,007,199,254,740,991. Little more than nine quadrilion... See MAX_SAFE_INTEGER.

For those who are using v-model.number, integers and floats are compleatly understood.
Let's follow another train of thought:
If your precision is set to 2 and you set a default model value of 55, it will be interpreted as 55.00. The same is true for 5.5. It will be interpreted as 5.50. Another example: 55.5 => 55.50.

More Examples

Usage

Installation

npm i v-money3 --save

Register Globally (view codesandbox)

import { createApp } from "vue";
import money from 'v-money3'

const app = createApp({/* options */})

// register directive v-money3 and component <money3>
app.use(money)

Only Global Component (view codesandbox)

import { createApp } from "vue";
import { Money3Component } from 'v-money3'

const app = createApp({/* options */})

// register component <money3>
app.component("money3", Money3Component)

Only Global Directive (view codesandbox)

import { createApp } from "vue";
import { Money3Directive } from 'v-money3'

const app = createApp({/* options */})

// register directive v-money3
app.directive('money3', Money3Directive)

Use as component (view codesandbox)

<template>
  <money3 v-model="amount" v-bind="config"></money3> {{ amount }}
</template>

<script>
  import { Money3Component } from 'v-money3'

  export default {
    components: { money3: Money3Component },
    data () {
      return {
        amount: '12345.67',
        config: {
          masked: false,
          prefix: '',
          suffix: '',
          thousands: ',',
          decimal: '.',
          precision: 2,
          disableNegative: false,
          disabled: false,
          min: null,
          max: null,
          allowBlank: false,
          minimumNumberOfCharacters: 0,
        }
      }
    }
  }
</script>

Component v-model number modifier (view codesandbox)

v-model will always return a string. If the masked property is set to true it will be formatted, otherwise it will be a fixed string representation of a float number. If you need your model to be a float number use the number modifier. Ex.: v-model.number="amount"

• v-model="amount" will return a fixed string with typeof string. Ex.: "123456.78"
• v-model.number="amount" will return a float number with typeof number. Ex.: 123456.78

<template>
  <money3 v-model.number="amount" v-bind="config"></money3>
</template>

<script>
  import { Money3Component } from 'v-money3'

  export default {
    components: { money3: Money3Component },
    data () {
      return {
        amount: 12345.67,
        config: { ... }
      }
    }
  }
</script>

Use as directive (view codesandbox)

Must use v-model.lazy to bind works properly.

<template>
  <input v-model.lazy="amount" v-money3="config" />
</template>

<script>
  import { Money3Directive } from 'v-money3'

  export default {
    data () {
      return {
        amount: '12345.67',
        config: {
          prefix: '',
          suffix: '',
          thousands: ',',
          decimal: '.',
          precision: 2,
          disableNegative: false,
          disabled: false,
          min: null,
          max: null,
          allowBlank: false,
          minimumNumberOfCharacters: 0,
        }
      }
    },
    directives: { money3: Money3Directive }
  }
</script>

By default directives work with v-model. It is not possible to use v-model.number on directives, so, if you need to work with floats/integers on directives you need to configure the number modifier manually.

Using config:

modelModifiers: {
  number: true,
}

If you bind it directly you are just fine too:

<input :model-modifiers="{ number: true }" v-model.lazy="amount" v-money3="config" />

Properties

Restricted Characters

Numbers 0-9 and the following characters...

• +
• -

...are restricted on following properties:

• decimal
• thousands
• prefix
• suffix

Restricted inputs will be filter out of the final mask. A console warn with more information will be shown!

Don't want to use a package manager?

Use it directly in the browser!

<script src="https://unpkg.com/v-money3@3.21.1/dist/v-money3.umd.js"></script>

Take a look at issue #15 and also this codesandbox working example.

Use the internal mask functions

import { format, unformat } from 'v-money3';

const config = {
    debug: false,
    masked: false,
    prefix: '',
    suffix: '',
    thousands: ',',
    decimal: '.',
    precision: 2,
    disableNegative: false,
    disabled: false,
    min: null,
    max: null,
    allowBlank: false,
    minimumNumberOfCharacters: 0,
    modelModifiers: {
        number: false,
    },
}

const formatted = format(12345.67, config);
console.log(formatted);
// output string: 'R$ 12.345,67 #'

const unformatted = unformat(formatted, config);
console.log(unformatted);
// output fixed string: '12345.67'

/* ----------------- or ----------------- */

config.modelModifiers = { number: true };

const unformatted = unformat(formatted, config);
console.log(unformatted);
// output float number: 12345.67

References

• https://github.com/vuejs-tips/v-money (based on v-money)