Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
branch: farbtastic-1
Fetching contributors…

Cannot retrieve contributors at this time

98 lines (59 sloc) 3.78 kB

Farbtastic: jQuery color picker plug-in

Farbtastic is a jQuery plug-in that can add one or more color picker widgets into a page. Each widget is then linked to an existing element (e.g. a text field) and will update the element's value when a color is selected.

Farbtastic uses layered transparent PNGs to render a saturation/luminance gradient inside of a hue circle. No Flash or pixel-sized divs are used.

Farbtastic was originally written by Steven Wittens and is licensed under the GPL.

Basic Usage

1) Include farbtastic.js and farbtastic.css in your HTML:

<script type="text/javascript" src="farbtastic.js"></script>
<link rel="stylesheet" href="farbtastic.css" type="text/css" />

2) Add a placeholder div and a text field to your HTML, and give each an ID:

<form><input type="text" id="color" name="color" value="#123456" /></form>
<div id="colorpicker"></div>

3) Add a ready() handler to the document which initializes the color picker and link it to the text field with the following syntax:

<script type="text/javascript">
  $(document).ready(function() {
    $('#colorpicker').farbtastic('#color');
  });
</script>

See demo1.html and demo2.html for an example.

Styling

The color picker is a block-level element and is 195x195 pixels large. You can control the position by styling your placeholder (e.g. floating it). Note that the black/white gradients inside wheel.png and mask.png were generated programmatically and cannot be recreated easily in an image editing program.

Advanced Usage

jQuery Method

$(...).farbtastic()
$(...).farbtastic(callback)

This creates color pickers in the selected objects. callback is optional and can be a:

  • DOM Node, jQuery object or jQuery selector: the color picker will be linked to the selected element(s) by syncing the value (for form elements) and color (all elements).
  • Function: this function will be called whenever the user chooses a different color.

Object

$.farbtastic(placeholder)
$.farbtastic(placeholder, callback)

Invoking $.farbtastic(placeholder) is the same as using $(placeholder).farbtastic() except that the Farbtastic object is returned instead of the jQuery object. This allows you to use the Farbtastic methods and properties below.

Note that there is only one Farbtastic object per placeholder. If you call $.farbtastic(placeholder) twice with the same placeholder, you will get the same object back each time.

The optional callback argument behaves exactly as for the jQuery method.

Methods

.linkTo(callback) - Allows you to set a new callback. Any existing callbacks are removed. See above for the meaning of callback.

.setColor(string) - Sets the picker color to the given color in hex representation.

.setColor([h, s, l]) - Sets the picker color to the given color in normalized HSL (0..1 scale).

Properties

.linked - The elements (jQuery object) or callback function this picker is linked to.

.color - Current color in hex representation.

.hsl - Current color in normalized HSL.

Changelog

1.3u (unofficial) - 2010/2/17

1.2 - 2007/01/08

  • Fixed bug with linking multiple fields with the same value.

1.1 - 2006/10/27

  • Work around for the transparent PNGs in Internet Explorer.
  • Better mouse handling code to accomodate CSS-based layouts better.

1.0 - 2006/07/14

  • Initial release.
Jump to Line
Something went wrong with that request. Please try again.