Compare commits

...

16 Commits

Author SHA1 Message Date
d3deb4cb11 Improve popup positioning based on rect's postion and not on click's X,Y coordiantes.
Closes #3
2025-06-11 10:01:40 +02:00
3cd86bf4c3 Fix scrollIntoView behavior and improve popup positioning #4 2025-06-09 11:48:15 +02:00
a04ffb3e70 Improve navigation and fix focus-visible colors in the popup #4 2025-06-05 09:44:52 +02:00
e4ba4dd3f1 Refactor findNextMistake method to be static and its calls #4 2025-06-05 08:54:56 +02:00
b99d233abc Prevent ctrl + enter shortuct when no grammar highlights are present #4 2025-06-05 08:17:19 +02:00
04cd5f2e7d Use scrollintoView after using shortcut navigation for finding a next/previous mistake #4 2025-06-05 08:11:42 +02:00
1163b3c47e Enhance shortcut navigation and add replacement acceptance logic for mistakes #4 2025-06-04 15:03:10 +02:00
e903917179 Add navigation buttons in popup #4 2025-06-04 13:18:30 +02:00
0f2fa218f3 Update popup positioning after using keyboard shortcut #4 2025-06-04 11:50:41 +02:00
99db143007 Add keyboard shortcut navigation for grammar mistakes
- Implements Ctrl+Š/Đ keyboard shortcuts to navigate between grammar mistakes/highlights. #4
2025-06-04 10:26:56 +02:00
c7c90101a2 Implement tab navigation for grammar mistakes
- The feature is still not fully finished yet.
- Navigation does not work in Quill, textarea and static-content examples.
- But it works well in CKEditor and contenteditable examples.

#4
2025-06-03 14:59:25 +02:00
Aljaž Grilc
b9ab9b6a64 Add double underline drawing for specific grammar rules 2025-05-28 21:01:43 +02:00
Aljaž Grilc
c67adcdc99 Adjust highlight color as requested by the company 2025-05-28 19:46:49 +02:00
be08136a31 Improve color of the popup close button #6 2025-05-21 09:14:06 +02:00
9bc8dfbdfc Display AI suggestions using different color 2025-04-24 14:46:23 +02:00
5cbac62de3 Fix BesQuillService when pasting a simple block of text 2025-04-16 09:27:20 +02:00
2 changed files with 293 additions and 26 deletions

View File

