clicklight v1.0.2

clicklight.js

Clicklight is a jQuery plugin to work with HTML image maps.

The plugin provides hover and click event handlers as well as callbacks to manipulate the color and opacity of mapped areas.

The plugin has a small footprint and has no dependencies other than jQuery 1.7+ and a browser that supports HTML5 canvas.

Clicklight was specifically designed to be small and nimble, hiding the gory details of HTML5 canvas under a small, clean API. It has very little built-in functionality. If you need a more featureful solution, you may want to have a look at the venerable ImageMapster plugin.

Basic Usage

Requirements

• image with an associated image map
• <img> wrapped in <div> tag
• <area> tags you want managed by clicklight are required to have a data-cl-uid="userSetID" on each.

Installation

npm install clicklight

bower install clicklight

Usage

Without configuration, clicklight applies and removes coloring to instantiated mapped areas.

HTML:

<div>
  <img src="some/img/src" usemap="#mapName" id="thisImg">
</div>

<map name="mapName">
  <area shape="rect" alt="" coords="x1,y1,x2,y2" href="#" data-cl-uid="1" title="example">
  <area shape="rect" alt="" coords="x1,y1,x2,y2" href="#" data-cl-uid="2" title="example">
  <area shape="rect" alt="" coords="x1,y1,x2,y2" href="#" data-cl-uid="2" title="example">
</map>

Javascript/jQuery:

$(function() {

  $('#thisImg').clicklight();

});

Configuration

Clicklight provides a small config object offering 3 properties and 7 callbacks.

Properties

hoverColor and clickColor only accept RGB strings.

Callbacks

Callbacks exist in two levels. First level callbacks are predefined with default behavior. Second level callbacks, when defined in config, are called by their first level counterparts.

All events are tied to an instantiated maps area tags.

Callbacks arguments

• this area that fired event
• inst active instance
• id the area's group

The seventh callback is onConfigured(inst), called after instantiation. It works slightly differently in that this will point to the image clicklight was called on while one argument inst is provided.

Using the config

To give our config object to clicklight, pass it in while instantiating.

$(function() {

  $('#thisImg').clicklight({
    clickColor : '255, 0, 0',
    hoverColor : '255, 200, 0',
    alpha      : '0.6',
    onClick    : function (inst, id) {
      console.log(this, 'was just clicked and is in group', id);
    },
    onConfigured : function (inst) {
      console.log(inst, 'was just instantiated on', this);
    }
  });

});

API

Clicklight provides 5 methods that can be called through clicklight by passing string identifiers into an instance. Each instance is tied to the image it was built on, to get back at it, just call clicklight on the image you want the instance of.

$('#thisImg').clicklight('set', 'ID', 'COLOR');
// set takes a group id and color to set the given group to. Current
// color will be set to the passed color internally

$('#thisImg').clicklight('reset', 'ID');
// reset takes a group id and sets the color to whatever is internally
// saved as current color

$('#thisImg').clicklight('setTransient', 'ID', 'COLOR');
// setTransient takes a group id and color to set the given group to.
// Current color is not changed internally

$('#thisImg').clicklight('resetState', 'ID');
// resetState takes a group id to remove color from as well as clear
// the current color saved internally

$('#thisImg').clicklight('updateConfig', {/*new config object*/});
// updateConfig takes the very same config object described above in
// case something needs to be changed during runtime

Limitations

• Colors need to be RGB string values
• no method for deletion of an instance
• only mapped area tags of type 'rectangle' will work