Skip to content

An open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间,让人与智能体在此协作

:sparkles: Support scrolling menus with mouse movement https://github.com/siyuan-note/siyuan/issues/20663

Daniel53c7e4c67ea3
diff --git a/app/appearance/langs/ar.json b/app/appearance/langs/ar.json
index 8174baa1f3..612f0d32bc 100644
--- a/app/appearance/langs/ar.json
+++ b/app/appearance/langs/ar.json
@@ -1,4 +1,6 @@
{
+ "menuMouseScroll": "تمرير القوائم مع حركة الماوس",
+ "menuMouseScrollTip": "حرّك الماوس لأعلى أو لأسفل داخل القائمة لتمرير محتواها عندما يتجاوز الارتفاع المتاح",
"aiWebSearchExaTip": "البحث في صفحات الويب باستخدام Exa",
"aiWebFetchDirectTip": "جلب محتوى الصفحات أو تنزيل الملفات مباشرة دون تشغيل JavaScript",
"aiWebTools": "البحث في الويب وجلب الصفحات",
diff --git a/app/appearance/langs/de.json b/app/appearance/langs/de.json
index 0bd261e92b..a43a4201e7 100644
--- a/app/appearance/langs/de.json
+++ b/app/appearance/langs/de.json
@@ -1,4 +1,6 @@
{
+ "menuMouseScroll": "Menüs durch Mausbewegung scrollen",
+ "menuMouseScrollTip": "Bewege die Maus innerhalb eines zu langen Menüs nach oben oder unten, um dessen Inhalt zu scrollen",
"aiWebSearchExaTip": "Webseiten mit Exa durchsuchen",
"aiWebFetchDirectTip": "Seiteninhalte direkt abrufen oder Dateien herunterladen, ohne JavaScript auszuführen",
"aiWebTools": "Websuche und Seitenabruf",
diff --git a/app/appearance/langs/en.json b/app/appearance/langs/en.json
index 82f3380391..2c0433d232 100644
--- a/app/appearance/langs/en.json
+++ b/app/appearance/langs/en.json
@@ -1,4 +1,6 @@
{
+ "menuMouseScroll": "Scroll menus with mouse movement",
+ "menuMouseScrollTip": "Move the mouse up or down within an overflowing menu to scroll its contents",
"aiWebSearchExaTip": "Search web pages with Exa",
"aiWebFetchDirectTip": "Retrieve page content or download files directly, without running JavaScript",
"aiWebTools": "Web search and fetch",
diff --git a/app/appearance/langs/es.json b/app/appearance/langs/es.json
index 404c9954ca..08b566024a 100644
--- a/app/appearance/langs/es.json
+++ b/app/appearance/langs/es.json
@@ -1,4 +1,6 @@
{
+ "menuMouseScroll": "Desplazar menús con el movimiento del ratón",
+ "menuMouseScrollTip": "Mueve el ratón hacia arriba o abajo dentro de un menú que exceda la altura disponible para desplazar su contenido",
"aiWebSearchExaTip": "Buscar páginas web con Exa",
"aiWebFetchDirectTip": "Obtener contenido o descargar archivos directamente, sin ejecutar JavaScript",
"aiWebTools": "Búsqueda y obtención web",
diff --git a/app/appearance/langs/fr.json b/app/appearance/langs/fr.json
index c3f7e09196..ac7ab90c35 100644
--- a/app/appearance/langs/fr.json
+++ b/app/appearance/langs/fr.json
@@ -1,4 +1,6 @@
{
+ "menuMouseScroll": "Faire défiler les menus avec le mouvement de la souris",
+ "menuMouseScrollTip": "Déplacez la souris vers le haut ou le bas dans un menu trop long pour faire défiler son contenu",
"aiWebSearchExaTip": "Rechercher des pages web avec Exa",
"aiWebFetchDirectTip": "Récupérer le contenu des pages ou télécharger des fichiers directement, sans exécuter JavaScript",
"aiWebTools": "Recherche et récupération web",
diff --git a/app/appearance/langs/he.json b/app/appearance/langs/he.json
index f0cefb093a..b229946d17 100644
--- a/app/appearance/langs/he.json
+++ b/app/appearance/langs/he.json
@@ -1,4 +1,6 @@
{
+ "menuMouseScroll": "גלילת תפריטים באמצעות תנועת העכבר",
+ "menuMouseScrollTip": "כאשר תוכן התפריט חורג מהגובה הזמין, יש להזיז את העכבר למעלה או למטה בתוך התפריט כדי לגלול את תוכנו",
"aiWebSearchExaTip": "חיפוש דפי אינטרנט באמצעות Exa",
"aiWebFetchDirectTip": "שליפת תוכן דפים או הורדת קבצים ישירות, ללא הפעלת JavaScript",
"aiWebTools": "חיפוש ושליפת דפי אינטרנט",
diff --git a/app/appearance/langs/hi.json b/app/appearance/langs/hi.json
index 21d5646712..e179284e97 100644
--- a/app/appearance/langs/hi.json
+++ b/app/appearance/langs/hi.json
@@ -1,4 +1,6 @@
{
+ "menuMouseScroll": "माउस की गति से मेनू स्क्रॉल करें",
+ "menuMouseScrollTip": "मेनू की सामग्री उपलब्ध ऊँचाई से अधिक होने पर उसे स्क्रॉल करने के लिए मेनू के भीतर माउस को ऊपर या नीचे ले जाएँ",
"aiWebSearchExaTip": "Exa से वेब पृष्ठ खोजें",
"aiWebFetchDirectTip": "JavaScript चलाए बिना सीधे पृष्ठ की सामग्री प्राप्त करें या फ़ाइलें डाउनलोड करें",
"aiWebTools": "वेब खोज और सामग्री प्राप्ति",
diff --git a/app/appearance/langs/id.json b/app/appearance/langs/id.json
index c87af7d932..eb1654ace2 100644
--- a/app/appearance/langs/id.json
+++ b/app/appearance/langs/id.json
@@ -1,4 +1,6 @@
{
+ "menuMouseScroll": "Gulir menu dengan gerakan tetikus",
+ "menuMouseScrollTip": "Gerakkan tetikus ke atas atau ke bawah di dalam menu yang melebihi tinggi yang tersedia untuk menggulir isinya",
"aiWebSearchExaTip": "Cari halaman web dengan Exa",
"aiWebFetchDirectTip": "Ambil isi halaman atau unduh berkas secara langsung tanpa menjalankan JavaScript",
"aiWebTools": "Pencarian dan pengambilan web",
diff --git a/app/appearance/langs/it.json b/app/appearance/langs/it.json
index 64dc0428cb..38253c4973 100644
--- a/app/appearance/langs/it.json
+++ b/app/appearance/langs/it.json
@@ -1,4 +1,6 @@
{
+ "menuMouseScroll": "Scorri i menu con il movimento del mouse",
+ "menuMouseScrollTip": "Sposta il mouse verso l'alto o il basso all'interno di un menu troppo lungo per scorrerne il contenuto",
"aiWebSearchExaTip": "Cerca pagine web con Exa",
"aiWebFetchDirectTip": "Recupera il contenuto delle pagine o scarica file direttamente, senza eseguire JavaScript",
"aiWebTools": "Ricerca e recupero web",
diff --git a/app/appearance/langs/ja.json b/app/appearance/langs/ja.json
index 84be2291ca..0c799864be 100644
--- a/app/appearance/langs/ja.json
+++ b/app/appearance/langs/ja.json
@@ -1,4 +1,6 @@
{
+ "menuMouseScroll": "マウスの動きに合わせてメニューをスクロール",
+ "menuMouseScrollTip": "メニューの内容が表示可能な高さを超える場合、メニュー内でマウスを上下に動かすと内容をスクロールできます",
"aiWebSearchExaTip": "Exa で Web ページを検索します",
"aiWebFetchDirectTip": "JavaScript を実行せず、ページ内容を直接取得したりファイルをダウンロードしたりします",
"aiWebTools": "Web 検索と取得",
diff --git a/app/appearance/langs/ko.json b/app/appearance/langs/ko.json
index d5f43d8a5a..5c59d0a222 100644
--- a/app/appearance/langs/ko.json
+++ b/app/appearance/langs/ko.json
@@ -1,4 +1,6 @@
{
+ "menuMouseScroll": "마우스 움직임으로 메뉴 스크롤",
+ "menuMouseScrollTip": "메뉴 내용이 표시 가능한 높이를 초과하면 메뉴 안에서 마우스를 위아래로 움직여 내용을 스크롤합니다",
"aiWebSearchExaTip": "Exa로 웹 페이지 검색",
"aiWebFetchDirectTip": "JavaScript를 실행하지 않고 페이지 내용을 직접 가져오거나 파일 다운로드",
"aiWebTools": "웹 검색 및 가져오기",
diff --git a/app/appearance/langs/nl.json b/app/appearance/langs/nl.json
index 6f1ecda3ea..8fe95dcfdf 100644
--- a/app/appearance/langs/nl.json
+++ b/app/appearance/langs/nl.json
@@ -1,4 +1,6 @@
{
+ "menuMouseScroll": "Menu's scrollen met muisbewegingen",
+ "menuMouseScrollTip": "Beweeg de muis omhoog of omlaag binnen een menu dat te lang is om de inhoud te scrollen",
"aiWebSearchExaTip": "Webpagina's zoeken met Exa",
"aiWebFetchDirectTip": "Pagina-inhoud rechtstreeks ophalen of bestanden downloaden, zonder JavaScript uit te voeren",
"aiWebTools": "Webzoeken en pagina's ophalen",
diff --git a/app/appearance/langs/pl.json b/app/appearance/langs/pl.json
index db6030e04e..d1f77f6e87 100644
--- a/app/appearance/langs/pl.json
+++ b/app/appearance/langs/pl.json
@@ -1,4 +1,6 @@
{
+ "menuMouseScroll": "Przewijanie menu ruchem myszy",
+ "menuMouseScrollTip": "Gdy zawartość menu przekracza dostępną wysokość, przesuwaj mysz w górę lub w dół wewnątrz menu, aby je przewijać",
"aiWebSearchExaTip": "Wyszukuj strony internetowe za pomocą Exa",
"aiWebFetchDirectTip": "Pobieraj treść stron lub pliki bezpośrednio, bez wykonywania JavaScript",
"aiWebTools": "Wyszukiwanie i pobieranie stron",
diff --git a/app/appearance/langs/pt-BR.json b/app/appearance/langs/pt-BR.json
index df0b683688..04341580d5 100644
--- a/app/appearance/langs/pt-BR.json
+++ b/app/appearance/langs/pt-BR.json
@@ -1,4 +1,6 @@
{
+ "menuMouseScroll": "Rolar menus com o movimento do mouse",
+ "menuMouseScrollTip": "Mova o mouse para cima ou para baixo dentro de um menu que exceda a altura disponível para rolar seu conteúdo",
"aiWebSearchExaTip": "Pesquisar páginas da web com o Exa",
"aiWebFetchDirectTip": "Obter conteúdo de páginas ou baixar arquivos diretamente, sem executar JavaScript",
"aiWebTools": "Pesquisa e obtenção de páginas",
diff --git a/app/appearance/langs/ru.json b/app/appearance/langs/ru.json
index d1b41ecee6..e3c5477acd 100644
--- a/app/appearance/langs/ru.json
+++ b/app/appearance/langs/ru.json
@@ -1,4 +1,6 @@
{
+ "menuMouseScroll": "Прокрутка меню движением мыши",
+ "menuMouseScrollTip": "Если содержимое меню превышает доступную высоту, перемещайте мышь вверх или вниз внутри меню для его прокрутки",
"aiWebSearchExaTip": "Поиск веб-страниц с помощью Exa",
"aiWebFetchDirectTip": "Получение содержимого страниц или скачивание файлов напрямую, без выполнения JavaScript",
"aiWebTools": "Поиск и загрузка веб-страниц",
diff --git a/app/appearance/langs/sk.json b/app/appearance/langs/sk.json
index 8318cad0bc..0cb1cbf8be 100644
--- a/app/appearance/langs/sk.json
+++ b/app/appearance/langs/sk.json
@@ -1,4 +1,6 @@
{
+ "menuMouseScroll": "Posúvanie ponúk pohybom myši",
+ "menuMouseScrollTip": "Ak obsah ponuky presahuje dostupnú výšku, posúvajte ho pohybom myši nahor alebo nadol v ponuke",
"aiWebSearchExaTip": "Vyhľadávanie webových stránok pomocou Exa",
"aiWebFetchDirectTip": "Priame načítanie obsahu stránok alebo sťahovanie súborov bez spúšťania JavaScriptu",
"aiWebTools": "Vyhľadávanie a načítanie webu",
diff --git a/app/appearance/langs/sr.json b/app/appearance/langs/sr.json
index f444aaa910..21c9c1d5b8 100644
--- a/app/appearance/langs/sr.json
+++ b/app/appearance/langs/sr.json
@@ -1,4 +1,6 @@
{
+ "menuMouseScroll": "Померање менија покретом миша",
+ "menuMouseScrollTip": "Када садржај менија премашује доступну висину, померајте миша нагоре или надоле унутар менија да бисте померали садржај",
"aiWebSearchExaTip": "Претражујте веб странице помоћу услуге Exa",
"aiWebFetchDirectTip": "Директно преузимање садржаја страница или датотека, без извршавања JavaScript-а",
"aiWebTools": "Веб претрага и преузимање",
diff --git a/app/appearance/langs/th.json b/app/appearance/langs/th.json
index d39a27f901..f2fc2e5138 100644
--- a/app/appearance/langs/th.json
+++ b/app/appearance/langs/th.json
@@ -1,4 +1,6 @@
{
+ "menuMouseScroll": "เลื่อนเมนูตามการเคลื่อนไหวของเมาส์",
+ "menuMouseScrollTip": "เมื่อเนื้อหาเมนูเกินความสูงที่แสดงได้ ให้เลื่อนเมาส์ขึ้นหรือลงภายในเมนูเพื่อเลื่อนเนื้อหา",
"aiWebSearchExaTip": "ค้นหาหน้าเว็บด้วย Exa",
"aiWebFetchDirectTip": "ดึงเนื้อหาหน้าเว็บหรือดาวน์โหลดไฟล์โดยตรง โดยไม่เรียกใช้ JavaScript",
"aiWebTools": "ค้นหาและดึงข้อมูลเว็บ",
diff --git a/app/appearance/langs/tr.json b/app/appearance/langs/tr.json
index 2d2c691f05..6dad982807 100644
--- a/app/appearance/langs/tr.json
+++ b/app/appearance/langs/tr.json
@@ -1,4 +1,6 @@
{
+ "menuMouseScroll": "Menüleri fare hareketiyle kaydır",
+ "menuMouseScrollTip": "Menü içeriği kullanılabilir yüksekliği aştığında, içeriği kaydırmak için fareyi menü içinde yukarı veya aşağı hareket ettirin",
"aiWebSearchExaTip": "Exa ile web sayfalarını arayın",
"aiWebFetchDirectTip": "JavaScript çalıştırmadan sayfa içeriğini doğrudan alın veya dosya indirin",
"aiWebTools": "Web araması ve içerik alma",
diff --git a/app/appearance/langs/uk.json b/app/appearance/langs/uk.json
index 690781de33..9d4c851ed8 100644
--- a/app/appearance/langs/uk.json
+++ b/app/appearance/langs/uk.json
@@ -1,4 +1,6 @@
{
+ "menuMouseScroll": "Прокручування меню рухом миші",
+ "menuMouseScrollTip": "Якщо вміст меню перевищує доступну висоту, рухайте мишу вгору або вниз усередині меню, щоб прокручувати його вміст",
"aiWebSearchExaTip": "Пошук вебсторінок за допомогою Exa",
"aiWebFetchDirectTip": "Отримання вмісту сторінок або завантаження файлів напряму, без виконання JavaScript",
"aiWebTools": "Пошук і завантаження вебсторінок",
diff --git a/app/appearance/langs/zh-CN.json b/app/appearance/langs/zh-CN.json
index 4f64ecaee4..7f76979145 100644
--- a/app/appearance/langs/zh-CN.json
+++ b/app/appearance/langs/zh-CN.json
@@ -1,4 +1,6 @@
{
+ "menuMouseScroll": "菜单跟随鼠标滚动",
+ "menuMouseScrollTip": "菜单内容超出可用高度时,在菜单内上下移动鼠标即可滚动菜单内容",
"aiWebSearchExaTip": "通过 Exa 搜索网页",
"aiWebFetchDirectTip": "直接获取网页内容或下载文件,不执行 JavaScript",
"aiWebTools": "网页搜索与抓取",
diff --git a/app/appearance/langs/zh-TW.json b/app/appearance/langs/zh-TW.json
index aea4eaaed0..fd2dda36f1 100644
--- a/app/appearance/langs/zh-TW.json
+++ b/app/appearance/langs/zh-TW.json
@@ -1,4 +1,6 @@
{
+ "menuMouseScroll": "選單隨滑鼠移動捲動",
+ "menuMouseScrollTip": "選單內容超出可用高度時,在選單內上下移動滑鼠即可捲動選單內容",
"aiWebSearchExaTip": "透過 Exa 搜尋網頁",
"aiWebFetchDirectTip": "直接取得網頁內容或下載檔案,不執行 JavaScript",
"aiWebTools": "網頁搜尋與擷取",
diff --git a/app/src/config/setting/windowRuntime.test.ts b/app/src/config/setting/windowRuntime.test.ts
index 61ec0a11d1..439216832c 100644
--- a/app/src/config/setting/windowRuntime.test.ts
+++ b/app/src/config/setting/windowRuntime.test.ts
@@ -50,6 +50,12 @@ const fixture = (deferSnippetScripts = false) => {
refreshCompactMode: async (guard: () => boolean) => {
if (guard()) calls.push({type: "compact-refresh"});
},
+ onMenuMouseScrollStorageChanged: (key: string) => {
+ if (key === "mouse-scroll") calls.push({type: "mouse-scroll", value: storage[key]});
+ },
+ refreshMenuMouseScroll: async (guard: () => boolean) => {
+ if (guard()) calls.push({type: "mouse-scroll-refresh"});
+ },
genNotebookOption: (id: string, _box: string, shorthand: boolean, filter: (notebook: unknown) => boolean) => {
calls.push({type: "options", value: {id, shorthand, filter}});
return '<option value="">Current</option><option value="a">Renamed</option>';
@@ -216,6 +222,24 @@ test("settings apply compact mode after every storage update and stop refreshing
assert.equal(f.calls.filter(call => call.type === "compact-refresh").length, 1);
});
+test("settings synchronize menu mouse scrolling for single and batch preference changes and reconnects", async () => {
+ const f = fixture();
+ const send = (cmd: string, data: unknown) => f.runtime.handleMessage({cmd, data} as IWebSocketData);
+ send("setLocalStorageVal", {key: "mouse-scroll", val: true});
+ send("removeLocalStorageVal", {key: "mouse-scroll"});
+ send("setLocalStorageVals", {keyVals: {"mouse-scroll": false}});
+ send("removeLocalStorageVals", {keys: ["mouse-scroll"]});
+ assert.deepEqual(f.calls.filter(call => call.type === "mouse-scroll").map(call => call.value),
+ [true, undefined, false, undefined]);
+ await f.runtime.reconnect();
+ assert.equal(f.calls.filter(call => call.type === "mouse-scroll-refresh").length, 1);
+ f.setActive(false);
+ send("setLocalStorageVal", {key: "mouse-scroll", val: true});
+ await f.runtime.reconnect();
+ assert.equal(f.storage["mouse-scroll"], undefined);
+ assert.equal(f.calls.filter(call => call.type === "mouse-scroll-refresh").length, 1);
+});
+
test("snippets assign configuration first and wait for Lute before rendering JS", async () => {
const f = fixture();
await f.runtime.refreshSnippets();
diff --git a/app/src/config/setting/windowRuntime.ts b/app/src/config/setting/windowRuntime.ts
index 0a9381de81..f864b0fe68 100644
--- a/app/src/config/setting/windowRuntime.ts
+++ b/app/src/config/setting/windowRuntime.ts
@@ -9,6 +9,7 @@ import {ensureLute} from "../../protyle/util/lute";
import {renderSnippet} from "../util/snippets";
import {onAgentStreamingMarkdownStorageChanged} from "../tabs/ai/agentStreamingMarkdown";
import {onCompactModeStorageChanged, refreshCompactMode} from "../tabs/compactMode";
+import {onMenuMouseScrollStorageChanged, refreshMenuMouseScroll} from "../tabs/menuMouseScroll";
import type {ISettingsWindowHost} from "./windowContext";
let notebookRefresh = () => Promise.resolve();
@@ -178,6 +179,7 @@ export const createSettingsWindowRuntime = (isActive: () => boolean, deferSnippe
const onStorageChanged = (keys: string[]) => {
keys.forEach(onAgentStreamingMarkdownStorageChanged);
keys.forEach(onCompactModeStorageChanged);
+ keys.forEach(onMenuMouseScrollStorageChanged);
if (keys.includes(Constants.LOCAL_ZOOM)) {
zoomRevision++;
applyZoom();
@@ -222,7 +224,8 @@ export const createSettingsWindowRuntime = (isActive: () => boolean, deferSnippe
const reconnect = async () => {
if (!isActive()) return;
- await Promise.all([refreshNotebooks(), refreshSnippets(true), refreshZoom(), refreshCompactMode(isActive)]);
+ await Promise.all([refreshNotebooks(), refreshSnippets(true), refreshZoom(), refreshCompactMode(isActive),
+ refreshMenuMouseScroll(isActive)]);
};
return {applyZoom, refreshNotebooks, refreshSnippets, enableSnippetScripts, handleMessage, reconnect};
};
diff --git a/app/src/config/tabs/appearanceTab.ts b/app/src/config/tabs/appearanceTab.ts
index 81f1748d9c..8a9bd7973a 100644
--- a/app/src/config/tabs/appearanceTab.ts
+++ b/app/src/config/tabs/appearanceTab.ts
@@ -53,6 +53,7 @@ import {genMobileBarsSettingHTML, mountMobileBarsSetting} from "../../mobile/uti
import {genEntryVisibilityHtml, mountEntryVisibility} from "../entryVisibility/ui";
import {genBodyGradientHtml, mountBodyGradient} from "./bodyGradient";
import {isCompactModeAvailable, isCompactModeEnabled, setCompactModeEnabled} from "./compactMode";
+import {isMenuMouseScrollAvailable, isMenuMouseScrollEnabled, setMenuMouseScrollEnabled} from "./menuMouseScroll";
import {openInlineStyleDialog} from "../../protyle/toolbar/inlineStyleDialog";
import type {TInlineStyleType} from "../../protyle/toolbar/inlineStyle";
@@ -1005,6 +1006,14 @@ const registerAppearanceControlsGroup = (tab: SettingTabBuilder) => {
html: genEntryVisibilityHtml,
afterMount: mountEntryVisibility,
});
+ if (isMenuMouseScrollAvailable()) {
+ group.switch("menuMouseScroll", {
+ title: window.siyuan.languages.menuMouseScroll,
+ desc: window.siyuan.languages.menuMouseScrollTip,
+ readConfig: isMenuMouseScrollEnabled,
+ save: value => setMenuMouseScrollEnabled(value as boolean),
+ });
+ }
/// #if !MOBILE
group.select("editor.floatWindowMode", {
title: window.siyuan.languages.floatWindowMode,
diff --git a/app/src/config/tabs/menuMouseScroll.test.ts b/app/src/config/tabs/menuMouseScroll.test.ts
new file mode 100644
index 0000000000..5341337cd1
--- /dev/null
+++ b/app/src/config/tabs/menuMouseScroll.test.ts
@@ -0,0 +1,104 @@
+import * as assert from "node:assert/strict";
+import {readFileSync} from "node:fs";
+import {test} from "node:test";
+import {runInNewContext} from "node:vm";
+import {ModuleKind, ScriptTarget, transpileModule} from "typescript";
+
+const compiled = transpileModule(readFileSync("src/config/tabs/menuMouseScroll.ts", "utf8"), {
+ compilerOptions: {module: ModuleKind.CommonJS, target: ScriptTarget.ES2021},
+}).outputText;
+
+const fixture = (frontend = "desktop", mobileApp = false) => {
+ const input = {checked: false};
+ const storage: Record<string, unknown> = {};
+ const siyuan = {storage, config: {readonly: false}, isPublish: false};
+ const saved: unknown[][] = [];
+ const requests: ((response: unknown) => void)[] = [];
+ const exports = {} as typeof import("./menuMouseScroll");
+ runInNewContext(compiled, {
+ exports,
+ window: {siyuan},
+ document: {querySelectorAll: () => [input]},
+ require: () => ({
+ Constants: {LOCAL_MENU_MOUSE_SCROLL: "scroll"},
+ getFrontend: () => frontend,
+ isInMobileApp: () => mobileApp,
+ setStorageVal: (...args: unknown[]) => saved.push(args),
+ fetchSyncPost: () => new Promise(resolve => requests.push(resolve)),
+ }),
+ });
+ return {api: exports, input, storage, siyuan, saved, requests};
+};
+
+test("existing workspaces keep mouse scrolling off and persist explicit choices through workspace storage", () => {
+ const f = fixture();
+ for (const value of [undefined, null, false, "true", 1]) {
+ f.storage.scroll = value;
+ assert.equal(f.api.isMenuMouseScrollEnabled(), false);
+ }
+ f.api.setMenuMouseScrollEnabled(true);
+ assert.deepEqual(f.saved, [["scroll", true]]);
+ assert.equal(f.input.checked, true);
+ delete f.storage.scroll;
+ f.api.onMenuMouseScrollStorageChanged("scroll");
+ assert.equal(f.input.checked, false);
+ f.api.setMenuMouseScrollEnabled(false);
+ assert.equal(f.storage.scroll, false);
+});
+
+test("new workspace defaults supplied by storage enable scrolling and remain subject to the user's choice", async () => {
+ const f = fixture();
+ const refresh = f.api.refreshMenuMouseScroll();
+ f.requests.shift()({code: 0, data: {scroll: true}});
+ await refresh;
+ assert.equal(f.api.isMenuMouseScrollEnabled(), true);
+ assert.equal(f.input.checked, true);
+ assert.equal(f.saved.length, 0);
+ f.api.setMenuMouseScrollEnabled(false);
+ assert.equal(f.api.isMenuMouseScrollEnabled(), false);
+ assert.equal(f.input.checked, false);
+ assert.deepEqual(f.saved, [["scroll", false]]);
+});
+
+test("menu mouse scrolling is available on desktop frontends and preserves mobile and readonly preferences", async () => {
+ for (const frontend of ["desktop", "desktop-window", "browser-desktop"]) {
+ assert.equal(fixture(frontend).api.isMenuMouseScrollAvailable(), true);
+ }
+ for (const [frontend, mobileApp] of [["mobile", false], ["browser-mobile", false], ["browser-desktop", true]] as const) {
+ const f = fixture(frontend, mobileApp);
+ f.storage.scroll = true;
+ f.api.setMenuMouseScrollEnabled(false);
+ await f.api.refreshMenuMouseScroll();
+ assert.equal(f.api.isMenuMouseScrollEnabled(), false);
+ assert.equal(f.storage.scroll, true);
+ assert.equal(f.saved.length, 0);
+ assert.equal(f.requests.length, 0);
+ }
+ for (const publish of [false, true]) {
+ const f = fixture();
+ f.siyuan.config.readonly = !publish;
+ f.siyuan.isPublish = publish;
+ f.api.setMenuMouseScrollEnabled(true);
+ assert.equal(f.saved.length, 0);
+ assert.equal(f.storage.scroll, undefined);
+ }
+});
+
+test("reconnection restores the preference without overwriting newer pushes or closed settings windows", async () => {
+ const f = fixture();
+ const refresh = f.api.refreshMenuMouseScroll();
+ f.requests.shift()({code: 0, data: {scroll: true}});
+ await refresh;
+ assert.equal(f.api.isMenuMouseScrollEnabled(), true);
+ const stale = f.api.refreshMenuMouseScroll();
+ f.api.setMenuMouseScrollEnabled(false);
+ f.requests.shift()({code: 0, data: {scroll: true}});
+ await stale;
+ assert.equal(f.api.isMenuMouseScrollEnabled(), false);
+ let active = true;
+ const closed = f.api.refreshMenuMouseScroll(() => active);
+ active = false;
+ f.requests.shift()({code: 0, data: {scroll: true}});
+ await closed;
+ assert.equal(f.api.isMenuMouseScrollEnabled(), false);
+});
diff --git a/app/src/config/tabs/menuMouseScroll.ts b/app/src/config/tabs/menuMouseScroll.ts
new file mode 100644
index 0000000000..ea9295b167
--- /dev/null
+++ b/app/src/config/tabs/menuMouseScroll.ts
@@ -0,0 +1,41 @@
+import {Constants} from "../../constants";
+import {isInMobileApp, setStorageVal} from "../../protyle/util/compatibility";
+import {getFrontend} from "../../util/functions";
+import {fetchSyncPost} from "../../util/fetch";
+
+let revision = 0;
+
+export const isMenuMouseScrollAvailable = () =>
+ !isInMobileApp() && ["desktop", "desktop-window", "browser-desktop"].includes(getFrontend());
+
+export const isMenuMouseScrollEnabled = () =>
+ isMenuMouseScrollAvailable() && window.siyuan.storage?.[Constants.LOCAL_MENU_MOUSE_SCROLL] === true;
+
+const syncControls = () => {
+ document.querySelectorAll<HTMLInputElement>('input[id="menuMouseScroll"]').forEach(input => {
+ input.checked = isMenuMouseScrollEnabled();
+ });
+};
+
+export const onMenuMouseScrollStorageChanged = (key: string) => {
+ if (key !== Constants.LOCAL_MENU_MOUSE_SCROLL) return;
+ revision++;
+ syncControls();
+};
+
+export const setMenuMouseScrollEnabled = (enabled: boolean) => {
+ if (!isMenuMouseScrollAvailable() || window.siyuan.config.readonly || window.siyuan.isPublish) return;
+ window.siyuan.storage[Constants.LOCAL_MENU_MOUSE_SCROLL] = enabled;
+ onMenuMouseScrollStorageChanged(Constants.LOCAL_MENU_MOUSE_SCROLL);
+ return setStorageVal(Constants.LOCAL_MENU_MOUSE_SCROLL, enabled);
+};
+
+// 重连时补齐离线期间的偏好变更,保留较新操作和推送的结果。
+export const refreshMenuMouseScroll = async (isActive = () => true) => {
+ if (!isMenuMouseScrollAvailable() || !isActive()) return;
+ const currentRevision = ++revision;
+ const response = await fetchSyncPost("/api/storage/getLocalStorage");
+ if (!isActive() || currentRevision !== revision || response.code !== 0) return;
+ window.siyuan.storage[Constants.LOCAL_MENU_MOUSE_SCROLL] = response.data[Constants.LOCAL_MENU_MOUSE_SCROLL] === true;
+ syncControls();
+};
diff --git a/app/src/constants.ts b/app/src/constants.ts
index 5166b3228c..252e8073c0 100644
--- a/app/src/constants.ts
+++ b/app/src/constants.ts
@@ -221,6 +221,7 @@ export abstract class Constants {
public static readonly LOCAL_AV_CALENDAR_MODES = "local-av-calendar-modes";
public static readonly LOCAL_TABS_READING = "local-tabs-reading";
public static readonly LOCAL_COMPACT_MODE = "local-compact-mode";
+ public static readonly LOCAL_MENU_MOUSE_SCROLL = "local-menu-mouse-scroll";
// dialog
public static readonly DIALOG_CONFIRM = "dialog-confirm";
diff --git a/app/src/index.ts b/app/src/index.ts
index a8528ce901..1f6c0939af 100644
--- a/app/src/index.ts
+++ b/app/src/index.ts
@@ -2,6 +2,7 @@ import {Constants} from "./constants";
import {refreshSettingConfig} from "./config/setting/sync";
import {onAgentStreamingMarkdownStorageChanged} from "./config/tabs/ai/agentStreamingMarkdown";
import {onCompactModeStorageChanged, refreshCompactMode} from "./config/tabs/compactMode";
+import {onMenuMouseScrollStorageChanged, refreshMenuMouseScroll} from "./config/tabs/menuMouseScroll";
import {closeNotebookHistoryDialogs} from "./history/notebookDialogs";
import {systemConfig} from "./config/systemConfig";
import {openStandaloneDatabaseItemByURI} from "./protyle/render/av/openStandaloneDatabaseItem";
@@ -93,6 +94,7 @@ export class App {
callback: () => {
if (window.siyuan.isReady) {
void refreshCompactMode().catch(error => console.error("Could not refresh compact mode", error));
+ void refreshMenuMouseScroll().catch(error => console.error("Could not refresh menu mouse scrolling", error));
}
},
msgCallback: (data) => {
@@ -184,6 +186,7 @@ export class App {
window.siyuan.storage[data.data.key] = data.data.val;
onAgentStreamingMarkdownStorageChanged(data.data.key);
onCompactModeStorageChanged(data.data.key);
+ onMenuMouseScrollStorageChanged(data.data.key);
}
break;
case "setLocalStorageVals":
@@ -191,18 +194,21 @@ export class App {
window.siyuan.storage[k] = data.data.keyVals[k];
onAgentStreamingMarkdownStorageChanged(k);
onCompactModeStorageChanged(k);
+ onMenuMouseScrollStorageChanged(k);
});
break;
case "removeLocalStorageVal":
delete window.siyuan.storage[data.data.key];
onAgentStreamingMarkdownStorageChanged(data.data.key);
onCompactModeStorageChanged(data.data.key);
+ onMenuMouseScrollStorageChanged(data.data.key);
break;
case "removeLocalStorageVals":
data.data.keys.forEach((k: string) => {
delete window.siyuan.storage[k];
onAgentStreamingMarkdownStorageChanged(k);
onCompactModeStorageChanged(k);
+ onMenuMouseScrollStorageChanged(k);
});
break;
case "rename":
diff --git a/app/src/menus/Menu.ts b/app/src/menus/Menu.ts
index 6b561eb750..eb78f5ae3f 100644
--- a/app/src/menus/Menu.ts
+++ b/app/src/menus/Menu.ts
@@ -1,7 +1,8 @@
-import {getEventName, updateHotkeyTip} from "../protyle/util/compatibility";
+import {getEventName, isInMobileApp, updateHotkeyTip} from "../protyle/util/compatibility";
import {setPosition} from "../util/setPosition";
import {isScrollAboveMenu} from "../util/zIndex";
import {getAnchoredMenuPosition} from "./menuPosition";
+import {bindMenuMouseScroll} from "./menuMouseScroll";
import {updateMenuGroupsOnMutation, updateMenuItemGroupClasses} from "./menuGroup";
import {getVisibleSheetViewport, waitForSheetViewport} from "./sheetOpen";
import {hasClosestByClassName} from "../protyle/util/hasClosest";
@@ -33,6 +34,7 @@ export class Menu {
public element: HTMLElement;
public data: any; // 用于记录当前菜单的数据
public removeCB: () => void;
+ private clearMouseScroll: () => void;
private wheelEvent: string;
private position: IPosition;
private sheetTouchStartX: number | undefined;
@@ -61,6 +63,10 @@ export class Menu {
this.preventDefault = this.preventDefault.bind(this);
this.element = element || document.getElementById("commonMenu");
+ if (!isMobile()) {
+ this.clearMouseScroll = bindMenuMouseScroll(this.element, () =>
+ !isInMobileApp() && window.siyuan.storage?.[Constants.LOCAL_MENU_MOUSE_SCROLL] === true);
+ }
// 内容增删或文字变化后重新定位;不监听分组类和定位样式,避免更新触发循环。
new MutationObserver((records) => {
updateMenuGroupsOnMutation(records);
@@ -153,6 +159,7 @@ export class Menu {
}
itemElement.classList.add("b3-menu__item--show");
if (!isSubMenuShown) {
+ itemElement.dispatchEvent(new CustomEvent(CUSTOM_EVENT_LOAD_SUBMENU));
if (this.element.classList.contains("b3-menu--sheet")) {
this.setSheetHeight();
} else if (!this.element.classList.contains("b3-menu--fullscreen")) {
@@ -162,6 +169,10 @@ export class Menu {
});
}
+ public resetMouseScroll() {
+ this.clearMouseScroll?.();
+ }
+
private getFullscreenScrim() {
if (this.element.id !== "commonMenu") {
return;
@@ -530,6 +541,7 @@ export class Menu {
}
private removeImmediately() {
+ this.resetMouseScroll();
// 菜单动作和菜单替换只清理状态,避免跳转或弹窗后抢回编辑焦点。
this.restoreKeyboard = undefined;
this.preserveSheetKeyboard = false;
@@ -584,6 +596,7 @@ export class Menu {
}
public popup(options: IPosition) {
+ this.resetMouseScroll();
this.cancelSheetOpen?.();
this.cancelSheetOpen = undefined;
if (isMobile()) {
@@ -645,11 +658,15 @@ export class Menu {
this.position.h = rect.height;
this.position.w = rect.width;
}
+ const scrollPositions = Array.from(this.element.querySelectorAll<HTMLElement>(".b3-menu__items"),
+ items => ({items, top: items.scrollTop}));
this.setPopupPosition();
this.element.querySelectorAll(".b3-menu__item--show > .b3-menu__submenu").forEach((item: HTMLElement) => {
// 可能有多层子菜单,都要重新定位
this.showSubMenu(item);
});
+ // 测量时会临时取消限高,恢复滚动位置以保留异步菜单加载期间的浏览进度。
+ scrollPositions.forEach(({items, top}) => { items.scrollTop = top; });
}
private startTrackingTargetPosition() {
@@ -946,6 +963,7 @@ export const bindMenuKeydown = (event: KeyboardEvent) => {
if (window.siyuan.menus.menu.element.classList.contains("fn__none") || event.isComposing) {
return false;
}
+ window.siyuan.menus.menu.resetMouseScroll?.();
const target = event.target as HTMLElement;
const eventCode = Constants.KEYCODELIST[event.keyCode];
if (window.siyuan.menus.menu.element.contains(target) && ["INPUT", "TEXTAREA"].includes(target.tagName)) {
diff --git a/app/src/menus/menuLayout.dom.test.ts b/app/src/menus/menuLayout.dom.test.ts
index 6763fd240a..f00175bf18 100644
--- a/app/src/menus/menuLayout.dom.test.ts
+++ b/app/src/menus/menuLayout.dom.test.ts
@@ -13,11 +13,13 @@ const browserCases = async (sources: Record<string, string>, css: string) => {
let mobile = false;
const modules: Record<string, {exports: any}> = {};
const externals = {
- "protyle/util/compatibility": {getEventName: () => "click", updateHotkeyTip: (value: string) => value},
+ "protyle/util/compatibility": {getEventName: () => "click", isInMobileApp: () => false,
+ updateHotkeyTip: (value: string) => value},
"util/functions": {isMobile: () => mobile},
"util/zIndex": {isScrollAboveMenu: () => false},
"layout/getTopBarHeight": {getTopBarHeight: () => 32},
- constants: {Constants: {TIMEOUT_DBLCLICK: 10, ATTRIBUTE_MENU_KEYMAP: "data-keymap"}},
+ constants: {Constants: {TIMEOUT_DBLCLICK: 10, ATTRIBUTE_MENU_KEYMAP: "data-keymap",
+ LOCAL_MENU_MOUSE_SCROLL: "menuMouseScroll"}},
"protyle/undo": {electronUndo() {}},
"util/escape": {escapeAttr: (value: string) => value},
"menus/menuKeyboard": {setMenuInputCurrent() {}},
@@ -59,7 +61,7 @@ const browserCases = async (sources: Record<string, string>, css: string) => {
.fn__none { display: none !important; }
`;
document.head.append(style);
- Object.assign(window, {siyuan: {languages: {back: "Back"}, zIndex: 0,
+ Object.assign(window, {siyuan: {languages: {back: "Back"}, zIndex: 0, storage: {},
mobile: {size: {portrait: {height1: innerHeight}}}, menus: {}}});
const {Menu, MenuItem}: typeof import("./Menu") = load("menus/Menu");
const {Menu: PluginMenu}: typeof import("../plugin/Menu") = load("plugin/Menu");
@@ -216,6 +218,166 @@ const browserCases = async (sources: Record<string, string>, css: string) => {
check.equal(independent.element.isConnected, false);
dispose(shared);
+ const pointer = (element: HTMLElement, ratio: number, pointerType = "mouse", buttons = 0) => {
+ const rect = element.getBoundingClientRect();
+ const x = rect.left + rect.width / 2;
+ const y = rect.top + rect.height * ratio;
+ const target = document.elementFromPoint(x, y);
+ check.ok(target && element.contains(target), "Pointer must hit the intended menu panel");
+ target.dispatchEvent(new PointerEvent("pointermove", {bubbles: true, pointerType, buttons, clientX: x, clientY: y}));
+ return {x, y};
+ };
+ const following = createMenu();
+ let clicked = -1;
+ for (let i = 0; i < 80; i++) {
+ following.addItem({label: `Mouse item ${i}`, click: () => { clicked = i; return true; }});
+ }
+ following.popup({x: 60, y: 40});
+ await settle();
+ const followingItems = following.element.lastElementChild as HTMLElement;
+ const maxScroll = () => followingItems.scrollHeight - followingItems.clientHeight;
+ pointer(followingItems, .3);
+ pointer(followingItems, .6);
+ check.equal(followingItems.scrollTop, 0, "The preference defaults to off");
+ window.siyuan.storage.menuMouseScroll = true;
+ pointer(followingItems, .3);
+ check.equal(followingItems.scrollTop, 0, "Entering establishes an anchor without jumping");
+ pointer(followingItems, .55);
+ const middleScroll = followingItems.scrollTop;
+ check.ok(middleScroll > 0 && middleScroll < maxScroll(), "Movement in the middle of the menu scrolls its contents");
+ const middlePoint = pointer(followingItems, .55);
+ await settle();
+ check.equal(followingItems.scrollTop, middleScroll, "A stationary pointer does not keep scrolling");
+ const hit = document.elementFromPoint(middlePoint.x, middlePoint.y).closest<HTMLElement>(".b3-menu__item");
+ check.ok(hit.classList.contains("b3-menu__item--current"), "Highlight follows the item under the pointer after scrolling");
+ hit.click();
+ check.equal(clicked, Number(hit.textContent.trim().replace("Mouse item ", "")), "Click activates the highlighted item");
+ pointer(followingItems, .8);
+ check.ok(followingItems.scrollTop > middleScroll);
+ pointer(followingItems, .55);
+ check.ok(Math.abs(followingItems.scrollTop - middleScroll) <= 1, "Reversing direction scrolls back");
+ pointer(followingItems, .99);
+ check.equal(followingItems.scrollTop, maxScroll(), "The last item is reachable");
+ pointer(followingItems, .01);
+ check.equal(followingItems.scrollTop, 0, "The first item is reachable");
+ pointer(followingItems, .5, "touch");
+ pointer(followingItems, .8, "touch");
+ check.equal(followingItems.scrollTop, 0, "Touch movement preserves native scrolling");
+ pointer(followingItems, .3);
+ pointer(followingItems, .7, "mouse", 1);
+ check.equal(followingItems.scrollTop, 0, "Dragging does not scroll the menu");
+ pointer(followingItems, .3);
+ pointer(followingItems, .55);
+ followingItems.scrollTop = 100;
+ followingItems.dispatchEvent(new WheelEvent("wheel", {bubbles: true, deltaY: -30}));
+ pointer(followingItems, .6);
+ check.equal(followingItems.scrollTop, 100, "Wheel scrolling establishes a new anchor");
+ pointer(followingItems, .7);
+ const beforeLeave = followingItems.scrollTop;
+ following.element.dispatchEvent(new PointerEvent("pointerleave"));
+ pointer(followingItems, .4);
+ check.equal(followingItems.scrollTop, beforeLeave, "Reentering does not jump");
+ following.addItem({label: "Loaded later"});
+ await settle();
+ check.equal(followingItems.scrollTop, beforeLeave, "Layout measurement preserves the existing scroll position");
+ const beforeMutationMove = followingItems.scrollTop;
+ pointer(followingItems, .6);
+ check.equal(followingItems.scrollTop, beforeMutationMove, "Dynamic content establishes a new anchor");
+ window.siyuan.storage.menuMouseScroll = false;
+ pointer(followingItems, .8);
+ check.equal(followingItems.scrollTop, beforeMutationMove, "Disabling takes effect on an open menu");
+ window.siyuan.storage.menuMouseScroll = true;
+ followingItems.scrollTop = 0;
+ following.resetMouseScroll();
+ const nativePointer = (type: string, x: number, y: number) =>
+ require("electron").ipcRenderer.invoke("menu-test-pointer", type, Math.round(x), Math.round(y));
+ await nativePointer("mouseMove", 0, 0);
+ await settle();
+ const nativeRect = followingItems.getBoundingClientRect();
+ const nativeX = nativeRect.left + nativeRect.width / 2;
+ await nativePointer("mouseMove", nativeX, nativeRect.top + nativeRect.height * .3);
+ await settle();
+ const nativeY = nativeRect.top + nativeRect.height * .55;
+ await nativePointer("mouseMove", nativeX, nativeY);
+ await settle();
+ check.ok(followingItems.scrollTop > 0, "Real browser mouse movement scrolls the whole menu");
+ const nativeHit = document.elementFromPoint(Math.round(nativeX), Math.round(nativeY)).closest<HTMLElement>(".b3-menu__item");
+ check.ok(nativeHit.classList.contains("b3-menu__item--current"), "Native hover matches the scrolled target");
+ await nativePointer("mouseDown", nativeX, nativeY);
+ await nativePointer("mouseUp", nativeX, nativeY);
+ check.equal(clicked, Number(nativeHit.textContent.trim().replace("Mouse item ", "")), "Native click selects the visible item");
+ dispose(following);
+
+ window.siyuan.storage.menuMouseScroll = true;
+ const mouseSubmenus = createMenu();
+ mouseSubmenus.addItem({label: "Scrollable children", submenu: Array.from({length: 80}, (_, i) => ({label: `Child ${i}`}))});
+ addItems(mouseSubmenus, 50);
+ mouseSubmenus.popup({x: 40, y: 40});
+ await settle();
+ const mouseParent = mouseSubmenus.element.lastElementChild.firstElementChild;
+ mouseParent.dispatchEvent(new MouseEvent("mouseover", {bubbles: true}));
+ const mouseSubmenu = mouseParent.querySelector<HTMLElement>(".b3-menu__submenu");
+ const mouseChildren = mouseSubmenu.lastElementChild as HTMLElement;
+ pointer(mouseChildren, .3);
+ pointer(mouseChildren, .65);
+ check.ok(mouseChildren.scrollTop > 0, "Submenus support movement across their own visible area");
+ const mouseRootItems = mouseSubmenus.element.lastElementChild as HTMLElement;
+ check.equal(mouseRootItems.scrollTop, 0, "Moving within a submenu leaves its parent stationary");
+ pointer(mouseRootItems, .3);
+ pointer(mouseRootItems, .65);
+ check.ok(mouseRootItems.scrollTop > 0);
+ check.equal(mouseParent.classList.contains("b3-menu__item--show"), false, "Scrolling the parent closes its detached submenu");
+ dispose(mouseSubmenus);
+
+ const lazyMouse = createMenu();
+ for (let i = 0; i < 60; i++) {
+ lazyMouse.addItem({label: `Lazy ${i}`, loadSubmenu: async () => [{label: `Loaded ${i}`}]});
+ }
+ lazyMouse.popup({x: 40, y: 40});
+ await settle();
+ const lazyItems = lazyMouse.element.lastElementChild as HTMLElement;
+ pointer(lazyItems, .3);
+ pointer(lazyItems, .6);
+ await settle();
+ const lazyScroll = lazyItems.scrollTop;
+ check.ok(lazyScroll > 0, "Asynchronous submenu loading preserves the parent's scroll position");
+ const loadedMenu = lazyItems.querySelector(".b3-menu__item--show > .b3-menu__submenu");
+ check.match(loadedMenu.textContent, /Loaded \d+/, "The item under a scrolled pointer loads its asynchronous submenu");
+ pointer(lazyItems, .75);
+ check.ok(lazyItems.scrollTop > lazyScroll, "Loading a child does not interrupt scrolling of its unchanged parent");
+ dispose(lazyMouse);
+
+ const form = createMenu();
+ form.addItem({type: "empty", label: '<input class="b3-text-field" style="height:32px"><div style="height:80px;overflow:auto"><div style="height:400px">Custom list</div></div>'});
+ addItems(form, 50);
+ form.popup({x: 40, y: 40});
+ await settle();
+ const formItems = form.element.lastElementChild as HTMLElement;
+ const input = formItems.querySelector("input");
+ input.focus();
+ pointer(formItems, .4);
+ pointer(formItems, .7);
+ check.equal(formItems.scrollTop, 0, "Editing a menu input keeps the form stationary");
+ input.blur();
+ const customList = input.nextElementSibling as HTMLElement;
+ pointer(customList, .2);
+ pointer(customList, .7);
+ check.equal(formItems.scrollTop, 0, "Nested scrollable widgets keep their own interaction");
+ dispose(form);
+
+ const pluginShared = createMenu();
+ const followingPlugin = new PluginMenu(undefined, undefined, true);
+ for (let i = 0; i < 80; i++) followingPlugin.addItem({label: `Plugin scroll ${i}`});
+ followingPlugin.open({x: 40, y: 40});
+ await settle();
+ const pluginItems = followingPlugin.element.lastElementChild as HTMLElement;
+ pointer(pluginItems, .3);
+ pointer(pluginItems, .7);
+ check.ok(pluginItems.scrollTop > 0, "Independent plugin menus share the same mouse scrolling behavior");
+ followingPlugin.close();
+ check.equal(followingPlugin.element.isConnected, false);
+ dispose(pluginShared);
+
mobile = true;
const sheet = createMenu();
sheet.element.classList.add("b3-menu--fit");
@@ -228,6 +390,10 @@ const browserCases = async (sources: Record<string, string>, css: string) => {
sheet.resetPosition = () => { sheetResets++; resetSheet(); };
addItems(sheet, 10);
await settle();
+ const sheetItems = sheet.element.lastElementChild as HTMLElement;
+ pointer(sheetItems, .3);
+ pointer(sheetItems, .7);
+ check.equal(sheetItems.scrollTop, 0, "Mobile sheets ignore mouse-follow scrolling even with a saved preference");
check.ok(sheet.element.getBoundingClientRect().height > sheetHeight);
check.ok(sheet.element.getBoundingClientRect().height <= innerHeight * .9 + .5);
check.equal(sheetResets, 1);
@@ -242,11 +408,11 @@ const browserCases = async (sources: Record<string, string>, css: string) => {
return "Menu layout cases passed";
};
-test("menus adapt to dynamic content, viewport changes, themes and mobile sheets", {
+test("menus adapt to layout changes and optional whole-menu mouse scrolling", {
skip: process.platform === "linux" && !process.env.DISPLAY && !process.env.WAYLAND_DISPLAY,
timeout: 45000,
}, async () => {
- const sources = Object.fromEntries(["menus/Menu", "menus/menuPosition", "menus/menuGroup", "menus/sheetOpen",
+ const sources = Object.fromEntries(["menus/Menu", "menus/menuPosition", "menus/menuMouseScroll", "menus/menuGroup", "menus/sheetOpen",
"util/setPosition", "protyle/util/hasClosest", "plugin/Menu"].map(name => [name,
transpileModule(readFileSync(path.join(__dirname, "..", name + ".ts"), "utf8"), {
compilerOptions: {target: ScriptTarget.ES2021, module: ModuleKind.CommonJS},
@@ -262,6 +428,8 @@ app.whenReady().then(async () => {
const win = new BrowserWindow({show: false, width: 1000, height: 800, useContentSize: true,
webPreferences: {nodeIntegration: true, contextIsolation: false, offscreen: true, backgroundThrottling: false}});
ipcMain.handle("resize-menu-test", (_event, width, height) => win.setContentSize(width, height));
+ ipcMain.handle("menu-test-pointer", (event, type, x, y) =>
+ event.sender.sendInputEvent({type, x, y, button: "left", clickCount: 1}));
try {
await win.loadURL("about:blank");
console.log(await win.webContents.executeJavaScript(${JSON.stringify(source)}));
diff --git a/app/src/menus/menuMouseScroll.ts b/app/src/menus/menuMouseScroll.ts
new file mode 100644
index 0000000000..253037f49c
--- /dev/null
+++ b/app/src/menus/menuMouseScroll.ts
@@ -0,0 +1,75 @@
+interface IMouseScrollAnchor {
+ items: HTMLElement;
+ y: number;
+ lastY: number;
+ scrollTop: number;
+ currentScrollTop: number;
+ top: number;
+ height: number;
+ scrollHeight: number;
+}
+
+export const bindMenuMouseScroll = (menu: HTMLElement, enabled: () => boolean) => {
+ let anchor: IMouseScrollAnchor;
+ const reset = () => { anchor = undefined; };
+ const interactive = "input, textarea, select, [contenteditable=\"true\"], [draggable=\"true\"]";
+ menu.addEventListener("pointermove", (event: PointerEvent) => {
+ if (!enabled() || event.pointerType !== "mouse" || event.buttons !== 0 || !menu.isConnected ||
+ menu.classList.contains("fn__none") || menu.classList.contains("b3-menu--fullscreen")) {
+ reset();
+ return;
+ }
+ const target = event.target as Element;
+ const panel = target.closest(".b3-menu__submenu, .b3-menu");
+ const items = panel?.querySelector<HTMLElement>(":scope > .b3-menu__items");
+ if (!items || !menu.contains(items) || target.closest(interactive) ||
+ (items.contains(document.activeElement) && document.activeElement.matches(interactive))) {
+ reset();
+ return;
+ }
+ // 自定义表单和嵌套滚动列表保留各自的鼠标操作。
+ for (let element = target; element && element !== panel; element = element.parentElement) {
+ if (element !== items && element.scrollHeight > element.clientHeight + 1 &&
+ ["auto", "scroll", "overlay"].includes(getComputedStyle(element).overflowY)) {
+ reset();
+ return;
+ }
+ }
+ const rect = items.getBoundingClientRect();
+ const maxScroll = items.scrollHeight - items.clientHeight;
+ if (maxScroll <= 1 || rect.height <= 1 || event.clientX < rect.left || event.clientX > rect.right ||
+ !["auto", "scroll", "overlay"].includes(getComputedStyle(items).overflowY)) {
+ reset();
+ return;
+ }
+ if (!anchor || anchor.items !== items || anchor.top !== rect.top || anchor.height !== rect.height ||
+ anchor.scrollHeight !== items.scrollHeight || Math.abs(anchor.currentScrollTop - items.scrollTop) > 1) {
+ // 进入菜单或其他操作改变滚动位置后建立基准,首次移动不跳转。
+ anchor = {items, y: event.clientY, lastY: event.clientY, scrollTop: items.scrollTop,
+ currentScrollTop: items.scrollTop, top: rect.top, height: rect.height, scrollHeight: items.scrollHeight};
+ return;
+ }
+ if (event.clientY === anchor.lastY) return;
+ anchor.lastY = event.clientY;
+ // 两端留出菜单项的点击空间;整个可见区域按移动距离映射到剩余内容。
+ const inset = Math.min(24, rect.height / 4);
+ const distance = event.clientY - anchor.y;
+ const progress = Math.min(1, Math.abs(distance) / Math.max(1,
+ distance > 0 ? rect.bottom - inset - anchor.y : anchor.y - rect.top - inset));
+ const previousScrollTop = items.scrollTop;
+ items.scrollTop = anchor.scrollTop + (distance > 0 ? maxScroll - anchor.scrollTop : -anchor.scrollTop) * progress;
+ anchor.currentScrollTop = items.scrollTop;
+ if (items.scrollTop === previousScrollTop) return;
+ items.querySelectorAll(".b3-menu__item--show").forEach(item => item.classList.remove("b3-menu__item--show"));
+ // 滚动后按实际命中项更新高亮和子菜单,保持点击目标与视觉反馈一致。
+ const hovered = document.elementFromPoint(event.clientX, event.clientY);
+ if (hovered && items.contains(hovered)) {
+ hovered.dispatchEvent(new MouseEvent("mouseover", {bubbles: true, clientX: event.clientX, clientY: event.clientY}));
+ }
+ });
+ menu.addEventListener("pointerleave", reset);
+ menu.addEventListener("pointerdown", reset, true);
+ menu.addEventListener("wheel", reset, {passive: true, capture: true});
+ menu.addEventListener("keydown", reset, true);
+ return reset;
+};
diff --git a/app/src/window/index.ts b/app/src/window/index.ts
index de376a81b1..1abb3bfea9 100644
--- a/app/src/window/index.ts
+++ b/app/src/window/index.ts
@@ -4,6 +4,7 @@ import {Constants} from "../constants";
import {refreshSettingConfig} from "../config/setting/sync";
import {onAgentStreamingMarkdownStorageChanged} from "../config/tabs/ai/agentStreamingMarkdown";
import {onCompactModeStorageChanged, refreshCompactMode} from "../config/tabs/compactMode";
+import {onMenuMouseScrollStorageChanged, refreshMenuMouseScroll} from "../config/tabs/menuMouseScroll";
import {systemConfig} from "../config/systemConfig";
import {Menus} from "../menus";
import {Model} from "../layout/Model";
@@ -65,6 +66,7 @@ class App {
callback: () => {
if (window.siyuan.isReady) {
void refreshCompactMode().catch(error => console.error("Could not refresh compact mode", error));
+ void refreshMenuMouseScroll().catch(error => console.error("Could not refresh menu mouse scrolling", error));
}
},
msgCallback: (data) => {
@@ -136,6 +138,7 @@ class App {
window.siyuan.storage[data.data.key] = data.data.val;
onAgentStreamingMarkdownStorageChanged(data.data.key);
onCompactModeStorageChanged(data.data.key);
+ onMenuMouseScrollStorageChanged(data.data.key);
onWindowWorkspaceStorageChanged(data.data.key);
}
break;
@@ -144,6 +147,7 @@ class App {
window.siyuan.storage[k] = data.data.keyVals[k];
onAgentStreamingMarkdownStorageChanged(k);
onCompactModeStorageChanged(k);
+ onMenuMouseScrollStorageChanged(k);
onWindowWorkspaceStorageChanged(k);
});
break;
@@ -151,6 +155,7 @@ class App {
delete window.siyuan.storage[data.data.key];
onAgentStreamingMarkdownStorageChanged(data.data.key);
onCompactModeStorageChanged(data.data.key);
+ onMenuMouseScrollStorageChanged(data.data.key);
onWindowWorkspaceStorageChanged(data.data.key);
break;
case "removeLocalStorageVals":
@@ -158,6 +163,7 @@ class App {
delete window.siyuan.storage[k];
onAgentStreamingMarkdownStorageChanged(k);
onCompactModeStorageChanged(k);
+ onMenuMouseScrollStorageChanged(k);
onWindowWorkspaceStorageChanged(k);
});
break;
diff --git a/app/tests/settingsNotifications.test.js b/app/tests/settingsNotifications.test.js
index 72df77a0af..acdc8b8814 100644
--- a/app/tests/settingsNotifications.test.js
+++ b/app/tests/settingsNotifications.test.js
@@ -55,6 +55,7 @@ for (const file of ["src/index.ts", "src/window/index.ts", "src/mobile/util/onMe
export const receive = data => {switch(data.cmd){${clauses.join("\n")}}};`), {
exports: receiver, window, ...preference,
onCompactModeStorageChanged() {},
+ onMenuMouseScrollStorageChanged() {},
onWindowWorkspaceStorageChanged: key => platformCalls.push(key),
MOBILE_BARS_CONFIG_KEY: "mobile-bars", Constants: {LOCAL_MOBILE_BOTTOM_BAR: "mobile-bottom", LOCAL_MOBILE_SIDE_PANEL: "mobile-side"},
showMobileBars: () => platformCalls.push("bars"), renderMobileBottomBar: () => platformCalls.push("bottom"),
diff --git a/kernel/model/conf.go b/kernel/model/conf.go
index e75d53ec45..8819ae3d09 100644
--- a/kernel/model/conf.go
+++ b/kernel/model/conf.go
@@ -476,6 +476,9 @@ func InitConf() {
}
if boxes, listErr := ListNotebooks(); listErr == nil {
prepareOnboardingForEmptyWorkspace(Conf.Onboarding.Load(), util.ReadOnly, len(boxes))
+ if err := initMenuMouseScrollPreference(confFileExists, len(boxes)); err != nil {
+ logging.LogWarnf("initialize menu mouse scrolling preference failed: %s", err)
+ }
}
if 0 < len(Conf.Repo.Load().Key) {
diff --git a/kernel/model/menu_mouse_scroll_test.go b/kernel/model/menu_mouse_scroll_test.go
new file mode 100644
index 0000000000..6f3baea2a0
--- /dev/null
+++ b/kernel/model/menu_mouse_scroll_test.go
@@ -0,0 +1,89 @@
+package model
+
+import (
+ "bytes"
+ "os"
+ "path/filepath"
+ "testing"
+
+ "github.com/siyuan-note/siyuan/kernel/util"
+)
+
+func TestInitMenuMouseScrollPreference(t *testing.T) {
+ const key = "local-menu-mouse-scroll"
+ for _, test := range []struct {
+ name string
+ confFileExists bool
+ notebookCount int
+ readOnly bool
+ storage string
+ wantEnabled bool
+ wantUnchanged bool
+ wantError bool
+ }{
+ {name: "new empty workspace", wantEnabled: true},
+ {name: "existing empty workspace", confFileExists: true, wantUnchanged: true},
+ {name: "existing notebooks without configuration", notebookCount: 1, wantUnchanged: true},
+ {name: "readonly workspace", readOnly: true, wantUnchanged: true},
+ {name: "explicitly disabled", storage: `{"local-menu-mouse-scroll":false}`, wantUnchanged: true},
+ {name: "explicitly enabled", storage: `{"local-menu-mouse-scroll":true}`, wantEnabled: true, wantUnchanged: true},
+ {name: "existing enabled workspace", confFileExists: true, storage: `{"local-menu-mouse-scroll":true}`,
+ wantEnabled: true, wantUnchanged: true},
+ {name: "existing preferences", storage: `{"other-preference":"saved"}`, wantEnabled: true},
+ {name: "invalid preference preserved", storage: `{"local-menu-mouse-scroll":"true"}`, wantUnchanged: true},
+ {name: "corrupt storage", storage: `{"other-preference":`, wantUnchanged: true, wantError: true},
+ {name: "null storage", storage: `null`, wantUnchanged: true, wantError: true},
+ } {
+ t.Run(test.name, func(t *testing.T) {
+ previousDataDir, previousReadOnly := util.DataDir, util.ReadOnly
+ util.DataDir, util.ReadOnly = t.TempDir(), test.readOnly
+ t.Cleanup(func() { util.DataDir, util.ReadOnly = previousDataDir, previousReadOnly })
+ storagePath := filepath.Join(util.DataDir, "storage", "local.json")
+ if test.storage != "" {
+ if err := os.MkdirAll(filepath.Dir(storagePath), 0755); err != nil {
+ t.Fatal(err)
+ }
+ if err := os.WriteFile(storagePath, []byte(test.storage), 0644); err != nil {
+ t.Fatal(err)
+ }
+ }
+ if err := initMenuMouseScrollPreference(test.confFileExists, test.notebookCount); (err != nil) != test.wantError {
+ t.Fatalf("initialization error = %v, wantError %v", err, test.wantError)
+ }
+ if test.wantUnchanged {
+ data, err := os.ReadFile(storagePath)
+ if test.storage == "" {
+ if !os.IsNotExist(err) {
+ t.Fatalf("unexpected storage file or error: %v", err)
+ }
+ } else if err != nil || !bytes.Equal(data, []byte(test.storage)) {
+ t.Fatalf("existing storage changed: %q, error %v", data, err)
+ }
+ }
+ if test.wantError {
+ return
+ }
+ storage, err := getLocalStorageWithError()
+ if err != nil {
+ t.Fatal(err)
+ }
+ if enabled, _ := storage[key].(bool); enabled != test.wantEnabled {
+ t.Fatalf("enabled = %v, want %v", storage[key], test.wantEnabled)
+ }
+ if test.name == "existing preferences" && storage["other-preference"] != "saved" {
+ t.Fatalf("unrelated preference was lost: %#v", storage)
+ }
+ if test.wantEnabled && !test.confFileExists {
+ if _, err = SetLocalStorageVals(map[string]any{key: false}); err != nil {
+ t.Fatal(err)
+ }
+ if err = initMenuMouseScrollPreference(false, 0); err != nil {
+ t.Fatal(err)
+ }
+ if storage = GetLocalStorage(); storage[key] != false {
+ t.Fatalf("initialization overwrote the user's later choice: %#v", storage)
+ }
+ }
+ })
+ }
+}
diff --git a/kernel/model/storage.go b/kernel/model/storage.go
index e83c8eed9e..6aeefce051 100644
--- a/kernel/model/storage.go
+++ b/kernel/model/storage.go
@@ -38,6 +38,29 @@ import (
var localStorageLock = sync.Mutex{}
+// 首次创建空工作空间时初始化菜单滚动偏好,保留已有工作空间和用户保存的选择。
+func initMenuMouseScrollPreference(confFileExists bool, notebookCount int) error {
+ if confFileExists || notebookCount != 0 || util.ReadOnly {
+ return nil
+ }
+ localStorageLock.Lock()
+ defer localStorageLock.Unlock()
+
+ storage, err := readLocalStorage()
+ if err != nil {
+ return err
+ }
+ if storage == nil {
+ return errors.New("local storage must be a JSON object")
+ }
+ const key = "local-menu-mouse-scroll"
+ if _, configured := storage[key]; configured {
+ return nil
+ }
+ storage[key] = true
+ return setLocalStorage(storage)
+}
+
func GetLocalStorage() (ret map[string]any) {
ret, _ = getLocalStorageWithError()
return