feat: implement virtualized grid list drag and drop ✨

lethemanh · rezk2ll · commit c4f93a12cc62 · 2025-07-21T16:42:02.000+02:00
diff --git a/react/GridList/Virtualized/Dnd/GridItem.jsx b/react/GridList/Virtualized/Dnd/GridItem.jsx
@@ -0,0 +1,86 @@
+import cx from 'classnames'
+import React, { useEffect } from 'react'
+import { useDrag, useDrop } from 'react-dnd'
+import { getEmptyImage } from 'react-dnd-html5-backend'
+
+const GridItem = ({ item, context, renderItem, className }) => {
+  const {
+    selectedItems = [],
+    itemsInDropProcess = [],
+    setItemsInDropProcess = () => {},
+    dragProps
+  } = context || {}
+
+  const {
+    onDrop,
+    canDrop: canDropProps,
+    canDrag: canDragProps,
+    dragId
+  } = dragProps
+
+  const isSelected = context?.isSelectedItem?.(item)
+  const isDisabled = itemsInDropProcess.includes(item._id)
+
+  const [{ isDragging }, dragRef, dragPreview] = useDrag(
+    () => ({
+      type: dragId,
+      isDragging: monitor => {
+        if (selectedItems.length > 0) {
+          return selectedItems.some(sel => sel._id === item._id)
+        }
+        return item._id === monitor.getItem().draggedItems?.[0]._id
+      },
+      item: {
+        draggedItems: selectedItems.length > 0 ? selectedItems : [item]
+      },
+      canDrag: () => {
+        const defaultCanDrag = canDragProps?.(item) ?? true
+        if (selectedItems.length > 0) {
+          return defaultCanDrag && isSelected
+        }
+        return defaultCanDrag
+      },
+      collect: monitor => ({
+        isDragging: monitor.isDragging()
+      })
+    }),
+    [item, selectedItems]
+  )
+
+  const [{ isOver }, dropRef] = useDrop(
+    () => ({
+      accept: dragId,
+      canDrop: () => (canDropProps ? canDropProps(item) : true),
+      drop: async draggedItem => {
+        setItemsInDropProcess(
+          draggedItem.draggedItems.map(dragged => dragged._id)
+        )
+        await onDrop(draggedItem.draggedItems, item, selectedItems)
+        setItemsInDropProcess([])
+      },
+      collect: monitor => ({
+        isOver: monitor.isOver()
+      })
+    }),
+    [item._id, selectedItems]
+  )
+
+  useEffect(() => {
+    dragPreview(getEmptyImage(), { captureDraggingState: true })
+  }, [dragPreview])
+
+  return (
+    <div
+      ref={node => dragRef(dropRef(node))}
+      className={cx(
+        className,
+        isDragging ? 'virtualized u-o-50' : 'virtualized'
+      )}
+      style={{ opacity: isDisabled ? 0.5 : 1 }}
+    >
+      {renderItem(item, { isDragging, isOver, isDisabled })}
+    </div>
+  )
+}
+
+export default GridItem
diff --git a/react/GridList/Virtualized/Dnd/index.jsx b/react/GridList/Virtualized/Dnd/index.jsx
@@ -0,0 +1,67 @@
+import React, { forwardRef, useState, useMemo } from 'react'
+
+import GridItem from './GridItem'
+import VirtualizedGridList from '../'
+import CustomDragLayer from '../../../utils/Dnd/CustomDrag/CustomDragLayer'
+import DnDConfigWrapper from '../../../utils/Dnd/DnDConfigWrapper'
+
+const VirtualizedGridListDnd = ({
+  dragProps,
+  context,
+  itemRenderer,
+  children,
+  componentProps = {
+    List: {},
+    Item: {}
+  },
+  components,
+  ...props
+}) => {
+  const [itemsInDropProcess, setItemsInDropProcess] = useState([])
+
+  const _context = useMemo(
+    () => ({
+      ...context,
+      dragProps,
+      itemRenderer,
+      itemsInDropProcess,
+      setItemsInDropProcess,
+      items: props.items
+    }),
+    [context, dragProps, itemRenderer, itemsInDropProcess, props.items]
+  )
+
+  return (
+    <>
+      <CustomDragLayer dragId={dragProps.dragId} />
+      <VirtualizedGridList
+        components={{
+          Scroller: forwardRef(({ ...scrollerProps }, ref) => (
+            <DnDConfigWrapper ref={ref}>
+              <div {...scrollerProps} ref={ref} />
+            </DnDConfigWrapper>
+          )),
+          Item: ({ context, children, ...props }) => {
+            const item = context?.items?.[props['data-index']]
+            return (
+              <GridItem
+                item={item}
+                context={context}
+                renderItem={() => <>{children}</>}
+                {...componentProps.Item}
+              />
+            )
+          },
+          ...components
+        }}
+        context={_context}
+        itemRenderer={itemRenderer}
+        {...props}
+      >
+        {children}
+      </VirtualizedGridList>
+    </>
+  )
+}
+
+export default VirtualizedGridListDnd
diff --git a/react/GridList/Virtualized/index.jsx b/react/GridList/Virtualized/index.jsx
@@ -2,11 +2,12 @@ import React, { forwardRef } from 'react'
 import { VirtuosoGrid } from 'react-virtuoso'
 
 const VirtualizedGridList = forwardRef(
-  ({ items = [], itemRenderer, components, ...props }, ref) => {
+  ({ items = [], itemRenderer, components, context, ...props }, ref) => {
     return (
       <VirtuosoGrid
         ref={ref}
         components={components}
+        context={context}
         style={{ height: '100%' }}
         totalCount={items.length}
         itemContent={index => itemRenderer(items[index])}
diff --git a/react/Table/Virtualized/Dnd/index.jsx b/react/Table/Virtualized/Dnd/index.jsx
@@ -1,7 +1,7 @@
 import React, { useState, useMemo } from 'react'
 
-import CustomDragLayer from './CustomDrag/CustomDragLayer'
 import virtuosoComponentsDnd from './virtuosoComponents'
+import CustomDragLayer from '../../../utils/Dnd/CustomDrag/CustomDragLayer'
 import VirtualizedTable from '../index'
 import virtuosoComponents from '../virtuosoComponents'
 
diff --git a/react/Table/Virtualized/Dnd/virtuosoComponents.jsx b/react/Table/Virtualized/Dnd/virtuosoComponents.jsx
@@ -1,8 +1,8 @@
 import React, { forwardRef } from 'react'
 
-import DnDConfigWrapper from './DnDConfigWrapper'
 import TableRowDnD from './TableRow'
 import TableContainer from '../../../TableContainer'
+import DnDConfigWrapper from '../../../utils/Dnd/DnDConfigWrapper'
 import virtuosoComponents from '../virtuosoComponents'
 
 /**
diff --git a/react/utils/Dnd/CustomDrag/CustomDragLayer.jsx b/react/utils/Dnd/CustomDrag/CustomDragLayer.jsx
@@ -0,0 +1,45 @@
+import React from 'react'
+import { useDragLayer } from 'react-dnd'
+
+import DragPreviewWrapper from './DragPreviewWrapper'
+
+const layerStyles = {
+  position: 'fixed',
+  pointerEvents: 'none',
+  zIndex: 100,
+  left: 0,
+  top: 0,
+  width: '100%',
+  height: '100%'
+}
+
+// Example find in the official documentation
+// https://react-dnd.github.io/react-dnd/examples/drag-around/custom-drag-layer
+export const CustomDragLayer = ({ dragId }) => {
+  const { itemType, isDragging, item, initialOffset, currentOffset } =
+    useDragLayer(monitor => ({
+      item: monitor.getItem(),
+      itemType: monitor.getItemType(),
+      initialOffset: monitor.getInitialSourceClientOffset(),
+      currentOffset: monitor.getSourceClientOffset(),
+      isDragging: monitor.isDragging()
+    }))
+
+  if (!isDragging) {
+    return null
+  }
+
+  return (
+    <div style={layerStyles}>
+      <DragPreviewWrapper
+        item={item}
+        itemType={itemType}
+        dragId={dragId}
+        initialOffset={initialOffset}
+        currentOffset={currentOffset}
+      />
+    </div>
+  )
+}
+
+export default CustomDragLayer
diff --git a/react/utils/Dnd/CustomDrag/DragPreview.jsx b/react/utils/Dnd/CustomDrag/DragPreview.jsx
@@ -0,0 +1,43 @@
+import React from 'react'
+
+import Badge from '../../../Badge'
+import Paper from '../../../Paper'
+import Typography from '../../../Typography'
+import { makeStyles } from '../../../styles'
+
+const useStyles = makeStyles({
+  root: {
+    width: 'fit-content'
+  }
+})
+
+const DragPreview = ({ fileName, selectedCount }) => {
+  const classes = useStyles()
+
+  return (
+    <>
+      {selectedCount > 1 ? (
+        <Badge
+          badgeContent={selectedCount}
+          size="large"
+          color="primary"
+          anchorOrigin={{
+            vertical: 'top',
+            horizontal: 'right'
+          }}
+          overlap="rectangular"
+        >
+          <Paper classes={classes} className="u-p-half u-maw-5">
+            <Typography>{fileName}</Typography>
+          </Paper>
+        </Badge>
+      ) : (
+        <Paper classes={classes} className="u-p-half u-maw-5">
+          <Typography>{fileName}</Typography>
+        </Paper>
+      )}
+    </>
+  )
+}
+
+export default React.memo(DragPreview)
diff --git a/react/utils/Dnd/CustomDrag/DragPreviewWrapper.jsx b/react/utils/Dnd/CustomDrag/DragPreviewWrapper.jsx
@@ -0,0 +1,52 @@
+import React, { useEffect, useState } from 'react'
+
+import DragPreview from './DragPreview'
+
+const makeStyles = ({ x, y }) => {
+  if (!x || !y) {
+    return { display: 'none' }
+  }
+
+  const transform = `translate(${x}px, ${y}px)`
+
+  return {
+    transform,
+    WebkitTransform: transform
+  }
+}
+
+const DragPreviewWrapper = ({
+  item,
+  itemType,
+  dragId,
+  initialOffset,
+  currentOffset
+}) => {
+  const [mousePosition, setMousePosition] = useState({ x: null, y: null })
+
+  useEffect(() => {
+    const handleMouseMove = e => {
+      setMousePosition({ x: e.clientX, y: e.clientY })
+    }
+
+    window.addEventListener('dragover', handleMouseMove)
+    return () => {
+      window.removeEventListener('dragover', handleMouseMove)
+    }
+  }, [])
+
+  if (!initialOffset || !currentOffset || itemType !== dragId) {
+    return null
+  }
+
+  return (
+    <div style={makeStyles(mousePosition)}>
+      <DragPreview
+        fileName={item.draggedItems[0].name}
+        selectedCount={item.draggedItems.length}
+      />
+    </div>
+  )
+}
+
+export default DragPreviewWrapper
diff --git a/react/utils/Dnd/DnDConfigWrapper.jsx b/react/utils/Dnd/DnDConfigWrapper.jsx
@@ -0,0 +1,48 @@
+import { forwardRef, useEffect, useState } from 'react'
+import { useDragDropManager } from 'react-dnd'
+
+const DnDConfigWrapper = forwardRef(({ children }, ref) => {
+  const dragDropManager = useDragDropManager()
+  const monitor = dragDropManager.getMonitor()
+  const [isDragging, setIsDragging] = useState(false)
+
+  useEffect(() => {
+    const unsubscribe = monitor.subscribeToStateChange(() => {
+      setIsDragging(monitor.isDragging())
+    })
+    return () => unsubscribe()
+  }, [monitor])
+
+  useEffect(() => {
+    if (!isDragging) return
+
+    const scrollThreshold = 100
+    const scrollMaxSpeed = 75
+
+    const intervalId = setInterval(() => {
+      const offset = monitor.getClientOffset()
+      const container = ref.current
+      if (!offset || !container) return
+
+      const { top, bottom } = container.getBoundingClientRect()
+      const distanceToTop = offset.y - top
+      const distanceToBottom = bottom - offset.y
+
+      if (distanceToTop < scrollThreshold) {
+        const speed = scrollMaxSpeed * (1 - distanceToTop / scrollThreshold)
+        container.scrollBy(0, -speed)
+      } else if (distanceToBottom < scrollThreshold) {
+        const speed = scrollMaxSpeed * (1 - distanceToBottom / scrollThreshold)
+        container.scrollBy(0, speed)
+      }
+    }, 16) // ~60fps
+
+    return () => clearInterval(intervalId)
+  }, [isDragging, monitor, ref])
+
+  return children
+})
+
+DnDConfigWrapper.displayName = 'DnDConfigWrapper'
+
+export default DnDConfigWrapper
