Wrote jquery.colorUtil plugin.
authorKrinkle <krinkle@users.mediawiki.org>
Wed, 5 Jan 2011 23:24:07 +0000 (23:24 +0000)
committerKrinkle <krinkle@users.mediawiki.org>
Wed, 5 Jan 2011 23:24:07 +0000 (23:24 +0000)
* Introduces rgbToHsl and hslToRgb functions
* Introdoces a simple way to get a brigher or darker color
* Moved getRGB() function and colors-array from jquery.color to it so they are publically available.
* Applied fixed from JSLint to all of this
* Made jquery.color use these instead to avoid duplication and added dependency for it

resources/Resources.php
resources/jquery/jquery.color.js
resources/jquery/jquery.colorUtil.js [new file with mode: 0644]

index dd524f1..174044c 100644 (file)
@@ -47,8 +47,12 @@ return array(
        'jquery.collapsibleTabs' => array(
                'scripts' => 'resources/jquery/jquery.collapsibleTabs.js'
        ),
+       'jquery.colorUtil' => array(
+               'scripts' => 'resources/jquery/jquery.colorUtil.js'
+       ),
        'jquery.color' => array(
-               'scripts' => 'resources/jquery/jquery.color.js'
+               'scripts' => 'resources/jquery/jquery.color.js',
+               'dependencies' => 'jquery.colorUtil'
        ),
        'jquery.cookie' => array(
                'scripts' => 'resources/jquery/jquery.cookie.js'
index e1b0d0d..3866107 100644 (file)
@@ -2,6 +2,8 @@
  * jQuery Color Animations
  * Copyright 2007 John Resig
  * Released under the MIT and GPL licenses.
+ *
+ * - 2011-01-05: Modified by Krinkle to use the jQuery.colorUtil plugin (needs to be loaded first)
  */
 
 (function(jQuery){
@@ -11,7 +13,7 @@
                jQuery.fx.step[attr] = function(fx){
                        if ( fx.state == 0 ) {
                                fx.start = getColor( fx.elem, attr );
-                               fx.end = getRGB( fx.end );
+                               fx.end = $.colorUtil.getRGB( fx.end );
                        }
 
                        fx.elem.style[attr] = "rgb(" + [
                        ].join(",") + ")";
                }
        });
-
-       // Color Conversion functions from highlightFade
-       // By Blair Mitchelmore
-       // http://jquery.offput.ca/highlightFade/
-
-       // Parse strings looking for color tuples [255,255,255]
-       function getRGB(color) {
-               var result;
-
-               // Check if we're already dealing with an array of colors
-               if ( color && color.constructor == Array && color.length == 3 )
-                       return color;
-
-               // Look for rgb(num,num,num)
-               if (result = /rgb\(\s*([0-9]{1,3})\s*,\s*([0-9]{1,3})\s*,\s*([0-9]{1,3})\s*\)/.exec(color))
-                       return [parseInt(result[1]), parseInt(result[2]), parseInt(result[3])];
-
-               // Look for rgb(num%,num%,num%)
-               if (result = /rgb\(\s*([0-9]+(?:\.[0-9]+)?)%\s*,\s*([0-9]+(?:\.[0-9]+)?)%\s*,\s*([0-9]+(?:\.[0-9]+)?)%\s*\)/.exec(color))
-                       return [parseFloat(result[1])*2.55, parseFloat(result[2])*2.55, parseFloat(result[3])*2.55];
-
-               // Look for #a0b1c2
-               if (result = /#([a-fA-F0-9]{2})([a-fA-F0-9]{2})([a-fA-F0-9]{2})/.exec(color))
-                       return [parseInt(result[1],16), parseInt(result[2],16), parseInt(result[3],16)];
-
-               // Look for #fff
-               if (result = /#([a-fA-F0-9])([a-fA-F0-9])([a-fA-F0-9])/.exec(color))
-                       return [parseInt(result[1]+result[1],16), parseInt(result[2]+result[2],16), parseInt(result[3]+result[3],16)];
-
-               // Otherwise, we're most likely dealing with a named color
-               return colors[jQuery.trim(color).toLowerCase()];
-       }
        
        function getColor(elem, attr) {
                var color;
                        attr = "backgroundColor";
                } while ( elem = elem.parentNode );
 
-               return getRGB(color);
-       };
-       
-       // Some named colors to work with
-       // From Interface by Stefan Petre
-       // http://interface.eyecon.ro/
-
-       var colors = {
-               aqua:[0,255,255],
-               azure:[240,255,255],
-               beige:[245,245,220],
-               black:[0,0,0],
-               blue:[0,0,255],
-               brown:[165,42,42],
-               cyan:[0,255,255],
-               darkblue:[0,0,139],
-               darkcyan:[0,139,139],
-               darkgrey:[169,169,169],
-               darkgreen:[0,100,0],
-               darkkhaki:[189,183,107],
-               darkmagenta:[139,0,139],
-               darkolivegreen:[85,107,47],
-               darkorange:[255,140,0],
-               darkorchid:[153,50,204],
-               darkred:[139,0,0],
-               darksalmon:[233,150,122],
-               darkviolet:[148,0,211],
-               fuchsia:[255,0,255],
-               gold:[255,215,0],
-               green:[0,128,0],
-               indigo:[75,0,130],
-               khaki:[240,230,140],
-               lightblue:[173,216,230],
-               lightcyan:[224,255,255],
-               lightgreen:[144,238,144],
-               lightgrey:[211,211,211],
-               lightpink:[255,182,193],
-               lightyellow:[255,255,224],
-               lime:[0,255,0],
-               magenta:[255,0,255],
-               maroon:[128,0,0],
-               navy:[0,0,128],
-               olive:[128,128,0],
-               orange:[255,165,0],
-               pink:[255,192,203],
-               purple:[128,0,128],
-               violet:[128,0,128],
-               red:[255,0,0],
-               silver:[192,192,192],
-               white:[255,255,255],
-               yellow:[255,255,0]
+               return $.colorUtil.getRGB(color);
        };
        
 })(jQuery);
diff --git a/resources/jquery/jquery.colorUtil.js b/resources/jquery/jquery.colorUtil.js
new file mode 100644 (file)
index 0000000..d1a9c5d
--- /dev/null
@@ -0,0 +1,195 @@
+/*
+ * jQuery Color Utilities
+ * Written by Krinkle in 2011
+ * Released under the MIT and GPL licenses.
+ * Mostly based on other plugins and functions (taken through JSLint and optimized a little).
+ * Sources cited locally.
+ */
+( function( $ ) {
+
+       $.colorUtil = {
+
+               // Color Conversion function from highlightFade
+               // By Blair Mitchelmore
+               // http://jquery.offput.ca/highlightFade/
+               // Parse strings looking for color tuples [255,255,255]
+               getRGB : function( color ) {
+                       var result;
+
+                       // Check if we're already dealing with an array of colors
+                       if ( color && color.constructor == Array && color.length == 3 ){
+                               return color;
+                                }
+
+                       // Look for rgb(num,num,num)
+                       if (result = /rgb\(\s*([0-9]{1,3})\s*,\s*([0-9]{1,3})\s*,\s*([0-9]{1,3})\s*\)/.exec(color)) {
+                               return [parseInt(result[1],10), parseInt(result[2],10), parseInt(result[3],10)];
+                       }
+
+                       // Look for rgb(num%,num%,num%)
+                       if (result = /rgb\(\s*([0-9]+(?:\.[0-9]+)?)\%\s*,\s*([0-9]+(?:\.[0-9]+)?)\%\s*,\s*([0-9]+(?:\.[0-9]+)?)\%\s*\)/.exec(color)) {
+                               return [parseFloat(result[1],10)*2.55, parseFloat(result[2],10)*2.55, parseFloat(result[3])*2.55];
+                       }
+
+                       // Look for #a0b1c2
+                       if (result = /#([a-fA-F0-9]{2})([a-fA-F0-9]{2})([a-fA-F0-9]{2})/.exec(color)) {
+                               return [parseInt(result[1],16), parseInt(result[2],16), parseInt(result[3],16)];
+                       }
+
+                       // Look for #fff
+                       if (result = /#([a-fA-F0-9])([a-fA-F0-9])([a-fA-F0-9])/.exec(color)) {
+                               return [parseInt(result[1]+result[1],16), parseInt(result[2]+result[2],16), parseInt(result[3]+result[3],16)];
+                       }
+
+                       // Look for rgba(0, 0, 0, 0) == transparent in Safari 3
+                       if (result = /rgba\(0, 0, 0, 0\)/.exec(color)) {
+                               return $.colorUtil.colors.transparent;
+                       }
+
+                       // Otherwise, we're most likely dealing with a named color
+                       return $.colorUtil.colors[jQuery.trim(color).toLowerCase()];
+               },
+
+               // Some named colors to work with
+               // From Interface by Stefan Petre
+               // http://interface.eyecon.ro/
+               colors: {
+                       aqua:[0,255,255],
+                       azure:[240,255,255],
+                       beige:[245,245,220],
+                       black:[0,0,0],
+                       blue:[0,0,255],
+                       brown:[165,42,42],
+                       cyan:[0,255,255],
+                       darkblue:[0,0,139],
+                       darkcyan:[0,139,139],
+                       darkgrey:[169,169,169],
+                       darkgreen:[0,100,0],
+                       darkkhaki:[189,183,107],
+                       darkmagenta:[139,0,139],
+                       darkolivegreen:[85,107,47],
+                       darkorange:[255,140,0],
+                       darkorchid:[153,50,204],
+                       darkred:[139,0,0],
+                       darksalmon:[233,150,122],
+                       darkviolet:[148,0,211],
+                       fuchsia:[255,0,255],
+                       gold:[255,215,0],
+                       green:[0,128,0],
+                       indigo:[75,0,130],
+                       khaki:[240,230,140],
+                       lightblue:[173,216,230],
+                       lightcyan:[224,255,255],
+                       lightgreen:[144,238,144],
+                       lightgrey:[211,211,211],
+                       lightpink:[255,182,193],
+                       lightyellow:[255,255,224],
+                       lime:[0,255,0],
+                       magenta:[255,0,255],
+                       maroon:[128,0,0],
+                       navy:[0,0,128],
+                       olive:[128,128,0],
+                       orange:[255,165,0],
+                       pink:[255,192,203],
+                       purple:[128,0,128],
+                       violet:[128,0,128],
+                       red:[255,0,0],
+                       silver:[192,192,192],
+                       white:[255,255,255],
+                       yellow:[255,255,0],
+                       transparent: [255,255,255]
+               },
+               /**
+                * http://mjijackson.com/2008/02/rgb-to-hsl-and-rgb-to-hsv-color-model-conversion-algorithms-in-javascript
+                * Converts an RGB color value to HSL. Conversion formula
+                * adapted from http://en.wikipedia.org/wiki/HSL_color_space.
+                * Assumes r, g, and b are contained in the set [0, 255] and
+                * returns h, s, and l in the set [0, 1].
+                *
+                * @param       Number  R               The red color value
+                * @param       Number  G               The green color value
+                * @param       Number  B               The blue color value
+                * @return      Array                   The HSL representation
+                */
+               rgbToHsl: function( R, G, B ) {
+                       var     r = R / 255,
+                               g = G / 255,
+                               b = B / 255;
+                       var max = Math.max(r, g, b), min = Math.min(r, g, b);
+                       var h, s, l = (max + min) / 2;
+
+                       if(max == min){
+                               h = s = 0; // achromatic
+                       }else{
+                               var d = max - min;
+                               s = l > 0.5 ? d / (2 - max - min) : d / (max + min);
+                               switch(max){
+                                       case r: h = (g - b) / d + (g < b ? 6 : 0); break;
+                                       case g: h = (b - r) / d + 2; break;
+                                       case b: h = (r - g) / d + 4; break;
+                               }
+                               h /= 6;
+                       }
+
+                       return [h, s, l];
+               },
+               /**
+                * http://mjijackson.com/2008/02/rgb-to-hsl-and-rgb-to-hsv-color-model-conversion-algorithms-in-javascript
+                * Converts an HSL color value to RGB. Conversion formula
+                * adapted from http://en.wikipedia.org/wiki/HSL_color_space.
+                * Assumes h, s, and l are contained in the set [0, 1] and
+                * returns r, g, and b in the set [0, 255].
+                *
+                * @param       Number  h               The hue
+                * @param       Number  s               The saturation
+                * @param       Number  l               The lightness
+                * @return      Array                   The RGB representation
+                */
+               hslToRgb: function( h, s, l ) {
+                       var r, g, b;
+
+                       if(s === 0){
+                               r = g = b = l; // achromatic
+                       }else{
+                               var hue2rgb = function(p, q, t){
+                                       if(t < 0){ t += 1; }
+                                       if(t > 1){ t -= 1; }
+                                       if(t < 1/6){ return p + (q - p) * 6 * t; }
+                                       if(t < 1/2){ return q; }
+                                       if(t < 2/3){ return p + (q - p) * (2/3 - t) * 6; }
+                                       return p;
+                               };
+
+                               var q = l < 0.5 ? l * (1 + s) : l + s - l * s;
+                               var p = 2 * l - q;
+                               r = hue2rgb(p, q, h + 1/3);
+                               g = hue2rgb(p, q, h);
+                               b = hue2rgb(p, q, h - 1/3);
+                       }
+
+                       return [r * 255, g * 255, b * 255];
+               },
+               /**
+                * Get's a brighter or darker rgb() value string.
+                *
+                * @author Krinkle
+                *
+                * @example     getCSSColorMod( 'red', +0.1 )
+                * @example     getCSSColorMod( 'rgb(200,50,50)', -0.2 )
+                *
+                * @param       Mixed   currentColor current value in css
+                * @param       Number  mod wanted brightness modification between -1 and 1
+                * @return      String 'rgb(r,g,b)'
+                */
+               getColorBrightness: function( currentColor, mod ) {
+                       var     rgbArr = $.colorUtil.getRGB( currentColor ),
+                               hslArr = $.colorUtil.rgbToHsl(rgbArr[0], rgbArr[1], rgbArr[2] );
+                       rgbArr = $.colorUtil.hslToRgb(hslArr[0], hslArr[1], hslArr[2]+mod);
+                       return 'rgb(' +
+                               [parseInt( rgbArr[0], 10), parseInt( rgbArr[1], 10 ), parseInt( rgbArr[2], 10 )].join( ',' ) +
+                               ')';
+               }
+
+       };
+
+} )( jQuery );
\ No newline at end of file