Skip to content

GordonLesti/broilerjs

Repository files navigation

broilerjs

Latest Version on npm Software License Build Status Coverage Status Total Downloads

A simple, lightweight jQuery plugin to get the color of an image pixel by click. Here is a small demo

Build Status Matrix

Sauce Test Status

Install

Several quick start options are available:

  • Download the latest release.
  • Clone the repo: git clone https://github.com/GordonLesti/broilerjs.git.
  • Install with npm: npm install broilerjs.
  • Install with Bower: bower install broilerjs.

Include script after the jQuery library (unless you are packaging scripts somehow else):

<script src="/path/to/broiler.js"></script>

The plugin can also be loaded as AMD or CommonJS module.

Usage

$("#image").broiler(function(color) {
  // do what ever you want with the color object, for example an alert
  alert("red:"+color.r+" green:"+color.g+" blue:"+color.b+" alpha:"+color.a);
});

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

$ grunt

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email info@gordonlesti.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

About

A simple, lightweight jQuery plugin to get the color of an image pixel by click.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published