Skip to content

Commit 75b22bf

Browse files
fix(web): dismiss image path tooltips after preview and scroll (#30620)
Co-authored-by: Julius Marminge <[email protected]>
1 parent 5badea5 commit 75b22bf

4 files changed

Lines changed: 94 additions & 8 deletions

File tree

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

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
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";
@@ -19,7 +20,45 @@ const snapShotSource: SnapShotSource = {
1920
const D2_SVG =
2021
'<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1174 920"><rect width="1174" height="920"/></svg>';
2122

23+
function ImagePreviewOpener() {
24+
const [open, setOpen] = useState(false);
25+
return (
26+
<>
27+
<button type="button" onClick={() => setOpen(true)}>
28+
Open preview
29+
</button>
30+
{open && (
31+
<ExpandedImageDialog
32+
preview={{ images: [{ src: PIXEL, name: "shot.png", source: snapShotSource }], index: 0 }}
33+
onClose={() => setOpen(false)}
34+
/>
35+
)}
36+
</>
37+
);
38+
}
39+
2240
describe("ExpandedImageDialog", () => {
41+
it.each([
42+
{ opener: "mouse", focusVisible: false },
43+
{ opener: "keyboard", focusVisible: true },
44+
])("returns $opener focus to the opener on close", async (c) => {
45+
await using screen = await render(<ImagePreviewOpener />, {
46+
// The opener renders no links and reads no route.
47+
router: false,
48+
});
49+
const opener = screen.getByRole("button", { name: "Open preview" });
50+
if (c.opener === "mouse") {
51+
await userEvent.click(opener);
52+
} else {
53+
await userEvent.keyboard("{Tab}");
54+
await userEvent.keyboard("{Enter}");
55+
}
56+
await expect.element(page.getByRole("button", { name: "Close image preview" })).toHaveFocus();
57+
await userEvent.keyboard("{Escape}");
58+
await expect.element(opener).toHaveFocus();
59+
expect(opener.element().matches(":focus-visible")).toBe(c.focusVisible);
60+
});
61+
2362
it.each(["/work/pipeline.svg", "/work/diagram#v2.svg", "/work/diagram?v2.svg"])(
2463
"fits a markdown SVG without intrinsic size to the viewer: %s",
2564
async (path) => {

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

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -85,15 +85,17 @@ export const ExpandedImageDialog = memo(function ExpandedImageDialog({
8585
const [failedImageSrc, setFailedImageSrc] = useState<string | null>(null);
8686
const [accessibilityDetailsSrc, setAccessibilityDetailsSrc] = useState<string | null>(null);
8787
const zoomableImageRef = useRef<ZoomableImageHandle>(null);
88-
const [returnFocusTarget] = useState(() =>
89-
document.activeElement instanceof HTMLElement ? document.activeElement : null,
90-
);
88+
const [returnFocus] = useState(() => {
89+
const target = document.activeElement instanceof HTMLElement ? document.activeElement : null;
90+
return { target, focusVisible: target?.matches(":focus-visible") ?? false };
91+
});
9192
// The host unmounts the dialog outright, so Base UI never runs finalFocus. Without
9293
// this, focus stays on the removed dialog, and the composer that owned the opener
93-
// reads that as a blur and rests.
94+
// reads that as a blur and rests. Preserve mouse focus when Escape closes it.
9495
const close = () => {
9596
flushSync(onClose);
96-
if (returnFocusTarget?.isConnected) returnFocusTarget.focus({ preventScroll: true });
97+
const { target, focusVisible } = returnFocus;
98+
if (target?.isConnected) target.focus({ preventScroll: true, focusVisible });
9799
};
98100
const closeButtonRef = useRef<HTMLButtonElement>(null);
99101
const imageCount = preview.images.length;
@@ -177,7 +179,7 @@ export const ExpandedImageDialog = memo(function ExpandedImageDialog({
177179
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)]"
178180
onKeyDown={onKeyDown}
179181
initialFocus={closeButtonRef}
180-
finalFocus={() => returnFocusTarget}
182+
finalFocus={() => returnFocus.target}
181183
onClick={(event) => {
182184
if (event.target === event.currentTarget) close();
183185
}}
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
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([
9+
{ focus: "mouse", keptOpen: false },
10+
{ focus: "keyboard", keptOpen: true },
11+
])("scrolling with a $focus-focused hovered trigger keeps it open: $keptOpen", async (c) => {
12+
const onScroll = vi.fn();
13+
await using screen = await render(
14+
<TooltipScrollDismissArea
15+
data-testid="timeline"
16+
onScrollCapture={onScroll}
17+
className="h-32 overflow-y-auto"
18+
>
19+
<Tooltip>
20+
<TooltipTrigger>Timeline action</TooltipTrigger>
21+
<TooltipPopup>Description</TooltipPopup>
22+
</Tooltip>
23+
<div className="h-96" />
24+
</TooltipScrollDismissArea>,
25+
);
26+
const trigger = screen.getByRole("button", { name: "Timeline action" });
27+
if (c.focus === "mouse") {
28+
// A press closes the tooltip; hovering again reopens it with mouse focus kept.
29+
await userEvent.click(trigger);
30+
await userEvent.unhover(trigger);
31+
} else {
32+
await userEvent.keyboard("{Tab}");
33+
}
34+
await userEvent.hover(trigger);
35+
await expect.element(trigger).toHaveFocus();
36+
await expect.element(page.getByText("Description")).toBeVisible();
37+
38+
screen.getByTestId("timeline").element().scrollTop = 20;
39+
await vi.waitFor(() => expect(onScroll).toHaveBeenCalledOnce());
40+
41+
if (c.keptOpen) await expect.element(page.getByText("Description")).toBeVisible();
42+
else await expect.element(page.getByText("Description")).not.toBeInTheDocument();
43+
});

‎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)