package
Restrict inputs to certain valid characters (e.g. formatting phone or card numbers)
npm install credit-card-input-maskGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
forked from braintree/restricted-input
Allow restricted character sets in input elements.
$ npm install --save credit-card-input-maskimport CreditCardInputMask from "credit-card-input-mask";
const formattedCreditCardInput = new CreditCardInputMask({
element: document.querySelector("#credit-card"),
pattern: "{{9999}} {{9999}} {{9999}} {{9999}}",
});Patterns are a mixture of Placeholders and PermaChars.
A Placeholder is the part of the pattern that accepts user input based on some restrictions. A placeholder is defined in the pattern using two open curly brackets, the placeholder, followed by two closing curly brackets e.g. {{Abc123}}.
The patterns a Placeholder can be are:
/[A-Za-z]/. e.g. {{C}} will match one alpha character./[0-9]/. e.g. {{3}} will match one digit.* character that matches /./. e.g. {{*}} will match the next character.A PermaChar is the part of the pattern that is automatically inserted. PermaChars are defined in the pattern as any characters other than Placeholders.
Some example patterns with behavior are listed:
12{{3}}
12.{{A}}BC
BC.${{*2L}}E
$.E.If an input is changed via a paste event, you may want to adjust the pattern before input formatting occurs. In this case, pass an onPasteEvent callback:
const formattedCreditCardInput = new RestrictedInput({
element: document.querySelector('#credit-card'),
pattern: '{{9999}} {{9999}} {{9999}} {{9999}}',
onPasteEvent: function (payload) {
var value = payload.unformattedInputValue;
if (requiresAmexPattern(value)) {
formattedCreditCardInput.setPattern('{{9999}} {{999999}} {{99999}}')
} else {
formattedCreditCardInput.setPattern('{{9999}} {{9999}} {{9999}} {{9999}}')
}
})
});| Key | Type | Description |
|---|---|---|
| element | HTMLInputElement or HTMLTextAreaElement | A valid reference to an input or textarea DOM node |
| pattern | String | Pattern describing the allowed character set you wish for entry into corresponding field. See Patterns. |
| onPasteEvent | Function (optional) | A callback function to inspect the unformatted value of the input during a paste event. See Paste Event. |
input elements.Estimated unpacked size across 3 packages.
170.8 kB
Includes dependencies.