Fine-tune markup drawing

This adjusts markup color slightly for the dark display, makes it fully
opaque, alternates the squiggly line between grammar and spelling
mistakes to visualize one-word-two-mistake-types, paints most important
mistakes last/on top etc.

All to make the markup as visible as possible.

Readme.md

@@ -91,8 +91,8 @@ Kategorije pravopisnih pravil so:
 
 Privzeto servis uporablja podčrtovanje pravopisnih napak (nastavitev `'underline'`). Videz lahko spreminjamo.
 
-<img src="samples/markup_underline.png" alt="underline" width="448"/>
+<img src="samples/images/markup_underline.png" alt="underline" width="448"/>
-<img src="samples/markup_lector.png" alt="lector" width="448"/>
+<img src="samples/images/markup_lector.png" alt="lector" width="448"/>
 
 Levo `'underline'`, desno `'lector'`.
 

samples/styles.css

@@ -1,3 +1,14 @@
+body {
+  color: #000;
+  background-color: #eee;
+}
+
+input, textarea {
+  color: #000;
+  background-color: #f5f5f5;
+  box-shadow: 0 0 10px rgba(0, 0, 0, 0.1);
+}
+
 .my-block {
   max-width: 500px;
   margin: 0 auto;
@@ -13,7 +24,6 @@
   border-radius: 10px;
   background-color: #f5f5f5;
   box-shadow: 0 0 10px rgba(0, 0, 0, 0.1);
-  line-height: 20px;
 }
 
 .ck-editor__editable {
@@ -52,3 +62,22 @@
 .bes-status-icon.bes-status-mistakes {
   background-image: url('images/mistake-svgrepo-com.svg');
 }
+
+@media (prefers-color-scheme: dark) {
+  body {
+    color: #eee;
+    background-color: #444;
+    font-weight: bolder;
+  }
+
+  input, textarea {
+    color: #eee;
+    background-color: #222;
+    box-shadow: 0 0 10px rgba(0, 0, 0, 0.5);
+  }
+
+  .my-control {
+    background-color: #222;
+    box-shadow: 0 0 10px rgba(0, 0, 0, 0.5);
+  }
+}

service.js

@@ -1,4 +1,5 @@
 // TODO: Research if there is a way to disable languageTool & Grammarly extensions in CKEditor
+// TODO: Add mutation observer should any style of hostElement/textElement change and repaint markup (e.g. notice font-weight difference when toggling light/dark color-scheme)
 
 /**
  * Collection of all grammar checking services in the document
@@ -59,7 +60,6 @@ class BesService {
     this.hostElement.setAttribute('data-gramm', 'false')
     this.hostElement.setAttribute('data-gramm_editor', 'false')
     this.hostElement.setAttribute('data-enable-grammarly', 'false')
-    this.textFont = window.getComputedStyle(this.hostElement).fontFamily
 
     this.onScroll = this.onScroll.bind(this)
     this.hostElement.addEventListener('scroll', this.onScroll)
@@ -371,13 +371,19 @@ class BesService {
     if (match.highlights.length === 0) return
     const dpr = window.devicePixelRatio
     this.ctx.lineWidth = 2 * dpr // Use 2 for clearer visibility
+    let amplitude = 0
     const ruleId = match.match.rule.id
-    this.ctx.strokeStyle = ruleId.startsWith('MORFOLOGIK_RULE')
+    if (ruleId.startsWith('MORFOLOGIK_RULE')) {
-      ? 'rgba(0, 123, 255, 0.8)'
+      const styles = window.getComputedStyle(this.highlightSpelling)
-      : 'rgba(255, 115, 0, 0.8)'
+      this.ctx.strokeStyle = styles.color
-    this.ctx.fillStyle = ruleId.startsWith('MORFOLOGIK_RULE')
+      this.ctx.fillStyle = styles.color
-      ? 'rgba(0, 123, 255, 0.8)'
+      amplitude = -1
-      : 'rgba(255, 115, 0, 0.8)'
+    } else {
+      const styles = window.getComputedStyle(this.highlightGrammar)
+      this.ctx.strokeStyle = styles.color
+      this.ctx.fillStyle = styles.color
+      amplitude = 1
+    }
     let markerY1, markerY2
     switch (this.markupStyle) {
       case 'lector':
@@ -681,7 +687,7 @@ class BesService {
           const x2 = rect.right
           const y = rect.bottom
           const scale = (rect.bottom - rect.top) / 18
-          this.drawAttentionRequired(x1, x2, y, scale)
+          this.drawAttentionRequired(x1, x2, y, amplitude, scale)
         }
 
         markerY1 = Math.min(...match.highlights.map(rect => rect.top))
@@ -723,7 +729,7 @@ class BesService {
     this.ctx.stroke()
 
     if (comment) {
-      this.ctx.font = `${12 * scale * dpr}px ${this.textFont}`
+      this.setCtxFont(scale, dpr)
       this.ctx.textAlign = 'center'
       this.ctx.textBaseline = 'bottom'
       this.ctx.fillText('?', (x + 2 * scale) * dpr, (y - 6 * scale) * dpr)
@@ -807,7 +813,7 @@ class BesService {
     this.ctx.lineTo(x2 * dpr, (y2 + 6 * scale) * dpr)
     this.ctx.stroke()
 
-    this.ctx.font = `${12 * scale * dpr}px ${this.textFont}`
+    this.setCtxFont(scale, dpr)
     this.ctx.textAlign = 'left' // Thou we want the text to be centered, we align it manually to prevent it getting off canvas.
     this.ctx.textBaseline = 'bottom'
     const textMetrics = this.ctx.measureText(text)
@@ -842,7 +848,7 @@ class BesService {
     this.ctx.lineTo(x * dpr, (y2 + 6 * scale) * dpr)
     this.ctx.stroke()
 
-    this.ctx.font = `${12 * scale * dpr}px ${this.textFont}`
+    this.setCtxFont(scale, dpr)
     this.ctx.textAlign = 'left' // Thou we want the text to be centered, we align it manually to prevent it getting off canvas.
     this.ctx.textBaseline = 'bottom'
     const textMetrics = this.ctx.measureText(text)
@@ -865,21 +871,35 @@ class BesService {
    * @param {Number} x1 Sign left [px]
    * @param {Number} x2 Sign right [px]
    * @param {Number} y Sign baseline [px]
+   * @param {Number} amplitude Sign amplitude [px]
    * @param {Number} scale Sign scale
    */
-  drawAttentionRequired(x1, x2, y, scale) {
+  drawAttentionRequired(x1, x2, y, amplitude, scale) {
     const dpr = window.devicePixelRatio
     this.ctx.beginPath()
-    this.ctx.moveTo(x1 * dpr, (y - scale) * dpr)
+    this.ctx.moveTo(x1 * dpr, (y - amplitude * scale) * dpr)
     for (let x = x1; ; ) {
       if (x >= x2) break
-      this.ctx.lineTo((x += 2 * scale) * dpr, (y + scale) * dpr)
+      this.ctx.lineTo((x += 2 * scale) * dpr, (y + amplitude * scale) * dpr)
       if (x >= x2) break
-      this.ctx.lineTo((x += 2 * scale) * dpr, (y - scale) * dpr)
+      this.ctx.lineTo((x += 2 * scale) * dpr, (y - amplitude * scale) * dpr)
     }
     this.ctx.stroke()
   }
 
+  /**
+   * Sets markup font
+   *
+   * @param {Number} scale Sign scale
+   * @param {Number} dpr Device pixel ratio
+   */
+  setCtxFont(scale, dpr) {
+    const styles = window.getComputedStyle(this.canvasPanel)
+    this.ctx.font = `${styles.fontStyle} ${styles.fontWeight} ${
+      14 * scale * dpr
+    }px ${styles.fontFamily}`
+  }
+
   /**
    * Calculates rectangles covering a given range and compensates for scroll offset
    *
@@ -932,10 +952,16 @@ class BesService {
    * @param {Number} x X coordinate
    * @param {Number} y Y coordinate
    * @param {DOMRect} rect Rectangle
+   * @param {Number} tolerance Extra margin around the rectangle treated as "inside"
    * @returns
    */
-  static isPointInRect(x, y, rect) {
+  static isPointInRect(x, y, rect, tolerance) {
-    return rect.left <= x && x < rect.right && rect.top <= y && y < rect.bottom
+    return (
+      rect.left - tolerance <= x &&
+      x < rect.right + tolerance &&
+      rect.top - tolerance <= y &&
+      y < rect.bottom + tolerance
+    )
   }
 
   /**
@@ -953,7 +979,16 @@ class BesService {
     this.ctx = this.canvasPanel.getContext('2d')
     this.ctx.scale(1, 1)
 
+    this.highlightSpelling = document.createElement('div')
+    this.highlightSpelling.classList.add('bes-highlight-placeholder')
+    this.highlightSpelling.classList.add('bes-highlight-spelling')
+    this.highlightGrammar = document.createElement('div')
+    this.highlightGrammar.classList.add('bes-highlight-placeholder')
+    this.highlightGrammar.classList.add('bes-highlight-grammar')
+
     this.correctionPanel.appendChild(this.scrollPanel)
+    this.correctionPanel.appendChild(this.highlightSpelling)
+    this.correctionPanel.appendChild(this.highlightGrammar)
     this.scrollPanel.appendChild(this.canvasPanel)
     this.textElement.parentElement.insertBefore(
       this.correctionPanel,
@@ -999,8 +1034,6 @@ class BesService {
       this.scrollPanel.style.height = `${hostRect.height}px`
     }
 
-    this.textFont = styles.fontFamily
-
     // Resize canvas if needed.
     this.canvasPanel.style.width = `${this.hostElement.scrollWidth}px`
     this.canvasPanel.style.height = `${this.hostElement.scrollHeight}px`
@@ -1023,14 +1056,14 @@ class BesService {
   /**
    * Prepares and displays popup.
    *
-   * @param {*} elMatch Array containing block element/paragraph containing grammar checking rule match and a match
+   * @param {*} hits Array containing block element/paragraph containing grammar checking rule match and a match
    * @param {PointerEvent} source Click event source
    */
-  preparePopup(elMatch, source) {
+  preparePopup(hits, source) {
     this.dismissPopup()
     const popup = document.querySelector('bes-popup-el')
     BesPopup.clearReplacements()
-    elMatch.forEach(({ el, match }) => {
+    hits.forEach(({ el, match }) => {
       popup.setContent(el, match, this, this.isContentEditable())
       this.highlightMistake(match)
     })
@@ -1049,8 +1082,8 @@ class BesService {
       el.classList.add('bes-highlight-rect')
       el.classList.add(
         match.match.rule.id.startsWith('MORFOLOGIK_RULE')
-          ? 'bes-highlight-spelling-rect'
+          ? 'bes-highlight-spelling'
-          : 'bes-highlight-grammar-rect'
+          : 'bes-highlight-grammar'
       )
       el.style.left = `${rect.x + canvasPanelRect.x + window.scrollX}px`
       el.style.top = `${rect.y + canvasPanelRect.y + window.scrollY}px`
@@ -1090,7 +1123,9 @@ class BesService {
   redrawAllMistakeMarkup() {
     this.ctx.clearRect(0, 0, this.canvasPanel.width, this.canvasPanel.height)
     this.results.forEach(result => {
-      result.matches.forEach(match => this.drawMistakeMarkup(match))
+      // Most important matches are first, we want to draw them last => iterate in reverse.
+      for (let i = result.matches.length; i-- > 0; )
+        this.drawMistakeMarkup(result.matches[i])
     })
   }
 
@@ -1246,9 +1281,11 @@ class BesTreeService extends BesService {
                     ),
                     match: match
                   }
-                  this.drawMistakeMarkup(m)
                   matches.push(m)
                 })
+                // Most important matches are first, we want to draw them last => iterate in reverse.
+                for (let i = matches.length; i-- > 0; )
+                  this.drawMistakeMarkup(matches[i])
                 this.markProofed(node, matches)
                 this.onProofingProgress(matches.length)
               })
@@ -1504,19 +1541,19 @@ class BesTreeService extends BesService {
     const canvasPanelRect = this.canvasPanel.getBoundingClientRect()
     let x = source.clientX - canvasPanelRect.x
     let y = source.clientY - canvasPanelRect.y
-    const pointsInRect = []
+    const hits = []
     for (let result of this.results) {
       for (let m of result.matches) {
         for (let rect of m.highlights) {
-          if (BesService.isPointInRect(x, y, rect)) {
+          if (BesService.isPointInRect(x, y, rect, 5)) {
-            pointsInRect.push({ el, match: m })
+            hits.push({ el, match: m })
             break
           }
         }
       }
     }
     this.dismissPopup()
-    if (pointsInRect.length) this.preparePopup(pointsInRect, source)
+    if (hits.length) this.preparePopup(hits, source)
   }
 }
 
@@ -2035,9 +2072,11 @@ class BesPlainTextService extends BesService {
                 ),
                 match: match
               }
-              this.drawMistakeMarkup(m)
               matches.push(m)
             })
+            // Most important matches are first, we want to draw them last => iterate in reverse.
+            for (let i = matches.length; i-- > 0; )
+              this.drawMistakeMarkup(matches[i])
             this.markProofed(paragraphRange, matches)
             this.onProofingProgress(matches.length)
           })
