-
Notifications
You must be signed in to change notification settings - Fork 0
feat(timeline): scroll position lives in url #201
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
dc18afc
f763177
162493c
acf2265
0dba8f0
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| import { useEffect, useLayoutEffect, useRef } from "react"; | ||
| import { useNavigate, useSearch } from "@tanstack/react-router"; | ||
| import type { RefObject } from "react"; | ||
| import { offsetToTime, timeToOffset } from "@/lib/timelineCalculator"; | ||
| import { | ||
| resolveTimelineMountMoment, | ||
| roundToNearestMinutes, | ||
| } from "@/lib/timelineMountMoment"; | ||
|
|
||
| const SCROLL_DEBOUNCE_MS = 300; | ||
| const SCROLL_ROUND_MINUTES = 5; | ||
|
|
||
| interface UseTimelineScrollSyncOptions { | ||
| scrollContainerRef: RefObject<HTMLDivElement>; | ||
| festivalStart: Date; | ||
| timezone: string; | ||
| } | ||
|
|
||
| /** | ||
| * Owns the one-way sync between the timeline's scroll position and the | ||
| * `scrollTo` URL param: | ||
| * | ||
| * - On mount only: centers the viewport per `resolveTimelineMountMoment`'s | ||
| * precedence (scrollTo -> day filter -> festival start). | ||
| * - On user scroll: after the scroll settles (~300ms), writes the moment | ||
| * now centered in the viewport back to the URL (history replace), | ||
| * rounded to 5-minute granularity. | ||
| * | ||
| * These two directions never trigger each other: the mount effect runs once | ||
| * and the scroll listener only ever navigates, never touches `scrollLeft`. | ||
| */ | ||
| export function useTimelineScrollSync({ | ||
| scrollContainerRef, | ||
| festivalStart, | ||
| timezone, | ||
| }: UseTimelineScrollSyncOptions) { | ||
| const route = | ||
| "/festivals/$festivalSlug/editions/$editionSlug/schedule/timeline" as const; | ||
|
|
||
| // Narrow, structurally-shared selection: this hook only cares about | ||
| // scrollTo/day, so its own writes to scrollTo don't cascade elsewhere. | ||
| const { scrollTo, day } = useSearch({ | ||
| from: route, | ||
| select: (search) => ({ scrollTo: search.scrollTo, day: search.day }), | ||
| structuralSharing: true, | ||
| }); | ||
| const navigate = useNavigate({ from: route }); | ||
|
|
||
| const hasCenteredOnMountRef = useRef(false); | ||
| // Position of the last programmatic scroll; scroll events reporting this | ||
| // position are ignored (a browser may fire more than one for a single | ||
| // scrollLeft write), so only genuine user scrolling reaches the URL. | ||
| const programmaticScrollLeftRef = useRef<number | null>(null); | ||
|
|
||
| useLayoutEffect(() => { | ||
| if (hasCenteredOnMountRef.current) return; | ||
| const container = scrollContainerRef.current; | ||
| if (!container) return; | ||
| hasCenteredOnMountRef.current = true; | ||
|
|
||
| const moment = resolveTimelineMountMoment({ | ||
| scrollTo, | ||
| day, | ||
| timezone, | ||
| festivalStart, | ||
| }); | ||
|
|
||
| const targetScrollLeft = Math.max( | ||
| 0, | ||
| timeToOffset(moment, festivalStart) - container.clientWidth / 2, | ||
| ); | ||
|
|
||
| if (targetScrollLeft !== container.scrollLeft) { | ||
| container.scrollLeft = targetScrollLeft; | ||
| // Read back: the browser clamps to the scrollable range, and the | ||
| // suppression check must match the position events will report. | ||
| programmaticScrollLeftRef.current = container.scrollLeft; | ||
| } | ||
| // Mount-only positioning: intentionally does not re-run when scrollTo/day | ||
| // change afterwards (one-way ownership, URL -> scroll only on mount). | ||
| // eslint-disable-next-line react-hooks/exhaustive-deps | ||
| }, [scrollContainerRef]); | ||
|
|
||
| useEffect(() => { | ||
| const container = scrollContainerRef.current; | ||
| if (!container) return; | ||
|
|
||
| let debounceTimer: ReturnType<typeof setTimeout> | undefined; | ||
|
|
||
| function handleScroll() { | ||
| const programmaticLeft = programmaticScrollLeftRef.current; | ||
| if (programmaticLeft !== null) { | ||
| const el = scrollContainerRef.current; | ||
| if (el && Math.abs(el.scrollLeft - programmaticLeft) <= 1) { | ||
| return; | ||
| } | ||
| programmaticScrollLeftRef.current = null; | ||
| } | ||
|
|
||
| if (debounceTimer) clearTimeout(debounceTimer); | ||
| debounceTimer = setTimeout(() => { | ||
| const el = scrollContainerRef.current; | ||
| if (!el) return; | ||
|
|
||
| const centerOffset = el.scrollLeft + el.clientWidth / 2; | ||
| const centerMoment = offsetToTime(centerOffset, festivalStart); | ||
| const rounded = roundToNearestMinutes( | ||
|
Comment on lines
+105
to
+107
Owner
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not taken — same reasoning as the thread above: the hour-marker axis (the canonical time→pixel mapping) has no 20px offset; only set blocks/date labels carry a pre-existing Generated by Claude Code |
||
| centerMoment, | ||
| SCROLL_ROUND_MINUTES, | ||
| ); | ||
|
|
||
| navigate({ | ||
| to: ".", | ||
| search: (prev) => ({ ...prev, scrollTo: rounded.toISOString() }), | ||
| replace: true, | ||
| }); | ||
| }, SCROLL_DEBOUNCE_MS); | ||
| } | ||
|
|
||
| container.addEventListener("scroll", handleScroll, { passive: true }); | ||
| return () => { | ||
| container.removeEventListener("scroll", handleScroll); | ||
| if (debounceTimer) clearTimeout(debounceTimer); | ||
| }; | ||
| }, [scrollContainerRef, festivalStart, navigate]); | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,8 +7,17 @@ export type TimeFilter = TimelineSearch["time"]; | |
| export function useTimelineUrlState(tab: "timeline" | "list" = "timeline") { | ||
| const route = | ||
| `/festivals/$festivalSlug/editions/$editionSlug/schedule/${tab}` as const; | ||
| // Select only the filter params this hook exposes, with structural sharing, | ||
| // so a `scrollTo` write (from scroll syncing) doesn't change this object's | ||
| // identity and trigger consumers to recompute the filtered schedule. | ||
| const state = useSearch({ | ||
| from: route, | ||
| select: (search) => ({ | ||
| day: search.day, | ||
| time: search.time, | ||
| stages: search.stages, | ||
| }), | ||
| structuralSharing: true, | ||
|
Owner
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Check: what is structuralSharing
Owner
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Generated by Claude Code |
||
| }); | ||
| const navigate = useNavigate({ from: route }); | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| import { describe, expect, it } from "vitest"; | ||
| import { | ||
| resolveTimelineMountMoment, | ||
| roundToNearestMinutes, | ||
| } from "./timelineMountMoment"; | ||
|
|
||
| const TIMEZONE = "Europe/Lisbon"; // UTC+1 in July (WEST) | ||
| const FESTIVAL_START = new Date("2025-07-12T10:00:00Z"); | ||
|
|
||
| describe("resolveTimelineMountMoment", () => { | ||
| it("prefers scrollTo when present and valid", () => { | ||
| const moment = resolveTimelineMountMoment({ | ||
| scrollTo: "2025-07-13T22:00:00.000Z", | ||
| day: "2025-07-12", | ||
| timezone: TIMEZONE, | ||
| festivalStart: FESTIVAL_START, | ||
| }); | ||
|
|
||
| expect(moment.getTime()).toBe( | ||
| new Date("2025-07-13T22:00:00.000Z").getTime(), | ||
| ); | ||
| }); | ||
|
|
||
| it("falls back to the day filter's start when scrollTo is absent", () => { | ||
| const moment = resolveTimelineMountMoment({ | ||
| scrollTo: undefined, | ||
| day: "2025-07-13", | ||
| timezone: TIMEZONE, | ||
| festivalStart: FESTIVAL_START, | ||
| }); | ||
|
|
||
| // Midnight in Europe/Lisbon (UTC+1 in July) is 23:00 UTC the prior day. | ||
| expect(moment.getTime()).toBe( | ||
| new Date("2025-07-12T23:00:00.000Z").getTime(), | ||
| ); | ||
| }); | ||
|
|
||
| it("falls back to the day filter's start when scrollTo is an invalid date string", () => { | ||
| const moment = resolveTimelineMountMoment({ | ||
| scrollTo: "not-a-date", | ||
| day: "2025-07-13", | ||
| timezone: TIMEZONE, | ||
| festivalStart: FESTIVAL_START, | ||
| }); | ||
|
|
||
| expect(moment.getTime()).toBe( | ||
| new Date("2025-07-12T23:00:00.000Z").getTime(), | ||
| ); | ||
| }); | ||
|
|
||
| it("falls back to festivalStart when day filter is 'all' and scrollTo is absent", () => { | ||
| const moment = resolveTimelineMountMoment({ | ||
| scrollTo: undefined, | ||
| day: "all", | ||
| timezone: TIMEZONE, | ||
| festivalStart: FESTIVAL_START, | ||
| }); | ||
|
|
||
| expect(moment.getTime()).toBe(FESTIVAL_START.getTime()); | ||
| }); | ||
|
|
||
| it("falls back to festivalStart when scrollTo is invalid and day is 'all'", () => { | ||
| const moment = resolveTimelineMountMoment({ | ||
| scrollTo: "garbage", | ||
| day: "all", | ||
| timezone: TIMEZONE, | ||
| festivalStart: FESTIVAL_START, | ||
| }); | ||
|
|
||
| expect(moment.getTime()).toBe(FESTIVAL_START.getTime()); | ||
| }); | ||
|
|
||
| it("scrollTo takes precedence over an active day filter", () => { | ||
| const moment = resolveTimelineMountMoment({ | ||
| scrollTo: "2025-07-14T12:00:00.000Z", | ||
| day: "2025-07-13", | ||
| timezone: TIMEZONE, | ||
| festivalStart: FESTIVAL_START, | ||
| }); | ||
|
|
||
| expect(moment.getTime()).toBe( | ||
| new Date("2025-07-14T12:00:00.000Z").getTime(), | ||
| ); | ||
| }); | ||
| }); | ||
|
|
||
| describe("roundToNearestMinutes", () => { | ||
| it("rounds down to the nearest 5 minutes", () => { | ||
| const date = new Date("2025-07-12T10:02:00.000Z"); | ||
| expect(roundToNearestMinutes(date, 5).getTime()).toBe( | ||
| new Date("2025-07-12T10:00:00.000Z").getTime(), | ||
| ); | ||
| }); | ||
|
|
||
| it("rounds up to the nearest 5 minutes", () => { | ||
| const date = new Date("2025-07-12T10:03:00.000Z"); | ||
| expect(roundToNearestMinutes(date, 5).getTime()).toBe( | ||
| new Date("2025-07-12T10:05:00.000Z").getTime(), | ||
| ); | ||
| }); | ||
|
|
||
| it("defaults to a 5-minute granularity", () => { | ||
| const date = new Date("2025-07-12T10:07:00.000Z"); | ||
| expect(roundToNearestMinutes(date).getTime()).toBe( | ||
| new Date("2025-07-12T10:05:00.000Z").getTime(), | ||
| ); | ||
| }); | ||
|
|
||
| it("is a no-op for a moment already on the grid", () => { | ||
| const date = new Date("2025-07-12T10:15:00.000Z"); | ||
| expect(roundToNearestMinutes(date, 5).getTime()).toBe(date.getTime()); | ||
| }); | ||
| }); |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| import { isValid, parseISO } from "date-fns"; | ||
| import { fromZonedTime } from "date-fns-tz"; | ||
|
|
||
| export interface TimelineMountMomentInput { | ||
| /** Raw `scrollTo` search param, if present in the URL. */ | ||
| scrollTo?: string; | ||
| /** Active day filter: "all" or a "yyyy-MM-dd" festival calendar day. */ | ||
| day: string; | ||
| /** Festival's IANA timezone, used to resolve the day filter's start. */ | ||
| timezone: string; | ||
| /** Timeline geometry origin (earliest moment on the timeline). */ | ||
| festivalStart: Date; | ||
| } | ||
|
|
||
| /** | ||
| * Decides which moment the timeline viewport should be centered on when the | ||
| * Timeline mounts. Pure and order-sensitive: | ||
| * | ||
| * 1. `scrollTo` from the URL, if present and parseable. | ||
| * 2. The start of the active `day` filter, if one is set. | ||
| * 3. The festival start (timeline origin). | ||
| * | ||
| * A future rule ("now, minus 1h, when now falls inside the festival window") | ||
| * slots in as an additional candidate between the day filter and the | ||
| * festival-start fallback (see issue #194). | ||
| */ | ||
| export function resolveTimelineMountMoment( | ||
| input: TimelineMountMomentInput, | ||
| ): Date { | ||
| return ( | ||
| momentFromScrollTo(input.scrollTo) ?? | ||
| momentFromDayFilter(input.day, input.timezone) ?? | ||
| input.festivalStart | ||
| ); | ||
| } | ||
|
|
||
| function momentFromScrollTo(scrollTo: string | undefined): Date | null { | ||
| if (!scrollTo) return null; | ||
| const parsed = parseISO(scrollTo); | ||
| return isValid(parsed) ? parsed : null; | ||
| } | ||
|
|
||
| function momentFromDayFilter(day: string, timezone: string): Date | null { | ||
| if (!day || day === "all") return null; | ||
| try { | ||
| const dayStart = fromZonedTime(`${day}T00:00:00`, timezone); | ||
| return isValid(dayStart) ? dayStart : null; | ||
| } catch { | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Rounds a moment to the nearest multiple of `minutes` (default 5), used to | ||
| * keep `scrollTo` URL writes coarse-grained instead of pixel-precise. | ||
| */ | ||
| export function roundToNearestMinutes(date: Date, minutes = 5): Date { | ||
| const ms = minutes * 60 * 1000; | ||
| return new Date(Math.round(date.getTime() / ms) * ms); | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Intentional, per the spec (issue #192 / PRD #188): mount precedence applies at mount only, and "filtering narrows, it never scrolls" — changing the day filter must never move the viewport. The day-filter rule exists only to pick the initial position when a page loads with
?day=and noscrollTo.Generated by Claude Code