Add option for scan without mouse move (#1252)

* Add option for scan without mouse move * Make tests happy
yomidevs · Jul 21, 2024 · 850f9d1 · 850f9d1
1 parent 3eadb5d
commit 850f9d1
Show file tree

Hide file tree

Showing 9 changed files with 40 additions and 3 deletions.
diff --git a/ext/data/schemas/options-schema.json b/ext/data/schemas/options-schema.json
@@ -467,7 +467,8 @@
                                     "matchTypePrefix",
                                     "hidePopupOnCursorExit",
                                     "hidePopupOnCursorExitDelay",
-                                    "normalizeCssZoom"
+                                    "normalizeCssZoom",
+                                    "scanWithoutMousemove"
                                 ],
                                 "properties": {
                                     "inputs": {
@@ -754,6 +755,10 @@
                                     "normalizeCssZoom": {
                                         "type": "boolean",
                                         "default": true
+                                    },
+                                    "scanWithoutMousemove": {
+                                        "type": "boolean",
+                                        "default": true
                                     }
                                 }
                             },

diff --git a/ext/js/app/frontend.js b/ext/js/app/frontend.js
@@ -514,6 +514,7 @@ export class Frontend {
             preventMiddleMouse,
             sentenceParsingOptions,
             scanAltText: scanningOptions.scanAltText,
+            scanWithoutMousemove: scanningOptions.scanWithoutMousemove,
         });
         this._updateTextScannerEnabled();
 

diff --git a/ext/js/data/options-util.js b/ext/js/data/options-util.js
@@ -558,6 +558,7 @@ export class OptionsUtil {
             this._updateVersion44,
             this._updateVersion45,
             this._updateVersion46,
+            this._updateVersion47,
         ];
         /* eslint-enable @typescript-eslint/unbound-method */
         if (typeof targetVersion === 'number' && targetVersion < result.length) {
@@ -1423,6 +1424,16 @@ export class OptionsUtil {
         }
     }
 
+    /**
+     * - Added scanning.scanWithoutMousemove
+     * @type {import('options-util').UpdateFunction}
+     */
+    async _updateVersion47(options) {
+        for (const profile of options.profiles) {
+            profile.options.scanning.scanWithoutMousemove = true;
+        }
+    }
+
     /**
      * @param {string} url
      * @returns {Promise<chrome.tabs.Tab>}

diff --git a/ext/js/display/display.js b/ext/js/display/display.js
@@ -465,6 +465,7 @@ export class Display extends EventDispatcher {
                 matchTypePrefix: false,
                 sentenceParsingOptions,
                 scanAltText: scanningOptions.scanAltText,
+                scanWithoutMousemove: scanningOptions.scanWithoutMousemove,
             },
         });
 

diff --git a/ext/js/language/text-scanner.js b/ext/js/language/text-scanner.js
@@ -258,6 +258,7 @@ export class TextScanner extends EventDispatcher {
         sentenceParsingOptions,
         matchTypePrefix,
         scanAltText,
+        scanWithoutMousemove,
     }) {
         if (Array.isArray(inputs)) {
             this._inputs = inputs.map((input) => this._convertInput(input));
@@ -295,6 +296,9 @@ export class TextScanner extends EventDispatcher {
         if (typeof scanAltText === 'boolean') {
             this._scanAltText = scanAltText;
         }
+        if (typeof scanWithoutMousemove === 'boolean') {
+            this._scanWithoutMousemove = scanWithoutMousemove;
+        }
         if (typeof sentenceParsingOptions === 'object' && sentenceParsingOptions !== null) {
             const {scanExtent, terminationCharacterMode, terminationCharacters} = sentenceParsingOptions;
             if (typeof scanExtent === 'number') {
@@ -1117,7 +1121,10 @@ export class TextScanner extends EventDispatcher {
         } else if (this._arePointerEventsSupported()) {
             eventListenerInfos = this._getPointerEventListeners(capture);
         } else {
-            eventListenerInfos = [...this._getMouseEventListeners(capture), ...this._getKeyboardEventListeners(capture)];
+            eventListenerInfos = [...this._getMouseEventListeners(capture)];
+            if (this._scanWithoutMousemove) {
+                eventListenerInfos.push(...this._getKeyboardEventListeners(capture));
+            }
             if (this._touchInputEnabled) {
                 eventListenerInfos.push(...this._getTouchEventListeners(capture));
             }

diff --git a/ext/settings.html b/ext/settings.html
@@ -387,6 +387,15 @@ <h1>Yomitan Settings</h1>
                 <input type="number" data-setting="scanning.delay" min="0">
             </div>
         </div></div>
+        <div class="settings-item advanced-only"><div class="settings-item-inner settings-item-inner-wrappable">
+            <div class="settings-item-left">
+                <div class="settings-item-label">Scan without mouse move</div>
+                <div class="settings-item-description">Allow scanning words under the pointer without the pointer being in motion.</div>
+            </div>
+            <div class="settings-item-right">
+                <label class="toggle"><input type="checkbox" data-setting="scanning.scanWithoutMousemove"><span class="toggle-body"><span class="toggle-track"></span><span class="toggle-knob"></span></span></label>
+            </div>
+        </div></div>
         <div class="settings-item"><div class="settings-item-inner">
             <div class="settings-item-left">
                 <div class="settings-item-label">Select matched text</div>

diff --git a/test/options-util.test.js b/test/options-util.test.js
@@ -349,6 +349,7 @@ function createProfileOptionsUpdatedTestData1() {
                 onSearchPages: false,
                 onSearchQuery: false,
             },
+            scanWithoutMousemove: true,
             inputs: [
                 {
                     include: 'shift',
@@ -636,7 +637,7 @@ function createOptionsUpdatedTestData1() {
             },
         ],
         profileCurrent: 0,
-        version: 46,
+        version: 47,
         global: {
             database: {
                 prefixWildcardsSupported: false,

diff --git a/types/ext/settings.d.ts b/types/ext/settings.d.ts
@@ -195,6 +195,7 @@ export type ScanningOptions = {
     hidePopupOnCursorExitDelay: number;
     normalizeCssZoom: boolean;
     scanAltText: boolean;
+    scanWithoutMousemove: boolean;
 };
 
 export type ScanningInput = {

diff --git a/types/ext/text-scanner.d.ts b/types/ext/text-scanner.d.ts
@@ -42,6 +42,7 @@ export type Options = {
     matchTypePrefix?: boolean;
     sentenceParsingOptions?: SentenceParsingOptions;
     scanAltText?: boolean;
+    scanWithoutMousemove?: boolean;
 };
 
 export type InputOptionsOuter = {