Last active
August 31, 2020 21:44
-
-
Save nickytonline/9af2bbd95fb0c28cbb1ee7fd83fe24c3 to your computer and use it in GitHub Desktop.
A (P)React hook for attaching drag and drop events to an element.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* Hook for drag attaching drag and drop functionality to a DOM element | |
* | |
* @param {object} props | |
* @param {Function} props.onDragOver The handler that runs when the dragover event is fired. | |
* @param {Function} props.onDragExit The handler that runs when the dragexit/dragleave events are fired. | |
* @param {Function} props.onDrop The handler that runs when the drop event is fired. | |
*/ | |
export function useDragAndDrop({ onDragOver, onDragExit, onDrop }) { | |
const [element, setElement] = useState(null); | |
useEffect(() => { | |
if (!element) { | |
return; | |
} | |
const noDragAndDropHandler = (event) => event.preventDefault(); | |
document.addEventListener('dragover', noDragAndDropHandler); | |
document.addEventListener('drop', noDragAndDropHandler); | |
element.addEventListener('dragover', onDragOver); | |
element.addEventListener('dragexit', onDragExit); | |
element.addEventListener('dragleave', onDragExit); | |
element.addEventListener('drop', onDrop); | |
return () => { | |
document.removeEventListener('dragover', noDragAndDropHandler); | |
document.removeEventListener('drop', noDragAndDropHandler); | |
element.removeEventListener('dragover', onDragOver); | |
element.removeEventListener('dragexit', onDragExit); | |
element.addEventListener('dragleave', onDragExit); | |
element.removeEventListener('drop', onDrop); | |
}; | |
}, [element, onDragOver, onDragExit, onDrop, allowDropOnDocument]); | |
return { setElement }; | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The
element
would be set viasetElement
in the component consuming the hook. The value passed in tosetElement
would be a DOM element from aref
.