Skip to content

yegor256/colorizejs

Repository files navigation

A jQuery Plugin for Conditional Colorization

DevOps By Rultor.com

gulp PDD status License NPM version

It's a simple jQuery plugin to colorize data elements according to their values:

$('#foo').colorizejs({ 500: 'green', 0: 'red' });

If the value of #foo is larger than 500, its color will be set to green, if it is larger than zero, it will be set to red, otherwise it won't be touched.

You can also use classes instead of colors by prepending them with a dot:

$('#foo').colorizejs({ 500: '.green', 0: '.red' });

The easiest way is to just include it in your HTML from the jsDelivr CDN:

<!DOCTYPE html>
<html>
  <head>
    <script src="https://cdn.jsdelivr.net/npm/[email protected]/colorizejs-1.2.0.min.js"
            integrity="sha384-Nk8DOyZntjNMRKhFcmFT36tbZ/qMucmsm8KLzUc6D1d4RI4qgokGlKi/yUFXK51M"
            crossorigin="anonymous"></script>
  </head>
</html>

Otherwise, you can download the latest release.

You can also install it with npm:

npm install colorizejs

Example

A minimal example.html file is included to demonstrate how ColorizeJS colours numeric values based on defined rules.

To try it:

  1. Open example.html in a browser.
  2. See the number "350" appear in red according to the rules.
  3. The rules are: { 500: '.green', 0: '.red' }.

This file is mainly for users or developers who want a quick way to verify that the plugin works after cloning the repository.

How to Contribute

First, make sure you can build it locally:

npm install --global gulp-cli
gulp

The build has to be clean. If it's not, submit an issue.

Then, make your changes, make sure the build is still clean, and submit a pull request.

About

A jQuery plugin for conditional colorization of data elements

Topics

Resources

License

Stars

Watchers

Forks

Contributors