feat: don't show overlay if another is already visible at the same range

Author: Andreas Gerlach

lib/datatip-manager.js

@@ -308,15 +308,14 @@ module.exports = class DatatipManager {
               return `<pre><code class="${editor.getGrammar().name.toLowerCase()}">${snippet}</code></pre>`;
             }).join('\r\n');
 
-            const requestToken = `${position.row}:${position.column}`;
-            this.renderer.render(requestToken, s).then(({ token, html }) => {
+            this.renderer.render(s).then((html) => {
               if (this.currentMarkerRange.containsPoint(position)) {    // make sure we are still on the same position
                 this.unmountDataTip();
                 dataTipView = new DataTipView({ htmlView: html });
                 this.dataTipMarkerDisposables = this.mountDataTipWithMarker(editor, result.range, position, dataTipView);
               }
-            }).catch(({ token, error }) => {
-              console.error(error);
+            }).catch((err) => {
+              console.error(err);
             });
           }
         });
@@ -349,6 +348,19 @@ module.exports = class DatatipManager {
       invalidate: 'never',
     });
 
+    // if there is an overlay already on the same position, skip showing the data tip 
+    const decorations = editor.getOverlayDecorations({
+      type: 'overlay'
+    }).filter((decoration) => {
+      const decorationMarker = decoration.getMarker();
+      if (decorationMarker.compare(highlightMarker) == 1) {
+        return decoration;
+      }
+      return null;
+    });
+
+    if (decorations.length > 0) return this.dataTipMarkerDisposables;
+
     const marker = editor.decorateMarker(overlayMarker, {
       type: 'overlay',
       class: 'datatip-overlay',

lib/provider-registry.js

@@ -1,6 +1,3 @@
-// @ts-check
-/// <reference path="../typings/atom-ide.d.ts"/>
-/// <reference path="../typings/atom.d.ts" />
 'use babel';
 
 const { CompositeDisposable, Disposable } = require('atom');

styles/atom-ide-datatips-marked.less

@@ -9,8 +9,8 @@
   color: @syntax-text-color;
   font-family: var(--editor-font-family);
   font-size: var(--editor-font-size);
-  max-width: 800px;
-  max-height: 400px;
+  max-height: 24em;
+  max-width: 64em;
   overflow: auto;
   white-space: normal;
 

styles/atom-ide-datatips.less

@@ -10,8 +10,8 @@
   position: relative;
   white-space: normal;
   pointer-events: all;
-  max-width: 800px;
-  max-height: 400px;
+  max-height: 24em;
+  max-width: 64em;
   overflow: none;
 
   p {
@@ -23,7 +23,7 @@
 }
 
 .datatip-overlay {
-  z-index: 12 !important; // HACK: exceed the z-index of
+  z-index: 4 !important; // HACK: exceed the z-index of
                           // .atom-dock-resize-handle-resizable, so that
                           // mouseleaves aren't triggered when the cursor enters
                           // the resizable
@@ -33,8 +33,8 @@
   background-color: @syntax-background-color;
   display: flex;
   position: relative;
-  max-width: 800px;
-  max-height: 400px;
+  max-height: 24em;
+  max-width: 64em;
   transition: background-color 0.15s ease;
   padding: 8px;
   white-space: pre-wrap;