feat: add scroll acceleration

Author: PhoSor

README.md

@@ -11,7 +11,7 @@ The commands itself do nothing, so use the hotkeys to scroll the editor.
 
 ![Editor Scroll Commands Hotkeys](media/editor-scroll-commands-hotkeys.png "Editor Scroll Commands Hotkeys")
 
-The settings allow you to change the scroll offset and the interval.
+The settings allow you to change the scroll offset, the interval, and some acceleration parameters.
 
 ![Editor Scroll Commands Settings](media/editor-scroll-commands-settings.png "Editor Scroll Commands Settings")
 
@@ -26,4 +26,4 @@ The settings allow you to change the scroll offset and the interval.
 
 - Copy over `main.js`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/obsidian-editor-scroll-commands/`.
 
-See [latest release](https://github.com/PhoSor/obsidian-editor-scroll-commands/releases/latest) in **Releases** section.
+See the [latest release](https://github.com/PhoSor/obsidian-editor-scroll-commands/releases/latest) in the **Releases** section.

main.ts

@@ -1,20 +1,26 @@
 import { Platform, App, MarkdownFileInfo, Hotkey, Plugin, PluginSettingTab, Setting } from 'obsidian';
 
-const PluginId = 'editor-scroll-commands';
-const ScrollUpCommandId = 'scroll-up';
-const ScrollDownCommandId = 'scroll-down';
+const PLUGIN_ID = 'editor-scroll-commands';
+const SCROLL_UP_COMMAND_ID = 'scroll-up';
+const SCROLL_DOWN_COMMAND_ID = 'scroll-down';
 
 interface EditorScrollCommandsSettings {
   offset: number;
   interval: number;
+  accelerate: boolean;
+  accelRate: number;
+  maxAccel: number;
 }
 
 const DEFAULT_SETTINGS: EditorScrollCommandsSettings = {
-  offset: 11,
-  interval: 8,
+  offset: 2,
+  interval: 5,
+  accelerate: true,
+  accelRate: 0.024,
+  maxAccel: 4,
 }
 
-const ModToEventProp = {
+const MODIFIER_TO_EVENT_PROP = {
   'Alt': 'altKey',
   'Shift': 'shiftKey',
   'Ctrl': 'ctrlKey',
@@ -26,11 +32,13 @@ export default class EditorScrollCommandsPlugin extends Plugin {
   settings: EditorScrollCommandsSettings;
   intervalId: number;
   editorScrolling: MarkdownFileInfo | null;
+  scrollCoef = 1;
 
   clearInterval() {
     window.clearInterval(this.intervalId);
     this.intervalId = 0;
     this.editorScrolling = null;
+    this.scrollCoef = 1;
   }
 
   scroll(offset: number) {
@@ -40,12 +48,12 @@ export default class EditorScrollCommandsPlugin extends Plugin {
     if (!this.intervalId) {
       this.editorScrolling = this.app.workspace.activeEditor;
       this.intervalId = window.setInterval(() => {
-        if (this.app.workspace.activeEditor != this.editorScrolling) {
-          this.clearInterval();
-          return;
+        if (this.settings.accelerate) {
+          this.scrollCoef += ((this.scrollCoef < this.settings.maxAccel) ?
+                              this.settings.accelRate : 0);
         }
         // @ts-expect-error
-        editor?.cm.scrollDOM.scrollBy(0, offset);
+        editor?.cm.scrollDOM.scrollBy(0, offset * this.scrollCoef);
       }, this.settings.interval);
       this.registerInterval(this.intervalId);
     }
@@ -60,18 +68,16 @@ export default class EditorScrollCommandsPlugin extends Plugin {
   }
 
   isScrollHotkeyEvent(event: KeyboardEvent, hotkeys: Hotkey[]) {
-    return hotkeys.some((hotkey: Hotkey) => {
+    return hotkeys?.some((hotkey: Hotkey) => {
       let keyMatched =
         (hotkey.key == event.code) ||
         ('Key' + hotkey.key == event.code);
 
       let allModsMatched = hotkey.modifiers.every(m => {
-        let propName = ModToEventProp[m];
+        let modifierPressed = MODIFIER_TO_EVENT_PROP[m];
 
         // @ts-expect-error
-        if (!event[propName]) { return false; }
-
-        return true;
+        return event[modifierPressed];
       });
 
       return keyMatched && allModsMatched;
@@ -80,18 +86,14 @@ export default class EditorScrollCommandsPlugin extends Plugin {
 
   isScrollUpHotkeyEvent(event: KeyboardEvent) {
     // @ts-expect-error
-    let scrollUpHotkeys = this.app.hotkeyManager.customKeys[`${PluginId}:${ScrollUpCommandId}`];
-
-    if (!scrollUpHotkeys) { return false; }
+    let scrollUpHotkeys = this.app.hotkeyManager.customKeys[`${PLUGIN_ID}:${SCROLL_UP_COMMAND_ID}`];
 
     return this.isScrollHotkeyEvent(event, scrollUpHotkeys);
   }
 
   isScrollDownHotkeyEvent(event: KeyboardEvent) {
     // @ts-expect-error
-    let scrollDownHotkeys = this.app.hotkeyManager.customKeys[`${PluginId}:${ScrollDownCommandId}`];
-
-    if (!scrollDownHotkeys) { return false; }
+    let scrollDownHotkeys = this.app.hotkeyManager.customKeys[`${PLUGIN_ID}:${SCROLL_DOWN_COMMAND_ID}`];
 
     return this.isScrollHotkeyEvent(event, scrollDownHotkeys);
   }
@@ -100,13 +102,13 @@ export default class EditorScrollCommandsPlugin extends Plugin {
     await this.loadSettings();
 
     this.addCommand({
-      id: ScrollUpCommandId,
+      id: SCROLL_UP_COMMAND_ID,
       name: 'Scroll up',
       editorCallback: () => {},
     });
 
     this.addCommand({
-      id: ScrollDownCommandId,
+      id: SCROLL_DOWN_COMMAND_ID,
       name: 'Scroll down',
       editorCallback: () => {},
     });
@@ -170,32 +172,72 @@ class EditorScrollCommandsSettingTab extends PluginSettingTab {
 
     containerEl.empty();
 
-    new Setting(containerEl)
-    .setHeading()
-    .setName('Editor Scroll Commands');
-
-    new Setting(containerEl)
-    .setName('Scroll offset')
-    .setDesc('The number of pixels to scroll per interval, px')
-    .addText(text => text
-             .setPlaceholder('Enter the scroll offset number')
-             .setValue(this.plugin.settings.offset?.toString())
-             .onChange(async (value) => {
-               this.plugin.settings.offset = value ?
-                 parseInt(value, 10) : DEFAULT_SETTINGS.offset;
-               await this.plugin.saveSettings();
-             }));
-
-    new Setting(containerEl)
-    .setName('Scroll interval')
-    .setDesc('The scroll offset interval in milliseconds, ms')
-    .addText(text => text
-             .setPlaceholder('Enter the interval amount')
-             .setValue(this.plugin.settings.interval?.toString())
-             .onChange(async (value) => {
-               this.plugin.settings.interval = value ?
-                 parseInt(value, 10) : DEFAULT_SETTINGS.interval;
-               await this.plugin.saveSettings();
-             }));
+    new Setting(containerEl).
+      setName('Scroll offset').
+      setDesc('The number of pixels to scroll per interval, px').
+      addText(text => text.
+        setPlaceholder('Enter the scroll offset number').
+        setValue(this.plugin.settings.offset?.toString()).
+        onChange(async (value) => {
+          this.plugin.settings.offset =
+            parseInt(value, 10) || DEFAULT_SETTINGS.offset;
+          await this.plugin.saveSettings();
+        })
+      );
+
+    new Setting(containerEl).
+      setName('Scroll interval').
+      setDesc('The scroll offset interval in milliseconds, ms').
+      addText(text => text.
+        setPlaceholder('Enter the interval amount').
+        setValue(this.plugin.settings.interval?.toString()).
+        onChange(async (value) => {
+          this.plugin.settings.interval =
+            parseInt(value, 10) || DEFAULT_SETTINGS.interval;
+          await this.plugin.saveSettings();
+        })
+      );
+
+    new Setting(containerEl).
+      setHeading().
+      setName('Scroll acceleration');
+
+    new Setting(containerEl).
+      setName('Enable scroll acceleration').
+      addToggle(text => text.
+        setValue(this.plugin.settings.accelerate).
+        onChange(async (value) => {
+        this.plugin.settings.accelerate = value;
+        await this.plugin.saveSettings();
+        if (increaseRate && maxRate) {
+          increaseRate.setDisabled(!value);
+          maxRate.setDisabled(!value);
+        }
+      })
+    );
+
+    let increaseRate = new Setting(containerEl).
+      setName('Scroll rate increase').
+      setDesc('The step of the increase of the scroll acceleration').
+      addText(text => text.
+        setValue(this.plugin.settings.accelRate.toString()).
+        onChange(async (value) => {
+          this.plugin.settings.accelRate =
+            parseFloat(value) || DEFAULT_SETTINGS.accelRate;
+          await this.plugin.saveSettings();
+        })
+      );
+
+    let maxRate = new Setting(containerEl).
+      setName('Max scroll rate').
+      setDesc('Max rate of the scroll acceleration').
+      addText(text => text.
+      setValue(this.plugin.settings.maxAccel.toString()).
+      onChange(async (value) => {
+        this.plugin.settings.maxAccel =
+          parseFloat(value) || DEFAULT_SETTINGS.maxAccel;
+        await this.plugin.saveSettings();
+      })
+    );
   }
 }

manifest.json

@@ -1,7 +1,7 @@
 {
   "id": "editor-scroll-commands",
   "name": "Editor Scroll Commands",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "minAppVersion": "0.15.0",
   "description": "Add scroll commands for editor, so you can assign hotkeys.",
   "author": "Andrey Sorokin <pho.nzp@gmail.com>",

media/editor-scroll-commands-settings.png

@@ -1,6 +1,6 @@
 {
   "name": "editor-scroll-commands",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "Add scroll commands for editor, so you can assign hotkeys.",
   "main": "main.js",
   "scripts": {

package.json

@@ -1,4 +1,5 @@
 {
-	"1.0.0": "0.15.0",
-	"1.0.3": "0.15.0"
-}
+  "1.0.0": "0.15.0",
+  "1.0.3": "0.15.0",
+  "1.1.0": "0.15.0"
+}