Skip to content

Commit 0c113c4

Browse files
fix(web): finish settings search jumps after panel expansion
1 parent ef4e04f commit 0c113c4

2 files changed

Lines changed: 111 additions & 22 deletions

File tree

‎apps/web/src/components/settings/settingsLayout.browser.test.tsx‎

Lines changed: 63 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ describe("settings search targets", () => {
6262
expect(target.classList.contains(PULSE)).toBe(false);
6363
});
6464

65-
it.each(["before", "after"] as const)(
66-
"fully reveals the row when selected %s the opening style clears",
65+
it.each(["before", "after", "without animation"] as const)(
66+
"fully reveals the row when the opening style clears: %s",
6767
async (phase) => {
6868
// Keep scrolling synchronous while the panel height transitions independently.
6969
reduceMotion(true);
@@ -81,19 +81,30 @@ describe("settings search targets", () => {
8181
const target = document.getElementById("legacy-sidebar")!;
8282

8383
void panel.offsetHeight;
84-
panel.style.height = "600px";
85-
const transition = panel.getAnimations()[0]!;
86-
expect(transition).toBeDefined();
87-
transition.pause();
88-
transition.currentTime = phase === "before" ? 0 : 100;
89-
if (phase === "after") panel.removeAttribute("data-starting-style");
84+
const animated = phase !== "without animation";
85+
if (animated) {
86+
panel.style.height = "600px";
87+
} else {
88+
panel.style.transition = "none";
89+
}
90+
const transition = panel.getAnimations()[0];
91+
if (animated) {
92+
expect(transition).toBeDefined();
93+
transition!.pause();
94+
transition!.currentTime = phase === "before" ? 0 : 100;
95+
if (phase === "after") panel.removeAttribute("data-starting-style");
96+
}
9097

9198
expect(scrollToSettingsTarget("legacy-sidebar")).toBe(true);
92-
const opened = new Promise<void>((resolve) => {
93-
panel.addEventListener("transitionend", () => resolve(), { once: true });
94-
});
99+
expect(document.activeElement).toBe(target);
100+
const opened = animated
101+
? new Promise<void>((resolve) => {
102+
panel.addEventListener("transitionend", () => resolve(), { once: true });
103+
})
104+
: Promise.resolve();
105+
panel.style.height = "600px";
95106
panel.removeAttribute("data-starting-style");
96-
transition.finish();
107+
transition?.finish();
97108
await opened;
98109

99110
const bounds = viewport.getBoundingClientRect();
@@ -104,6 +115,46 @@ describe("settings search targets", () => {
104115
},
105116
);
106117

118+
it("keeps the newer search destination visible when an earlier panel finishes opening", async () => {
119+
reduceMotion(true);
120+
document.body.innerHTML = `
121+
<div id="viewport" style="height: 200px; overflow: auto; overflow-anchor: none">
122+
<div id="new-target" tabindex="-1" style="height: 40px">New target</div>
123+
<div style="height: 1000px"></div>
124+
<div id="panel" data-slot="collapsible-panel" data-open data-starting-style
125+
style="height: 0; overflow: hidden; transition: height 200ms linear">
126+
<div style="height: 500px"></div>
127+
<div id="legacy-sidebar" tabindex="-1" style="height: 40px">Legacy sidebar</div>
128+
<div style="height: 60px"></div>
129+
</div>
130+
</div>`;
131+
const panel = document.getElementById("panel")!;
132+
void panel.offsetHeight;
133+
panel.style.height = "600px";
134+
const transition = panel.getAnimations()[0]!;
135+
transition.pause();
136+
transition.currentTime = 100;
137+
138+
scrollToSettingsTarget("legacy-sidebar");
139+
panel.removeAttribute("data-starting-style");
140+
scrollToSettingsTarget("new-target");
141+
const opened = new Promise<void>((resolve) => {
142+
panel.addEventListener("transitionend", () => resolve(), { once: true });
143+
});
144+
transition.finish();
145+
await opened;
146+
147+
const viewport = document.getElementById("viewport")!;
148+
const target = document.getElementById("new-target")!;
149+
expect(target.getBoundingClientRect().top).toBeGreaterThanOrEqual(
150+
viewport.getBoundingClientRect().top,
151+
);
152+
expect(target.getBoundingClientRect().bottom).toBeLessThanOrEqual(
153+
viewport.getBoundingClientRect().bottom,
154+
);
155+
expect(document.activeElement).toBe(target);
156+
});
157+
107158
it("leaves not-yet-mounted destinations to their mount lifecycle", () => {
108159
expect(scrollToSettingsTarget("archive")).toBe(false);
109160
});

‎apps/web/src/components/settings/settingsLayout.tsx‎

Lines changed: 48 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,10 @@ function SettingsSearchTargetProvider({
7575
return <SettingsSearchTargetContext value={value}>{children}</SettingsSearchTargetContext>;
7676
}
7777

78+
let pendingTargetScroll: AbortController | undefined;
79+
7880
function scrollAndFocusSettingsTarget(target: HTMLElement, highlight = true): void {
81+
pendingTargetScroll?.abort();
7982
const prefersReducedMotion = window.matchMedia("(prefers-reduced-motion: reduce)").matches;
8083
const markedScrollTarget =
8184
typeof target.querySelector === "function"
@@ -93,18 +96,53 @@ function scrollAndFocusSettingsTarget(target: HTMLElement, highlight = true): vo
9396
block: "center",
9497
});
9598
scroll();
96-
// A target inside a collapsible panel that is still opening is measured
97-
// before the panel reaches full height, so scroll again once it has grown.
98-
const openingPanel = target.parentElement?.closest<HTMLElement>(
99-
'[data-slot="collapsible-panel"][data-starting-style]',
99+
const panel = target.parentElement?.closest<HTMLElement>(
100+
'[data-slot="collapsible-panel"][data-open]',
100101
);
101-
if (openingPanel) {
102-
const onPanelOpened = (event: TransitionEvent) => {
103-
if (event.target !== openingPanel) return;
104-
openingPanel.removeEventListener("transitionend", onPanelOpened);
105-
scroll();
102+
const heightTransition = () =>
103+
panel
104+
?.getAnimations()
105+
.find(
106+
(animation) =>
107+
animation instanceof CSSTransition && animation.transitionProperty === "height",
108+
);
109+
if (panel && (panel.hasAttribute("data-starting-style") || heightTransition())) {
110+
const controller = new AbortController();
111+
pendingTargetScroll = controller;
112+
const { signal } = controller;
113+
const finishScroll = () => {
114+
if (signal.aborted) return;
115+
controller.abort();
116+
if (
117+
panel.hasAttribute("data-open") &&
118+
target.isConnected &&
119+
document.activeElement === target
120+
) {
121+
scroll();
122+
}
123+
};
124+
const waitForHeight = () => {
125+
const transition = heightTransition();
126+
if (transition) {
127+
void transition.finished.then(finishScroll, () => controller.abort());
128+
} else {
129+
finishScroll();
130+
}
106131
};
107-
openingPanel.addEventListener("transitionend", onPanelOpened);
132+
// Base UI clears the starting style before the height transition finishes.
133+
if (panel.hasAttribute("data-starting-style")) {
134+
const observer = new MutationObserver(() => {
135+
if (!panel.hasAttribute("data-starting-style")) {
136+
observer.disconnect();
137+
waitForHeight();
138+
}
139+
});
140+
observer.observe(panel, { attributes: true, attributeFilter: ["data-starting-style"] });
141+
signal.addEventListener("abort", () => observer.disconnect(), { once: true });
142+
} else {
143+
waitForHeight();
144+
}
145+
target.addEventListener("blur", () => controller.abort(), { once: true, signal });
108146
}
109147
target.focus({ preventScroll: true });
110148
target.classList.remove("settings-search-target-pulse");

0 commit comments

Comments
 (0)