restricted-input
Advanced tools
Restrict inputs to certain valid characters (e.g. formatting phone or card numbers)
The restricted-input npm package allows developers to restrict the input in HTML input fields based on custom rules. It is useful for enforcing specific formats such as phone numbers, credit card numbers, or any other custom input patterns.
Restrict input to a specific pattern
This feature allows you to restrict the input to a specific pattern. In this example, the input is restricted to a phone number format (999-999-9999).
const RestrictedInput = require('restricted-input');
const inputElement = document.querySelector('#my-input');
new RestrictedInput({
element: inputElement,
pattern: '999-999-9999'
});Custom placeholder character
This feature allows you to set a custom placeholder character. In this example, the placeholder character is set to '_'.
const RestrictedInput = require('restricted-input');
const inputElement = document.querySelector('#my-input');
new RestrictedInput({
element: inputElement,
pattern: '999-999-9999',
placeholder: '_'
});Dynamic pattern updates
This feature allows you to update the input pattern dynamically. In this example, the pattern is initially set to a phone number format and then updated to a credit card format.
const RestrictedInput = require('restricted-input');
const inputElement = document.querySelector('#my-input');
const restrictedInput = new RestrictedInput({
element: inputElement,
pattern: '999-999-9999'
});
// Update the pattern dynamically
restrictedInput.updatePattern('9999-9999-9999-9999');Inputmask is a JavaScript library that creates an input mask. Input masks are a way to constrain data that users enter into form fields. It is more feature-rich compared to restricted-input, offering a wide range of predefined masks and additional options for customization.
Cleave.js is a JavaScript library for formatting input text content when you are typing. It offers a variety of formatting options such as credit card numbers, phone numbers, dates, and more. Cleave.js is similar to restricted-input but provides more built-in formats and easier configuration.
Vanilla Text Mask is a pure JavaScript input mask library. It allows you to create input masks for various types of data, including phone numbers, dates, and custom patterns. It is similar to restricted-input but offers more flexibility and integration with React, Angular, and other frameworks.
Allow restricted character sets in input elements.
Try the latest version of Restricted Input here.
Install dependencies
nvm use # if you have node version manager installed
npm i
Watch files and run demo server
npm run development
This will start a server on port 3099 which can be overridden with the PORT env var.
Unit tests
The following command will run the linting task and the unit tests.
npm test
Integration tests
We use Browserstack to automate end to end testing on Google Chrome, Safari, Firefox, Microsoft Edge, and Internet Explorer 11.
First, sign up for a free open source Browserstack account.
Copy the .env.example file to .env
cp .env.example .env
Fill in the BROWSERSTACK_USERNAME and BROWSERSTACK_ACCESS_KEY environmental variables with your credentials:
BROWSERSTACK_USERNAME=username
BROWSERSTACK_ACCESS_KEY=access_key
To run the integration tests in Safari, Google Chrome, Firefox, IE11 and Microsoft Edge:
npm run development # in another terminal window
npm run test:integration
To run tests in only one browser, prefix the test command with an ONLY_BROWSERS env variable:
# run only in edge browser
ONLY_BROWSERS=edge npm run test:integration
# run only in chrome browser
ONLY_BROWSERS=chrome npm run test:integration
# run only in ie 11 browser
ONLY_BROWSERS=ie npm run test:integration
# run only in safari browser
ONLY_BROWSERS=safari npm run test:integration
# run only in firefox browser
ONLY_BROWSERS=firefox npm run test:integration
To run tests in certain browsers, prefix the test command with an ONLY_BROWSERS env variable, with each browser comma separated:
# run only in edge and chrome browsers
ONLY_BROWSERS=edge,chrome npm run test:integration
To run only certain tests, add the .only property before running the test:
it.only('does something', function () {
import RestrictedInput from "restricted-input";
const formattedCreditCardInput = new RestrictedInput({
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. |
Desktop
Old versions of Samsung Android browsers are incompatible with formatting. These will not attempt to intercept the values and format the input.
FAQs
Restrict inputs to certain valid characters (e.g. formatting phone or card numbers)
The npm package restricted-input receives a total of 254,610 weekly downloads. As such, restricted-input popularity was classified as popular.
We found that restricted-input demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.