svgmap 2.19.3 → 2.20.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "svgmap",
   "description": "svgMap is a JavaScript library that lets you easily create an interactable world map comparing customizable data for each country.",
-  "version": "2.19.3",
+  "version": "2.20.0",
   "type": "module",
   "license": "MIT",
   "keywords": [
@@ -47,8 +47,8 @@
     "@rollup/plugin-node-resolve": "^16.0.3",
     "@rollup/plugin-terser": "^1.0.0",
     "csso": "^5.0.5",
-    "rollup": "^4.60.1",
+    "rollup": "^4.60.2",
     "rollup-plugin-postcss": "^4.0.2",
-    "sass": "^1.98.0"
+    "sass": "^1.99.0"
   }
 }

package/src/js/core/svg-map.js

@@ -70,6 +70,15 @@ export default class svgMap {
       // Set to true to open the link on mobile devices, set to false (default) to show the tooltip
       touchLink: false,
 
+      // When false, disables hover/touch-following tooltips (not the on-map persistent labels; see persistentTooltips)
+      showTooltips: true,
+
+      // 'hover' (default): mouse shows tooltip on enter. 'click': mouse opens tooltip on click; touch/pen unchanged.
+      tooltipTrigger: 'hover',
+
+      // Persistent on-map tooltips: an array of country IDs, or a function (countryID, countryValues) => boolean
+      persistentTooltips: false,
+
       // Set to true to show the to show a zoom reset button
       showZoomReset: false,
 
@@ -78,6 +87,10 @@ export default class svgMap {
         return null;
       },
 
+      // Called on country click (pointer released without dragging). Receives
+      // (countryID, event). Return false to skip opening data.values[*].link.
+      onCountryClick: null,
+
       // Country specific options
       countries: {
         // Western Sahara: Set to false to combine Morocco (MA) and Western Sahara (EH)
@@ -117,6 +130,9 @@ export default class svgMap {
     // Wrapper element
     this.wrapper = document.getElementById(this.options.targetElementID);
     this.wrapper.classList.add('svgMap-wrapper');
+    if (typeof this.options.onCountryClick === 'function') {
+      this.wrapper.classList.add('svgMap-country-click-callback');
+    }
 
     // Container element
     this.container = document.createElement('div');
@@ -808,7 +824,9 @@ export default class svgMap {
 
   createMap() {
     // Create the tooltip
-    this.createTooltip();
+    if (this.options.showTooltips) {
+      this.createTooltip();
+    }
 
     // Create map wrappers
     this.mapWrapper = this.createElement(
@@ -934,6 +952,7 @@ export default class svgMap {
     }.bind(this);
 
     // Add map elements
+    var countryElements = [];
     Object.keys(mapPaths).forEach(
       function (countryID) {
         var countryData = this.mapPaths[countryID];
@@ -955,6 +974,7 @@ export default class svgMap {
         countryElement.classList.add('svgMap-country');
 
         this.mapImage.appendChild(countryElement);
+        countryElements.push(countryElement);
 
         // Add tooltip when touch is used
         function handlePointerMove(e) {
@@ -970,7 +990,7 @@ export default class svgMap {
             this.hideTooltip();
             document
               .querySelectorAll('.svgMap-active')
-              .forEach(el => el.classList.remove('svgMap-active'));
+              .forEach((el) => el.classList.remove('svgMap-active'));
           }
         }
 
@@ -979,29 +999,40 @@ export default class svgMap {
         countryElement.addEventListener(
           'pointerenter',
           function (e) {
+            if (
+              e.pointerType === 'mouse' &&
+              this.options.showTooltips &&
+              this.options.tooltipTrigger === 'click'
+            ) {
+              return;
+            }
+
             // Only add pointermove listener for non-touch pointers
             if (e.pointerType !== 'touch') {
-              document.addEventListener(
-                'pointermove',
-                handlePointerMoveBound,
-                { passive: true }
-              );
+              document.addEventListener('pointermove', handlePointerMoveBound, {
+                passive: true
+              });
             }
 
             document
               .querySelectorAll('.svgMap-active')
-              .forEach(el => el.classList.remove('svgMap-active'));
+              .forEach((el) => el.classList.remove('svgMap-active'));
 
-            countryElement.parentNode.appendChild(countryElement);
+            countryElement.parentNode.insertBefore(
+              countryElement,
+              this.persistentTooltipGroup || null
+            );
             countryElement.classList.add('svgMap-active');
 
             const countryID = countryElement.getAttribute('data-id');
-            this.setTooltipContent(this.getTooltipContent(countryID));
-            this.showTooltip(e);
+            if (this.options.showTooltips) {
+              this.setTooltipContent(this.getTooltipContent(countryID));
+              this.showTooltip(e);
 
-            // For touch, move tooltip to the touch position and keep it there
-            if (e.pointerType === 'touch') {
-              this.moveTooltip(e);
+              // For touch, move tooltip to the touch position and keep it there
+              if (e.pointerType === 'touch') {
+                this.moveTooltip(e);
+              }
             }
           }.bind(this)
         );
@@ -1020,7 +1051,10 @@ export default class svgMap {
           'touchend',
           function (e) {
             const touch = e.changedTouches[0];
-            const elementAtEnd = document.elementFromPoint(touch.clientX, touch.clientY);
+            const elementAtEnd = document.elementFromPoint(
+              touch.clientX,
+              touch.clientY
+            );
 
             // Only hide if touch ended outside the country or tooltip
             if (
@@ -1031,7 +1065,7 @@ export default class svgMap {
               this.hideTooltip();
               document
                 .querySelectorAll('.svgMap-active')
-                .forEach(el => el.classList.remove('svgMap-active'));
+                .forEach((el) => el.classList.remove('svgMap-active'));
             }
           }.bind(this),
           { passive: true }
@@ -1042,11 +1076,22 @@ export default class svgMap {
           'pointerleave',
           function (e) {
             if (e.pointerType !== 'touch') {
-              document.removeEventListener('pointermove', handlePointerMoveBound);
-              this.hideTooltip();
-              document
-                .querySelectorAll('.svgMap-active')
-                .forEach(el => el.classList.remove('svgMap-active'));
+              document.removeEventListener(
+                'pointermove',
+                handlePointerMoveBound
+              );
+              if (
+                !(
+                  e.pointerType === 'mouse' &&
+                  this.options.showTooltips &&
+                  this.options.tooltipTrigger === 'click'
+                )
+              ) {
+                this.hideTooltip();
+                document
+                  .querySelectorAll('.svgMap-active')
+                  .forEach((el) => el.classList.remove('svgMap-active'));
+              }
             }
           }.bind(this)
         );
@@ -1066,7 +1111,7 @@ export default class svgMap {
             this.hideTooltip();
             document
               .querySelectorAll('.svgMap-active')
-              .forEach(el => el.classList.remove('svgMap-active'));
+              .forEach((el) => el.classList.remove('svgMap-active'));
           }.bind(this),
           { passive: true }
         );
@@ -1090,17 +1135,29 @@ export default class svgMap {
       }.bind(this)
     );
 
+    var persistent = this.options.persistentTooltips;
+    if (
+      persistent &&
+      (Array.isArray(persistent) || typeof persistent === 'function')
+    ) {
+      this.createPersistentTooltips(countryElements);
+    }
+
     let pointerStart = null;
     let activeCountry = null;
 
-    this.mapImage.addEventListener('pointerdown', e => {
-      // Ignore right click (on desktop it allows inspecting the chart elements without opening the URL)
-      if (e.button !== 0) return;
+    this.mapImage.addEventListener(
+      'pointerdown',
+      (e) => {
+        // Ignore right click (on desktop it allows inspecting the chart elements without opening the URL)
+        if (e.button !== 0) return;
 
-      pointerStart = { x: e.clientX, y: e.clientY };
-    }, { passive: true });
+        pointerStart = { x: e.clientX, y: e.clientY };
+      },
+      { passive: true }
+    );
 
-    this.mapImage.addEventListener('pointerup', e => {
+    this.mapImage.addEventListener('pointerup', (e) => {
       // Ignore right click (on desktop it allows inspecting the chart elements without opening the URL)
       if (e.button !== 0) return;
 
@@ -1120,31 +1177,137 @@ export default class svgMap {
 
       const countryID = countryElement.getAttribute('data-id');
       const link = countryElement.getAttribute('data-link');
-      const target = countryElement.getAttribute('data-link-target');
-      if (!link) return;
-
+      const linkTarget = countryElement.getAttribute('data-link-target');
+      const hasCallback = typeof this.options.onCountryClick === 'function';
+      const hasLink = !!link;
       const isTouch = e.pointerType === 'touch' || e.pointerType === 'pen';
 
+      const isClickTooltipMouse =
+        e.pointerType === 'mouse' &&
+        this.options.showTooltips &&
+        this.options.tooltipTrigger === 'click';
+
+      if (!hasLink && !hasCallback && !isClickTooltipMouse) return;
+
+      if (isClickTooltipMouse && this.options.showTooltips) {
+        const willNavigate =
+          hasLink && countryElement.classList.contains('svgMap-active');
+        const shouldFireCallback = hasCallback && (!hasLink || willNavigate);
+
+        var callbackResultClick;
+        if (shouldFireCallback) {
+          callbackResultClick = this.options.onCountryClick(countryID, e);
+        }
+
+        if (hasLink) {
+          if (callbackResultClick === false) return;
+          if (countryElement.classList.contains('svgMap-active')) {
+            if (linkTarget) window.open(link, linkTarget);
+            else window.location.href = link;
+          } else {
+            this.mapImage
+              .querySelectorAll('.svgMap-country.svgMap-active')
+              .forEach((el) => el.classList.remove('svgMap-active'));
+            countryElement.parentNode.insertBefore(
+              countryElement,
+              this.persistentTooltipGroup || null
+            );
+            countryElement.classList.add('svgMap-active');
+            this.setTooltipContent(this.getTooltipContent(countryID));
+            this.showTooltip(e);
+          }
+          return;
+        }
+
+        if (callbackResultClick === false) return;
+
+        this.mapImage
+          .querySelectorAll('.svgMap-country.svgMap-active')
+          .forEach((el) => el.classList.remove('svgMap-active'));
+        countryElement.parentNode.insertBefore(
+          countryElement,
+          this.persistentTooltipGroup || null
+        );
+        countryElement.classList.add('svgMap-active');
+        this.setTooltipContent(this.getTooltipContent(countryID));
+        this.showTooltip(e);
+        return;
+      }
+
+      const willNavigate =
+        hasLink &&
+        (!isTouch || countryElement.classList.contains('svgMap-active'));
+
+      const shouldFireCallback =
+        hasCallback && (!hasLink || !isTouch || willNavigate);
+
+      var callbackResult;
+      if (shouldFireCallback) {
+        callbackResult = this.options.onCountryClick(countryID, e);
+      }
+
+      if (!hasLink) return;
+
+      if (callbackResult === false) return;
+
       if (isTouch) {
         // Touch: only open if already active
         if (countryElement.classList.contains('svgMap-active')) {
-          if (target) window.open(link, target);
+          if (linkTarget) window.open(link, linkTarget);
           else window.location.href = link;
         } else {
-          // first tap shows tooltip
+          // first tap shows tooltip (or opens link immediately if tooltips are off)
           if (activeCountry) activeCountry.classList.remove('svgMap-active');
           activeCountry = countryElement;
           countryElement.classList.add('svgMap-active');
-          this.setTooltipContent(this.getTooltipContent(countryID));
-          this.showTooltip(e);
+          if (this.options.showTooltips) {
+            this.setTooltipContent(this.getTooltipContent(countryID));
+            this.showTooltip(e);
+          } else {
+            if (linkTarget) window.open(link, linkTarget);
+            else window.location.href = link;
+          }
         }
       } else {
         // Desktop: open immediately
-        if (target) window.open(link, target);
+        if (linkTarget) window.open(link, linkTarget);
         else window.location.href = link;
       }
     });
 
+    this._clickTooltipOutsideHandler = function (ev) {
+      if (ev.pointerType !== 'mouse') return;
+      if (
+        !this.options.showTooltips ||
+        this.options.tooltipTrigger !== 'click' ||
+        !this.tooltip
+      ) {
+        return;
+      }
+      if (!this.tooltip.classList.contains('svgMap-active')) return;
+      var node = ev.target;
+      if (
+        node &&
+        node.closest &&
+        (node.closest('.svgMap-country') || node.closest('.svgMap-tooltip'))
+      ) {
+        return;
+      }
+      this.hideTooltip();
+      if (this.mapImage) {
+        this.mapImage
+          .querySelectorAll('.svgMap-country.svgMap-active')
+          .forEach(function (el) {
+            el.classList.remove('svgMap-active');
+          });
+      }
+    }.bind(this);
+    document.addEventListener(
+      'pointerdown',
+      this._clickTooltipOutsideHandler,
+      true
+    );
+
     // Expose instance
     var me = this;
 
@@ -1210,13 +1373,82 @@ export default class svgMap {
     }
   }
 
+  // Create the persistent tooltips
+
+  createPersistentTooltips(countryElements) {
+    if (this.persistentTooltipGroup) {
+      this.persistentTooltipGroup.remove();
+    }
+
+    this.persistentTooltipGroup = document.createElementNS(
+      'http://www.w3.org/2000/svg',
+      'g'
+    );
+    this.persistentTooltipGroup.classList.add('svgMap-persistent-tooltips');
+    this.mapImage.appendChild(this.persistentTooltipGroup);
+
+    countryElements.forEach(
+      function (countryElement) {
+        var countryID = countryElement.getAttribute('data-id');
+        if (!this.shouldShowTooltipOnLoad(countryID)) {
+          return;
+        }
+
+        var boundingBox = countryElement.getBBox();
+        var tooltipPosition = {
+          x: boundingBox.x + boundingBox.width / 2,
+          y: boundingBox.y + boundingBox.height / 2
+        };
+
+        var tooltipObject = document.createElementNS(
+          'http://www.w3.org/2000/svg',
+          'foreignObject'
+        );
+        tooltipObject.setAttribute('x', tooltipPosition.x);
+        tooltipObject.setAttribute('y', tooltipPosition.y);
+        tooltipObject.setAttribute('width', 1);
+        tooltipObject.setAttribute('height', 1);
+        tooltipObject.classList.add('svgMap-persistent-tooltip-wrapper');
+
+        var tooltipElement = this.createElement(
+          'div',
+          'svgMap-persistent-tooltip',
+          tooltipObject
+        );
+        tooltipElement.append(
+          this.getTooltipContent(countryID, tooltipElement)
+        );
+        this.createElement('div', 'svgMap-tooltip-pointer', tooltipElement);
+
+        this.persistentTooltipGroup.appendChild(tooltipObject);
+      }.bind(this)
+    );
+  }
+
+  // Check if a persistent tooltip should be shown on load
+
+  shouldShowTooltipOnLoad(countryID) {
+    var persistent = this.options.persistentTooltips;
+    var countryValues = this.options.data.values[countryID];
+
+    if (Array.isArray(persistent)) {
+      return persistent.indexOf(countryID) !== -1;
+    }
+
+    if (typeof persistent === 'function') {
+      return persistent(countryID, countryValues);
+    }
+
+    return false;
+  }
+
   // Create the tooltip content
 
-  getTooltipContent(countryID) {
+  getTooltipContent(countryID, tooltipDiv = this.tooltip) {
     // Custom tooltip
     if (this.options.onGetTooltip) {
       var customDiv = this.options.onGetTooltip(
-        this.tooltip,
+        tooltipDiv,
         countryID,
         this.options.data.values[countryID]
       );
@@ -2198,6 +2430,9 @@ export default class svgMap {
   // Show the tooltip
 
   showTooltip(e) {
+    if (!this.tooltip) {
+      return;
+    }
     this.tooltip.classList.add('svgMap-active');
     this.moveTooltip(e);
   }
@@ -2205,12 +2440,18 @@ export default class svgMap {
   // Hide the tooltip
 
   hideTooltip() {
+    if (!this.tooltip) {
+      return;
+    }
     this.tooltip.classList.remove('svgMap-active');
   }
 
   // Move the tooltip
 
   moveTooltip(e) {
+    if (!this.tooltip) {
+      return;
+    }
     var x = e.pageX || (e.touches && e.touches[0] ? e.touches[0].pageX : null);
     var y = e.pageY || (e.touches && e.touches[0] ? e.touches[0].pageY : null);
 

package/src/scss/map.scss

@@ -255,3 +255,7 @@
     }
   }
 }
+
+.svgMap-wrapper.svgMap-country-click-callback .svgMap-map-wrapper .svgMap-country {
+  cursor: pointer;
+}

package/src/scss/tooltip.scss

@@ -1,6 +1,7 @@
 @use 'variables' as *;
 
-.svgMap-tooltip {
+.svgMap-tooltip,
+.svgMap-persistent-tooltip {
   box-shadow: 0 0 3px $mapTooltipBoxShadowColor;
   position: absolute;
   z-index: 2;
@@ -8,7 +9,6 @@
   background: $mapTooltipBackgroundColor;
   transform: translate(-50%, -100%);
   border-bottom: 1px solid $mapTooltipColor;
-  display: none;
   pointer-events: none;
   min-width: 60px;
 
@@ -18,10 +18,6 @@
     border-top: 1px solid $mapTooltipColor;
   }
 
-  &.svgMap-active {
-    display: block;
-  }
-
   .svgMap-tooltip-content-container {
     position: relative;
     padding: 10px 20px;
@@ -126,3 +122,27 @@
     }
   }
 }
+
+.svgMap-tooltip {
+  display: none;
+
+  &.svgMap-active {
+    display: block;
+  }
+}
+
+.svgMap-persistent-tooltips,
+.svgMap-persistent-tooltip-wrapper {
+  pointer-events: none;
+}
+
+.svgMap-persistent-tooltip-wrapper {
+  overflow: visible;
+}
+
+.svgMap-persistent-tooltip {
+  display: block;
+  left: 0;
+  top: 0;
+  width: max-content;
+}