Skip to content

πŸ™Œ OpenHands: AI-Driven Development

fix: support mouse drag-to-scroll on recommended rails (#16742)

Hiep Le4c2367afbf1d
diff --git a/__tests__/components/automations/recommended-automations-rail.test.tsx b/__tests__/components/automations/recommended-automations-rail.test.tsx
index 7b1012a6f9..096ac36cd6 100644
--- a/__tests__/components/automations/recommended-automations-rail.test.tsx
+++ b/__tests__/components/automations/recommended-automations-rail.test.tsx
@@ -29,6 +29,25 @@ describe("RecommendedAutomationsRail", () => {
vi.unstubAllGlobals();
});
+ function mockScrollMetrics(
+ element: HTMLElement,
+ metrics: { scrollWidth: number; clientWidth: number; scrollLeft: number },
+ ) {
+ Object.defineProperty(element, "scrollWidth", {
+ configurable: true,
+ value: metrics.scrollWidth,
+ });
+ Object.defineProperty(element, "clientWidth", {
+ configurable: true,
+ value: metrics.clientWidth,
+ });
+ Object.defineProperty(element, "scrollLeft", {
+ configurable: true,
+ writable: true,
+ value: metrics.scrollLeft,
+ });
+ }
+
it("renders remaining proven workflows before conversation-only extras", () => {
render(
<RecommendedAutomationsRail
@@ -134,25 +153,6 @@ describe("RecommendedAutomationsRail", () => {
});
describe("clipped-content fades", () => {
- function mockScrollMetrics(
- element: HTMLElement,
- metrics: { scrollWidth: number; clientWidth: number; scrollLeft: number },
- ) {
- Object.defineProperty(element, "scrollWidth", {
- configurable: true,
- value: metrics.scrollWidth,
- });
- Object.defineProperty(element, "clientWidth", {
- configurable: true,
- value: metrics.clientWidth,
- });
- Object.defineProperty(element, "scrollLeft", {
- configurable: true,
- writable: true,
- value: metrics.scrollLeft,
- });
- }
-
it("shows an edge gradient only on the clipped side", () => {
render(
<RecommendedAutomationsRail
@@ -190,4 +190,120 @@ describe("RecommendedAutomationsRail", () => {
expect(rightFade).toHaveAttribute("data-visible", "false");
});
});
+
+ describe("drag-to-scroll", () => {
+ it("scrolls the rail while dragging with the mouse", () => {
+ render(
+ <RecommendedAutomationsRail
+ installedAutomations={[]}
+ onSelect={vi.fn()}
+ />,
+ );
+ const scroller = screen.getByTestId(
+ "recommended-automations-rail-scroll",
+ );
+ mockScrollMetrics(scroller, {
+ scrollWidth: 900,
+ clientWidth: 320,
+ scrollLeft: 100,
+ });
+
+ fireEvent.mouseDown(scroller, { button: 0, clientX: 300 });
+ fireEvent.mouseMove(document, { clientX: 250, buttons: 1 });
+
+ expect(scroller.scrollLeft).toBe(150);
+ });
+
+ it("does not select a card on the click that ends a drag, but allows the next click", () => {
+ const onSelect = vi.fn();
+ render(
+ <RecommendedAutomationsRail
+ installedAutomations={[]}
+ onSelect={onSelect}
+ />,
+ );
+ const card = screen.getByTestId(
+ "recommended-automation-rail-card-slack-standup-digest",
+ );
+
+ fireEvent.mouseDown(card, { button: 0, clientX: 300 });
+ fireEvent.mouseMove(document, { clientX: 250, buttons: 1 });
+ fireEvent.mouseUp(document);
+ fireEvent.click(card);
+
+ expect(onSelect).not.toHaveBeenCalled();
+
+ fireEvent.mouseDown(card, { button: 0, clientX: 250 });
+ fireEvent.mouseUp(document);
+ fireEvent.click(card);
+
+ expect(onSelect).toHaveBeenCalledTimes(1);
+ });
+
+ it("treats movement below the drag threshold as a click", () => {
+ const onSelect = vi.fn();
+ render(
+ <RecommendedAutomationsRail
+ installedAutomations={[]}
+ onSelect={onSelect}
+ />,
+ );
+ const card = screen.getByTestId(
+ "recommended-automation-rail-card-slack-standup-digest",
+ );
+
+ fireEvent.mouseDown(card, { button: 0, clientX: 300 });
+ fireEvent.mouseMove(document, { clientX: 301, buttons: 1 });
+ fireEvent.mouseUp(document);
+ fireEvent.click(card);
+
+ expect(onSelect).toHaveBeenCalledTimes(1);
+ });
+
+ it("ignores drags started with a non-primary mouse button", () => {
+ render(
+ <RecommendedAutomationsRail
+ installedAutomations={[]}
+ onSelect={vi.fn()}
+ />,
+ );
+ const scroller = screen.getByTestId(
+ "recommended-automations-rail-scroll",
+ );
+ mockScrollMetrics(scroller, {
+ scrollWidth: 900,
+ clientWidth: 320,
+ scrollLeft: 100,
+ });
+
+ fireEvent.mouseDown(scroller, { button: 2, clientX: 300 });
+ fireEvent.mouseMove(document, { clientX: 250, buttons: 2 });
+
+ expect(scroller.scrollLeft).toBe(100);
+ });
+
+ it("ends the drag once the primary button is no longer held", () => {
+ render(
+ <RecommendedAutomationsRail
+ installedAutomations={[]}
+ onSelect={vi.fn()}
+ />,
+ );
+ const scroller = screen.getByTestId(
+ "recommended-automations-rail-scroll",
+ );
+ mockScrollMetrics(scroller, {
+ scrollWidth: 900,
+ clientWidth: 320,
+ scrollLeft: 100,
+ });
+
+ fireEvent.mouseDown(scroller, { button: 0, clientX: 300 });
+ fireEvent.mouseMove(document, { clientX: 250, buttons: 1 });
+ fireEvent.mouseMove(document, { clientX: 200, buttons: 0 });
+ fireEvent.mouseMove(document, { clientX: 100, buttons: 1 });
+
+ expect(scroller.scrollLeft).toBe(150);
+ });
+ });
});
diff --git a/src/components/features/automations/recommended-automations-rail.tsx b/src/components/features/automations/recommended-automations-rail.tsx
index 8ebe3acc2f..0c893b4313 100644
--- a/src/components/features/automations/recommended-automations-rail.tsx
+++ b/src/components/features/automations/recommended-automations-rail.tsx
@@ -14,6 +14,7 @@ import {
getRecommendedRailGroups,
} from "#/utils/recommended-automation-rail";
import { readScrollFadeState } from "#/utils/scroll-fade-state";
+import { useDragScroll } from "#/hooks/use-drag-scroll";
import type { Automation } from "#/types/automation";
import { AUTOMATION_STACK_SECTION_BOTTOM_CLASS } from "#/utils/automation-stack-section";
import { cn } from "#/utils/utils";
@@ -87,6 +88,8 @@ export function RecommendedAutomationsRail({
getRecommendedRailGroups(installedAutomations),
);
const scrollRef = useRef<HTMLDivElement>(null);
+ const { handleMouseDown, handleClickCapture, handleDragStart } =
+ useDragScroll(scrollRef);
const [fadeState, setFadeState] = useState({ left: false, right: false });
const updateFadeState = useCallback(() => {
@@ -130,12 +133,16 @@ export function RecommendedAutomationsRail({
</h2>
<div className="relative">
+ {/* eslint-disable-next-line jsx-a11y/no-noninteractive-element-interactions -- mouse drag-to-scroll is a pointer convenience; keyboard users scroll the list natively via the focusable cards. */}
<div
ref={scrollRef}
role="list"
data-testid="recommended-automations-rail-scroll"
onScroll={updateFadeState}
- className="flex flex-nowrap gap-3 overflow-x-auto scrollbar-hide"
+ onMouseDown={handleMouseDown}
+ onClickCapture={handleClickCapture}
+ onDragStart={handleDragStart}
+ className="flex flex-nowrap gap-3 overflow-x-auto scrollbar-hide select-none"
>
{items.map((automation) => (
<div key={automation.id} role="listitem">
diff --git a/src/hooks/use-drag-scroll.ts b/src/hooks/use-drag-scroll.ts
new file mode 100644
index 0000000000..8b11450ea8
--- /dev/null
+++ b/src/hooks/use-drag-scroll.ts
@@ -0,0 +1,94 @@
+import {
+ useCallback,
+ useEffect,
+ useRef,
+ useState,
+ type RefObject,
+} from "react";
+
+/** Movement required before a mouse gesture is treated as a scroll drag. */
+const DRAG_COMMIT_PX = 2;
+
+/**
+ * Mouse drag-to-scroll for a horizontal `overflow-x-auto` container. Touch
+ * input keeps the browser's native panning; only primary-button mouse drags
+ * are handled. After a committed drag, the click that follows mouseup is
+ * suppressed so child buttons are not activated by the drag release.
+ */
+export function useDragScroll(scrollRef: RefObject<HTMLElement | null>) {
+ const [isDragging, setIsDragging] = useState(false);
+ const startXRef = useRef(0);
+ const startScrollLeftRef = useRef(0);
+ const dragCommittedRef = useRef(false);
+
+ const handleMouseDown = useCallback(
+ (event: React.MouseEvent) => {
+ const element = scrollRef.current;
+ if (event.button !== 0 || !element) {
+ return;
+ }
+ dragCommittedRef.current = false;
+ startXRef.current = event.clientX;
+ startScrollLeftRef.current = element.scrollLeft;
+ setIsDragging(true);
+ },
+ [scrollRef],
+ );
+
+ const handleClickCapture = useCallback((event: React.MouseEvent) => {
+ if (!dragCommittedRef.current) {
+ return;
+ }
+ dragCommittedRef.current = false;
+ event.preventDefault();
+ event.stopPropagation();
+ }, []);
+
+ const handleDragStart = useCallback((event: React.DragEvent) => {
+ // Child <img> elements would otherwise start a native image drag.
+ event.preventDefault();
+ }, []);
+
+ useEffect(() => {
+ if (!isDragging) {
+ return undefined;
+ }
+
+ const handleMouseMove = (event: MouseEvent) => {
+ const element = scrollRef.current;
+ if (!element) {
+ return;
+ }
+
+ // The mouseup can be missed when released outside the window; end the
+ // drag once the primary button is no longer held.
+ if ((event.buttons & 1) === 0) {
+ setIsDragging(false);
+ return;
+ }
+
+ if (!dragCommittedRef.current) {
+ if (Math.abs(event.clientX - startXRef.current) < DRAG_COMMIT_PX) {
+ return;
+ }
+ dragCommittedRef.current = true;
+ }
+
+ event.preventDefault();
+ element.scrollLeft =
+ startScrollLeftRef.current - (event.clientX - startXRef.current);
+ };
+
+ const handleMouseUp = () => setIsDragging(false);
+
+ document.addEventListener("mousemove", handleMouseMove);
+ document.addEventListener("mouseup", handleMouseUp);
+
+ return () => {
+ document.removeEventListener("mousemove", handleMouseMove);
+ document.removeEventListener("mouseup", handleMouseUp);
+ };
+ }, [isDragging, scrollRef]);
+
+ return { handleMouseDown, handleClickCapture, handleDragStart };
+}