Skip to content

Commit 9bf3440

Browse files
committed
fix(web): dismiss image path tooltips after preview and scroll
1 parent 67fdc53 commit 9bf3440

4 files changed

Lines changed: 119 additions & 8 deletions

File tree

‎apps/web/src/components/chat/ExpandedImageDialog.browser.test.tsx‎

Lines changed: 72 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1+
import { useState } from "react";
12
import type { SnapShotSource } from "@t3tools/contracts";
23
import { describe, expect, it, vi } from "vite-plus/test";
3-
import { userEvent } from "vite-plus/test/browser";
4+
import { page, userEvent } from "vite-plus/test/browser";
45

56
import "~/index.css";
67
import { render } from "../../../test/render";
8+
import { MediaActions } from "../media/MediaActions";
9+
import { TooltipScrollDismissArea } from "../ui/tooltip";
710
import { ExpandedImageDialog } from "./ExpandedImageDialog";
811

912
const PIXEL =
@@ -19,7 +22,75 @@ const snapShotSource: SnapShotSource = {
1922
const D2_SVG =
2023
'<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1174 920"><rect width="1174" height="920"/></svg>';
2124

25+
function ImagePreviewTimeline() {
26+
const [open, setOpen] = useState(false);
27+
const source = {
28+
kind: "image" as const,
29+
name: "shot.png",
30+
src: PIXEL,
31+
reference: { kind: "file" as const, path: "/work/shot.png" },
32+
};
33+
return (
34+
<>
35+
<TooltipScrollDismissArea data-testid="timeline" className="mt-16 h-80 overflow-y-auto">
36+
<MediaActions source={source}>
37+
<img
38+
src={PIXEL}
39+
alt="Timeline image"
40+
width={200}
41+
height={200}
42+
role="button"
43+
tabIndex={0}
44+
aria-label="Preview Timeline image"
45+
onClick={() => setOpen(true)}
46+
onKeyDown={(event) => {
47+
if (event.key === "Enter" || event.key === " ") {
48+
event.preventDefault();
49+
event.stopPropagation();
50+
setOpen(true);
51+
}
52+
}}
53+
/>
54+
</MediaActions>
55+
<div className="h-[600px]" />
56+
</TooltipScrollDismissArea>
57+
<button type="button">Next timeline action</button>
58+
{open && (
59+
<ExpandedImageDialog
60+
preview={{ images: [{ src: PIXEL, name: "shot.png", actionsSource: source }], index: 0 }}
61+
onClose={() => setOpen(false)}
62+
/>
63+
)}
64+
</>
65+
);
66+
}
67+
2268
describe("ExpandedImageDialog", () => {
69+
it("dismisses the image path tooltip on scroll after returning focus from the preview", async () => {
70+
await using screen = await render(<ImagePreviewTimeline />);
71+
const image = screen.getByRole("button", { name: "Preview Timeline image" });
72+
await userEvent.click(image);
73+
await expect.element(page.getByRole("button", { name: "Close image preview" })).toHaveFocus();
74+
await userEvent.keyboard("{Escape}");
75+
await expect.element(image).toHaveFocus();
76+
expect(image.element().matches(":focus-visible")).toBe(false);
77+
await expect.element(page.getByText("/work/shot.png", { exact: true })).not.toBeInTheDocument();
78+
await userEvent.unhover(image);
79+
await userEvent.hover(image);
80+
await expect.element(page.getByText("/work/shot.png", { exact: true })).toBeVisible();
81+
screen.getByTestId("timeline").element().scrollTop = 20;
82+
await expect.element(page.getByText("/work/shot.png", { exact: true })).not.toBeInTheDocument();
83+
await expect.element(image).toHaveFocus();
84+
await userEvent.keyboard("{Tab}{Shift>}{Tab}{/Shift}");
85+
await expect.element(image).toHaveFocus();
86+
expect(image.element().matches(":focus-visible")).toBe(true);
87+
await userEvent.keyboard("{Enter}");
88+
await expect.element(page.getByRole("button", { name: "Close image preview" })).toHaveFocus();
89+
await userEvent.keyboard("{Escape}");
90+
await expect.element(image).toHaveFocus();
91+
expect(image.element().matches(":focus-visible")).toBe(true);
92+
});
93+
2394
it.each(["/work/pipeline.svg", "/work/diagram#v2.svg", "/work/diagram?v2.svg"])(
2495
"fits a markdown SVG without intrinsic size to the viewer: %s",
2596
async (path) => {

‎apps/web/src/components/chat/ExpandedImageDialog.tsx‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -87,15 +87,17 @@ export const ExpandedImageDialog = memo(function ExpandedImageDialog({
8787
const [failedImageSrc, setFailedImageSrc] = useState<string | null>(null);
8888
const [accessibilityDetailsSrc, setAccessibilityDetailsSrc] = useState<string | null>(null);
8989
const zoomableImageRef = useRef<ZoomableImageHandle>(null);
90-
const [returnFocusTarget] = useState(() =>
91-
document.activeElement instanceof HTMLElement ? document.activeElement : null,
92-
);
90+
const [returnFocus] = useState(() => {
91+
const target = document.activeElement instanceof HTMLElement ? document.activeElement : null;
92+
return { target, focusVisible: target?.matches(":focus-visible") ?? false };
93+
});
9394
// The host unmounts the dialog outright, so Base UI never runs finalFocus. Without
9495
// this, focus stays on the removed dialog, and the composer that owned the opener
95-
// reads that as a blur and rests.
96+
// reads that as a blur and rests. Preserve mouse focus when Escape closes it.
9697
const close = () => {
9798
flushSync(onClose);
98-
if (returnFocusTarget?.isConnected) returnFocusTarget.focus({ preventScroll: true });
99+
const { target, focusVisible } = returnFocus;
100+
if (target?.isConnected) target.focus({ preventScroll: true, focusVisible });
99101
};
100102
const closeButtonRef = useRef<HTMLButtonElement>(null);
101103
const imageCount = preview.images.length;
@@ -179,7 +181,7 @@ export const ExpandedImageDialog = memo(function ExpandedImageDialog({
179181
className="row-start-1 h-full max-h-[92vh] w-[92vw] max-w-[92vw] items-center justify-center overflow-visible [--media-width:92vw] [--media-height:min(calc((100vh-var(--native-titlebar-height,0px))*0.86),calc(100vh-var(--native-titlebar-height,0px)-160px))] sm:[--media-width:calc(92vw-96px)]"
180182
onKeyDown={onKeyDown}
181183
initialFocus={closeButtonRef}
182-
finalFocus={() => returnFocusTarget}
184+
finalFocus={() => returnFocus.target}
183185
onClick={(event) => {
184186
if (event.target === event.currentTarget) close();
185187
}}
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
import { expect, it, vi } from "vite-plus/test";
2+
import { page, userEvent } from "vite-plus/test/browser";
3+
4+
import "~/index.css";
5+
import { render } from "../../../test/render";
6+
import { Tooltip, TooltipPopup, TooltipScrollDismissArea, TooltipTrigger } from "./tooltip";
7+
8+
it.each([false, true])(
9+
"keeps a keyboard-focused tooltip open on scroll (hover first: %s)",
10+
async (hoverFirst) => {
11+
const onScroll = vi.fn();
12+
await using screen = await render(
13+
<TooltipScrollDismissArea
14+
data-testid="timeline"
15+
onScrollCapture={onScroll}
16+
className="h-32 overflow-y-auto"
17+
>
18+
<Tooltip>
19+
<TooltipTrigger>Timeline action</TooltipTrigger>
20+
<TooltipPopup>Keyboard description</TooltipPopup>
21+
</Tooltip>
22+
<div className="h-96" />
23+
</TooltipScrollDismissArea>,
24+
);
25+
const trigger = screen.getByRole("button", { name: "Timeline action" });
26+
if (hoverFirst) await userEvent.hover(trigger);
27+
await userEvent.keyboard("{Tab}");
28+
await expect.element(trigger).toHaveFocus();
29+
expect(trigger.element().matches(":focus-visible")).toBe(true);
30+
await expect.element(page.getByText("Keyboard description")).toBeVisible();
31+
screen.getByTestId("timeline").element().scrollTop = 20;
32+
await vi.waitFor(() => expect(onScroll).toHaveBeenCalledOnce());
33+
await expect.element(page.getByText("Keyboard description")).toBeVisible();
34+
await expect.element(trigger).toHaveFocus();
35+
},
36+
);

‎apps/web/src/components/ui/tooltip.tsx‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,9 @@ function createTooltipHoverTracker() {
3131
},
3232
dismissUnfocused() {
3333
const tooltip = hovered;
34-
if (!tooltip || tooltip.trigger.contains(tooltip.trigger.ownerDocument.activeElement)) {
34+
if (!tooltip) return;
35+
const focused = tooltip.trigger.ownerDocument.activeElement;
36+
if (focused && tooltip.trigger.contains(focused) && focused.matches(":focus-visible")) {
3537
return;
3638
}
3739
hovered = null;

0 commit comments

Comments
 (0)