@@ -63,6 +63,8 @@ class BesService {
this.onScroll = this.onScroll.bind(this) this.onScroll = this.onScroll.bind(this)
this.hostElement.addEventListener('scroll', this.onScroll) this.hostElement.addEventListener('scroll', this.onScroll)
this.onShortcutNavigation = this.onShortcutNavigation.bind(this)
this.hostElement.addEventListener('keydown', this.onShortcutNavigation)
this.hostBoundingClientRect = this.hostElement.getBoundingClientRect() this.hostBoundingClientRect = this.hostElement.getBoundingClientRect()
this.mutationObserver = new MutationObserver(this.onBodyMutate.bind(this)) this.mutationObserver = new MutationObserver(this.onBodyMutate.bind(this))
@@ -109,6 +111,7 @@ class BesService {
if (this.abortController) this.abortController.abort() if (this.abortController) this.abortController.abort()
besServices = besServices.filter(item => item !== this) besServices = besServices.filter(item => item !== this)
this.mutationObserver.disconnect() this.mutationObserver.disconnect()
this.hostElement.removeEventListener('keydown', this.onShortcutNavigation)
this.hostElement.removeEventListener('scroll', this.onScroll) this.hostElement.removeEventListener('scroll', this.onScroll)
this.hostElement.setAttribute('spellcheck', this.originalSpellcheck) this.hostElement.setAttribute('spellcheck', this.originalSpellcheck)
this.hostElement.setAttribute('data-gramm', this.originalDataGramm) this.hostElement.setAttribute('data-gramm', this.originalDataGramm)
@@ -276,6 +279,9 @@ class BesService {
*/ */
onProofingProgress(numberOfMatches) { onProofingProgress(numberOfMatches) {
this.proofingMatches += numberOfMatches this.proofingMatches += numberOfMatches
// Sorting the array here is preferable to sorting only in onEndProofing.This way it allows users to interact
// with and navigate newly detected mistakes as soon as they appear.
this.sortMatchesArray()
if (this.eventSink && 'proofingProgress' in this.eventSink) if (this.eventSink && 'proofingProgress' in this.eventSink)
this.eventSink.proofingProgress(this) this.eventSink.proofingProgress(this)
if (--this.proofingCount <= 0) this.onEndProofing() if (--this.proofingCount <= 0) this.onEndProofing()
@@ -324,6 +330,46 @@ class BesService {
} }
} }
/**
* Called to report keydown event
*
* @param {Event} e
*/
onShortcutNavigation(e) {
switch (e.code) {
case 'BracketLeft':
if (e.ctrlKey) {
// Handle Ctrl + [ OR Ctrl + Š
e.preventDefault()
e.stopPropagation()
BesService.findNextMistake(this, -1)
}
break
case 'BracketRight':
if (e.ctrlKey) {
// Handle Ctrl + ] OR Ctrl + Đ
e.preventDefault()
e.stopPropagation()
BesService.findNextMistake(this, 1)
}
break
case 'Enter':
// Handle Ctrl + Enter
if (e.ctrlKey) {
if (!this.highlightElements.length) return
e.preventDefault()
e.stopPropagation()
this.acceptReplacement()
}
break
case 'Escape':
this.dismissPopup()
break
default:
break
}
}
/** /**
* Called to report repositioning * Called to report repositioning
*/ */
@@ -378,6 +424,11 @@ class BesService {
this.ctx.strokeStyle = styles.color this.ctx.strokeStyle = styles.color
this.ctx.fillStyle = styles.color this.ctx.fillStyle = styles.color
amplitude = -1 amplitude = -1
} else if (ruleId === 'BESANA_178' /*PR_VNAP_POPRAVEK_UI*/) {
const styles = window.getComputedStyle(this.highlightAI)
this.ctx.strokeStyle = styles.color
this.ctx.fillStyle = styles.color
amplitude = 1
} else { } else {
const styles = window.getComputedStyle(this.highlightGrammar) const styles = window.getComputedStyle(this.highlightGrammar)
this.ctx.strokeStyle = styles.color this.ctx.strokeStyle = styles.color
@@ -687,7 +738,9 @@ class BesService {
const x2 = rect.right const x2 = rect.right
const y = rect.bottom const y = rect.bottom
const scale = (rect.bottom - rect.top) / 18 const scale = (rect.bottom - rect.top) / 18
this.drawAttentionRequired(x1, x2, y, amplitude, scale) if (ruleId !== 'MORFOLOGIK_RULE') {
this.drawDoubleUnderline(x1, x2, y, scale)
} else this.drawAttentionRequired(x1, x2, y, amplitude, scale)
} }
markerY1 = Math.min(...match.highlights.map(rect => rect.top)) markerY1 = Math.min(...match.highlights.map(rect => rect.top))
@@ -887,6 +940,23 @@ class BesService {
this.ctx.stroke() this.ctx.stroke()
} }
/**
*
* @param {Number} x1 Sign left [px]
* @param {Number} x2 Sign right [px]
* @param {Number} y Sign baseline [px]
* @param {Number} scale Sign scale
*/
drawDoubleUnderline(x1, x2, y, scale) {
const dpr = window.devicePixelRatio
this.ctx.beginPath()
this.ctx.moveTo(x1 * dpr, (y - 2 * scale) * dpr)
this.ctx.lineTo(x2 * dpr, (y - 2 * scale) * dpr)
this.ctx.moveTo(x1 * dpr, (y + 1 * scale) * dpr)
this.ctx.lineTo(x2 * dpr, (y + 1 * scale) * dpr)
this.ctx.stroke()
}
/** /**
* Sets markup font * Sets markup font
* *
@@ -964,6 +1034,11 @@ class BesService {
) )
} }
static arrowBtnNavigation(value, service) {
const direction = value === 'forward' ? 1 : value === 'back' ? -1 : 0
BesService.findNextMistake(service, direction)
}
/** /**
* Creates auxiliary DOM elements for text adornments. * Creates auxiliary DOM elements for text adornments.
*/ */
@@ -982,12 +1057,16 @@ class BesService {
this.highlightSpelling = document.createElement('div') this.highlightSpelling = document.createElement('div')
this.highlightSpelling.classList.add('bes-highlight-placeholder') this.highlightSpelling.classList.add('bes-highlight-placeholder')
this.highlightSpelling.classList.add('bes-highlight-spelling') this.highlightSpelling.classList.add('bes-highlight-spelling')
this.highlightAI = document.createElement('div')
this.highlightAI.classList.add('bes-highlight-placeholder')
this.highlightAI.classList.add('bes-highlight-ai')
this.highlightGrammar = document.createElement('div') this.highlightGrammar = document.createElement('div')
this.highlightGrammar.classList.add('bes-highlight-placeholder') this.highlightGrammar.classList.add('bes-highlight-placeholder')
this.highlightGrammar.classList.add('bes-highlight-grammar') this.highlightGrammar.classList.add('bes-highlight-grammar')
this.correctionPanel.appendChild(this.scrollPanel) this.correctionPanel.appendChild(this.scrollPanel)
this.correctionPanel.appendChild(this.highlightSpelling) this.correctionPanel.appendChild(this.highlightSpelling)
this.correctionPanel.appendChild(this.highlightAI)
this.correctionPanel.appendChild(this.highlightGrammar) this.correctionPanel.appendChild(this.highlightGrammar)
this.scrollPanel.appendChild(this.canvasPanel) this.scrollPanel.appendChild(this.canvasPanel)
this.textElement.parentElement.insertBefore( this.textElement.parentElement.insertBefore(
@@ -1066,8 +1145,14 @@ class BesService {
hits.forEach(({ el, match }) => { hits.forEach(({ el, match }) => {
popup.setContent(el, match, this, this.isContentEditable()) popup.setContent(el, match, this, this.isContentEditable())
this.highlightMistake(match) this.highlightMistake(match)
const containerRect = this.hostElement.getBoundingClientRect()
match.highlights.forEach(rect => {
const clientX = rect.x + containerRect.left
const clientY =
rect.y + containerRect.top + rect.height - this.hostElement.scrollTop
popup.show(clientX, clientY, this)
})
}) })
popup.show(source.clientX, source.clientY)
} }
/** /**
@@ -1083,6 +1168,8 @@ class BesService {
el.classList.add( el.classList.add(
match.match.rule.id.startsWith('MORFOLOGIK_RULE') match.match.rule.id.startsWith('MORFOLOGIK_RULE')
? 'bes-highlight-spelling' ? 'bes-highlight-spelling'
: match.match.rule.id === 'BESANA_178' /*PR_VNAP_POPRAVEK_UI*/
? 'bes-highlight-ai'
: 'bes-highlight-grammar' : 'bes-highlight-grammar'
) )
el.style.left = `${rect.x + canvasPanelRect.x + window.scrollX}px` el.style.left = `${rect.x + canvasPanelRect.x + window.scrollX}px`
@@ -1090,19 +1177,113 @@ class BesService {
el.style.width = `${rect.width}px` el.style.width = `${rect.width}px`
el.style.height = `${rect.height}px` el.style.height = `${rect.height}px`
document.body.appendChild(el) document.body.appendChild(el)
this.highlightElements.push(el) const matchSorted =
this.sortedMatches.find(entry => entry.match === match) || null
this.highlightElements.push({ el, matchSorted })
}) })
} }
/**
* This function finds the next/previous mistake.
* @param {Number} direction Navigation direction: 1 for next, -1 for previous
* @returns
*/
static findNextMistake(service, direction = 1) {
if (!service || !service.sortedMatches || !service.sortedMatches.length)
return
const active = service.highlightElements.find(
({ matchSorted }) => matchSorted
)
let current = -1
if (active && active.matchSorted) {
current = service.sortedMatches.findIndex(
entry => entry.match === active.matchSorted.match
)
}
const len = service.sortedMatches.length
const next = (current + direction + len) % len
service.activeMatchIndex = next
const { el, match } = service.sortedMatches[next]
if (el && typeof el.scrollIntoView === 'function') {
el.scrollIntoView({ behavior: 'instant', block: 'center' })
}
// Not the cleanest solution to setTimeout()
setTimeout(() => {
service.dismissPopup()
const popup = document.querySelector('bes-popup-el')
BesPopup.clearReplacements()
popup.setContent(el, match, service, service.isContentEditable())
service.highlightMistake(match)
const containerRect = service.hostElement.getBoundingClientRect()
match.highlights.forEach(rect => {
const clientX = rect.x + containerRect.left
const clientY =
rect.y +
containerRect.top +
rect.height -
service.hostElement.scrollTop
popup.show(clientX, clientY, service)
})
}, 150)
}
/**
* Accepts the replacement for the current grammar mistake.
*/
acceptReplacement() {
const popup = document.querySelector('bes-popup-el')
const replacementDiv = popup.shadowRoot.querySelector(
'.bes-replacement-div'
)
const firstReplacement = replacementDiv?.firstChild
if (replacementDiv.childElementCount === 1) {
// Is this an ugly solution?
firstReplacement.click()
} else if (replacementDiv.childElementCount > 1) {
firstReplacement.focus()
} else BesService.findNextMistake(this, 1)
}
/** /**
* Clears highlight and hides popup * Clears highlight and hides popup
*/ */
dismissPopup() { dismissPopup() {
BesPopup.hide() BesPopup.hide()
this.highlightElements.forEach(el => el.remove()) this.highlightElements.forEach(obj => {
if (obj.el && typeof obj.el.remove === 'function') {
obj.el.remove()
}
})
this.highlightElements = [] this.highlightElements = []
} }
/**
* This function collects all matches from the results array, flattens them into a single array,
* and sorts them in order: first by their Y axis, then by X axis.
*/
sortMatchesArray() {
this.sortedMatches = []
this.results.forEach(element => {
element.matches.forEach(match => {
if (!match.highlights || !match.highlights.length) return
this.sortedMatches.push({
el: element.element,
match,
top: match.highlights[0].top
})
})
})
this.sortedMatches.sort((a, b) => {
if (a.top !== b.top) return a.top - b.top
const aLeft = a.match.highlights[0].left
const bLeft = b.match.highlights[0].left
return aLeft - bLeft
})
}
/** /**
* Checks if host element content is editable. * Checks if host element content is editable.
* *
@@ -1857,6 +2038,7 @@ class BesQuillService extends BesTreeService {
onChangeData(delta) { onChangeData(delta) {
let index = 0 let index = 0
let reproofNeeded = false let reproofNeeded = false
const affectedBlocks = new Set()
delta.ops.forEach(op => { delta.ops.forEach(op => {
if (op.retain) { if (op.retain) {
@@ -1866,11 +2048,12 @@ class BesQuillService extends BesTreeService {
} }
} else if (op.insert) { } else if (op.insert) {
reproofNeeded = true reproofNeeded = true
index += op.insert.length index += typeof op.insert === 'string' ? op.insert.length : 1 // Handle string or embed
} else if (op.delete) { } else if (op.delete) {
reproofNeeded = true reproofNeeded = true
} }
}) })
if (reproofNeeded) { if (reproofNeeded) {
const editorLength = this.quillInstance.getLength() const editorLength = this.quillInstance.getLength()
const clampedIndex = Math.min(index, editorLength - 1) const clampedIndex = Math.min(index, editorLength - 1)
@@ -1879,22 +2062,55 @@ class BesQuillService extends BesTreeService {
if (leaf) { if (leaf) {
let domElement = leaf.domNode let domElement = leaf.domNode
// Traverse up to find the block element
while (domElement && !this.isBlockElement(domElement)) { while (domElement && !this.isBlockElement(domElement)) {
domElement = domElement.parentNode domElement = domElement.parentNode
} }
if (domElement) {
this.clearProofing(domElement)
setTimeout(() => { if (domElement) affectedBlocks.add(domElement)
this.redrawAllMistakeMarkup()
this.scheduleProofing(1000)
}, 0)
}
} else { } else {
console.warn( console.warn(
'Leaf is null. The index might be out of bounds or the editor content is empty.' 'Leaf is null. The index might be out of bounds or the editor content is empty.'
) )
} }
// Handle pasted content spanning multiple blocks
const selection = this.quillInstance.getSelection()
if (selection) {
const [startLeaf] = this.quillInstance.getLeaf(selection.index)
const [endLeaf] = this.quillInstance.getLeaf(
selection.index + selection.length
)
if (startLeaf && endLeaf) {
let startElement = startLeaf.domNode
let endElement = endLeaf.domNode
while (startElement && !this.isBlockElement(startElement)) {
startElement = startElement.parentNode
}
while (endElement && !this.isBlockElement(endElement)) {
endElement = endElement.parentNode
}
if (startElement && endElement) {
let currentElement = startElement
while (currentElement) {
affectedBlocks.add(currentElement)
if (currentElement === endElement) break
currentElement = currentElement.nextElementSibling
}
}
}
}
// Clear proofing for all affected blocks
affectedBlocks.forEach(block => this.clearProofing(block))
// Schedule proofing for all affected blocks
setTimeout(() => {
this.scheduleProofing(1000)
}, 0)
} }
} }
@@ -2700,7 +2916,7 @@ class BesPopup extends HTMLElement {
padding: 3px 2px; padding: 3px 2px;
} }
.bes-toolbar button { .bes-toolbar button {
margin-right: 2px; margin-right: 0px;
} }
.bes-popup-title { .bes-popup-title {
color: #333; color: #333;
@@ -2725,6 +2941,12 @@ class BesPopup extends HTMLElement {
} }
.bes-replacement-btn:hover{ .bes-replacement-btn:hover{
background-color: #1976f0; background-color: #1976f0;
}
.bes-replacement-btn:focus{
outline: -webkit-focus-ring-color auto 1px;
}
.bes-replacement-btn:focus-visible{
outline: -webkit-focus-ring-color auto 1px;
} }
.bes-replacement-div{ .bes-replacement-div{
margin-top: 4px; margin-top: 4px;
@@ -2740,11 +2962,17 @@ class BesPopup extends HTMLElement {
.bes-close-btn svg { .bes-close-btn svg {
width: 100%; width: 100%;
height: 100%; height: 100%;
fill: #333;
} }
.bes-mistake-nav{
margin-right: 10px;
}
:host{
--bes-close-icon: #485362;
--hover-bg-clr: #dee3ed;
}
.bes-close-btn:hover { .bes-close-btn:hover {
background: #dee3ed; background: var(--hover-bg-clr);
border-radius: 8px border-radius: 4px
} }
:host(.show) .bes-popup-container { :host(.show) .bes-popup-container {
visibility: visible; visibility: visible;
@@ -2773,17 +3001,45 @@ class BesPopup extends HTMLElement {
background-color: #111213; background-color: #111213;
border: 1px solid #2e3036; border: 1px solid #2e3036;
} }
:host{
--bes-close-icon: #a4b5c7;
--hover-bg-clr:rgba(189, 189, 189, 0.28);
}
} }
</style> </style>
<div class="bes-popup-container"> <div class="bes-popup-container">
<div class="bes-toolbar"> <div class="bes-toolbar">
<div class="bes-popup-title">Besana</div> <div class="bes-popup-title">Besana</div>
<div class="bes-mistake-nav">
<button class="bes-close-btn" title="Prejšnja napaka">
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 24 24"><!-- Icon from Material Symbols by Google - https://github.com/google/material-design-icons/blob/master/LICENSE --><path fill="var(--bes-close-icon)" d="M11 20V7.825l-5.6 5.6L4 12l8-8l8 8l-1.4 1.425l-5.6-5.6V20z"/></svg>
</button>
<button class="bes-close-btn" title="Naslednja napaka">
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 24 24"><!-- Icon from Material Symbols by Google - https://github.com/google/material-design-icons/blob/master/LICENSE --><path fill="var(--bes-close-icon)" d="M11 4v12.175l-5.6-5.6L4 12l8 8l8-8l-1.4-1.425l-5.6 5.6V4z"/></svg>
</button>
</div>
<button class="bes-close-btn" onclick="BesPopup.dismiss()"> <button class="bes-close-btn" onclick="BesPopup.dismiss()">
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 24 24"><path fill="currentColor" d="M13.46 12L19 17.54V19h-1.46L12 13.46L6.46 19H5v-1.46L10.54 12L5 6.46V5h1.46L12 10.54L17.54 5H19v1.46z"/></svg> <svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 24 24"><path fill="var(--bes-close-icon)" d="M13.46 12L19 17.54V19h-1.46L12 13.46L6.46 19H5v-1.46L10.54 12L5 6.46V5h1.46L12 10.54L17.54 5H19v1.46z"/></svg>
</button> </button>
</div> </div>
</div> </div>
` `
const prevBtn = this.shadowRoot.querySelector(
'.bes-mistake-nav .bes-close-btn[title="Prejšnja napaka"]'
)
const nextBtn = this.shadowRoot.querySelector(
'.bes-mistake-nav .bes-close-btn[title="Naslednja napaka"]'
)
prevBtn.addEventListener('click', () => {
if (this.hostElService)
BesService.arrowBtnNavigation('back', this.hostElService)
})
nextBtn.addEventListener('click', () => {
if (this.hostElService)
BesService.arrowBtnNavigation('forward', this.hostElService)
})
this.addEventListener('mousedown', this.onMouseDown) this.addEventListener('mousedown', this.onMouseDown)
} }
@@ -2793,8 +3049,9 @@ class BesPopup extends HTMLElement {
* @param {Number} x X location hint * @param {Number} x X location hint
* @param {Number} y Y location hint * @param {Number} y Y location hint
*/ */
show(x, y) { show(x, y, service) {
this.style.position = 'fixed' this.style.position = 'fixed'
this.hostElService = service
// Element needs some initial placement for the browser to provide this.offsetWidth and this. // Element needs some initial placement for the browser to provide this.offsetWidth and this.
// offsetHeight measurements. // offsetHeight measurements.

View File

@@ -5,24 +5,34 @@
} }
.bes-highlight-spelling { .bes-highlight-spelling {
color: hsl(211, 100%, 60%); color: rgb(242, 90, 90);
background: hsla(211, 100%, 60%, 0.3); background: hsla(0, 100%, 67%, 0.18);
}
.bes-highlight-ai {
color: rgb(139, 62, 223);
background: hsla(262, 70%, 56%, 0.18);
} }
.bes-highlight-grammar { .bes-highlight-grammar {
color: hsl(27, 100%, 45%); color: rgb(60, 120, 220);
background: hsla(27, 100%, 45%, 0.3); background: hsla(220, 80%, 56%, 0.18);
} }
@media (prefers-color-scheme: dark) { @media (prefers-color-scheme: dark) {
.bes-highlight-spelling { .bes-highlight-spelling {
color: hsl(211, 100%, 55%); color: rgb(255, 120, 120);
background: hsla(211, 100%, 55%, 0.3); background: hsla(0, 100%, 67%, 0.32);
}
.bes-highlight-ai {
color: rgb(180, 120, 255);
background: hsla(262, 70%, 56%, 0.32);
} }
.bes-highlight-grammar { .bes-highlight-grammar {
color: hsl(27, 100%, 65%); color: rgb(100, 164, 243);
background: hsla(27, 100%, 65%, 0.3); background: hsla(220, 80%, 56%, 0.32);
} }
} }