Release v1.5.2

CHANGELOG.md

@@ -11,6 +11,14 @@
 - Migrate to modern testframework
 - Update website and host on Github
 
+## Version 1.5.2 - 2021.02.14
+- [Issue 137](https://github.com/jamietre/ImageMapster/issues/137) area href empty or not specified
+- [Issue 170](https://github.com/jamietre/ImageMapster/issues/170) Tooltips/Highlight/Select incorrect when AREA `shape` attribute is missing or its value is non-conforming/empty
+- [Issue 364](https://github.com/jamietre/ImageMapster/issues/364) `Uncaught (in promise) undefined` when mouseoutDelay -1
+- [Issue 365](https://github.com/jamietre/ImageMapster/issues/365) Visual 'selection' cannot be removed via API when `staticState === true`
+- [Issue 366](https://github.com/jamietre/ImageMapster/issues/366) area w/ `staticState === false` that has been selected via API becomes unselected when clicking another area
+- [Issue 367](https://github.com/jamietre/ImageMapster/issues/367) `select`/`set` options not applied or not applied correctly
+
 ## Version 1.5.1 - 2021.01.30
 
 - [Issue 362](https://github.com/jamietre/ImageMapster/issues/362) Apply width/height to hidden elements on `resize` when `duration` specified

CONTRIBUTING.md

@@ -18,12 +18,9 @@ A bug is a _demonstrable problem_ that is caused by the code in the repository.
 
 Guidelines for bug reports:
 
-0. **Lint your code** — Use [jshint](http://jshint.com/) to ensure your problem isn't caused by a simple error in your own code.
-
+1. **Lint your code** — Use [eslint](http://eslint.org/) to ensure your problem isn't caused by a simple error in your own code.
 1. **Use the GitHub issue search** — check if the issue has already been reported.
-
 1. **Check if the issue has been fixed** — try to reproduce it using the latest `master` or development branch in the repository.
-
 1. **Isolate the problem** — ideally create a [reduced test case](https://css-tricks.com/reduced-test-cases/) and a [live example](https://jsfiddle.net).
 
 A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? Do other browsers show the bug differently? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

README.md

@@ -57,13 +57,13 @@ Alternatively, you can include ImageMapster from one of the following CDNs:
 Activate all image maps on the page with default options: on mouseover areas are highlighted with a gray fill with no border, and clicking an area causes it to become selected.
 
 ```js
-$('img').mapster();
+$('img[usemap]').mapster();
 ```
 
-Activate image maps with some specific options.
+Activate all image maps on the page with some specific options.
 
 ```js
-$('img').mapster({
+$('img[usemap]').mapster({
   fillColor: 'ff0000',
   stroke: true,
   singleSelect: true
@@ -82,7 +82,7 @@ $('area').mapster('select');
 
 Programatically select elements from the image map. The programmatic selection/deselection methods will not honor the staticState property.
 
-**deselect**: Cause an area to become "selected"
+**deselect**: Cause an area to become "deselected"
 
 ```js
 $('area').mapster('deselect');
@@ -97,15 +97,15 @@ $('area').mapster('set', selected);
 You can also select or deselect areas using a their `mapKey`. This is an attribute on each area in your HTML that identifies it. You define a mapKey using a configuration option: `mapKey: 'data-key'`.
 
 ```js
-$('img').mapster('set', true, 'key1,key2');
+$('img[usemap]').mapster('set', true, 'key1,key2');
 ```
 
 If two areas share the same value for the `mapKey` they will be automatically grouped together when activated. You can also use the values of the mapKey to select areas from code.
 
 You can pass options to change the rendering effects when using set as the last parameter:
 
 ```js
-$('img').mapster('set', true, 'key', { fillColor: 'ff0000' });
+$('img[usemap]').mapster('set', true, 'key', { fillColor: 'ff0000' });
 ```
 
 MapKeys can contain more than one value. The first value always defines groups when you mouse over. Other values can be used to create logical groups. For example:
@@ -135,10 +135,10 @@ Mousing over each state would cause just that state to be higlighted. You can al
 
 ```js
 // select all New England states
-$('img').mapster('set', true, 'new-england');
+$('#usamap').mapster('set', true, 'new-england');
 
 // select just Maine, New Hampshire & Vermont
-$('img').mapster('set', true, 'really-cold');
+$('#usamap').mapster('set', true, 'really-cold');
 ```
 
 Groups created this way are _independent_ of the primary group. If you select "new-england" from code, you can't unselect just "MA" by clicking on it. You would have to unselect "new-england" from code.
@@ -158,7 +158,7 @@ ImageMapster includes several examples. To view the examples:
 
 ## Zepto Compatibility
 
-As of ImageMapster v1.3.2, ImageMapster contains full support for Zepto v1.2.0. The latest Zepto compatible version of ImageMapster is [1.5.1](https://github.com/jamietre/ImageMapster/releases/tag/v1.5.1).
+As of ImageMapster v1.3.2, ImageMapster contains full support for Zepto v1.2.0. The latest Zepto compatible version of ImageMapster is [1.5.2](https://github.com/jamietre/ImageMapster/releases/tag/v1.5.2).
 
 Prior to ImageMapster v1.3.2 and with any version of Zepto except v1.2.0, ImageMapster is unlikely to work as expected. In the early versions of ImageMapster, Zepto support was maintained, however due to changes in Zepto, as of v1.2.5 of ImageMapster, support for Zepto compatability was not maintained as it required too much effort and pushing ImageMapster forward with jQuery was the priority.
 
@@ -177,8 +177,8 @@ To use ImageMapster >= v1.3.2 < 2.0.0 with Zepto v.1.2.0, Zepto must contain the
 
 :warning: **_As of ImageMapster v1.3.0, if targeting ES5 browers, you must include a Promise polyfill such as [es6-promise](https://www.npmjs.com/package/es6-promise). See [Issue 341](https://github.com/jamietre/ImageMapster/issues/341) for details._**
 
-1. [jsDelivr](https://www.jsdelivr.com/package/npm/imagemapster?version=1.5.1) - https://www.jsdelivr.com/package/npm/imagemapster?version=1.5.1
-2. [cdnjs](https://cdnjs.com/libraries/imagemapster/1.5.1) - https://cdnjs.com/libraries/imagemapster/1.5.1
+1. [jsDelivr](https://www.jsdelivr.com/package/npm/imagemapster?version=1.5.2) - https://www.jsdelivr.com/package/npm/imagemapster?version=1.5.2
+2. [cdnjs](https://cdnjs.com/libraries/imagemapster/1.5.2) - https://cdnjs.com/libraries/imagemapster/1.5.2
 
 Use `jquery.imagemapster.zepto.min.js`
 
@@ -194,7 +194,7 @@ Use `jquery.imagemapster.zepto.min.js`
 ></script>
 <script
   language="text/javascript"
-  src="/path/to/cdn/for/v1.5.1/dist/jquery.imagemapster.zepto.min.js"
+  src="/path/to/cdn/for/v1.5.2/dist/jquery.imagemapster.zepto.min.js"
 ></script>
 ```
 
@@ -207,7 +207,7 @@ Using `webpack` and `zepto-modules` as an example:
 #### Install from NPM
 
 ```sh
-npm install zepto-modules [email protected].1 --save
+npm install zepto-modules [email protected].2 --save
 ```
 
 #### src/yourzepto.js

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "ImageMapster",
-  "version": "1.5.1",
+  "version": "1.5.2",
   "homepage": "https://github.com/jamietre/ImageMapster",
   "description": "jQuery plugin that activates areas in HTML imagemaps with support for highlighting, selecting, tooltips, resizing and more",
   "main": "dist/jquery.imagemapster.min.js",