Skip to content

A reactive notebook for Python — run reproducible experiments, query with SQL, execute as a script, deploy as an app, and version with git. Stored as pure Python. All in a modern, AI-native editor.

2.8 KB
Raw Blame
/* Copyright 2026 Marimo. All rights reserved. */

import {
  afterEach,
  beforeEach,
  describe,
  expect,
  it,
  type MockInstance,
  vi,
} from "vitest";
import { smartScrollIntoView } from "../scroll";

describe("smartScrollIntoView", () => {
  let element: HTMLElement;
  let mockScrollBy: MockInstance<typeof window.scrollBy>;

  const mockRect = (top: number, bottom: number): DOMRect => ({
    top,
    bottom,
    left: 0,
    right: 100,
    width: 100,
    height: 100,
    x: 0,
    y: top,
    toJSON: () => ({}),
  });

  beforeEach(() => {
    element = document.createElement("div");
    document.body.append(element);

    mockScrollBy = vi
      .spyOn(window, "scrollBy")
      .mockImplementation(() => undefined);

    Object.defineProperty(window, "innerHeight", {
      writable: true,
      configurable: true,
      value: 1000,
    });
  });

  afterEach(() => {
    vi.restoreAllMocks();
  });

  it("should scroll when element is above viewport", () => {
    vi.spyOn(element, "getBoundingClientRect").mockReturnValue(
      mockRect(-50, 50),
    );

    smartScrollIntoView(element, {
      offset: { top: 10, bottom: 20 },
    });

    expect(mockScrollBy).toHaveBeenCalledWith({
      top: -60,
      behavior: "smooth",
    });
  });

  it("should scroll when element is below viewport", () => {
    vi.spyOn(element, "getBoundingClientRect").mockReturnValue(
      mockRect(950, 1050),
    );

    smartScrollIntoView(element, {
      offset: { top: 10, bottom: 20 },
    });

    expect(mockScrollBy).toHaveBeenCalledWith({
      top: 70,
      behavior: "smooth",
    });
  });

  it("should not scroll when element is in view", () => {
    vi.spyOn(element, "getBoundingClientRect").mockReturnValue(
      mockRect(100, 200),
    );

    smartScrollIntoView(element, {
      offset: { top: 10, bottom: 20 },
    });

    expect(mockScrollBy).not.toHaveBeenCalled();
  });

  it("should respect behavior parameter", () => {
    vi.spyOn(element, "getBoundingClientRect").mockReturnValue(
      mockRect(-50, 50),
    );

    smartScrollIntoView(element, {
      offset: { top: 10, bottom: 20 },
      behavior: "instant",
    });

    expect(mockScrollBy).toHaveBeenCalledWith({
      top: -60,
      behavior: "instant",
    });
  });

  it("should scroll custom body element", () => {
    const customBody = document.createElement("div");
    const mockCustomScrollBy = vi.fn();
    customBody.scrollBy = mockCustomScrollBy;

    vi.spyOn(element, "getBoundingClientRect").mockReturnValue(
      mockRect(-50, 50),
    );

    smartScrollIntoView(element, {
      offset: { top: 10, bottom: 20 },
      body: customBody,
    });

    expect(mockCustomScrollBy).toHaveBeenCalledWith({
      top: -60,
      behavior: "smooth",
    });
    expect(mockScrollBy).not.toHaveBeenCalled();
  });
});