Skip to content

Commit

Permalink
chore: fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
techfg committed Apr 6, 2024
1 parent e494065 commit 1c98300
Show file tree
Hide file tree
Showing 13 changed files with 27 additions and 30 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ body:
id: reproduction
attributes:
label: Reproduction
description: Please provide a link to a location (e.g., repo, [jsFiddle](https://www.jsfiddle.net), etc.) that reproduces the problem you ran into using the latest version of ImageMapster. Please see the [contributing docs](https://github.com/jamietre/ImageMapster/blob/main/CONTRIBUTING.md) for suggestions on creating a reproduction. A [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) **is required** ([Why?](https://antfu.me/posts/why-reproductions-are-required)). If a report is vague (e.g., just a generic error message) and has no reproduction, it will receive a "needs author feedback" label and the issue closed until there is enough information provided.
description: Please provide a link to a location (e.g., repo, [JSFiddle](https://www.jsfiddle.net), etc.) that reproduces the problem you ran into using the latest version of ImageMapster. Please see the [contributing docs](https://github.com/jamietre/ImageMapster/blob/main/CONTRIBUTING.md) for suggestions on creating a reproduction. A [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) **is required** ([Why?](https://antfu.me/posts/why-reproductions-are-required)). If a report is vague (e.g., just a generic error message) and has no reproduction, it will receive a "needs author feedback" label and the issue closed until there is enough information provided.
placeholder: Reproduction URL
validations:
required: true
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ Bug fixes:

Features:

- [Issue #52](https://github.com/jamietre/ImageMapster/issues/52) Add "clickNavigate" feature to allow basic imagemap functionality
- [Issue #52](https://github.com/jamietre/ImageMapster/issues/52) Add "clickNavigate" feature to allow basic image map functionality
- Add "highlight" option to programatically set/unset the highlight effect (as if a user just moused over an area vs. clicked)
- Detect touchscreen devices and disable "mouseover"
- [Issue #11](https://github.com/jamietre/ImageMapster/issues/11) Detect excanvas automatically and force into IE mode if present
Expand Down
21 changes: 7 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
[![cdnjs version](https://img.shields.io/cdnjs/v/imagemapster.svg?color=orange)](https://cdnjs.com/libraries/imagemapster)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

ImageMapster activates the areas in HTML imagemaps so you can highlight and select them. It has lots of other features for manual control, tooltips, resizing, and more. It is designed to be compatible with every common platform, and is tested with Internet Explorer 6-10, Firefox 3.0+, Safari, Opera, and Chrome. It works on mobile devices and doesn't use Flash.
ImageMapster activates the areas in HTML image maps so you can highlight and select them. It has lots of other features for manual control, tooltips, resizing, and more. It is designed to be compatible with every common platform, and is tested with Internet Explorer 6-10, Firefox 3.0+, Safari, Opera, and Chrome. It works on mobile devices and doesn't use Flash.

## Release Information

Expand Down Expand Up @@ -43,10 +43,10 @@ Download the latest version of ImageMapster from the [Releases](https://github.c
src="https://cdn.jsdelivr.net/npm/es6-promise/dist/es6-promise.auto.min.js"
></script>
<script
language="text/javascript"
type="text/javascript"
src="https://ajax.googleapis.com/ajax/libs/jquery/3.7.1/jquery.min.js"
></script>
<script language="text/javascript" src="jquery.imagemapster.min.js"></script>
<script type="text/javascript" src="jquery.imagemapster.min.js"></script>
```

Alternatively, you can include ImageMapster from one of the following CDNs:
Expand Down Expand Up @@ -74,7 +74,7 @@ $('img[usemap]').mapster({

#### Methods

There are lots of ways to manipulate the imagemap from Javascript. Here area a few, see the [ImageMapster web site](http://www.outsharked.com/imagemapster) for complete documentation.
There are lots of ways to manipulate the image map from Javascript. Here area a few, see the [ImageMapster web site](http://www.outsharked.com/imagemapster) for complete documentation.

**select**: Cause an area to become "selected"

Expand Down Expand Up @@ -187,24 +187,17 @@ To use ImageMapster >= v1.3.2 < 2.0.0 with Zepto v.1.2.0, Zepto must contain the
>
> 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.
Download the latest Zepto version of ImageMapster from the [Releases](https://github.com/jamietre/ImageMapster/releases) page and include in your webpage:

> ℹ️ **Note**
>
> Make sure to use `jquery.imagemapster.zepto.min.js`
Download the latest Zepto version of ImageMapster from the [Releases](https://github.com/jamietre/ImageMapster/releases) page and include in your webpage **making sure to use `jquery.imagemapster.zepto.min.js` or `jquery.imagemapster.zepto.js`**:

```html
<!-- Optional: If targeting ES5 browers, as of ImageMapster v1.3.0, a Promise polyfill is required! -->
<script
type="text/javascript"
src="https://cdn.jsdelivr.net/npm/es6-promise/dist/es6-promise.auto.min.js"
></script>
<script type="text/javascript" src="/path/to/your/custom/zeptodist"></script>
<script
language="text/javascript"
src="/path/to/your/custom/zeptodist"
></script>
<script
language="text/javascript"
type="text/javascript"
src="/path/to/cdn/for/v1.6.0/dist/jquery.imagemapster.zepto.min.js"
></script>
```
Expand Down
2 changes: 1 addition & 1 deletion bower.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "ImageMapster",
"version": "1.6.0",
"homepage": "https://github.com/jamietre/ImageMapster",
"description": "jQuery plugin that activates areas in HTML imagemaps with support for highlighting, selecting, tooltips, resizing and more",
"description": "jQuery plugin that activates areas in HTML image maps with support for highlighting, selecting, tooltips, resizing and more",
"main": "dist/jquery.imagemapster.min.js",
"keywords": [
"jquery",
Expand Down
5 changes: 3 additions & 2 deletions examples/shapes-spec.html
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,9 @@
<h2>Shapes HTML Spec Test</h2>
<p>
Test 'shape' attributes using various combinations of values. If working
as expected, behavior of all 4 imagemaps should function identically. This
should be converted to a unit test once the testing framework is updated.
as expected, behavior of all 4 image maps should function identically.
This should be converted to a unit test once the testing framework is
updated.
</p>
<p>The behavior of each shape should be:</p>
<ul>
Expand Down
3 changes: 2 additions & 1 deletion examples/tooltips.html
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,8 @@
<h2>Advanced ToolTip Example</h2>
<p>
This shows how to use ToolTip features in 1.2.6 and extended in 1.3.3 to
render tooltips manually, and for any area (inside or outside an imagemap)
render tooltips manually, and for any area (inside or outside an image
map)
</p>
<hr />
<p>
Expand Down
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "imagemapster",
"version": "1.6.0",
"description": "jQuery plugin that activates areas in HTML imagemaps with support for highlighting, selecting, tooltips, resizing and more",
"description": "jQuery plugin that activates areas in HTML image maps with support for highlighting, selecting, tooltips, resizing and more",
"main": "dist/jquery.imagemapster.min.js",
"module": "dist/jquery.imagemapster.min.mjs",
"exports": {
Expand Down Expand Up @@ -44,8 +44,10 @@
"html",
"plugin",
"maps",
"map",
"image",
"imagemap",
"image map",
"canvas",
"highlight",
"select",
Expand Down
2 changes: 1 addition & 1 deletion src/areacorners.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

/**
* Compute positions that will place a target with dimensions [width,height] outside
* but near the boundaries of the elements "elements". When an imagemap is passed, the
* but near the boundaries of the elements "elements". When an image map is passed, the
*
* @param {Element|Element[]} elements An element or an array of elements (such as a jQuery object)
* @param {Element} image The image to which area elements are bound, if this is an image map.
Expand Down
2 changes: 1 addition & 1 deletion src/core.js
Original file line number Diff line number Diff line change
Expand Up @@ -471,7 +471,7 @@
* invoked on an image, or an area; then queues the command if the MapData is in an active state.
*
* @param {[jQuery]} that The target of the invocation
* @param {[function]} func_map The callback if the target is an imagemap
* @param {[function]} func_map The callback if the target is an image map
* @param {[function]} func_area The callback if the target is an area
* @param {[object]} opt Options: { key: a map key if passed explicitly
* name: the command name, if it can be queued,
Expand Down
4 changes: 2 additions & 2 deletions src/mapdata.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
mapdata.js
The MapData object, repesents an instance of a single bound imagemap
The MapData object, repesents an instance of a single bound image map
*/

(function ($) {
Expand Down Expand Up @@ -770,7 +770,7 @@
me.wrapper = wrap;

// me.images[1] is the copy of the original image. It should be loaded & at its native size now so we can obtain the true
// width & height. This is needed to scale the imagemap if not being shown at its native size. It is also needed purely
// width & height. This is needed to scale the image map if not being shown at its native size. It is also needed purely
// to finish binding in case the original image was not visible. It can be impossible in some browsers to obtain the
// native size of a hidden image.

Expand Down
4 changes: 2 additions & 2 deletions src/mapimage.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
/*
mapimage.js
The MapImage object, repesents an instance of a single bound imagemap
The MapImage object, repesents an instance of a single bound image map
*/

(function ($) {
Expand Down
4 changes: 2 additions & 2 deletions tests/migrated.tests.js
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ this.tests.push(
'test',
"typeof m !== 'undefined' && m.map_cache && m.map_cache.length"
),
'Only imagemap bound images were obtained on generic create'
'Only image map bound images were obtained on generic create'
);

map = $('img,div').mapster({
Expand All @@ -85,7 +85,7 @@ this.tests.push(
'test',
"typeof m !== 'undefined' && m.map_cache && m.map_cache.length"
),
'Only imagemap bound images were obtained on generic create with other elements'
'Only image map bound images were obtained on generic create with other elements'
);

getPromise('stage2').resolve();
Expand Down
2 changes: 1 addition & 1 deletion tests/tooltip.tests.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ this.tests = this.tests || [];
this.tests.push(
iqtest
.create('tooltips', 'tests for imagemapster tooltips')
.add('Imagemap tooltips', function (a) {
.add('Image map tooltips', function (a) {
'use strict';

var me = this,
Expand Down

0 comments on commit 1c98300

Please sign in to comment.