From 89b250a4f6780e676678011339dac35b7e8fde4f Mon Sep 17 00:00:00 2001 From: Joe Anderson Date: Fri, 21 Jun 2024 18:28:58 +0100 Subject: [PATCH] Make drop and dragend event handlers global --- .changeset/grumpy-icons-refuse.md | 5 ++++ .../slate-react/src/components/editable.tsx | 30 +++++++++++-------- packages/slate-react/src/index.ts | 2 +- 3 files changed, 23 insertions(+), 14 deletions(-) create mode 100644 .changeset/grumpy-icons-refuse.md diff --git a/.changeset/grumpy-icons-refuse.md b/.changeset/grumpy-icons-refuse.md new file mode 100644 index 0000000000..c23438bd54 --- /dev/null +++ b/.changeset/grumpy-icons-refuse.md @@ -0,0 +1,5 @@ +--- +'slate-react': patch +--- + +Fix: `state.isDraggingInternally` is stale if a drop handler outside the editor causes the dragged DOM element to unmount diff --git a/packages/slate-react/src/components/editable.tsx b/packages/slate-react/src/components/editable.tsx index ffd6e251d5..74a13af381 100644 --- a/packages/slate-react/src/components/editable.tsx +++ b/packages/slate-react/src/components/editable.tsx @@ -822,26 +822,37 @@ export const Editable = (props: EditableProps) => { ] ) - // Attach a native DOM event handler for `selectionchange`, because React's - // built-in `onSelect` handler doesn't fire for all selection changes. It's a - // leaky polyfill that only fires on keypresses or clicks. Instead, we want to - // fire for any change to the selection inside the editor. (2019/11/04) - // https://github.com/facebook/react/issues/5785 useIsomorphicLayoutEffect(() => { const window = ReactEditor.getWindow(editor) + // Attach a native DOM event handler for `selectionchange`, because React's + // built-in `onSelect` handler doesn't fire for all selection changes. It's + // a leaky polyfill that only fires on keypresses or clicks. Instead, we + // want to fire for any change to the selection inside the editor. + // (2019/11/04) https://github.com/facebook/react/issues/5785 window.document.addEventListener( 'selectionchange', scheduleOnDOMSelectionChange ) + // Listen for dragend and drop globally. In Firefox, if a drop handler + // initiates an operation that causes the originally dragged element to + // unmount, that element will not emit a dragend event. (2024/06/21) + const stoppedDragging = () => { + state.isDraggingInternally = false + } + window.document.addEventListener('dragend', stoppedDragging) + window.document.addEventListener('drop', stoppedDragging) + return () => { window.document.removeEventListener( 'selectionchange', scheduleOnDOMSelectionChange ) + window.document.removeEventListener('dragend', stoppedDragging) + window.document.removeEventListener('drop', stoppedDragging) } - }, [scheduleOnDOMSelectionChange]) + }, [scheduleOnDOMSelectionChange, state]) const decorations = decorate([editor, []]) @@ -1378,8 +1389,6 @@ export const Editable = (props: EditableProps) => { ReactEditor.focus(editor) } } - - state.isDraggingInternally = false }, [readOnly, editor, attributes.onDrop, state] )} @@ -1393,11 +1402,6 @@ export const Editable = (props: EditableProps) => { ) { attributes.onDragEnd(event) } - - // When dropping on a different droppable element than the current editor, - // `onDrop` is not called. So we need to clean up in `onDragEnd` instead. - // Note: `onDragEnd` is only called when `onDrop` is not called - state.isDraggingInternally = false }, [readOnly, state, attributes, editor] )} diff --git a/packages/slate-react/src/index.ts b/packages/slate-react/src/index.ts index 4568b8f29f..efb3e1f7d6 100644 --- a/packages/slate-react/src/index.ts +++ b/packages/slate-react/src/index.ts @@ -26,4 +26,4 @@ export { ReactEditor } from './plugin/react-editor' export { withReact } from './plugin/with-react' // Utils -export { NODE_TO_INDEX, NODE_TO_PARENT } from "./utils/weak-maps" +export { NODE_TO_INDEX, NODE_TO_PARENT } from './utils/weak-maps'