vanilla

JavaScript Input Mask

Note: IE9 is not supported in this module.

Getting started

First, install it.

npm i vanilla-text-mask --save

Then, use it as follows:

<script
  type="text/javascript"
  src="./node_modules/vanilla-text-mask/dist/vanillaTextMask.js"
></script>
<script type="text/javascript">
  var phoneMask = [
    "(",
    /[1-9]/,
    /\d/,
    /\d/,
    ")",
    " ",
    /\d/,
    /\d/,
    /\d/,
    "-",
    /\d/,
    /\d/,
    /\d/,
    /\d/,
  ];

  // Assuming you have an input element in your HTML with the class .myInput
  var myInput = document.querySelector(".myInput");

  var maskedInputController = vanillaTextMask.maskInput({
    inputElement: myInput,
    mask: phoneMask,
  });

  // Calling `vanillaTextMask.maskInput` adds event listeners to the input element.
  // If you need to remove those event listeners, you can call
  maskedInputController.destroy();
</script>

Documentation

As you can see in the code above, you are passing an object to vanillaTextMask.maskInput(...).

The object takes inputElement, which is the <input/> element that you are masking. It also accepts other values which are documented here.

Example

To see an example of the code running, follow these steps:

1. Clone the repo, git clone git@github.com:im-open/text-mask.git
2. cd text-mask
3. npm install
4. npm run vanilla:dev
5. Open http://localhost:3000

The code of the example is in vanilla/example.

Contributing

We would love some contributions! Check out this document to get started.