InputMask
A flexible modern input-mask js plugin.
Introduction
Installation
Yarn
yarn add @pluginjs/input-maskNPM
npm i @pluginjs/input-maskGetting Started
CDN:
Development:
<script src="https://unpkg.com/@pluginjs/input-mask/dist/input-mask.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/input-mask/dist/input-mask.css">Production:
<script src="https://unpkg.com/@pluginjs/input-mask/dist/input-mask.min.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/input-mask/dist/input-mask.min.css">Initialize
HTML:
<div class="element"></div>ECMAScript Module:
import InputMask from "@pluginjs/input-mask"
import "@pluginjs/input-mask/dist/input-mask.css"
InputMask.of(document.querySelector('.element'), options)CommonJS:
require("@pluginjs/input-mask/dist/input-mask.css")
const InputMask = require("@pluginjs/input-mask")
InputMask.of(document.querySelector('.element'), options)Browser:
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/input-mask/dist/input-mask.css">
<script src="https://unpkg.com/@pluginjs/input-mask/dist/input-mask.js"></script>
<script>
Pj.inputMask('.element', options)
</script>API
Options
Options are called on inputMask instances through the inputMask options itself. You can also save the instances to variable for further use.
| Name | Description | Default |
|---|---|---|
"type" |
Set plugin type option | custom |
"delimiter" |
Set plugin delimiter option | `` |
"blocks" |
Set plugin blocks option | noLimit |
Events
Events are called on inputMask instances through the inputMask events itself. You can also save the instances to variable for further use.
| Name | Description |
|---|---|
"ready" |
Gets fired when plugin has ready |
"enable" |
Gets fired when plugin has enabled |
"disable" |
Gets fired when plugin has disabled |
"destroy" |
Gets fired when plugin has destroy |
"focus" |
Gets fired when plugin has focus |
"blur" |
Gets fired when plugin has blur |
Methods
Methods are called on inputMask instances through the inputMask method itself. You can also save the instances to variable for further use.
| Name | Description |
|---|---|
"enable" |
Enabled plugin if plugin is disabled |
"disable" |
Disable plugin |
"destroy" |
Destroy plugin |
Classes
Name | Description | Default
--||
"NAMESPACE" | Declare plugin namespace | pj-inputMask
"INPUT" | Declare plugin input | {namespace}-input
Browser support
Tested on all major browsers.
 IE / Edge |
 Firefox |
 Chrome |
 Safari |
 Opera |
|---|---|---|---|---|
| IE11, Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
License
@pluginjs/input-mask is Licensed under the GPL-v3 license.
If you want to use @pluginjs/input-mask project to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary.
For purchase an Commercial License, contact us purchase@thecreation.co.
Copyright
Copyright (C) 2022 Creation Studio Limited.