Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gordonlesti/broilerjs

A simple, lightweight jQuery plugin to get the color of an image pixel by click.
https://github.com/gordonlesti/broilerjs

color image javascript jquery

Last synced: 1 day ago
JSON representation

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

Awesome Lists containing this project

README

        

# broilerjs

[![Latest Version on npm][ico-version]][link-npm]
[![Software License][ico-license]](LICENSE.md)
[![Build Status][ico-travis]][link-travis]
[![Coverage Status][ico-coverall]][link-coveralls]
[![Total Downloads][ico-downloads]][link-downloads]

A simple, lightweight jQuery plugin to get the color of an image pixel by click. Here is a small [demo](https://gordonlesti.com/broiler-demo-rainbow/)

## Build Status Matrix

[![Sauce Test Status](https://saucelabs.com/browser-matrix/broilerjs.svg)](https://saucelabs.com/u/broilerjs)

## Install

Several quick start options are available:
* [Download the latest release](https://github.com/GordonLesti/broilerjs/releases/latest).
* Clone the repo: `git clone https://github.com/GordonLesti/broilerjs.git`.
* Install with [npm](https://www.npmjs.com/): `npm install broilerjs`.
* Install with [Bower](http://bower.io): `bower install broilerjs`.

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

```html

```

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

## Usage

```javascript
$("#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](CHANGELOG.md) for more information what has changed recently.

## Testing

``` bash
$ grunt
```

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for details.

## Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

## Credits

- [Gordon Lesti][link-author]
- [All Contributors][link-contributors]

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

[ico-version]: https://img.shields.io/npm/v/broilerjs.svg?style=flat-square
[ico-license]: https://img.shields.io/github/license/GordonLesti/broilerjs.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/GordonLesti/broilerjs/master.svg?style=flat-square
[ico-coverall]: https://img.shields.io/coveralls/GordonLesti/broilerjs/master.svg?style=flat-square
[ico-downloads]: https://img.shields.io/npm/dt/broilerjs.svg?style=flat-square

[link-npm]: https://www.npmjs.com/package/broilerjs
[link-travis]: https://travis-ci.org/GordonLesti/broilerjs
[link-coveralls]: https://coveralls.io/r/GordonLesti/broilerjs
[link-downloads]: https://www.npmjs.com/package/broilerjs
[link-author]: https://gordonlesti.com/
[link-contributors]: ../../contributors