___ __ __ _
/ _/__ ______ _ ___ _/ /_/ /____ ____ (_)__
/ _/ _ \/ __/ ' \/ _ `/ __/ __/ -_) __/ / (_-<
/_/ \___/_/ /_/_/_/\_,_/\__/\__/\__/_/ (_)_/ /___/
|___/
Format user input to match a specified pattern
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.
bower install formatter
- uncompressed: formatter.js
- compressed: formatter.min.js
new Formatter(document.getElementById('credit-input'), {
'pattern': '{{999}}-{{999}}-{{999}}-{{9999}}',
'persistent': true
});
- uncompressed: jquery.formatter.js
- compressed: jquery.formatter.min.js
$('#credit-input').formatter({
'pattern': '{{999}}-{{999}}-{{999}}-{{9999}}',
'persistent': true
});
- 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.
Install Dependencies:
npm install
Run Tests:
npm test
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.