├── README.md
├── examples
├── advanced_usage.html
├── basic_usage.html
├── css
│ ├── bootstrap.min.css
│ └── style.css
├── images
│ ├── sample-image.png
│ ├── sample-image1.jpg
│ └── sample-image2.jpg
└── js
│ └── jquery.min.js
├── jquery.hotspot.css
├── jquery.hotspot.js
└── package.json
/README.md:
--------------------------------------------------------------------------------
1 | jQuery - Hotspot
2 | ===
3 |
4 | A [jQuery](http://www.jquery.com) plugin for creating *Hotspots* in an HTML element. This plugin operates in two modes, `admin` and `display`. The **admin mode** enables user to create hotspots on desired HTML elements. The **display mode** is used for only displaying the hotspots to the end user. The design of the hotspot created are fully customizable. User can add their own CSS class to style the hotspots.
5 |
6 | ### [View Demo](http://aniruddhanath.github.io/jquery-hotspot/)
7 |
8 | Note: Ensures responsiveness with the latest update.
9 |
10 | The Setup
11 | ---------
12 |
13 | ```
14 | npm install jquery-hotspot
15 | ```
16 |
17 | Include `jquery.hotspot.js` at the bottom of the HTML page before the closing body tag. Wrap the HTML element for which the hotspot is to be obtained with another element. Also include the `jquery.hotspot.css` file to go with some of the default design decisions.
18 | ```
19 |
20 |
21 |
22 | ```
23 | The plugin instance will be called with `theElement`.
24 | > **Note:** The CSS property, *position* for this element should be kept as *relative*.
25 | ```
26 | #theElement {
27 | position: relative;
28 | }
29 | ```
30 |
31 |
32 | Usage - Display mode
33 | --------------------
34 |
35 | The data associated with the hotspots can be passed in directly to the plugin. The data can also be fetched from a backend server by enabling `ajax` option.
36 |
37 | There are three options given for hotspot-interactivity - hover, click and none.
38 | - **hover** : The data associated with the hotspot will show up on *hovering* over spot.
39 | - **click** : The data associated will show up on *clicking* the spot.
40 | - **none** : The data will be static and would not be affected by any events.
41 |
42 | ### Basic call with known coordinates:
43 | ```
44 | $('#theElement').hotspot({
45 | data: [
46 | { "x":18, "y":38, "Title":"The Title","Message":"Create the Message here" },
47 | { "x":43, "y":40, "Title":"jQuery Hotspot","Message":"This jQuery Plugin lets you create hotspot to any HTML element." }
48 | ],
49 | tag: 'img', //optional (default is img)
50 | interactivity: "hover", // options : click, none (default is hover)
51 | hotspotClass: 'Hotspot'
52 | });
53 | ```
54 | The `data` object above can be populated with any number of properties and can be designed with appropriate CSS. The `tag` variable passed to the plugin determines the type of HTML tag for which the hotspot is obtained. The `hotspotClass` is class of the hotspots created. One can change the look of the hotspot by applying some CSS to this class.
55 |
56 | By default in display mode, repositioning of hotspots on window resize is enabled. To disable this, a parameter can be passed in the plugin options.
57 | ```
58 | listenOnResize: false
59 | ```
60 |
61 | ### Fetching data via AJAX call
62 | ```
63 | $("#theElement").hotspot({
64 | ajax: true, // Switching on the ajax
65 | ajaxOptions: {
66 | url: '/hotspots',
67 | type: 'GET',
68 | ...
69 | },
70 | interactivity: "hover" // options : click, none (default is hover)
71 | });
72 | ```
73 | The data coming from the server-side is expected to be JSON encoded. The object `ajaxOptions` can be utilized to change the http headers, etc.
74 |
75 |
76 | Usage - Admin mode
77 | --------------------
78 | ### Standard call
79 | ```
80 | $("#theElement").hotspot({
81 | mode: "admin", // Switching to admin mode
82 | ajax: true, // Turn on ajax
83 | ajaxOptions: {
84 | url: '/hotspots',
85 | type: 'POST',
86 | ...
87 | },
88 | interactivity: "hover" // options : click, none (default is hover)
89 | });
90 | ```
91 | `ajax` and `ajaxOptions` are required here so that the hotspot that are being created in the admin mode get stored in the server. However if someone turn off the ajax, then the hotspots data gets stored in the browser's LocalStorage.
92 |
93 | Key Features
94 | ------------
95 |
96 | 1. Any number of *messages/nodes* can be stuffed in a single hotspot. To do so the `schema` parameter is passed to the plugin. By default there are two nodes (Title and Message)
97 |
98 | ```
99 | $("#theElement").hotspot({
100 | mode: "admin", // Switching to admin mode
101 | ajax: true, // Turn on ajax
102 | ajaxOptions: {
103 | url: '/hotspots',
104 | type: 'POST',
105 | ...
106 | },
107 | schema: [
108 | {
109 | 'property': 'Time',
110 | 'default': '5:40am'
111 | },
112 | {
113 | 'property': 'Date',
114 | 'default': '12/11/2018'
115 | },
116 | {
117 | 'property': 'Place',
118 | 'default': 'Siberia'
119 | },
120 | ]
121 | });
122 | ```
123 | The `default` property in the `schema` object above will be overwritten everytime a new hotspot is created.
124 |
125 | 2. The plugin also provides some basic functions that can be invoked after certain events in the process of creation of hotspots.
126 |
127 | ```
128 | $("#theElement").hotspot({
129 | mode: "admin", // Switching to admin mode
130 | ajax: true, // Turn on ajax
131 | ajaxOptions: {
132 | url: '/hotspots',
133 | type: 'POST',
134 | ...
135 | },
136 | afterSave: function(err, data) {
137 | // hotspots `data` in json format can be stored
138 | // & passed in `display` mode for the image
139 | },
140 | afterRemove: function(err, message) {
141 | // `message` from the plugin
142 | },
143 | afterSend: function(error, message) {
144 | // check if any `error` has occurred
145 | }
146 | });
147 | ```
148 | These functions can be utilized to keep track of the flow of hotspot creation.
149 |
150 | 3. The plugin can be used with any number of HTML elements in a page. However to do so, the `LS_Variable` passed to the plugin should be named uniquely for every instance. This helps plugin to avoid conflicts and while using HTML5 LocalStorage.
151 |
152 | HTML :
153 | ```
154 |
155 |
156 |
157 |
158 |
159 |
160 | ```
161 |
162 | JavaScript :
163 |
164 | ```
165 | $("#theElement-a").hotspot({
166 | mode: "admin",
167 | ...
168 | LS_Variable: "HotspotPlugin-a"
169 | });
170 |
171 | $("#theElement-b").hotspot({
172 | mode: "admin",
173 | ...
174 | LS_Variable: "HotspotPlugin-b"
175 | });
176 | ```
177 |
178 | For better clarity the examples folder can be checked
179 |
180 |
181 | Fetch data via AJAX Request
182 | ------------
183 |
184 | Include jquery and hotspot plugin in the html code.
185 |
186 | ```
187 |
195 | ```
196 |
197 | Also make sure `result` passed as `data` in the plugin should be an array of objects.
198 | ```
199 | [
200 | { "x":18, "y":29, "Title":"The Title","Message":"Create the Message here" },
201 | { "x":14, "y":40, "Title":"jQuery Hotspot","Message":"This jQuery Plugin lets you create hotspot to any HTML element." }
202 | ]
203 | ```
204 |
--------------------------------------------------------------------------------
/examples/advanced_usage.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | jQuery Hotspot | Advanced usage
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
21 | 
156 | 
159 | 
23 | 
29 | 
22 |