Getting started

Get started with these basic examples, showcasing the different plugin options. You can also view the whole list of default options here.

Simple usage

Most simple example, with any options or color information.

Code
<input id="cp1" type="text" class="form-control input-lg" value=""/>
<script>
  $(function () {
    $('#cp1').colorpicker();
  });
</script>

Setting the initial color

The initial color can be specified in 3 ways: input value, data-color attribute and programmatically with the color constructor option.
This demo is also showing how to use the input addon component to display the color.

The used initial color has this precedence order when present and not empty: color option, input value, input data-color attribute, colopicker element data-color attribute.

Code
<div id="cp2" class="input-group" title="Using input value">
  <input type="text" class="form-control input-lg" value="#DD0F20FF"/>
  <span class="input-group-append">
    <span class="input-group-text colorpicker-input-addon"><i></i></span>
  </span>
</div>

<div id="cp3a" class="input-group" data-color="rgb(241, 138, 49)"
     title="Using data-color attribute in the colorpicker element">
  <input type="text" class="form-control input-lg"/>
  <span class="input-group-append">
    <span class="input-group-text colorpicker-input-addon"><i></i></span>
  </span>
</div>

<div id="cp3b" class="input-group" title="Using data-color attribute in the input">
  <input type="text" class="form-control input-lg" data-color="hsl(56, 93%, 63%)"/>
  <span class="input-group-append">
    <span class="input-group-text colorpicker-input-addon"><i></i></span>
  </span>
</div>

<div id="cp4" class="input-group" title="Using color option">
  <input type="text" class="form-control input-lg"/>
  <span class="input-group-append">
    <span class="input-group-text colorpicker-input-addon"><i></i></span>
  </span>
</div>

<script>
  $(function () {
    $('#cp2, #cp3a, #cp3b').colorpicker();
    $('#cp4').colorpicker({"color": "#16813D"});
  });
</script>

Automatic format detection

Whenever the format option is 'auto', the first parsed color format will be detected and used as default, but when the option equals null (default), the format is recalculated every time. You can see the differences here, one of them allowing you to adjust the alpha channel:

Code
<div id="cp5a" class="input-group" title="Using format option">
  <input type="text" class="form-control input-lg" value="#305AA2"/>
  <span class="input-group-append">
    <span class="input-group-text colorpicker-input-addon"><i></i></span>
  </span>
</div>
<div id="cp5b" class="input-group" title="Using format option">
  <input type="text" class="form-control input-lg" value="#305AA2"/>
  <span class="input-group-append">
    <span class="input-group-text colorpicker-input-addon"><i></i></span>
  </span>
</div>
<script>
  $(function () {
    $('#cp5a').colorpicker({
      format: 'auto'
    });
    $('#cp5b').colorpicker({
      format: null
    });
  });
</script>

Force a format

If defined, the format option forces an specific format, ignoring the original one.

Code
<div id="cp5c" class="input-group" title="Using format option">
  <input type="text" class="form-control input-lg" value="#305AA2"/>
  <span class="input-group-append">
    <span class="input-group-text colorpicker-input-addon"><i></i></span>
  </span>
</div>
<script>
  $(function () {
    $('#cp5c').colorpicker({
      format: "rgb"
    });
  });
</script>

Disabled / Enabled states

When the input is disabled, the colorpicker also gets disabled.


Code
<div id="cp5d" title="Using format option">
  <div class="input-group">
    <input type="text" class="form-control input-lg" value="rgb(203, 38, 192)" disabled/>
  </div>
</div>
<br>
<button id="cp5d_toggle" class="btn btn-primary">Toggle Enable/Disable</button>
<script>
  $(function () {
    $('#cp5d').colorpicker({
      inline: true
    });
    $('#cp5d_toggle').on('click', function () {
      var cp = $('#cp5d').colorpicker('colorpicker');
      if (cp.isEnabled()) {
        cp.disable();
      } else {
        cp.enable();
      }
    });
  });
</script>

Horizontal mode

In this mode the hue and alpha bars are horizontal instead of vertical.

Code
<div id="cp6" class="input-group" title="Using horizontal option">
  <input type="text" class="form-control input-lg" value="#6D2781"/>
  <span class="input-group-append">
    <span class="input-group-text colorpicker-input-addon"><i></i></span>
  </span>
</div>
<script>
  $(function () {
    $('#cp6').colorpicker({
      horizontal: true
    });
  });
</script>

Inline containerized mode

In this mode the colorpicker widget is an inline element and it is also placed inside the element (otherwise it is placed in the body).
This example also shows the two ways of using the container option.

Inner inline →
Sibling inline →
Code
<div id="cp7" style="border:1px dashed #DD0F20;">Inner inline &rightarrow;</div>
<hr>
<div id="cp8_container">
  <span id="cp8" style="border:1px dashed #F18A31;">Sibling inline &rightarrow;</span>
</div>
<script>
  $(function () {
    $('#cp7').colorpicker({
      color: '#DD0F20',
      inline: true,
      container: true
    });
    $('#cp8').colorpicker({
      color: '#F18A31',
      inline: true,
      container: '#cp8_container'
    });
  });
</script>