@@ -2172,19 +2211,19 @@ class BesPlainTextService extends BesService {
     const canvasPanelRect = this.canvasPanel.getBoundingClientRect()
     let x = source.clientX - canvasPanelRect.x
     let y = source.clientY - canvasPanelRect.y
-    const pointsInRect = []
+    const hits = []
     for (let result of this.results) {
       for (let m of result.matches) {
         for (let rect of m.highlights) {
-          if (BesService.isPointInRect(x, y, rect)) {
+          if (BesService.isPointInRect(x, y, rect, 5)) {
-            pointsInRect.push({ el: result.range, match: m })
+            hits.push({ el: result.range, match: m })
             break
           }
         }
       }
     }
     this.dismissPopup()
-    if (pointsInRect.length) this.preparePopup(pointsInRect, source)
+    if (hits.length) this.preparePopup(hits, source)
   }
 
   /**
@@ -2457,11 +2496,13 @@ class BesTAService extends BesPlainTextService {
       parseFloat(styles.paddingRight) -
       parseFloat(styles.borderRightWidth)
     }px`
-    textElement.style.height = `${rect.height -
+    textElement.style.height = `${
+      rect.height -
       parseFloat(styles.borderTopWidth) -
       parseFloat(styles.paddingTop) -
       parseFloat(styles.paddingBottom) -
-      parseFloat(styles.borderBottomWidth)}px`
+      parseFloat(styles.borderBottomWidth)
+    }px`
   }
 
   /**

styles.css

@@ -1,25 +1,29 @@
-/* TODO: Dark mode theme */
-
 /* Mistake types styles */
-.bes-spelling-mistake {
-  border-bottom: 2px solid #ff7300;
-  position: absolute;
-  z-index: 3;
-  cursor: text;
-}
-
 .bes-highlight-rect {
   position: absolute;
-  opacity: 0.3;
   cursor: text;
 }
 
-.bes-highlight-spelling-rect {
+.bes-highlight-spelling {
-  background: rgb(0, 123, 255);
+  color: hsl(211, 100%, 60%);
+  background: hsla(211, 100%, 60%, 0.3);
 }
 
-.bes-highlight-grammar-rect {
+.bes-highlight-grammar {
-  background: rgb(255, 115, 0);
+  color: hsl(27, 100%, 45%);
+  background: hsla(27, 100%, 45%, 0.3);
+}
+
+@media (prefers-color-scheme: dark) {
+  .bes-highlight-spelling {
+    color: hsl(211, 100%, 55%);
+    background: hsla(211, 100%, 55%, 0.3);
+  }
+
+  .bes-highlight-grammar {
+    color: hsl(27, 100%, 65%);
+    background: hsla(27, 100%, 65%, 0.3);
+  }
 }
 
 /* Styles required to ensure full functionality and optimal user experience. */
@@ -56,3 +60,8 @@
   background: none;
   z-index: -1;
 }
+
+.bes-highlight-placeholder {
+  display: none;
+  visibility: hidden;
+}