Build your personal knowledge base with Trilium Notes
TypeScript electronelectron-appknowledge-baseknowledge-graphknowledge-managementknowledge-management-graphlocal-firstnote-managmentnote-takernote-takingnotebooknotesnotes-apppersonal-knowledge-basepersonal-wikiscriptableself-hostedself-hostingwiki
import { afterEach, describe, expect, it, vi } from "vitest";
import { findScrollAnchor, restoreScrollAnchor } from "./scroll_anchor";
describe("findScrollAnchor", () => {
afterEach(() => {
document.body.innerHTML = "";
vi.restoreAllMocks();
});
it("takes the first block that reaches past the top edge", () => {
const container = buildContainer(`<p id="a"></p><p id="b"></p><p id="c"></p>`);
placeAt(byId(container, "a"), 20, 50);
placeAt(byId(container, "b"), 70, 50);
placeAt(byId(container, "c"), 120, 50);
expect(findScrollAnchor(container)).toEqual({ element: byId(container, "b"), offset: -30 });
expect(findScrollAnchor(buildContainer(""))).toBeNull();
});
it("descends into a block that the top edge cuts through", () => {
const container = buildContainer(
`<div id="content"><p id="a"></p><figure id="b"></figure></div>`);
placeAt(byId(container, "content"), -400, 1000);
placeAt(byId(container, "a"), -400, 50);
placeAt(byId(container, "b"), 110, 200);
expect(findScrollAnchor(container)).toEqual({ element: byId(container, "b"), offset: 10 });
});
it("skips inline, positioned and hidden boxes", () => {
const container = buildContainer(`
<p id="text"><strong id="inline" style="display: inline"></strong></p>
<div id="sticky" style="position: sticky"></div>
<div id="hidden"></div>
<p id="next"></p>`);
placeAt(byId(container, "text"), 80, 50);
placeAt(byId(container, "inline"), 110, 20);
placeAt(byId(container, "sticky"), 100, 40);
placeAt(byId(container, "hidden"), 0, 0, 0);
placeAt(byId(container, "next"), 130, 50);
// The paragraph stays the anchor, since its only child is inline.
expect(findScrollAnchor(container))
.toEqual({ element: byId(container, "text"), offset: -20 });
placeAt(byId(container, "text"), 20, 50);
expect(findScrollAnchor(container))
.toEqual({ element: byId(container, "next"), offset: 30 });
});
describe("with the previous anchor", () => {
it("walks forward from it without reading the blocks above it", () => {
const { container, rects } = buildParagraphs([ -500, -400, -300, -200, -100, 20 ]);
const previous = byId(container, "p3");
expect(findScrollAnchor(container, previous))
.toEqual({ element: byId(container, "p5"), offset: -80 });
expect(rects[0]).not.toHaveBeenCalled();
expect(rects[2]).not.toHaveBeenCalled();
});
it("walks back from it when the content moved down", () => {
const { container, rects } = buildParagraphs([ -200, -100, 20, 120, 220, 320 ]);
const previous = byId(container, "p4");
expect(findScrollAnchor(container, previous))
.toEqual({ element: byId(container, "p2"), offset: -80 });
expect(rects[0]).not.toHaveBeenCalled();
expect(rects[5]).not.toHaveBeenCalled();
});
it("searches all blocks when it left the container", () => {
const { container, rects } = buildParagraphs([ -200, -100, 20, 120, 220, 320 ]);
const previous = byId(container, "p4");
previous.remove();
expect(findScrollAnchor(container, previous))
.toEqual({ element: byId(container, "p2"), offset: -80 });
expect(rects[0]).toHaveBeenCalled();
});
it("searches all blocks when it is hidden", () => {
const { container, rects } = buildParagraphs([ -200, -100, 20, 120, 220, 320 ]);
const previous = byId(container, "p4");
placeAt(previous, 0, 0, 0);
expect(findScrollAnchor(container, previous))
.toEqual({ element: byId(container, "p2"), offset: -80 });
expect(rects[0]).toHaveBeenCalled();
});
});
});
describe("restoreScrollAnchor", () => {
afterEach(() => {
document.body.innerHTML = "";
vi.restoreAllMocks();
});
it("scrolls by the distance the anchor moved, and only when it moved", () => {
const container = buildContainer(`<p id="a"></p>`);
const element = byId(container, "a");
const scrollTo = vi.fn();
container.scrollTo = scrollTo;
container.scrollTop = 500;
placeAt(element, 80.5, 50);
restoreScrollAnchor(container, { element, offset: -20 });
expect(scrollTo).not.toHaveBeenCalled();
placeAt(element, 160, 50);
restoreScrollAnchor(container, { element, offset: -20 });
expect(scrollTo).toHaveBeenCalledExactlyOnceWith({ top: 580, behavior: "instant" });
});
it("leaves the position alone once the anchor left the container", () => {
const container = buildContainer(`<p id="a"></p>`);
const element = byId(container, "a");
const scrollTo = vi.fn();
container.scrollTo = scrollTo;
placeAt(element, 400, 50);
element.remove();
restoreScrollAnchor(container, { element, offset: 0 });
expect(scrollTo).not.toHaveBeenCalled();
});
});
/** Builds a container whose visible area starts at y=100. */
function buildContainer(html: string) {
const container = document.createElement("div");
container.innerHTML = html;
document.body.appendChild(container);
placeAt(container, 100, 400);
return container;
}
/**
* Builds a container with a `content` block holding paragraphs `p0`, `p1`… 100px tall at `tops`,
* and returns the mocks of their boxes.
*/
function buildParagraphs(tops: number[]) {
const paragraphs = tops.map((_, index) => `<p id="p${index}"></p>`).join("");
const container = buildContainer(`<div id="content">${paragraphs}</div>`);
placeAt(byId(container, "content"), tops[0], 1000);
const rects = tops.map((top, index) => placeAt(byId(container, `p${index}`), top, 100));
return { container, rects };
}
function byId(container: HTMLElement, id: string) {
const element = container.querySelector(`#${id}`);
if (!element) {
throw new Error(`No element with the ID ${id}.`);
}
return element;
}
/** Mocks the box of `element`, since happy-dom does no layout. */
function placeAt(element: Element, top: number, height: number, width = 100) {
return vi.spyOn(element, "getBoundingClientRect")
.mockReturnValue(new DOMRect(0, top, width, height));
}