Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/BankFacil/vanilla-masker


https://github.com/BankFacil/vanilla-masker

Last synced: 19 days ago
JSON representation

Lists

README 

        
# What's this



[![Build Status](https://travis-ci.org/vanilla-masker/vanilla-masker.svg)](https://travis-ci.org/vanilla-masker/vanilla-masker)



It's a pure JavaScript mask input.

Now you can use a simple and pure javascript lib to mask your input elements, without need to load jQuery or Zepto to do it.



Let's live a lightweight client-side world using micro libraries as VanillaMasker is!

Don't worry about where this will work, because this is a cross-browser and cross-device library. And if you find any bug, please let us know about it [reporting an issue](https://github.com/vanilla-masker/vanilla-masker/issues).



If you wanna see how this lib works, click to test this [demo page](https://vanilla-masker.github.io/vanilla-masker/demo.html).



# How to install



### Download script

* [development version](https://raw.githubusercontent.com/vanilla-masker/vanilla-masker/1.1.0/lib/vanilla-masker.js) (6.2 Kbytes);

* [minified version](https://raw.githubusercontent.com/vanilla-masker/vanilla-masker/1.1.0/build/vanilla-masker.min.js) (3.24 Kbytes);

* [gzipped version](https://raw.githubusercontent.com/vanilla-masker/vanilla-masker/1.1.0/build/vanilla-masker.min.gz.js) (1.3 Kbytes);



We have the following CDN available, for development or minified versions:



`//unpkg.com/[email protected]/lib/vanilla-masker.js`

`//unpkg.com/[email protected]/build/vanilla-masker.min.js`



We intent to automatically send new versions to the CDN, but keep in mind that the version you want might not be available there. Of course you can always download and put it in your own site.



### NPM

For npm users you just run this command: `npm install vanilla-masker --save`



### Bower

You can install it via bower too, using this command: `bower install --save vanilla-masker`



### Meteor

And you can install inside your meteor projects with this command: `meteor add bankfacil:vanilla-masker`



# How to use



### Loading the lib



Like I said, you need to download and put this lib in your own site, using this tag below:



``` html



   

   

      

      

      

   



```



### Common uses



#### Money format



``` javascript



// Masking input element to money.

VMasker(document.querySelector("data-js-input")).maskMoney();



// Masking input element to money with options.

VMasker(document.querySelector("data-js-input")).maskMoney({

  // Decimal precision -> "90"

  precision: 2,

  // Decimal separator -> ",90"

  separator: ',',

  // Number delimiter -> "12.345.678"

  delimiter: '.',

  // Money unit -> "R$ 12.345.678,90"

  unit: 'R$',

  // Money unit -> "12.345.678,90 R$"

  suffixUnit: 'R$',

  // Force type only number instead decimal,

  // masking decimals with ",00"

  // Zero cents -> "R$ 1.234.567.890,00"

  zeroCents: true

});



// Masking an array of input elements to money.

VMasker(document.querySelectorAll("data-js-input")).maskMoney();



// Converts number to money string

VMasker.toMoney(1234); // -> R$ 1.234,00

```



#### Only numbers



``` javascript

// Masking input element to number.

VMasker(document.querySelector("data-js-input")).maskNumber();



// Converts any string to number

VMasker.toNumber("123ac34"); // -> 12334

VMasker.toNumber("-123ac34"); // -> -12334

```



#### Custom pattern



``` javascript

// Listen the input element masking it to format with pattern.

VMasker(document.querySelector("input")).maskPattern("(99) 9999-9999");



// Converts value to masked phone

VMasker.toPattern(1099911111, "(99) 9999-9999"); // -> (10) 9991-1111

// Converts value to masked date

VMasker.toPattern(12122000, "99/99/9999"); // -> 12/12/2000

// Converts value to masked document

VMasker.toPattern(99911111101, "999.999.999-99"); // -> 999.111.111-01

// Converts value to masked car plate

VMasker.toPattern('ABC1234', "AAA-9999"); // -> ABC-1234

// Converts value to masked vehicle identification

VMasker.toPattern('9BGRD08X04G117974', "SS.SS.SSSSS.S.S.SSSSSS"); // -> 9B.GR.D08X0.4.G.117974



// Pass in an optional placeholder option to represent remaining characters to be entered

VMasker.toPattern('4', {pattern: "(999) 999-9999", placeholder: "x"}); // -> (4xx) xxx-xxxx

```



#### Undoing a mask



``` javascript

var el = document.querySelector("input")

VMasker(el).maskPattern("(99) 9999-9999"); // masking the input

VMasker(el).unMask(); // unmask!

```



#### Dynamic mask



Sometimes you need swap the mask according with value.

You can see the sample below on [codepen.io](http://codepen.io/lagden/pen/meemqG)



```javascript

function inputHandler(masks, max, event) {

  var c = event.target;

  var v = c.value.replace(/\D/g, '');

  var m = c.value.length > max ? 1 : 0;

  VMasker(c).unMask();

  VMasker(c).maskPattern(masks[m]);

  c.value = VMasker.toPattern(v, masks[m]);

}



var telMask = ['(99) 9999-99999', '(99) 99999-9999'];

var tel = document.querySelector('#tel');

VMasker(tel).maskPattern(telMask[0]);

tel.addEventListener('input', inputHandler.bind(undefined, telMask, 14), false);



var docMask = ['999.999.999-999', '99.999.999/9999-99'];

var doc = document.querySelector('#doc');

VMasker(doc).maskPattern(docMask[0]);

doc.addEventListener('input', inputHandler.bind(undefined, docMask, 14), false);

```



### Meteor uses



If your app is built on top of Meteor framework, you can use the lib in this way...



``` html



  
Welcome to Meteor!


  {{> myTemplate}}



  

  

  



```



You just need to bind the elements into the template `rendered` function...



``` javascript

if (Meteor.isClient) {

  Template.myTemplate.rendered = function() {

    VMasker(this.find("[data-vm-mask-money]")).maskMoney();

    VMasker(this.find("[data-vm-mask-number]")).maskNumber();

    VMasker(this.find("[data-vm-mask-date]")).maskPattern("99/99/9999");

  };

}

```



# How to run localhost



* Install node.js - http://nodejs.org/download

* Clone this repository - `git clone [email protected]:vanilla-masker/vanilla-masker.git`

* Install Grunt - `npm install -g grunt-cli`

* Install Grunt dependencies - `cd vanilla-masker && npm install`

* Running development mode - `grunt dev`

* Open the browser - http://localhost:4500



# Run test



* Run the command: `grunt test`



# Build project



* Run the command: `grunt build`



# TODO - we need pull requests :]



* Test Opera mini browser;

* Beautify Demo Page;

* Bind mask using `data-vm` attributes;



# Compatibility



Desktop browsers:



* Chrome 4.0+

* Firefox 2.0+

* Safari 4.0+

* Opera 10.0+

* Internet Explorer 8+



Mobile browsers:



* Android browser 2.2+

* Chrome mobile 35.0+

* Firefox mobile 29.0+

* Opera mobile 10.0+

* iOS Safari 3.2+

* Windows Phone browsers



# Contributors



Caio Ribeiro Pereira - [email protected]

Leandro Alvares da Costa - [email protected]

Bobby - [email protected]

Henrique Antonini Silvério - [email protected]

Joilson Marques - [email protected]

Leonardo Andrade - [email protected]

Thiago Lagden - [email protected]



# License



MIT License: http://vanilla-masker.mit-license.org