JSPM

  • Created
  • Published
  • Downloads 332038
  • Score
    100M100P100Q168895F
  • License MIT

Restrict inputs to certain valid characters (e.g. formatting phone or card numbers)

Package Exports

  • restricted-input

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (restricted-input) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Restricted Input

Allow restricted character sets in input elements.

Features

  • Disallow arbitrary chars based on patterns
  • Maintains caret position
  • Format/Update on paste
  • Works in IE9+

Development

Install dependencies

$ npm i

Watch files and run server

$ npm run development

This will start a server on port 3099 which can be overridden with the PORT env var.

Run tests

There are unit tests:

$ npm t

Usage

import RestrictedInput from 'restricted-input';

const formattedCreditCardInput = new RestrictedInput({
  element: document.querySelector('#credit-card'),
  pattern: '{{9999}} {{9999}} {{9999}} {{9999}}'
});

API

options

Key Type Description
element HTMLInputElement or HTMLTextAreaElement A valid reference to an input or textarea DOM node
pattern RegExp A regular expression describing the allowed character set you wish for entry into corresponding field.

Browser Support

Desktop

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

TODO

  • Improve jsdoc
  • Add example guides/pages