/jquery-highlighter

Simple jquery plugin to highlight any DOM element.

Primary LanguageJavaScript

/*
 * jQuery highlighter plugin
 *
 * version 1.1 (2/29/2012)
 *
 * Dual licensed under the MIT and GPL licenses:
 *   http://www.opensource.org/licenses/mit-license.php
 *   http://www.gnu.org/licenses/gpl.html
 */

/**
 * The highlighter() method provides a simple way of highlighting DOM elements.  
 *
 * For more details see: https://github.com/unknpwn/jquery-highlighter
 *
 *
 * @example $('.a').highlighter();
 * @desc Highlights all links with the default yellow color.
 *
 * @example $('.a').highlighter({color: 'blue'});
 * @desc Highlights all links with the blue color.
 * 
 * @example $('.a').highlighter('destroy');
 * @desc Will remove any highlights applied to the selected elements.
 * 
 * @name highlighter
 * @type jQuery
 * @param Object literal options. See above.
 * @cat Plugins/Highlighter
 * @return jQuery
 * @author Brian Herold (bmherold@gmail.com)
 */