/formatter.js

Format html inputs to match a specified pattern
  1. JavaScript 95.4%
  2. CSS 4.6%
JavaScript CSS

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Download ZIP
Find file
Switch branches/tags
Nothing to show
Latest commit 21e6419 Oct 31, 2013 @jaridmargolin jaridmargolin bump package.json
Permalink
Failed to load latest commit information.
lib Better functioning delete key Oct 29, 2013
src Better functioning delete key Oct 29, 2013
test arrow key error Oct 29, 2013
.gitignore Add _site dir to .gitignore Oct 21, 2013
.travis.yml bump version Oct 31, 2013
Gruntfile.js Add support for jquery Oct 21, 2013
Makefile Add unit tests Oct 4, 2013
README.md Fix #5 Oct 29, 2013
package.json bump package.json Oct 31, 2013

README.md

formatter.js Build Status

   ___                    __  __              _   
  / _/__  ______ _  ___ _/ /_/ /____ ____    (_)__
 / _/ _ \/ __/  ' \/ _ `/ __/ __/ -_) __/   / (_-<
/_/ \___/_/ /_/_/_/\_,_/\__/\__/\__/_/ (_)_/ /___/
                                        |___/

Format user input to match a specified pattern

Demos/Examples

view demo

Why?

Sometimes it is useful to format user input as they type. Existing libraries lacked proper functionality / felxibility. Formatter was built from the ground up with no dependencies. There is however a jquery wrapper version for quick use.

On Bower

bower install formatter

Usage

Vanilla Javascript

  • uncompressed: formatter.js
  • compressed: formatter.min.js

new Formatter(el, opts)

new Formatter(document.getElementById('credit-input'), {
  'pattern': '{{999}}-{{999}}-{{999}}-{{9999}}',
  'persistent': true
});

Jquery

  • uncompressed: jquery.formatter.js
  • compressed: jquery.formatter.min.js

$(selector).formatter(opts)

$('#credit-input').formatter({
  'pattern': '{{999}}-{{999}}-{{999}}-{{9999}}',
  'persistent': true
});

Opts

  • pattern (required): String representing the pattern of your formatted input. User input areas begin with {{ and end with }}. For example, a phone number may be represented: ({{999}}) {{999}}-{{999}}. You can specify numbers, letters, or numbers and letters.
    • 9: [0-9]
    • a: [A-Za-z]
    • *: [A-Za-z0-9]
  • persistent: [False] Boolean representing if the formatted characters are always visible (persistent), or if they appear as you type.

Tests

Install Dependencies:

npm install

Run Tests:

npm test

License

The MIT License (MIT) Copyright (c) 2013 First Opinion

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.