forked from bgrins/spectrum
/
index.html
1214 lines (1055 loc) · 46 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!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/bootstrap.css">
<link rel="stylesheet" type="text/css" href="docs/docs.css">
<script type="text/javascript" src="docs/jquery-3.5.1.js"></script>
<script type="text/javascript" src="spectrum.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/archive/1.8.1.zip' class="btn btn-primary">Download Zip</a>
View the <a href='http://github.com/bgrins/spectrum'>Source code</a>.
Spectrum is a project by <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'>
<input type='color' value='#f594d0' />
<input type='color' class='basic' value='#f594d0' />
</pre>
<h2 id="why">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 id="why-footprint" 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'>
<script src='<a href='http://bgrins.github.com/spectrum/spectrum.js' target="_blank">spectrum.js</a>'></script>
<link rel='stylesheet' href='<a href='http://bgrins.github.com/spectrum/spectrum.css' target="_blank">spectrum.css</a>' />
</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.</p>
<h3 id="why-polyfill" 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>
<p>If you don't want this behavior to happen, but still want to use spectrum elsewhere on the page, you can set <code>$.fn.spectrum.load = false;</code> right after loading the script file.</p>
<h3 id="why-customizable" 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.
</p>
<h3 id="why-mobile" class='point'>Mobile Support</h3>
<p>Along with desktop browser support, I wanted a mobile colorpicker that was touch friendly, worked in iOS and Android, and used standards
that maximize future mobile support.
</p>
<h3 id="why-devtools" class='point'>Devtools</h3>
<p>
Believe it or not, <strong>this colorpicker lives inside of Chrome, Firefox, and Safari devtools</strong> to make picking colors easier for web developers and designers.
</p>
<p>
When I started the project, I wrote about <a href="http://www.briangrinstead.com/blog/chrome-developer-tools-colorpicker-concept">developer tools concept colorpicker implementation</a>. After that, I was <a href="http://groups.google.com/group/google-chrome-developer-tools/browse_thread/thread/4dd1e853b8051727/4549a6f0788885d4">contacted on the devtools mailing list</a> and got some initial feedback about the possibility of integrating it with devtools. Then I pulled the jQuery dependency out of a branch and I submitted a patch to the WebKit project.
</p>
<p>
From there, I opened a <a href="https://bugs.webkit.org/show_bug.cgi?id=71262">bug</a> to start working on it Web Inspector. 50+ comments and 10 patches later, the case <a href="http://www.webkit.org/blog/1804/last-week-in-webkit-calculated-css-values-and-the-translate-attribute/">landed in WebKit</a>. Here is the <a href='https://bugzilla.mozilla.org/show_bug.cgi?id=911702'>Firefox bug</a> where it was added.
</p>
<h2 id="modes">Modes</h2>
<h3 id="modes-custom" 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'>
<input type='text' id="custom" />
</pre>
<pre class='prettyprint'>
<script>
$("#custom").spectrum({
color: "#f00"
});
</script>
</pre>
<div class='example'>
<input type='text' id='custom' />
</div>
<h3 id="modes-flat" 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'>
<input type='text' id="flat" />
<br/>
<input type='text' id="flat" />
</pre>
<pre class='prettyprint'>
$("#flat").spectrum({
flat: true,
showInput: true
});
$("#flatClearable").spectrum({
flat: true,
showInput: true,
allowEmpty:true
});
</pre>
<div class='example'>
<input type='text' id='flat' value="limegreen" />
<br/>
<input type='text' id='flatClearable' value="limegreen" />
</div>
<h3 id="modes-input" 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'>
<input type='color' name='color' />
<input type='color' name='color2' value='#3355cc' />
</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>
<!--
<div class="alert">
Heads up! Make sure you do not have a <code>maxlength</code> property set on your input. It has been known to break IE10.
</div>
-->
<h2 id="options">Options</h2>
<pre class='prettyprint'>
$("#picker").spectrum({
color: <strong>tinycolor</strong>,
flat: bool,
showInput: bool,
showInitial: bool,
allowEmpty: bool,
showAlpha: bool,
disabled: bool,
localStorageKey: string,
showPalette: bool,
showPaletteOnly: bool,
togglePaletteOnly: bool,
showSelectionPalette: bool,
clickoutFiresChange: bool,
cancelText: string,
chooseText: string,
togglePaletteMoreText: string,
togglePaletteLessText: string,
containerClassName: string,
replacerClassName: string,
preferredFormat: string,
maxSelectionSize: int,
palette: [[string]],
selectionPalette: [string]
});
</pre>
<div class="alert alert-info">
Tip: options can be specified in an options object in the <code>spectrum</code> initializer, like <code>$(element).spectrum({showAlpha: true })</code> or on the element's markup, like <code><input data-show-alpha="true" /></code>.
</div>
<h3 id="options-color">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'>
<input type='text' class='basic' value='red' />
<input type='text' class='basic' value='#0f0' />
<input type='text' class='basic' value='blue' />
<br />
<input type='text' class='override' />
<br />
<input type='text' class='startEmpty' value='' />
</pre>
<pre class='prettyprint'>
<script>
$(".basic").spectrum();
$(".override").spectrum({
color: "yellow"
});
(".startEmpty").spectrum({
allowEmpty: true
});
</script>
</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' />
<br/>
<input type='text' class='startEmpty' value='' />
</div>
</div>
<h3 id="options-showInput">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
});
$("#showInputWithClear").spectrum({
showInput: true,
allowEmpty:true
});
</pre>
<div class='example'>
<input type='text' name='showInput' id='showInput' />
<br/>
<input type='text' name='showInputWithClear' id='showInputWithClear' value='' />
</div>
</div>
<h3 id="options-showAlpha">Show Alpha</h3>
<div class='option-content'>
<div class='description'>
<p>You can allow alpha transparency selection. Check out these examples: </p>
</div>
<pre class='prettyprint'>
$("#showAlpha").spectrum({
showAlpha: true
});
</pre>
<div class='example'>
<input type='text' name='showAlpha' id='showAlpha' />
</div>
<div class='example'>
<input type='text' name='showAlphaWithInput' id='showAlphaWithInput' />
</div>
</div>
<h3 id="options-disabled">Disabled</h3>
<div class='option-content'>
<div class='description'>
<p>Spectrum can be automatically disabled if you pass in the <code>disabled</code> flag. Additionally, if the input that you initialize spectrum on is disabled, this will be the default value. Note: you <strong>cannot</strong> enable spectrum if the input is disabled (see below).</p>
</div>
<pre class='prettyprint'>
$("#disabled").spectrum({
disabled: true
});
$("input:disabled").spectrum({
});
</pre>
<div class='example'>
<input type='text' name='disabled' id='disabled' value='lightblue' />
<input type='text' disabled value='lightblue' />
<button id='toggle-disabled' class='btn'>Toggle Disabled</button>
</div>
</div>
<h3 id="options-showPalette">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' />
<em data-label-for="showPalette" class='em-label'></em>
</div>
</div>
<h3 id="options-showPaletteOnly">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,
showPalette: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' />
<em data-label-for="showPaletteOnly" class='em-label'></em>
</div>
</div>
<h3 id="options-togglePaletteOnly">Toggle Palette Only</h3>
<div class='option-content'>
<div class='description'>
<p>Spectrum can show a button to toggle the colorpicker next to the palette. This way, the user can choose from a limited number of colors in the palette, but still be able to pick a color that's not in the palette.<br />
The default value for <code>togglePaletteOnly</code> is FALSE. Set it to TRUE to enable the Toggle button.<br /><br />
You can also change the text on the Toggle Button with the options <code>togglePaletteMoreText</code> (default is "more") and <code>togglePaletteLessText</code> (default is "less").</p>
</div>
<pre class='prettyprint'>
$("#togglePaletteOnly").spectrum({
showPaletteOnly: true,
togglePaletteOnly: true,
togglePaletteMoreText: 'more',
togglePaletteLessText: 'less',
color: 'blanchedalmond',
palette: [
["#000","#444","#666","#999","#ccc","#eee","#f3f3f3","#fff"],
["#f00","#f90","#ff0","#0f0","#0ff","#00f","#90f","#f0f"],
["#f4cccc","#fce5cd","#fff2cc","#d9ead3","#d0e0e3","#cfe2f3","#d9d2e9","#ead1dc"],
["#ea9999","#f9cb9c","#ffe599","#b6d7a8","#a2c4c9","#9fc5e8","#b4a7d6","#d5a6bd"],
["#e06666","#f6b26b","#ffd966","#93c47d","#76a5af","#6fa8dc","#8e7cc3","#c27ba0"],
["#c00","#e69138","#f1c232","#6aa84f","#45818e","#3d85c6","#674ea7","#a64d79"],
["#900","#b45f06","#bf9000","#38761d","#134f5c","#0b5394","#351c75","#741b47"],
["#600","#783f04","#7f6000","#274e13","#0c343d","#073763","#20124d","#4c1130"]
]
});
</pre>
<div class='example'>
<span class='label label-result'>
Result
</span>
<input type='text' name='togglePaletteOnly' id='togglePaletteOnly' />
</div>
</div>
<h3 id="options-showSelectionPalette">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 switching between the two colorpickers or reloading your page, the chosen colors are always available:</span><br /><br />
<input type='text' name='showSelectionPaletteStorage' id='showSelectionPaletteStorage' value='lightblue' />
<input type='text' name='showSelectionPaletteStorage2' id='showSelectionPaletteStorage2' value='pink' />
</div>
</div>
<h3 id="options-selectionPalette">Selection Palette</h3>
<div class='option-content'>
<div class='description'>
<p>The default values inside of the selection palette. Make sure that <a href="#options-showSelectionPalette">showSelectionPalette</a> and <a href="#options-showPalette">showPalette</a> are both enabled.</p>
<p>If a <code>localStorageKey</code> is defined, then this value will be overwritten by it.</p>
</div>
<pre class='prettyprint'>
$("#selectionPalette").spectrum({
showPalette: true,
palette: [ ],
showSelectionPalette: true, // true by default
selectionPalette: ["red", "green", "blue"]
});
</pre>
<div class='example'>
<span class='label label-info'>This colorpicker has default values in the selection palette:</span><br /><br />
<input type='text' name='selectionPalette' id='selectionPalette' value='orange' />
</div>
</div>
<h3 id="options-maxSelectionSize">Max Selection Size</h3>
<div class='option-content'>
<div class='description'>
<p>This is how many elements are allowed in the <a href="#options-selectionPalette">selectionPallete</a> at once.</p>
<p>Elements will be removed from the palette in first in - first out order if this limit is reached.</p>
</div>
<pre class='prettyprint'>
$("#maxSelectionSize").spectrum({
showPalette: true,
palette: [ ],
showSelectionPalette: true, // true by default
selectionPalette: ["red", "green", "blue"],
maxSelectionSize: 2
});
</pre>
<div class='example'>
<span class='label label-info'>This colorpicker starts removing selection palette colors older than 2:</span><br /><br />
<input type='text' name='maxSelectionSize' id='maxSelectionSize' value='red' />
</div>
</div>
<h3 id="options-hideAfterPaletteSelect">Hide After Palette Select</h3>
<div class='option-content'>
<div class='description'>
<p>You can have the colorpicker automatically hide after a palette color is selected.</p>
</div>
<pre class='prettyprint'>
$("#hideAfterPaletteSelect").spectrum({
showPaletteOnly: true,
showPalette:true,
hideAfterPaletteSelect: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='hideAfterPaletteSelect' id='hideAfterPaletteSelect' />
<em data-label-for="hideAfterPaletteSelect" class='em-label'></em>
</div>
</div>
<h3 id="options-clickoutFiresChange">Clickout Fires Change</h3>
<div class='option-content'>
<div class='description'>
<p>
When clicking outside of the colorpicker, you can force it to fire a <code>change</code> event rather than having it revert the change. This is <code>true</code> by default.
</p>
</div>
<pre class='prettyprint'>
$("#clickoutFiresChange").spectrum({
clickoutFiresChange: true
});
$("#clickoutDoesntChange").spectrum({
clickoutFiresChange: false
});
</pre>
<div class='example'>
<input type='text' name='clickoutFiresChange' id='clickoutFiresChange' value='goldenrod' />
<input type='text' name='clickoutDoesntFireChange' id='clickoutDoesntFireChange' value='goldenrod' />
</div>
</div>
<h3 id="options-showInitial">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 id="options-showInputAndInitial">Show Input and Initial</h3>
<div class='option-content'>
<div class='description'>
<p>If you specify both the <code>showInput</code> and <code>showInitial</code> options, the CSS keeps things in order by wrapping the buttons to the bottom row, and shrinking the input. <em>Note: this is all customizable via CSS.</em></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>Show Input, Initial, and Clear</h3>
<div class='option-content'>
<div class='description'>
<p>If you specify both the <code>showInput</code>, <code>showInitial</code>, and <code>allowEmpty</code> options, the CSS keeps things in order by wrapping the buttons to the bottom row, and shrinking the input. <em>Note: this is all customizable via CSS.</em></p>
</div>
<pre class='prettyprint'>
$("#showInputInitialClear").spectrum({
allowEmpty:true,
showInitial: true,
showInput: true
});
</pre>
<div class='example'>
<input type='text' name='showInputInitialClear' id='showInputInitialClear' value='' />
</div>
</div>
<h3 id="options-buttonText">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({
allowEmpty:true,
chooseText: "Alright",
cancelText: "No way"
});
</pre>
<div class='example'>
<input type='text' name='buttonText' id='buttonText' value='orangered' />
</div>
</div>
<h3 id="options-showButtons">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 id="options-containerClassName">Container Class Name</h3>
<div class='option-content'>
<div class='description'>
<p>
You can add an additional class name to the just the container element using the <code>containerClassName</code> property.
</p>
</div>
<pre class='prettyprint'>
$("#containerClassName").spectrum({
containerClassName: 'awesome'
});
</pre>
<pre class='prettyprint'>
.awesome {
background: purple;
}
</pre>
<style type='text/css'>
.awesome {
background: purple;
}
</style>
<div class='example'>
<input type='text' name='containerClassName' id='containerClassName' value='orangered' />
</div>
</div>
<h3 id="options-replacerClassName">Replacer Class Name</h3>
<div class='option-content'>
<div class='description'>
<p>
You can add an additional class name to just the replacer element using the <code>replacerClassName</code> property.
</p>
</div>
<pre class='prettyprint'>
$("#replacerClassName").spectrum({
replacerClassName: 'awesome'
});
</pre>
<pre class='prettyprint'>
.awesome {
background: purple;
}
</pre>
<style type='text/css'>
.awesome {
background: purple;
}
</style>
<div class='example'>
<input type='text' name='replacerClassName' id='replacerClassName' value='orangered' />
</div>
</div>
<h3 id="options-preferredFormat">Preferred Format</h3>
<div class='option-content'>
<div class='description'>
<p>You can set the format that is displayed in the text box.</p>
<p>This will also change the format that is displayed in the titles from the palette swatches.</p>
</div>
<pre class='prettyprint'>
$("#preferredHex").spectrum({
preferredFormat: "hex",
showInput: true,
showPalette: true,
palette: [["red", "rgba(0, 255, 0, .5)", "rgb(0, 0, 255)"]]
});
$("#preferredHex3").spectrum({
preferredFormat: "hex3",
showInput: true,
showPalette: true,
palette: [["red", "rgba(0, 255, 0, .5)", "rgb(0, 0, 255)"]]
});
$("#preferredHsl").spectrum({
preferredFormat: "hsl",
showInput: true,
showPalette: true,
palette: [["red", "rgba(0, 255, 0, .5)", "rgb(0, 0, 255)"]]
});
$("#preferredRgb").spectrum({
preferredFormat: "rgb",
showInput: true,
showPalette: true,
palette: [["red", "rgba(0, 255, 0, .5)", "rgb(0, 0, 255)"]]
});
$("#preferredName").spectrum({
preferredFormat: "name",
showInput: true,
showPalette: true,
palette: [["red", "rgba(0, 255, 0, .5)", "rgb(0, 0, 255)"]]
});
$("#preferredNone").spectrum({
showInput: true,
showPalette: true,
palette: [["red", "rgba(0, 255, 0, .5)", "rgb(0, 0, 255)"]]
});
</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'>Hex (3 Characters If Possible)</div>
<input type='text' name='preferredHex3' id='preferredHex3' 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>
<h3 id="options-appendTo">appendTo</h3>
<div class='option-content'>
<div class='description'>
<p>You can choose which element the colorpicker container is appended to (default is <code>"body"</code>). This can be any valid object taken into the jQuery <a href="https://api.jquery.com/appendTo/">appendTo</a> function.</p>
<p>Changing this can help resolve issues with opening the colorpicker in a modal dialog or fixed position container, for instance.</p>
</div>
</div>
<h2 id="events">Events</h2>
<pre class='prettyprint'>
// Events can be bound in the intialization process as options:
$("#picker").spectrum({
move: function(tinycolor) { },
show: function(tinycolor) { },
hide: function(tinycolor) { },
beforeShow: function(tinycolor) { },
});
// Alternatively, they can be added as an event listener:
$("#picker").on('move.spectrum', function(e, tinycolor) { });
$("#picker").on('show.spectrum', function(e, tinycolor) { });
$("#picker").on('hide.spectrum', function(e, tinycolor) { });
$("#picker").on('beforeShow.spectrum', function(e, tinycolor) { });
</pre>
<h3 id="events-change">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 data-label-for="changeOnMoveNo" class='em-label'></em>
</div>
</div>
<h3 id="events-move">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 data-label-for="changeOnMove" class='em-label'></em>
</div>
</div>
<h3 id="events-hide">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 class='example'>
<input type='text' value='blanchedalmond' name='eventhide' id='eventhide' />
<em id='eventhideLabel' class='em-label'></em>
</div>
</div>
<h3 id="events-show">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 class='example'>
<input type='text' value='blanchedalmond' name='eventshow' id='eventshow' />
<em id='eventshowLabel' class='em-label'></em>
</div>
</div>
<h3 id="events-beforeShow">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>
<h3 id="events-dragstart">dragstart</h3>
<div class='option-content'>
<div class='description'>
<p>
Called at the beginning of a drag event on either
hue slider, alpha slider, or main color picker areas
</p>
</div>
<pre class='prettyprint'>
$(element).on("dragstart.spectrum", function(e, color) {
color.toHexString(); // #ff0000
});
</pre>
<div class='example'>
<input type='text' value='blanchedalmond' name='eventdragstart' id='eventdragstart' />
<em id='eventdragstartLabel' class='em-label'></em>
</div>
</div>
<h3 id="events-dragstop">dragstop</h3>
<div class='option-content'>
<div class='description'>
<p>
Called at the end of a drag event on either
hue slider, alpha slider, or main color picker areas
</p>
</div>
<pre class='prettyprint'>
$(element).on("dragstop.spectrum", function(e, color) {
color.toHexString(); // #ff0000
});
</pre>
<div class='example'>
<input type='text' value='blanchedalmond' name='eventdragstop' id='eventdragstop' />
<em id='eventdragstopLabel' class='em-label'></em>
</div>
</div>
<h2 id="methods">Methods</h2>
<pre class='prettyprint'>
$("#picker").spectrum("show");
$("#picker").spectrum("hide");
$("#picker").spectrum("toggle");
$("#picker").spectrum("get");
$("#picker").spectrum("set", colorString);
$("#picker").spectrum("container");
$("#picker").spectrum("reflow");
$("#picker").spectrum("destroy");
$("#picker").spectrum("enable");
$("#picker").spectrum("disable");
$("#picker").spectrum("option", optionName);
$("#picker").spectrum("option", optionName, newOptionValue);
</pre>
<h3 id="methods-show">show</h3>
<div class='option-content'>
<div class='description'>
<p>
Shows the colorpicker.
</p>
</div>
</div>
<h3 id="methods-hide">hide</h3>
<div class='option-content'>
<div class='description'>
<p>
Hides the colorpicker.
</p>
</div>
</div>
<h3 id="methods-toggle">toggle</h3>
<div class='option-content'>
<div class='description'>
<p>
Toggles the colorpicker.
</p>
<p class="warning">
<b>Warning:</b> If you are calling toggle from a click handler, make sure you <code>return false</code> to prevent the colorpicker from immediately hiding after it is toggled.
</p>
</div>
<pre class='prettyprint'>
$("#btn-toggle").click(function() {
$("#toggle").spectrum("toggle");
return false;
});
</pre>
<div class='example'>
<input type='text' value='blanchedalmond' name='toggle' id='toggle' />
<button id='btn-toggle'>Toggle</button>
</div>
</div>
<h3 id="methods-get">get</h3>
<div class='option-content'>
<div class='description'>
<p>
Gets the current value from the colorpicker.
</p>
</div>
</div>
<h3 id="methods-set">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>