Skip to content

armgit / memos

Public Imported from GitHub
0

Memos is an open-source, self-hosted note-taking app that brings your everyday thoughts together in a personal timeline. Your data stays yours, and you choose what to keep private or share.

feat(web): restore scroll position across navigation

boojacke497895bf3b7
diff --git a/web/src/App.tsx b/web/src/App.tsx
index f1228256b..1f7014791 100644
--- a/web/src/App.tsx
+++ b/web/src/App.tsx
@@ -1,5 +1,5 @@
import { useEffect } from "react";
-import { Outlet } from "react-router-dom";
+import { Outlet, ScrollRestoration } from "react-router-dom";
import { useInstance } from "./contexts/InstanceContext";
import { MemoFilterProvider } from "./contexts/MemoFilterContext";
import useNavigateTo from "./hooks/useNavigateTo";
@@ -59,9 +59,12 @@ const App = () => {
}, [instanceGeneralSetting.customProfile]);
return (
- <MemoFilterProvider>
- <Outlet />
- </MemoFilterProvider>
+ <>
+ <MemoFilterProvider>
+ <Outlet />
+ </MemoFilterProvider>
+ <ScrollRestoration />
+ </>
);
};
diff --git a/web/tests/scroll-restoration.test.tsx b/web/tests/scroll-restoration.test.tsx
new file mode 100644
index 000000000..83f862ad1
--- /dev/null
+++ b/web/tests/scroll-restoration.test.tsx
@@ -0,0 +1,69 @@
+import { act, render, screen, waitFor } from "@testing-library/react";
+import type { ReactNode } from "react";
+import { createMemoryRouter, RouterProvider } from "react-router-dom";
+import { beforeEach, describe, expect, it, vi } from "vitest";
+import App from "@/App";
+
+vi.mock("@/contexts/InstanceContext", () => ({
+ useInstance: () => ({
+ profile: { needsSetup: false },
+ profileLoaded: true,
+ generalSetting: {},
+ }),
+}));
+
+vi.mock("@/contexts/MemoFilterContext", () => ({
+ MemoFilterProvider: ({ children }: { children: ReactNode }) => children,
+}));
+
+vi.mock("@/hooks/useNavigateTo", () => ({ default: () => vi.fn() }));
+vi.mock("@/hooks/useUserLocale", () => ({ useUserLocale: vi.fn() }));
+vi.mock("@/hooks/useUserTheme", () => ({ useUserTheme: vi.fn() }));
+vi.mock("@/utils/oauth", () => ({ cleanupExpiredOAuthState: vi.fn() }));
+
+describe("scroll restoration", () => {
+ let scrollY = 0;
+
+ beforeEach(() => {
+ scrollY = 0;
+ Object.defineProperty(window, "scrollY", {
+ configurable: true,
+ get: () => scrollY,
+ });
+ });
+
+ it("resets new routes and restores history entries", async () => {
+ const scrollTo = vi.spyOn(window, "scrollTo").mockImplementation((xOrOptions, y) => {
+ scrollY = typeof xOrOptions === "number" ? (y ?? 0) : (xOrOptions.top ?? 0);
+ });
+ const router = createMemoryRouter(
+ [
+ {
+ path: "/",
+ element: <App />,
+ children: [
+ { index: true, element: <div>First page</div> },
+ { path: "second", element: <div>Second page</div> },
+ ],
+ },
+ ],
+ { initialEntries: ["/"] },
+ );
+
+ render(<RouterProvider router={router} />);
+ await screen.findByText("First page");
+ scrollTo.mockClear();
+
+ scrollY = 640;
+ await act(async () => {
+ await router.navigate("/second");
+ });
+ await waitFor(() => expect(scrollTo).toHaveBeenLastCalledWith(0, 0));
+
+ scrollY = 180;
+ await act(async () => {
+ await router.navigate(-1);
+ });
+ await waitFor(() => expect(scrollTo).toHaveBeenLastCalledWith(0, 640));
+ });
+});