jquery.allowed-chars/dist/jquery.allowed-chars.js

jQuery plugin to restrict users for typing only allowed chars for specified element

/**
 * jQuery Allowed Chars simple plugin version: 1.0.4, date: 27/05/2014
 *
 * jQuery plugin to restrict users for typing only allowed chars (regExp) for specified element
 *
 * Copyright (c) 2014 Pavlo Voznenko (p.voznenko@gmail.com) and other contributors
 * Distributed under the MIT License
 *
 * GitHub: https://github.com/fosco-maestro/jquery-allowed-chars-simple-plugin
 * jQuery Plugin: http://plugins.jquery.com/jquery.allowed-chars/
 *
 * Usage Example: @see github: https://github.com/fosco-maestro/jquery-allowed-chars-simple-plugin
 *
 * Demo available on: http://jsfiddle.net/fosco/55XLd/
 */
;(function($, undefined) {
    "use strict";

    /**
     * By default plugin allow only int chars: 0123456789
     * You can change chars by passing string with chars as parameter
     *
     * @param {String|RegExp|Object} options
     */
    $.fn.allowedChars = function(options) {
        var settings = {
                allowed       : "0123456789",
                caseSensitive : true
            },
            $this = $(this);

        var methods = {

            /**
             * Method for init options
             *
             * @param {String|RegExp|Object} options
             * @returns {boolean}
             */
            init : function (options) {
                if (undefined !== options) {
                    var optionsType = Object.prototype.toString.call(options);
                    switch (optionsType) {
                        case "[object RegExp]":
                        case "[object String]":
                            settings.allowed = options;
                            break;
                        case "[object Object]":
                            $.extend(settings, options);
                            break;
                        default:
                            methods.errorHandler("Unexpected 'options' type: " + optionsType +
                                "; Supported types: RegExp, String, Object");

                            return false;
                        }
                }
                return true;
            },

            /**
             * Error handle, writing error to console through console.log if console.log defined
             *
             * @param {String} msg error message
             */
            errorHandler : function(msg) {
                if (undefined !== console && undefined !== console.log) {
                    console.log('jquery.allowedChars error: ' + msg);
                }
            }
        };

        if (methods.init(options)) {
            $this.keypress(function(event) {
                var key = window.event ? window.event.keyCode : (event.keyCode || (event.charCode || undefined)),
                    chars = settings.allowed,
                    isRegExp = "[object RegExp]" === Object.prototype.toString.call(chars),
                    keyChar;

                if (key === undefined) {
                    return true;
                }

                keyChar = String.fromCharCode(key);

                if (isRegExp) {
                    if (!chars.test(keyChar)) {
                        event.preventDefault();
                    }
                } else {
                    if (!settings.caseSensitive) {
                        chars = chars.toLowerCase();
                        keyChar = keyChar.toLowerCase();
                    }

                    if (chars.indexOf(keyChar) !== -1) {
                        return true;
                    }

                    var preventKeyPress = [null, 0, 8, 9, 13, 27].indexOf(key) === -1;

                    if (preventKeyPress) {
                        event.preventDefault();
                    }
                }

                return true;
            });
        }
    };
}(jQuery));