Skip to content

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

:sparkles: Support persistent mobile main menu group collapse https://github.com/siyuan-note/siyuan/issues/20435

Danielad10d4115d75
diff --git a/app/src/constants.ts b/app/src/constants.ts
index f5be52a630..183be87d04 100644
--- a/app/src/constants.ts
+++ b/app/src/constants.ts
@@ -188,6 +188,7 @@ export abstract class Constants {
public static readonly LOCAL_MOBILE_TABS = "local-mobile-tabs"; // only mobile
public static readonly LOCAL_MOBILE_BOTTOM_BAR = "local-mobile-bottom-bar"; // only mobile
public static readonly LOCAL_MOBILE_SIDE_PANEL = "local-mobile-side-panel"; // only mobile
+ public static readonly LOCAL_MOBILE_MENU_COLLAPSED = "local-mobile-menu-collapsed";
public static readonly LOCAL_DAILYNOTEID = "local-dailynoteid"; // string
public static readonly LOCAL_HISTORY = "local-history";
public static readonly LOCAL_CODELANG = "local-codelang"; // string
diff --git a/app/src/mobile/menu/index.ts b/app/src/mobile/menu/index.ts
index 8ca78d99a9..30bab48a5e 100644
--- a/app/src/mobile/menu/index.ts
+++ b/app/src/mobile/menu/index.ts
@@ -11,6 +11,7 @@ import {openDock} from "../dock/util";
import {escapeAttr, escapeHtml} from "../../util/escape";
import {processSync} from "../../dialog/processSystem";
import {afterLayoutReady} from "../../plugin/loader";
+import {syncMainMenuGroupCollapse, toggleMainMenuGroup} from "./mainMenuCollapse";
let mobileMenuReturnCallback: (() => void) | undefined;
@@ -68,6 +69,10 @@ const renderMobilePluginDockMenu = (app: App, menuElement: HTMLElement) => {
/** 分发单层元素的点击:handled 表示已响应,ignored 表示继续向上查找,abort 表示终止本次事件处理 */
const dispatchMobileMainMenuClick = (app: App, target: HTMLElement, search: IMainMenuSearch):
"handled" | "ignored" | "abort" => {
+ if (target.dataset.type === "toggle-menu-group") {
+ toggleMainMenuGroup(target);
+ return "handled";
+ }
if (target.dataset.type === "close-menu") {
closePanel();
return "handled";
@@ -101,6 +106,7 @@ const dispatchMobileMainMenuClick = (app: App, target: HTMLElement, search: IMai
export const initRightMenu = (app: App) => {
const menuElement = document.getElementById("menu");
menuElement.innerHTML = renderMobileMainMenuHTML();
+ syncMainMenuGroupCollapse(menuElement, false);
renderMobilePluginDockMenu(app, menuElement);
window.addEventListener(MOBILE_PLUGIN_DOCKS_CHANGE_EVENT, () => {
renderMobilePluginDockMenu(app, menuElement);
diff --git a/app/src/mobile/menu/mainMenu.ts b/app/src/mobile/menu/mainMenu.ts
index 0b505881fe..4273446b72 100644
--- a/app/src/mobile/menu/mainMenu.ts
+++ b/app/src/mobile/menu/mainMenu.ts
@@ -41,6 +41,7 @@ export type TMobileMainMenuSlot = "settingTabs" | "pluginTopBar" | "pluginDocks"
export type TMobileMainMenuEntry = IMobileMainMenuItem | TMobileMainMenuSlot;
export interface IMobileMainMenuGroup {
+ id: string;
title: () => string;
hidden?: () => boolean;
entries: TMobileMainMenuEntry[];
@@ -63,6 +64,7 @@ const dockItem = (id: string, dockType: string, icon: string, label: () => strin
});
export const MOBILE_MAIN_MENU_GROUPS: IMobileMainMenuGroup[] = [{
+ id: "navigation",
title: lang("mobileMenuNavigation"),
entries: [
dockItem("menuDocuments", "file", "iconFiles", lang("fileTree")),
@@ -157,6 +159,7 @@ export const MOBILE_MAIN_MENU_GROUPS: IMobileMainMenuGroup[] = [{
},
],
}, {
+ id: "create",
title: lang("mobileMenuCreate"),
hidden: isReadonly,
entries: [{
@@ -194,6 +197,7 @@ export const MOBILE_MAIN_MENU_GROUPS: IMobileMainMenuGroup[] = [{
},
}],
}, {
+ id: "data",
title: lang("mobileMenuDataManagement"),
hidden: isReadonly,
entries: [{
@@ -220,6 +224,7 @@ export const MOBILE_MAIN_MENU_GROUPS: IMobileMainMenuGroup[] = [{
},
}],
}, {
+ id: "extensions",
title: lang("extensions"),
entries: [{
id: "menuPlugin",
@@ -230,6 +235,7 @@ export const MOBILE_MAIN_MENU_GROUPS: IMobileMainMenuGroup[] = [{
},
}, "pluginTopBar", "pluginDocks"],
}, {
+ id: "settings",
title: lang("mobileMenuSettingsAndHelp"),
entries: ["settingTabs", {
id: "menuHelp",
@@ -302,9 +308,11 @@ const renderMobileMainMenuEntryHTML = (entry: TMobileMainMenuEntry) => {
};
const renderMobileMainMenuGroupHTML = (group: IMobileMainMenuGroup) =>
- `<div class="b3-menu__group${group.hidden?.() ? " fn__none" : ""}">
- <div class="b3-menu__group-title">${group.title()}</div>
- <div class="b3-menu__group-items">${group.entries.map(renderMobileMainMenuEntryHTML).join("")}</div>
+ `<div class="b3-menu__group${group.hidden?.() ? " fn__none" : ""}" data-menu-group="${group.id}">
+ <div class="b3-menu__group-title fn__flex"><span class="fn__flex-1">${group.title()}</span>
+ <button type="button" class="block__icon" data-type="toggle-menu-group" aria-expanded="true" aria-controls="mobile-menu-group-${group.id}" aria-label="${escapeAttr(window.siyuan.languages.collapse + " - " + group.title())}"><svg><use xlink:href="#iconDown"></use></svg></button>
+ </div>
+ <div id="mobile-menu-group-${group.id}" class="b3-menu__group-items">${group.entries.map(renderMobileMainMenuEntryHTML).join("")}</div>
</div>`;
/** 生成主菜单容器 `#menu` 的内容,分组与条目均由 `MOBILE_MAIN_MENU_GROUPS` 推导 */
diff --git a/app/src/mobile/menu/mainMenuCollapse.test.ts b/app/src/mobile/menu/mainMenuCollapse.test.ts
new file mode 100644
index 0000000000..4b2c7d86f4
--- /dev/null
+++ b/app/src/mobile/menu/mainMenuCollapse.test.ts
@@ -0,0 +1,57 @@
+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";
+
+test("mobile menu collapse persists independently and search temporarily reveals its items", () => {
+ const storage: Record<string, unknown> = {};
+ const writes: unknown[] = [];
+ const groups = ["navigation", "extensions"].map(id => {
+ let hidden = false;
+ const attributes = new Map<string, string>();
+ const group = {
+ dataset: {menuGroup: id},
+ closest: () => menu,
+ querySelector: (selector: string): unknown => selector.includes("group-items") ? {
+ classList: {toggle: (_name: string, value: boolean) => { hidden = value; }},
+ } : selector.includes("group-title") ? {textContent: id} : button,
+ };
+ const button = {
+ disabled: false,
+ hasAttribute: () => button.disabled,
+ closest: () => group,
+ setAttribute: (key: string, value: string) => attributes.set(key, value),
+ querySelector: () => ({setAttribute() {}}),
+ };
+ return {group, button, hidden: () => hidden, attributes};
+ });
+ const menu = {querySelectorAll: (): unknown[] => groups.map(value => value.group)};
+ const exports = {} as {
+ syncMainMenuGroupCollapse: (element: unknown, searching: boolean) => void;
+ toggleMainMenuGroup: (button: unknown) => void;
+ };
+ runInNewContext(transpileModule(readFileSync("src/mobile/menu/mainMenuCollapse.ts", "utf8"), {
+ compilerOptions: {module: ModuleKind.CommonJS, target: ScriptTarget.ES2021},
+ }).outputText, {
+ exports,
+ window: {siyuan: {storage, languages: {expand: "Expand", collapse: "Collapse"}}},
+ require: () => ({Constants: {LOCAL_MOBILE_MENU_COLLAPSED: "collapsed"},
+ setStorageVal: (_key: string, value: unknown) => writes.push(value)}),
+ });
+ exports.syncMainMenuGroupCollapse(menu, false);
+ assert.deepEqual(groups.map(value => value.hidden()), [false, false]);
+ exports.toggleMainMenuGroup(groups[1].button);
+ assert.equal(JSON.stringify(storage.collapsed), '["extensions"]');
+ assert.deepEqual(groups.map(value => value.hidden()), [false, true]);
+ assert.equal(groups[1].attributes.get("aria-expanded"), "false");
+ exports.syncMainMenuGroupCollapse(menu, true);
+ assert.deepEqual(groups.map(value => value.hidden()), [false, false]);
+ exports.toggleMainMenuGroup(groups[1].button);
+ assert.equal(writes.length, 1);
+ exports.syncMainMenuGroupCollapse(menu, false);
+ assert.equal(groups[1].hidden(), true);
+ exports.toggleMainMenuGroup(groups[1].button);
+ assert.equal(groups[1].hidden(), false);
+ assert.equal(writes.length, 2);
+});
diff --git a/app/src/mobile/menu/mainMenuCollapse.ts b/app/src/mobile/menu/mainMenuCollapse.ts
new file mode 100644
index 0000000000..50fc697c4b
--- /dev/null
+++ b/app/src/mobile/menu/mainMenuCollapse.ts
@@ -0,0 +1,41 @@
+import {Constants} from "../../constants";
+import {setStorageVal} from "../../protyle/util/compatibility";
+
+const getCollapsedGroups = (): string[] => {
+ const value = window.siyuan.storage[Constants.LOCAL_MOBILE_MENU_COLLAPSED];
+ return Array.isArray(value) ? value.filter(item => typeof item === "string") : [];
+};
+
+export const syncMainMenuGroupCollapse = (element: Element, searching: boolean) => {
+ const collapsed = getCollapsedGroups();
+ element.querySelectorAll<HTMLElement>("[data-menu-group]").forEach(group => {
+ const hidden = !searching && collapsed.includes(group.dataset.menuGroup);
+ group.querySelector(":scope > .b3-menu__group-items").classList.toggle("fn__none", hidden);
+ const button = group.querySelector<HTMLButtonElement>('[data-type="toggle-menu-group"]');
+ button.disabled = searching;
+ button.setAttribute("aria-expanded", String(!hidden));
+ button.setAttribute("aria-label", `${window.siyuan.languages[hidden ? "expand" : "collapse"]} - ${group.querySelector(".b3-menu__group-title > span").textContent}`);
+ button.querySelector("use").setAttribute("xlink:href", hidden ? "#iconRight" : "#iconDown");
+ });
+};
+
+export const toggleMainMenuGroup = (button: HTMLElement) => {
+ if (button.hasAttribute("disabled")) {
+ return;
+ }
+ const group = button.closest<HTMLElement>("[data-menu-group]");
+ const menu = group?.closest("#menu");
+ if (!menu) {
+ return;
+ }
+ const collapsed = new Set(getCollapsedGroups());
+ if (collapsed.has(group.dataset.menuGroup)) {
+ collapsed.delete(group.dataset.menuGroup);
+ } else {
+ collapsed.add(group.dataset.menuGroup);
+ }
+ const value = Array.from(collapsed);
+ window.siyuan.storage[Constants.LOCAL_MOBILE_MENU_COLLAPSED] = value;
+ setStorageVal(Constants.LOCAL_MOBILE_MENU_COLLAPSED, value);
+ syncMainMenuGroupCollapse(menu, false);
+};
diff --git a/app/src/mobile/menu/mainMenuSearch.ts b/app/src/mobile/menu/mainMenuSearch.ts
index 2303c26c63..45b3a6cdc0 100644
--- a/app/src/mobile/menu/mainMenuSearch.ts
+++ b/app/src/mobile/menu/mainMenuSearch.ts
@@ -7,6 +7,7 @@ import {isMobileMenuSearchMatch} from "./searchFilter";
import {getSettingTabFromMenuTarget} from "./mainMenu";
import {unmountSettingTab} from "./settingPanel";
import {activeBlur} from "../util/keyboardToolbar";
+import {syncMainMenuGroupCollapse} from "./mainMenuCollapse";
export interface IMainMenuSearch {
/** 搜索框当前关键字,已归一化;空串表示未处于搜索态 */
@@ -72,6 +73,8 @@ const createSettingSearchMountQueue = (app: App) => {
/** 按关键字过滤主菜单项,返回命中的设置页及其扫描结果 */
const filterMainMenu = (element: HTMLElement, keywords: string) => {
+ // 搜索时临时展开分组,清空搜索后恢复用户保存的折叠状态。
+ syncMainMenuGroupCollapse(element, !!keywords);
const matchedSettings = new Map<TSettingTab, SettingTabSearchResult>();
let hasMatches = false;
element.querySelectorAll<HTMLElement>(".mobile-main-menu__groups > .b3-menu__group").forEach((group) => {