Git Product home page Git Product logo

colorpick.js's Introduction

alt tag

ColorPick.js

ColorPick.js is a simple and minimal jQuery color picker plugin for the modern web.

Features

  • The recently used colors are automatically saved to local storage
  • Simplicity of integration
  • Gorgeous modern design that will suit almost every website
  • Dark mode

Usage

You can clone this repository or download the latest build as a zip from here.

ColorPick.js requires jQuery. This is the only dependency. Make sure to load it before ColorPick.js.

Basic example:

<head>
  <link rel="stylesheet" href="css/colorPick.min.css">
</head>
<body>
  <div class="picker"></div>
  
  <script src="js/jquery.min.js"></script>
  <script src="js/colorPick.min.js"></script>
  <script>
    $(".picker").colorPick();
  </script>
</body>

Result:

alt tag

Options

Initial color

By default, the initial color is #3498db.

You can overwrite this globally for all pickers on the page with initialColor option:

$(".picker").colorPick({ 'initialColor': '#27ae60' });

For different initial colors for individual pickers use data-initialcolor attribute:

<div class="picker" data-initialcolor="#3998DB"></div>

Custom action

You can specify your own action event which will be called as soon as the color is selected. The hex color which has been selected can be referred to as "this.color".

$(".picker").colorPick({ 
  'onColorSelected': function() {
    console.log("The user has selected the color: " + this.color)
    this.element.css({'backgroundColor': this.color, 'color': this.color});
  } 
});

Allowing saving recent colors and specifying their number

By default, recent colors are allowed, and their max number is 5.

$(".picker").colorPick({ 'allowRecent': true, 'recentMax': 5 });

Custom colors database

By default, we use Flat UI color database.

$(".picker").colorPick({ 'palette': ["#1abc9c", "#16a085", "#2ecc71"] });

Custom palette label

Default is "Default palette:" (with colon). If provided paletteLabel will overwrite the palette label.

$(".picker").colorPick({ 'paletteLabel': 'Custom label' });

Allow custom color

You can allow users to enter custom color. This will enable input field that accepts 3- or 6-letter HEX color. Defaults to false.

$(".picker").colorPick({ 'allowCustomColor': true });

License

MIT License

Copyright (c) 2017 Phil Zet (a.k.a. Philipp Zakharchenko)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

colorpick.js's People

Contributors

philptr avatar mashedkeyboard avatar aromalanil avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.