Automatically disable when the active element matches with this pattern

Author: brookhong

README.md

@@ -594,6 +594,7 @@ Some functionalities are also available when you're using original pdf viewer, b
 | settings.autoSpeakOnInlineQuery | false | Whether to automatically speak the query string with TTS on inline query. |
 | settings.showTabIndices | false | Whether to show tab numbers (indices) in the tab titles. |
 | settings.tabIndicesSeparator | "\|" | The separator between index and original title of a tab. |
+| settings.disabledOnActiveElementPattern | undefined | Automatically disable this extension when the active element matches with this pattern and reactivate the extension when the active element changes, one useful case is to enable user to type to locate an option in a large dropdown, such as `settings.disabledOnActiveElementPattern = "ul.select-dropdown-options";` |
 
 ### Example of settings.theme, below is to set font size of status bar
 

README_CN.md

@@ -578,6 +578,7 @@ Surfingkeys默认使用[这个markdown分析器](https://github.com/chjj/marked)
 | settings.autoSpeakOnInlineQuery | false | 是否在使用inline query时自动发声。 |
 | settings.showTabIndices | false | 是否在标签页标题上显示当前标签页的编号。 |
 | settings.tabIndicesSeparator | "\|" | 标签页编号与标签页原始标题之间的分隔符。 |
+| settings.disabledOnActiveElementPattern | undefined | 当活动元素匹配这个设置时自动停用Surfingkeys，当活动元素变了继续启用，一个比较有用的场景是可以通过这个设置允许用户在一个大的下拉列表中通过按键快速定位选项，比如 `settings.disabledOnActiveElementPattern = "ul.select-dropdown-options";` |
 
 ### settings.theme示例，修改状态栏字体
 

src/content_scripts/common/hints.js

@@ -376,6 +376,11 @@ div.hint-scrollable {
                     dispatchMouseEvent(element, behaviours.mouseEvents, mouseEventModifiers);
                     dispatchSKEvent("observer", ['turnOn']);
                     lastMouseTarget = element;
+                    if (document.activeElement.matches(runtime.conf.disabledOnActiveElementPattern)) {
+                        setTimeout(() => {
+                            normal.disable(true);
+                        }, 100);
+                    }
                 }
 
                 if (behaviours.multipleHits) {

src/content_scripts/common/normal.js

@@ -24,10 +24,14 @@ function createDisabled(normal) {
     // Disabled has higher priority than others.
     self.priority = 99;
 
+    self.activatedOnElement = false;
     self.addEventListener('keydown', function(event) {
         // prevent this event to be handled by Surfingkeys' other listeners
         event.sk_suppressed = true;
-        if (Mode.isSpecialKeyOf("<Alt-s>", event.sk_keyName)) {
+        if (self.activatedOnElement && !document.activeElement.matches(runtime.conf.disabledOnActiveElementPattern)) {
+            normal.enable();
+            self.activatedOnElement = false;
+        } else if (Mode.isSpecialKeyOf("<Alt-s>", event.sk_keyName)) {
             normal.toggleBlocklist();
             self.exit();
             event.sk_stopPropagation = true;
@@ -963,11 +967,12 @@ function createNormal(insert) {
     }
 
     var _disabled = null;
-    self.disable = function() {
+    self.disable = function(onElement) {
         if (!_disabled) {
             _disabled = createDisabled(self);
             _disabled.enter(0, true);
         }
+        _disabled.activatedOnElement = onElement;
         dispatchSKEvent("observer", ['turnOff']);
         document.removeEventListener("mouseup", _onMouseUp);
     };

src/content_scripts/common/runtime.js

@@ -46,6 +46,7 @@ const runtime = (function() {
             // local part from settings
             blocklistPattern: undefined,
             lurkingPattern: undefined,
+            disabledOnActiveElementPattern: undefined,
             smartCase: true,
             caseSensitive: false,
             clickablePat: /(https?:\/\/|thunder:\/\/|magnet:)\S+/ig,