Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

663 lines (571 sloc) 24.89 kb
<!doctype html>
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Spectrum - The No Hassle jQuery Colorpicker</title>
<meta name="description" content="Spectrum is a JavaScript colorpicker plugin using the jQuery framework. It is highly customizable, but can also be used as a simple input type=color polyfill">
<meta name="author" content="Brian Grinstead and Spectrum contributors">
<link rel="stylesheet" type="text/css" href="spectrum.css">
<link rel="stylesheet" type="text/css" href="docs/docs.css">
<script type="text/javascript" src="docs/jquery-1.6.2.js"></script>
<script type="text/javascript" src="spectrum.js"></script>
<script type="text/javascript" src="docs/prettify.js"></script>
<script type='text/javascript' src='docs/toc.js'></script>
<script type='text/javascript' src='docs/docs.js'></script>
</head>
<body>
<div id='header'>
<h1><a href='http://bgrins.github.com/spectrum'>Spectrum</a></h1> <h2><em>The No Hassle jQuery Colorpicker</em></h2>
<div id='links'>
<a href='http://github.com/bgrins/spectrum'>Source code</a> |
<a href='http://twitter.com/bgrins'>@bgrins</a>
</div>
<br style='clear:both;' />
</div>
<div id='toc'></div>
<div id='toc-slider'></div>
<div id='docs'>
<div id='docs-content'>
<div id='switch-current'>
<input type='text' name='color1' id='pick1' value='#ddddff' />
<div id='switch-current-hsv' class='switch-current-output'></div>
<div id='switch-current-rgb' class='switch-current-output'></div>
<div id='switch-current-hex' class='switch-current-output'></div>
</div>
<div style='text-align:center;'>
<input id="full" />
</div>
<pre class='prettyprint hide' id='code-heading'>
&lt;input type='color' value='#f594d0' /&gt;
<input type='color' class='basic' value='#f594d0' />
</pre>
<h2>Why A Colorpicker?</h2>
<p><em>I wasn't satisfied with the solutions available for colorpicking</em>.
Many of them included a ton of images, were hard to skin or customize, or were very large plugins.
Here are the goals I had when making a new one:
</p>
<h3 class='point'>Small Footprint</h3>
<div class='note'>see a working <a href='http://jsfiddle.net/bgrins/ctkY3/'>jsFiddle example</a></div>
<p>Just include the needed CSS and JavaScript files, and you are ready to go! </p>
<pre class='prettyprint' id='code-subheading'>
&lt;script src='<a href='http://bgrins.github.com/spectrum/spectrum.js' target="_blank">spectrum.js</a>'&gt;&lt;/script&gt;
&lt;link rel='stylesheet' href='<a href='http://bgrins.github.com/spectrum/spectrum.css' target="_blank">spectrum.css</a>' /&gt;
</pre>
<p><strong>We don't need no stinkin' images!</strong></p>
<p>Nobody wants to add a bunch of code into their project. Spectrum is contained in two files, and both are careful not to mess with your existing code.
The JavaScript is well less than 10K gzipped, see the <a href='https://github.com/bgrins/spectrum/blob/master/README.md'>current size</a> in the README.
<h3 class='point'>Polyfill</h3>
<p>I wanted an option for the most basic use case, a polyfill for the <a href='http://dev.w3.org/html5/markup/input.color.html'>input[type=color]</a> HTML5 control.
This mode needs to work without JavaScript enabled - and fallback to an input[type=text] like other HTML5 inputs.
</p>
<h3 class='point'>Customizable</h3>
<p>Just because you don't <em>have</em> to change anything to get it to work, doesn't mean you <em>can't</em>!
It is easy to skin and customize the plugin with CSS, and there are a wide range of modes and options to explore.
<h2>Modes</h2>
<h3 class='point'>input[type=color]</h3>
<p>
If you just want to provide a polyfill for the native color input,
the easiest way is to create an input with the type of color.
Once a user's browser supports a native color control, it will opt to use their native control instead.
</p>
<p><strong>Unlike the other modes, your value must be a 6 character hex value starting with a '#'.</strong> Why? Because the spec <a href='http://dev.w3.org/html5/markup/input.color.html#input.color.attrs.value'>says so</a>, that's why.
</p>
<pre class='prettyprint' id='code-subheading'>
&lt;input type='color' name='color' /&gt;
&lt;input type='color' name='color2' value='#3355cc' /&gt;
</pre>
<div class='example'>
<form method="get">
<input type='color' name='color' />
<input type='color' name='color2' value='#3355cc' />
<input type='color' name='color3' value='#000000' />
<input type="submit" />
</form>
</div>
<p><strong>That's it!</strong>
The field will degrade to a text input if the user does not have JavaScript enabled,
so that they will still be able to manually enter a color. You don't need to add a single line of code.
</p>
<h3 class='point'>Custom</h3>
<p>If you want to get more into the functionality, just create a normal input and initialize it as a normal jQuery plugin.
<strong>You can set a lot of options</strong> when initializing the colorpicker.
See the 'Options' section below.
</p>
<pre class='prettyprint'>
&lt;input type='text' id="custom" /&gt;
</pre>
<pre class='prettyprint'>
&lt;script&gt;
$("#custom").spectrum({
color: "#f00"
});
&lt;/script&gt;
</pre>
<div class='example'>
<input type='text' id='custom' />
</div>
<h3 class='point'>Flat</h3>
<p><strong>Flat</strong>
This means that it will always show up at full size,
and be positioned as an inline-block element.
Look to the left for a full sized flat picker.
</p>
<pre class='prettyprint'>
&lt;input type='text' id="flat" /&gt;
</pre>
<pre class='prettyprint'>
$("#flat").spectrum({
flat: true
});
</pre>
<div class='example'>
<input type='text' id='flat' value="limegreen" />
</div>
<h2>Options</h2>
<pre class='prettyprint'>
$("#picker").spectrum({
color: <strong>tinycolor</strong>,
flat: bool,
showInput: bool,
showInitial: bool,
localStorageKey: string,
showPalette: bool,
showPaletteOnly: bool,
showSelectionPalette: bool,
cancelText: string,
chooseText: string,
className: string,
preferredFormat: string,
maxSelectionSize: int,
palette: [[string]],
selectionPalette: [string]
});
</pre>
<h3>Color</h3>
<div class='option-content'>
<div class='description'>
<p>
The initial color will be set with the <code>color</code> option.
If you don't pass in a color, Spectrum will use the <code>value</code> attribute on the input.
</p>
<p>
The color parsing is based on the <a href='https://github.com/bgrins/TinyColor'>TinyColor</a> plugin.
This should parse any color string you throw at it.</p>
</p>
</div>
<pre class='prettyprint'>
&lt;input type='text' class='basic' value='red' /&gt;
&lt;input type='text' class='basic' value='#0f0' /&gt;
&lt;input type='text' class='basic' value='blue' /&gt;
&lt;br /&gt;
&lt;input type='text' class='override' /&gt;
</pre>
<pre class='prettyprint'>
&lt;script&gt;
$(".basic").spectrum();
$(".override").spectrum({
color: "yellow"
});
&lt;/script&gt;
</pre>
<div class='example'>
<input type='text' class='basic' value='red' />
<input type='text' class='basic' value='green' />
<input type='text' class='basic' value='blue' />
<br />
<input type='text' class='override' />
</div>
</div>
<h3>Show Input</h3>
<div class='option-content'>
<div class='description'>
<p>You can add an input to allow free form typing. The color parsing is very permissive in the allowed strings. See <a href='https://github.com/bgrins/TinyColor'>TinyColor</a> for more details.
</div>
<pre class='prettyprint'>
$("#showInput").spectrum({
showInput: true
});
</pre>
<div class='example'>
<input type='text' name='showInput' id='showInput' />
</div>
</div>
<h3>Show Palette</h3>
<div class='option-content'>
<div class='description'>
<p>Spectrum can show a palette below the colorpicker to make it convenient for users to choose from frequently or recently used colors. When the colorpicker is closed, the current color will be added to the palette if it isn't there already. Check it out here: </p>
</div>
<pre class='prettyprint'>
$("#showPalette").spectrum({
showPalette: true,
palette: [
['black', 'white', 'blanchedalmond'],
['rgb(255, 128, 0);', 'hsv 100 70 50', 'lightyellow']
]
});
</pre>
<div class='example'>
<input type='text' name='showPalette' id='showPalette' value='lightblue' />
</div>
</div>
<h3>Show Palette Only</h3>
<div class='option-content'>
<div class='note'>see a working <a href='http://jsfiddle.net/bgrins/S45tW/'>jsFiddle example</a></div>
<div class='description'>
<p>If you'd like, spectrum can show the palettes you specify, and nothing else.</p>
</div>
<pre class='prettyprint'>
$("#showPaletteOnly").spectrum({
showPaletteOnly: true,
color: 'blanchedalmond',
palette: [
['black', 'white', 'blanchedalmond',
'rgb(255, 128, 0);', 'hsv 100 70 50'],
['red', 'yellow', 'green', 'blue', 'violet']
]
});
</pre>
<div class='example'>
<span class='label label-result'>
Result
</span>
<input type='text' name='showPaletteOnly' id='showPaletteOnly' />
</div>
</div>
<h3>Show Selection Palette</h3>
<div class='option-content'>
<div class='description'>
<p>Spectrum can keep track of what has been selected by the user with the <code>showSelectionPalette</code> option.</p>
<p>If the <code>localStorageKey</code> option is defined, the selection will be saved in the browser's localStorage object</p>
</div>
<pre class='prettyprint'>
$("#showSelectionPalette").spectrum({
showPalette: true,
showSelectionPalette: true, // true by default
palette: [ ]
});
$("#showSelectionPaletteStorage").spectrum({
showPalette: true,
showSelectionPalette: true,
palette: [ ],
localStorageKey: "spectrum.homepage", // Any Spectrum with the same string will share selection
});
</pre>
<div class='example'>
<span class='label label-info'>This colorpicker will store what you pick:</span><br /><br />
<input type='text' name='showSelectionPalette' id='showSelectionPalette' value='lightblue' /><br /><br />
<span class='label label-info'>Try reloading your page, it will still be here on this one:</span><br /><br />
<input type='text' name='showSelectionPaletteStorage' id='showSelectionPaletteStorage' value='lightblue' />
</div>
</div>
<h3>Show Initial</h3>
<div class='option-content'>
<div class='description'>
<p>
Spectrum can show the color that was initially set when opening.
This provides an easy way to click back to what was set when opened.
</p>
</div>
<pre class='prettyprint'>
$("#showInitial").spectrum({
showInitial: true
});
</pre>
<div class='example'>
<input type='text' name='showInitial' id='showInitial' value='goldenrod' />
</div>
</div>
<h3>Show Input and Initial</h3>
<div class='option-content'>
<div class='description'>
<p>Spectrum can show the color that was initially set when opening. This provides an easy way to click back to what was set when opened.</p>
</div>
<pre class='prettyprint'>
$("#showInputAndInitial").spectrum({
showInitial: true,
showInput: true
});
</pre>
<div class='example'>
<input type='text' name='showInputAndInitial' id='showInputAndInitial' value='goldenrod' />
</div>
</div>
<h3>Button Text</h3>
<div class='option-content'>
<div class='description'>
<p>You can set the button's text using <code>cancelText</code> and <code>chooseText</code> properties.</p>
</div>
<pre class='prettyprint'>
$("#buttonText").spectrum({
chooseText: "Alright",
cancelText: "No way"
});
</pre>
<div class='example'>
<input type='text' name='buttonText' id='buttonText' value='orangered' />
</div>
</div>
<h3>Show Buttons</h3>
<div class='option-content'>
<div class='description'>
<p>
You can show or hide the buttons using the <code>showButtons</code> property.
If there are no buttons, the behavior will be to fire the `change` event (and update the original input) when the picker is closed.
</p>
</div>
<pre class='prettyprint'>
$("#hideButtons").spectrum({
showButtons: false
});
</pre>
<div class='example'>
<input type='text' name='hideButtons' id='hideButtons' value='orangered' />
</div>
</div>
<h3>Preferred Format</h3>
<div class='option-content'>
<div class='description'>
<p>You can set the format that is displayed</p>
</div>
<pre class='prettyprint'>
$("#preferredHex").spectrum({
preferredFormat: "hex",
showInput: true
});
$("#preferredHsl").spectrum({
preferredFormat: "hsl",
showInput: true
});
$("#preferredRgb").spectrum({
preferredFormat: "rgb",
showInput: true
});
$("#preferredName").spectrum({
preferredFormat: "name",
showInput: true
});
$("#preferredNone").spectrum({
showInput: true
});
</pre>
<div class='example'>
<div class='alert alert-info'>Hex</div>
<input type='text' name='preferredHex' id='preferredHex' value='orangered' />
<div class='alert alert-info'>Hsl</div>
<input type='text' name='preferredHsl' id='preferredHsl' value='orangered' />
<div class='alert alert-info'>Rgb</div>
<input type='text' name='preferredRgb' id='preferredRgb' value='orangered' />
<div class='alert alert-info'>Name (Falls back to hex)</div>
<input type='text' name='preferredName' id='preferredName' value='orangered' />
<div class='alert alert-info'>None (Depends on input - try changing formats with the text box)</div>
<input type='text' name='preferredNone' id='preferredNone' value='orangered' />
</div>
</div>
<h2>Events</h2>
<pre class='prettyprint'>
$("#picker").spectrum({
move: function(tinycolor) { },
show: function(tinycolor) { },
hide: function(tinycolor) { },
beforeShow: function(tinycolor) { },
});
</pre>
<h3>change</h3>
<div class='option-content'>
<div class='description'>
<p>Called as the original input changes. Only happens when the input is closed or the 'Choose' button is clicked.</p>
</div>
<pre class='prettyprint'>
change: function(color) {
color.toHexString(); // #ff0000
}
</pre>
<div class='example'>
<input type='text' value='blanchedalmond' name='changeOnMoveNo' id='changeOnMoveNo' />
<em id='changeOnMoveNoLabel' class='em-label'></em>
</div>
</div>
<h3>move</h3>
<div class='option-content'>
<div class='description'>
<p>Called as the user moves around within the colorpicker</p>
</div>
<pre class='prettyprint'>
move: function(color) {
color.toHexString(); // #ff0000
}
</pre>
<div class='example'>
<input type='text' value='blanchedalmond' name='changeOnMove' id='changeOnMove' />
<em id='changeOnMoveLabel' class='em-label'></em>
</div>
</div>
<h3>hide</h3>
<div class='option-content'>
<div class='description'>
<p>
Called after the colorpicker is hidden.
This happens when clicking outside of the picker while it is open.
Note, when any colorpicker on the page is shown it will hide any that are already open.
This event is ignored on a flat colorpicker.
</p>
</div>
<pre class='prettyprint'>
hide: function(color) {
color.toHexString(); // #ff0000
}
</pre>
</div>
<h3>show</h3>
<div class='option-content'>
<div class='description'>
<p>
Called after the colorpicker is opened.
This is ignored on a flat colorpicker.
Note, when any colorpicker on the page is shown it will hide any that are already open.
</p>
</div>
<pre class='prettyprint'>
show: function(color) {
color.toHexString(); // #ff0000
}
</pre>
</div>
<h3>beforeShow</h3>
<div class='option-content'>
<div class='description'>
<p>
You can prevent the colorpicker from showing up if you return false in the beforeShow event.
This event is ignored on a flat colorpicker.
</p>
</div>
<pre class='prettyprint'>
beforeShow: function(color) {
return false; // Will never show up
}
</pre>
<div class='example'>
<input type='text' value='blanchedalmond' name='beforeShow' id='beforeShow' />
</div>
</div>
<h2>Methods</h2>
<pre class='prettyprint'>
$("#picker").spectrum("show");
$("#picker").spectrum("hide");
$("#picker").spectrum("get");
$("#picker").spectrum("set", colorString);
$("#picker").spectrum("container");
</pre>
<h3>set</h3>
<div class='option-content'>
<div class='description'>
<p>
Setting the colorpicker programmatically will update the original input.
</p>
<p>
Note: this will <strong>not</strong> fire the <code>change</code> event,
to prevent infinite loops from calling <code>set</code> from within <code>change</code>.
</p>
</div>
<pre class='prettyprint'>
&lt;input type='text' value='blanchedalmond' name='triggerSet' id='triggerSet' /&gt;
&lt;input type='text' placeholder='Enter A Color' id='enterAColor' /&gt;
&lt;button id='btnEnterAColor'&gt;Trigger Set&lt;/button&gt;
&lt;script&gt;
$("#triggerSet").spectrum();
// Show the original input to demonstrate the value changing when calling `set`
$("#triggerSet").show();
$("#btnEnterAColor").click(function() {
$("#triggerSet").spectrum("set", $("#enterAColor").val());
});
&lt;/script&gt;
</pre>
<div class='example'>
<input type='text' value='blanchedalmond' name='triggerSet' id='triggerSet' /><br /><br />
<input type='text' placeholder='Enter A Color' id='enterAColor' /><button id='btnEnterAColor'>Trigger Set</button>
</div>
</div>
<h2>Skinning</h2>
<p>Since it is all built with HTML/CSS, you can skin it easily. There are two parts to the <a href='https://github.com/bgrins/spectrum/blob/master/spectrum.css'>spectrum.css</a> file, the core rules (at the top of the file), and the themable rules (at the bottom). Feel free to tweak these rules to make it look how you want.</p>
<h3 class='point'>Non-input elements</h3>
<p>
You can use any element you would like to trigger the colorpicker: <a href='#' id='openWithLink'>Click me to open a colorpicker</a>, though it is strongly recommended to stick with <code>&lt;input&gt;</code> tags.
</p>
<h2>Nitty Gritty</h2>
<h3 class='point'>Browser Support</h3>
<p>I wanted this to work in the latest and greatest browsers, but also target backwords compatibility and <strong>mobile support</strong>.
Here are the currently supported browers:
<ul>
<li>IE <small>6+</small></li>
<li>Chrome <small>4+</small></li>
<li>Firefox <small>3.6+</small></li>
<li>Safari <small>4+</small></li>
<li>Opera <small>11.1+</small></li>
<li>iOS</li>
</ul>
<h3 class='point'>IE Implementation</h3>
<p>
IE Support is provided using
<a href='http://msdn.microsoft.com/en-us/library/ms532997(v=vs.85).aspx'>proprietary filters</a>.
Other browsers use CSS gradients.
</p>
<h3 class='point'>Accepted Color Inputs</h3>
<p>Spectrum will use the color passed in to initialize. If there is no color passed in,
it will try to parse a color based on the <code>value</code> of the input. The color parsing is based on the <a href='https://github.com/bgrins/TinyColor'>TinyColor</a> plugin, and accepts many forms of input:</p>
<pre class='prettyprint'>
red
#fff
fff
#ffffff
ffffff
rgb(255, 0, 0)
rgb 255 0 0
hsl(0, 100, 50)
hsl(0, 100%, 50%)
hsl 0 100 50
hsl 0 100% 50%
hsv(0, 100%, 100%)
hsv(0, 100, 100)
hsv 0 100% 100%
hsv 0 100 100
</pre>
<p>It also provides the following forms of output:</p>
<pre class='prettyprint'>
var t = $("#element").spectrum("get");
t.toHex() // "ff0000"
t.toHexString() // "#ff0000"
t.toRgb() // {"r":255,"g":0,"b":0}
t.toRgbString() // "rgb(255, 0, 0)"
t.toHsv() // {"h":0,"s":1,"v":1}
t.toHsvString() // "hsv(0, 100%, 100%)"
t.toHsl() // {"h":0,"s":1,"l":0.5}
t.toHslString() // "hsl(0, 100%, 50%)"
t.toName() // "red"
</pre>
<div class='footer'>
<h2>Share</h2>
<p>
If you've made it this far, please share one of these links to help others find this project!
<br />
<a href='http://bgrins.github.com/spectrum'>JavaScript Colorpicker</a> |
<a href='http://bgrins.github.com/spectrum'>jQuery Colorpicker</a> |
<a href='http://bgrins.github.com/spectrum'>Spectrum colorpicker</a>
</p>
<p>
If you want to let me (<a href='http://twitter.com/bgrins'>@bgrins</a>) know you are using it, send me a link and I'll add you to the <a href='https://github.com/bgrins/spectrum/wiki/Sites-Using-Spectrum'>list of projects using Spectrum</a>!
</p>
</div>
</div>
</div>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-8259845-4']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</body>
</html>
Jump to Line
Something went wrong with that request. Please try again.