npmpackage.info

Gathering detailed insights and metrics for restricted-input

Other packages similar to restricted-input

@terra-dev/use-restricted-input

0.20.1

Restrict text input

vue-restricted-input

1.0.2

Creates a pattern for restricted-input from data obtained from credit-card-type

use-restricted-input

0.1.0

Restricts key input to <input/> elements

react-restricted-input

1.0.3

Restrict text inputs to only accept certain characters.

Gathering detailed insights and metrics for restricted-input

restricted-input - 4.1.4 | npmpackage.info

restricted-input

Restrict <input>s to certain valid characters (e.g. formatting phone or card numbers)

4.1.4

MIT

TypeScript

53.56 kB

Installations

npm install restricted-input

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

18.20.7

NPM Version

10.8.2 Pull Requests

Open

6

Total

120

Closed

30

Merged

84

Issues

Open

0

Total

10

Closed

10

Releases

v4.1.4

4.1.4

Updated on Feb 26, 2025

v4.1.3

4.1.3

Updated on Feb 25, 2025

v4.1.2

4.1.2

Updated on Feb 25, 2025

v4.1.1

4.1.1

Updated on Feb 24, 2025

v4.1.0

4.1.0

Updated on Feb 21, 2025

4.0.1

v4.0.1

Updated on Apr 10, 2024

View All 14 releases

Languages

TypeScript

JavaScript

HTML

TypeScript (66.61%)

JavaScript (25.73%)

HTML (7.66%)

Developer

braintree

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

70 Stars

324 Commits

26 Forks

19 Watchers

41 Branches

81 Contributors

Updated on May 27, 2025

Maintainers

View All 81 Contributors

Package Meta Information

Latest Version

4.1.4

Package Id

restricted-input@4.1.4

Unpacked Size

53.56 kB

Size

13.17 kB

File Count

NPM Version

10.8.2

Node Version

18.20.7

Published on

Feb 26, 2025

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Restricted Input

Allow restricted character sets in input elements.

Demo

Try the latest version of Restricted Input here.

Features

Disallow arbitrary characters based on patterns
Maintains caret position
Format/Update on paste
Works in IE11+

Development

Install dependencies

1nvm use # if you have node version manager installed
2npm i

Watch files and run demo server

1npm 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.

1npm 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

1cp .env.example .env

Fill in the BROWSERSTACK_USERNAME and BROWSERSTACK_ACCESS_KEY environmental variables with your credentials:

1BROWSERSTACK_USERNAME=username
2BROWSERSTACK_ACCESS_KEY=access_key

To run the integration tests in Safari, Google Chrome, Firefox, IE11 and Microsoft Edge:

1npm run development # in another terminal window
2npm run test:integration

To run tests in only one browser, prefix the test command with an ONLY_BROWSERS env variable:

1# run only in edge browser
2ONLY_BROWSERS=edge npm run test:integration
3
4# run only in chrome browser
5ONLY_BROWSERS=chrome npm run test:integration
6
7# run only in ie 11 browser
8ONLY_BROWSERS=ie npm run test:integration
9
10# run only in safari browser
11ONLY_BROWSERS=safari npm run test:integration
12
13# run only in firefox browser
14ONLY_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:

1# run only in edge and chrome browsers
2ONLY_BROWSERS=edge,chrome npm run test:integration

To run only certain tests, add the .only property before running the test:

1it.only('does something', function () {

Usage

1import RestrictedInput from "restricted-input";
2
3const formattedCreditCardInput = new RestrictedInput({
4  element: document.querySelector("#credit-card"),
5  pattern: "{{9999}} {{9999}} {{9999}} {{9999}}",
6});

Patterns

Patterns are a mixture of Placeholders and PermaChars.

Placeholder

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 single alpha character that matches the alpha regex /[A-Za-z]/. e.g. {{C}} will match one alpha character.
a single digit that matches the digit regex /[0-9]/. e.g. {{3}} will match one digit.
a * character that matches /./. e.g. {{*}} will match the next character.

PermaChar

A PermaChar is the part of the pattern that is automatically inserted. PermaChars are defined in the pattern as any characters other than Placeholders.

Example patterns

Some example patterns with behavior are listed:

12{{3}}
- Inserts 12.
- Waits for a single digit from the user.
{{A}}BC
- Waits for a single alpha from the user.
- Inserts BC.
${{*2L}}E
- Inserts $.
- Waits for any single character input from the user.
- Waits for a single digit from the user.
- Waits for a single alpha from the user.
- Inserts E.

Paste Event

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:

1const formattedCreditCardInput = new RestrictedInput({
2  element: document.querySelector('#credit-card'),
3  pattern: '{{9999}} {{9999}} {{9999}} {{9999}}',
4  onPasteEvent: function (payload) {
5    var value = payload.unformattedInputValue;
6
7    if (requiresAmexPattern(value)) {
8      formattedCreditCardInput.setPattern('{{9999}} {{999999}} {{99999}}')
9    } else {
10      formattedCreditCardInput.setPattern('{{9999}} {{9999}} {{9999}} {{9999}}')
11    }
12  })
13});

API

options

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.

Browser Support

Desktop

Chrome (latest)
Firefox (17+)
Safari (8+)
IE11 (desktop/metro)
IE10 (desktop/metro)
IE9

Browsers Where Formatting is Turned Off Automatically

Old versions of Samsung Android browsers are incompatible with formatting. These will not attempt to intercept the values and format the input.

TODO

Improve jsdoc
Add example guides/pages

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

3

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 3

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/braintree/restricted-input/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/braintree/restricted-input/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/integration-tests.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/braintree/restricted-input/integration-tests.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/integration-tests.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/braintree/restricted-input/integration-tests.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/integration-tests.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/braintree/restricted-input/integration-tests.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/integration-tests.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/braintree/restricted-input/integration-tests.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/integration-tests.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/braintree/restricted-input/integration-tests.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-gh-pages.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/braintree/restricted-input/publish-gh-pages.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-gh-pages.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/braintree/restricted-input/publish-gh-pages.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/braintree/restricted-input/publish.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/braintree/restricted-input/publish.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-notes.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/braintree/restricted-input/release-notes.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-notes.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/braintree/restricted-input/release-notes.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-notes.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/braintree/restricted-input/release-notes.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/version-bump.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/braintree/restricted-input/version-bump.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/version-bump.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/braintree/restricted-input/version-bump.yml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/integration-tests.yml:35
Info: 0 out of 13 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 3 third-party GitHubAction dependencies pinned
Info: 3 out of 4 npmCommand dependencies pinned

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to restricted-input

Other packages similar to restricted-input

restricted-input

Installations

Developer Guide

Yes

CommonJS

18.20.7

10.8.2

Pull Requests

6

120

30

84

Issues

0

10

10

Releases

Languages

Developer

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

Restricted Input

Demo

Features

Development

Usage

Patterns

Placeholder

PermaChar

Example patterns

Paste Event

API

options

Browser Support

Browsers Where Formatting is Turned Off Automatically

TODO

10

10

10

3

3

0

0

0

0

0

0

0

0

3

/10