Disable alpha channel

When the alpha channel is disabled with the useAlpha option, the alpha bar will be hidden and the color object will be restricted to opaque (alpha = 1).

Code
<div id="cp9" class="input-group">
  <input type="text" class="form-control input-lg" value="rgba(248, 235, 72, 0.5)"/>
  <span class="input-group-append">
    <span class="input-group-text colorpicker-input-addon"><i></i></span>
  </span>
</div>
<script>
  $(function () {
    $('#cp9').colorpicker({
      useAlpha: false
    });
  });
</script>

Disable hexadecimal hash

This example shows how to avoid the input to have the hexadecimal hash prefix, using the useHashPrefix option.

Code
<div id="cp10" class="input-group">
  <input type="text" class="form-control input-lg" value="#16813d"/>
  <span class="input-group-append">
    <span class="input-group-text colorpicker-input-addon"><i></i></span>
  </span>
</div>
<script>
  $(function () {
    $('#cp10').colorpicker({
      useHashPrefix: false
    });
  });
</script>

transparent support

Example showing the transparent named color support.

Code
<div id="cp12" class="input-group">
  <input type="text" class="form-control input-lg" value="transparent"/>
  <span class="input-group-append">
    <span class="input-group-text colorpicker-input-addon"><i></i></span>
  </span>
</div>
<script>
  $(function () {
    $('#cp12').colorpicker();
  });
</script>

Use a custom fallback color

Use a predefined fallback color with the fallbackColor option, whenever the given one is invalid.

Code
<div id="cp11" class="input-group">
  <input type="text" class="form-control input-lg" value="invalid color"/>
  <span class="input-group-append">
    <span class="input-group-text colorpicker-input-addon"><i></i></span>
  </span>
</div>
<script>
  $(function () {
    $('#cp11').colorpicker({
      fallbackColor: 'rgb(48, 90, 162)'
    });
  });
</script>

Disable invalid color auto replacement

By default, the autoInputFallback option is enabled, meaning that whenever there is an invalid color typed in the input, it will be automatically replaced by a valid color or the fallback one.
You can stop this behavior by setting this option to false. Note that this only affects the input value and not the internal color object. This allows you introduce errors in the input while typing without having the input constantly replaced with the fallback. This way, the internal color object will be equal to the fallback until the input has a valid color.

Code
<div id="cp13" class="input-group">
  <input type="text" class="form-control input-lg" value="I am an invalid color"/>
  <span class="input-group-append">
    <span class="input-group-text colorpicker-input-addon"><i></i></span>
  </span>
</div>
<script>
  $(function () {
    $('#cp13').colorpicker({
      autoInputFallback: false
    });
  });
</script>

Disable HEX change from #RGB to #RRGGBB

By default, if the autoInputFallback option is enabled, even when you will change input to HEX3 (#RGB), it will automatically convert to hex6 (#RRGGBB)
You can stop this by setting this option to false. That way, when someone will type color to input, that is identified as HEX color, it will convert to #RRGGBB only if it will be a valid HEX6 color.

Code
<div id="cp14" class="input-group">
      <input type="text" class="form-control input-lg" value="I am an invalid color"/>
      <span class="input-group-append">
        <span class="input-group-text colorpicker-input-addon"><i></i></span>
      </span>
    </div>
    <script>
      $(function () {
        $('#cp14').colorpicker({
          autoInputFallback: false,
          autoHexInputFallback: false,
        });
      });
    </script>

Adjust the popover options

You can use any Bootstrap Popover options (except: trigger, content and html) using the "popover" property in the colorpicker options.

Code
<div id="cp15" class="input-group">
  <input type="text" class="form-control input-lg" value="hsl(103, 70%, 64%)"/>
  <span class="input-group-append">
    <span class="input-group-text colorpicker-input-addon"><i></i></span>
  </span>
</div>
<script>
  $(function () {
    $('#cp15').colorpicker({
      popover: {
        title: 'Adjust the color',
        placement: 'top'
      }
    });
  });
</script>

Use a color picker inside a modal

Code
<!-- Button trigger modal -->
<button type="button" class="btn btn-primary" data-toggle="modal" data-target="#exampleModal">
  Launch demo modal
</button>

<!-- Modal -->
<div class="modal fade" id="exampleModal" tabindex="-1" role="dialog"
     aria-labelledby="exampleModalLabel" aria-hidden="true">
  <div class="modal-dialog" role="document">
    <div class="modal-content">
      <div class="modal-header">
        <h5 class="modal-title" id="exampleModalLabel">Modal title</h5>
        <button type="button" class="close" data-dismiss="modal" aria-label="Close">
          <span aria-hidden="true">&times;</span>
        </button>
      </div>
      <div class="modal-body">
        <input id="cp16" type="text" class="form-control input-lg" value="rgb(130, 44, 29)"/>
      </div>
      <div class="modal-footer">
        <button type="button" class="btn btn-secondary" data-dismiss="modal">Close</button>
        <button type="button" class="btn btn-primary">Save changes</button>
      </div>
    </div>
  </div>
</div>
<script>
  $(function () {
    $('#cp16').colorpicker();
  });
</script>