Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import {
MotionValue,
useWillChange,
} from "../../../"
import { pointerDown, pointerMove, render } from "../../../jest.setup"
import { pointerDown, pointerMove, pointerUp, render } from "../../../jest.setup"
import { WillChangeMotionValue } from "../../../value/use-will-change/WillChangeMotionValue"
import { nextFrame } from "../../__tests__/utils"
import { deferred, drag, dragFrame, MockDrag, Point, sleep } from "./utils"
Expand Down Expand Up @@ -143,6 +143,31 @@ describe("dragging", () => {
expect(onDragEnd).toBeCalledTimes(1)
})

test("dragEnd fires when a child stops pointerup propagation (#2794)", async () => {
const onDragEnd = jest.fn()
const Component = () => (
<MockDrag>
<motion.div drag="y" onDragEnd={onDragEnd}>
<div
data-testid="child"
onPointerUp={(event) => event.stopPropagation()}
/>
</motion.div>
</MockDrag>
)

const { container, getByTestId, rerender } = render(<Component />)
rerender(<Component />)

await drag(container.firstChild).to(0, 100)

pointerUp(getByTestId("child"))

await nextFrame()

expect(onDragEnd).toBeCalledTimes(1)
})

test("dragEnd doesn't fire if dragging never initiated", async () => {
const onDragEnd = jest.fn()
const Component = () => (
Expand Down
13 changes: 10 additions & 3 deletions packages/framer-motion/src/gestures/pan/PanSession.ts
Original file line number Diff line number Diff line change
Expand Up @@ -148,21 +148,28 @@ export class PanSession {
onSessionStart &&
onSessionStart(event, getPanInfo(initialInfo, this.history))

// Listen in the capture phase so a descendant calling
// stopPropagation() (e.g. in its own pointerup handler) can't
// prevent the gesture from ending. See #2794.
const eventOptions = { passive: true, capture: true }
this.removeListeners = pipe(
addPointerEvent(
this.contextWindow,
"pointermove",
this.handlePointerMove
this.handlePointerMove,
eventOptions
),
addPointerEvent(
this.contextWindow,
"pointerup",
this.handlePointerUp
this.handlePointerUp,
eventOptions
),
addPointerEvent(
this.contextWindow,
"pointercancel",
this.handlePointerUp
this.handlePointerUp,
eventOptions
)
)

Expand Down
2 changes: 1 addition & 1 deletion packages/motion-dom/src/events/add-dom-event.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ export function addDomEvent(
) {
target.addEventListener(eventName, handler, options)

return () => target.removeEventListener(eventName, handler)
return () => target.removeEventListener(eventName, handler, options)
}
28 changes: 24 additions & 4 deletions packages/motion-dom/src/gestures/press/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,25 @@ export function press(

const onPressEnd = onPressStart(target, startEvent)

/**
* End listeners run in the capture phase so a descendant calling
* stopPropagation() in its own pointerup handler can't prevent the
* press gesture from ending. This also keeps the gesture-end
* ordering consistent with the drag gesture. See #2794.
*/
const endEventOptions = { ...eventOptions, capture: true }

const onPointerEnd = (endEvent: PointerEvent, success: boolean) => {
window.removeEventListener("pointerup", onPointerUp)
window.removeEventListener("pointercancel", onPointerCancel)
window.removeEventListener(
"pointerup",
onPointerUp,
endEventOptions
)
window.removeEventListener(
"pointercancel",
onPointerCancel,
endEventOptions
)

if (isPressing.has(target)) {
isPressing.delete(target)
Expand Down Expand Up @@ -99,8 +115,12 @@ export function press(
onPointerEnd(cancelEvent, false)
}

window.addEventListener("pointerup", onPointerUp, eventOptions)
window.addEventListener("pointercancel", onPointerCancel, eventOptions)
window.addEventListener("pointerup", onPointerUp, endEventOptions)
window.addEventListener(
"pointercancel",
onPointerCancel,
endEventOptions
)
}

targets.forEach((target: EventTarget) => {
Expand Down