Skip to content

Write HTML. Render video. Built for agents.

feat(studio): the timeline publishes where it draws 0 s, so a host can map a click to a time (#4724)

Miguel Ángelb171ee571696
diff --git a/packages/studio/src/player/components/Timeline.rulerSeek.test.tsx b/packages/studio/src/player/components/Timeline.rulerSeek.test.tsx
new file mode 100644
index 0000000000..25d2902b09
--- /dev/null
+++ b/packages/studio/src/player/components/Timeline.rulerSeek.test.tsx
@@ -0,0 +1,111 @@
+// @vitest-environment happy-dom
+
+import React, { act } from "react";
+import { createRoot } from "react-dom/client";
+import { afterEach, beforeAll, describe, expect, it, vi } from "vitest";
+import { Timeline } from "./Timeline";
+import { installTimelineMountEnv } from "./timelineMountTestEnv";
+import { usePlayerStore } from "../store/playerStore";
+
+(globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean }).IS_REACT_ACT_ENVIRONMENT = true;
+
+installTimelineMountEnv();
+
+beforeAll(() => {
+ HTMLElement.prototype.setPointerCapture = vi.fn();
+ HTMLElement.prototype.releasePointerCapture = vi.fn();
+});
+
+afterEach(() => {
+ document.body.innerHTML = "";
+});
+
+const KEYFRAMED = new Map([
+ [
+ "card",
+ [
+ {
+ id: "card-position",
+ targetSelector: "#card",
+ method: "to" as const,
+ position: 0,
+ duration: 2,
+ properties: {},
+ propertyGroup: "position" as const,
+ keyframes: {
+ format: "percentage" as const,
+ keyframes: [
+ { percentage: 0, properties: { x: 0 } },
+ { percentage: 50, properties: { x: 100 } },
+ ],
+ },
+ },
+ ],
+ ],
+]);
+
+/** Presses the ruler exactly on the first drawn tick after 0 and returns its time and the seek. */
+async function seekOnFirstTick(
+ props: { showKeyframes?: boolean },
+ keyframesLate: boolean,
+ animations: typeof KEYFRAMED | Map<string, never[]> = KEYFRAMED,
+) {
+ usePlayerStore.setState({
+ duration: 10,
+ currentTime: 0,
+ timelineReady: true,
+ elements: [{ id: "card", label: "Hero card", tag: "div", start: 0, duration: 10, track: 0 }],
+ gsapAnimations: keyframesLate ? new Map() : animations,
+ });
+ const onSeek = vi.fn();
+ const host = document.createElement("div");
+ document.body.append(host);
+ const root = createRoot(host);
+ await act(async () => root.render(<Timeline {...props} onSeek={onSeek} />));
+ if (keyframesLate) await act(async () => usePlayerStore.setState({ gsapAnimations: animations }));
+
+ const viewport = host.querySelector<HTMLElement>("[data-timeline-scroll-viewport]")!;
+ viewport.getBoundingClientRect = () =>
+ ({ left: 0, top: 0, right: 900, bottom: 400, width: 900, height: 400 }) as DOMRect;
+ const label = host.querySelector<HTMLElement>('[data-timeline-grid-cell="major"] span')!;
+ const band = label.parentElement!.parentElement!;
+ const tick = band.querySelectorAll<HTMLElement>('[data-timeline-grid-cell="major"]')[1]!;
+ const [, mm, ss] = /(\d+):(\d+)/.exec(tick.textContent ?? "")!;
+ const tickTime = Number(mm) * 60 + Number(ss);
+ // The ruler's corner block is as wide as the origin the ruler draws 0 s at.
+ const origin = (band.previousElementSibling as HTMLElement).style.width;
+ const clientX = parseFloat(origin) + parseFloat(tick.style.left) + 0.5;
+ const at = { bubbles: true, clientX, clientY: 4, button: 0, pointerId: 1 };
+ await act(async () => tick.dispatchEvent(new PointerEvent("pointerdown", at)));
+ await act(async () => tick.dispatchEvent(new PointerEvent("pointerup", at)));
+ act(() => root.unmount());
+ return {
+ time: onSeek.mock.calls.at(-1)?.[0] as number | undefined,
+ tickTime,
+ origin,
+ published: viewport.getAttribute("data-timeline-content-origin"),
+ };
+}
+
+describe("Timeline ruler origin", () => {
+ it.each([
+ ["keyframes shown", { showKeyframes: true }, false],
+ ["keyframes hidden", { showKeyframes: false }, false],
+ ["keyframes shown, arriving after mount", { showKeyframes: true }, true],
+ ["keyframes hidden, arriving after mount", { showKeyframes: false }, true],
+ ])(
+ "publishes where the ruler draws 0 s, and a press seeks by it (%s)",
+ async (_case, props, late) => {
+ const { time, tickTime, origin, published } = await seekOnFirstTick(props, late);
+ expect(origin).toBe("264px");
+ expect(published).toBe("264");
+ expect(time).toBeCloseTo(tickTime, 1);
+ },
+ );
+
+ it("publishes the narrow origin when no clip needs the label column", async () => {
+ const { origin, published } = await seekOnFirstTick({}, false, new Map());
+ expect(origin).toBe("80px");
+ expect(published).toBe("80");
+ });
+});
diff --git a/packages/studio/src/player/components/TimelineProvider.tsx b/packages/studio/src/player/components/TimelineProvider.tsx
index b16f3cd551..2ab6d91676 100644
--- a/packages/studio/src/player/components/TimelineProvider.tsx
+++ b/packages/studio/src/player/components/TimelineProvider.tsx
@@ -127,6 +127,7 @@ export interface TimelineViewportProps {
ref: RefCallback<HTMLDivElement>;
"data-timeline-scroll-viewport": boolean;
"data-timeline-auto-scroll-left-inset": number;
+ "data-timeline-content-origin": number;
tabIndex: number;
className: string;
onScroll: (event: UIEvent<HTMLDivElement>) => void;
diff --git a/packages/studio/src/player/components/timelineProviderStateBuilders.test.ts b/packages/studio/src/player/components/timelineProviderStateBuilders.test.ts
index 5abee8c949..664b6158d2 100644
--- a/packages/studio/src/player/components/timelineProviderStateBuilders.test.ts
+++ b/packages/studio/src/player/components/timelineProviderStateBuilders.test.ts
@@ -27,6 +27,7 @@ function inputs(overrides: Partial<TimelineMetaBuilderInputs> = {}): TimelineMet
ref: vi.fn(),
tabIndex: -1,
labelMode: false,
+ contentOrigin: 80,
zoomMode: "fit",
onScroll: vi.fn(),
onFocus: vi.fn(),
diff --git a/packages/studio/src/player/components/timelineProviderStateBuilders.ts b/packages/studio/src/player/components/timelineProviderStateBuilders.ts
index b3ab8e382f..5228bd7efa 100644
--- a/packages/studio/src/player/components/timelineProviderStateBuilders.ts
+++ b/packages/studio/src/player/components/timelineProviderStateBuilders.ts
@@ -46,9 +46,13 @@ type ContainerInputs = Omit<TimelineContainerProps, "className"> & {
type ViewportInputs = Omit<
TimelineViewportProps,
- "className" | "data-timeline-scroll-viewport" | "data-timeline-auto-scroll-left-inset"
+ | "className"
+ | "data-timeline-scroll-viewport"
+ | "data-timeline-auto-scroll-left-inset"
+ | "data-timeline-content-origin"
> & {
labelMode: boolean;
+ contentOrigin: number;
zoomMode: "fit" | "manual";
};
@@ -69,7 +73,7 @@ export function buildTimelineMeta({
labelColumnWidth,
razorGuide,
}: TimelineMetaBuilderInputs): TimelineMeta {
- const { labelMode, zoomMode, ...viewportProps } = viewport;
+ const { labelMode, zoomMode, contentOrigin, ...viewportProps } = viewport;
const containerClassName = `relative border-t select-none h-full overflow-hidden ${container.isDragOver ? container.accentClass : ""} ${container.activeTool === "razor" ? "cursor-crosshair" : container.shiftHeld ? "cursor-crosshair" : "cursor-default"}`;
const viewportClassName = `${zoomMode === "fit" ? "overflow-x-hidden" : "overflow-x-auto"} overflow-y-auto h-full outline-hidden`;
return {
@@ -87,6 +91,7 @@ export function buildTimelineMeta({
...viewportProps,
"data-timeline-scroll-viewport": true,
"data-timeline-auto-scroll-left-inset": labelMode ? labelColumnWidth : 0,
+ "data-timeline-content-origin": contentOrigin,
className: viewportClassName,
},
razorGuide,
diff --git a/packages/studio/src/player/components/useTimelineProviderState.tsx b/packages/studio/src/player/components/useTimelineProviderState.tsx
index d2a473796c..652d0f3fcf 100644
--- a/packages/studio/src/player/components/useTimelineProviderState.tsx
+++ b/packages/studio/src/player/components/useTimelineProviderState.tsx
@@ -548,6 +548,7 @@ export function useTimelineProviderState({
ref: setScrollRef,
tabIndex: -1,
labelMode,
+ contentOrigin,
zoomMode,
onScroll: (e) => {
lastScrollLeftRef.current = e.currentTarget.scrollLeft;