feat(ui): drag-and-drop reordering for reference images

invokeai/frontend/web/src/features/controlLayers/components/RefImage/RefImageList.tsx

@@ -1,6 +1,10 @@
+import { monitorForElements } from '@atlaskit/pragmatic-drag-and-drop/element/adapter';
+import { extractClosestEdge } from '@atlaskit/pragmatic-drag-and-drop-hitbox/closest-edge';
+import { reorderWithEdge } from '@atlaskit/pragmatic-drag-and-drop-hitbox/util/reorder-with-edge';
 import { Button, Collapse, Divider, Flex, IconButton } from '@invoke-ai/ui-library';
-import { useAppSelector, useAppStore } from 'app/store/storeHooks';
+import { useAppDispatch, useAppSelector, useAppStore } from 'app/store/storeHooks';
 import { useImageUploadButton } from 'common/hooks/useImageUploadButton';
+import { colorTokenToCssVar } from 'common/util/colorTokenToCssVar';
 import { RefImagePreview } from 'features/controlLayers/components/RefImage/RefImagePreview';
 import { CanvasManagerProviderGate } from 'features/controlLayers/contexts/CanvasManagerProviderGate';
 import { RefImageIdContext } from 'features/controlLayers/contexts/RefImageIdContext';
@@ -9,15 +13,18 @@ import { useNewGlobalReferenceImageFromBbox } from 'features/controlLayers/hooks
 import { useCanvasIsBusySafe } from 'features/controlLayers/hooks/useCanvasIsBusy';
 import {
   refImageAdded,
+  refImagesReordered,
   selectIsRefImagePanelOpen,
   selectRefImageEntityIds,
   selectSelectedRefEntityId,
 } from 'features/controlLayers/store/refImagesSlice';
 import { imageDTOToCroppableImage } from 'features/controlLayers/store/util';
-import { addGlobalReferenceImageDndTarget } from 'features/dnd/dnd';
+import { addGlobalReferenceImageDndTarget, singleRefImageDndSource } from 'features/dnd/dnd';
 import { DndDropTarget } from 'features/dnd/DndDropTarget';
+import { triggerPostMoveFlash } from 'features/dnd/util';
 import { selectActiveTab } from 'features/ui/store/uiSelectors';
-import { memo, useMemo } from 'react';
+import { memo, useEffect, useMemo } from 'react';
+import { flushSync } from 'react-dom';
 import { useTranslation } from 'react-i18next';
 import { PiBoundingBoxBold, PiUploadBold } from 'react-icons/pi';
 import type { ImageDTO } from 'services/api/types';
@@ -29,6 +36,69 @@ export const RefImageList = memo(() => {
   const ids = useAppSelector(selectRefImageEntityIds);
   const isPanelOpen = useAppSelector(selectIsRefImagePanelOpen);
   const selectedEntityId = useAppSelector(selectSelectedRefEntityId);
+  const dispatch = useAppDispatch();
+
+  useEffect(() => {
+    return monitorForElements({
+      canMonitor({ source }) {
+        return singleRefImageDndSource.typeGuard(source.data);
+      },
+      onDrop({ location, source }) {
+        const target = location.current.dropTargets[0];
+        if (!target) {
+          return;
+        }
+
+        const sourceData = source.data;
+        const targetData = target.data;
+
+        if (!singleRefImageDndSource.typeGuard(sourceData) || !singleRefImageDndSource.typeGuard(targetData)) {
+          return;
+        }
+
+        const indexOfSource = ids.indexOf(sourceData.payload.id);
+        const indexOfTarget = ids.indexOf(targetData.payload.id);
+
+        if (indexOfTarget < 0 || indexOfSource < 0) {
+          return;
+        }
+
+        if (indexOfSource === indexOfTarget) {
+          return;
+        }
+
+        const closestEdgeOfTarget = extractClosestEdge(targetData);
+
+        let edgeIndexDelta = 0;
+        if (closestEdgeOfTarget === 'right') {
+          edgeIndexDelta = 1;
+        } else if (closestEdgeOfTarget === 'left') {
+          edgeIndexDelta = -1;
+        }
+
+        if (indexOfSource === indexOfTarget + edgeIndexDelta) {
+          return;
+        }
+
+        const nextIds = reorderWithEdge({
+          list: ids,
+          startIndex: indexOfSource,
+          indexOfTarget,
+          closestEdgeOfTarget,
+          axis: 'horizontal',
+        });
+
+        flushSync(() => {
+          dispatch(refImagesReordered({ ids: nextIds }));
+        });
+
+        const element = document.querySelector(`[data-ref-image-id="${sourceData.payload.id}"]`);
+        if (element instanceof HTMLElement) {
+          triggerPostMoveFlash(element, colorTokenToCssVar('base.700'));
+        }
+      },
+    });
+  }, [dispatch, ids]);
 
   return (
     <Flex flexDir="column">

invokeai/frontend/web/src/features/controlLayers/components/RefImage/RefImagePreview.tsx

@@ -1,7 +1,8 @@
 import type { SystemStyleObject } from '@invoke-ai/ui-library';
-import { Flex, Icon, IconButton, Skeleton, Text, Tooltip } from '@invoke-ai/ui-library';
+import { Box, Flex, Icon, IconButton, Skeleton, Text, Tooltip } from '@invoke-ai/ui-library';
 import { useAppDispatch, useAppSelector } from 'app/store/storeHooks';
 import { round } from 'es-toolkit/compat';
+import { useRefImageDnd } from 'features/controlLayers/components/RefImage/useRefImageDnd';
 import { useRefImageEntity } from 'features/controlLayers/components/RefImage/useRefImageEntity';
 import { useRefImageIdContext } from 'features/controlLayers/contexts/RefImageIdContext';
 import { selectMainModelConfig } from 'features/controlLayers/store/paramsSlice';
@@ -12,7 +13,8 @@ import {
 } from 'features/controlLayers/store/refImagesSlice';
 import { isIPAdapterConfig } from 'features/controlLayers/store/types';
 import { getGlobalReferenceImageWarnings } from 'features/controlLayers/store/validators';
-import { memo, useCallback, useEffect, useMemo, useState } from 'react';
+import { DndListDropIndicator } from 'features/dnd/DndListDropIndicator';
+import { memo, useCallback, useEffect, useMemo, useRef, useState } from 'react';
 import { useTranslation } from 'react-i18next';
 import { PiExclamationMarkBold, PiEyeSlashBold, PiImageBold } from 'react-icons/pi';
 import { useImageDTOFromCroppableImage } from 'services/api/endpoints/images';
@@ -49,6 +51,13 @@ const weightDisplaySx: SystemStyleObject = {
   },
 };
 
+// Scoped to ref image thumbnails only: prevents the iOS long-press "Save Image"
+// callout from hijacking drag attempts on iPad.
+const wrapperSx: SystemStyleObject = {
+  WebkitTouchCallout: 'none',
+  userSelect: 'none',
+};
+
 const getImageSxWithWeight = (weight: number): SystemStyleObject => {
   const fillPercentage = Math.max(0, Math.min(100, weight * 100));
 
@@ -75,6 +84,8 @@ export const RefImagePreview = memo(() => {
   const isPanelOpen = useAppSelector(selectIsRefImagePanelOpen);
   const [showWeightDisplay, setShowWeightDisplay] = useState(false);
   const isExternalModel = !!mainModelConfig && isExternalApiModelConfig(mainModelConfig);
+  const dndRef = useRef<HTMLDivElement>(null);
+  const [dndListState, isDragging] = useRefImageDnd(dndRef, id);
 
   const imageDTO = useImageDTOFromCroppableImage(entity.config.image);
 
@@ -108,98 +119,124 @@ export const RefImagePreview = memo(() => {
 
   if (!entity.config.image) {
     return (
-      <IconButton
-        aria-label={t('controlLayers.selectRefImage')}
+      <Box
+        ref={dndRef}
+        position="relative"
         h="full"
-        variant="ghost"
         aspectRatio="1/1"
-        borderWidth={1}
-        borderStyle="solid"
-        borderColor="error.300"
-        borderRadius="base"
-        icon={<PiImageBold />}
-        colorScheme="error"
-        onClick={onClick}
         flexShrink={0}
-        data-is-open={selectedEntityId === id && isPanelOpen}
-        data-is-error={true}
-        data-is-disabled={!entity.isEnabled}
-        sx={sx}
-      />
+        opacity={isDragging ? 0.3 : 1}
+        data-ref-image-id={id}
+        sx={wrapperSx}
+      >
+        <IconButton
+          aria-label={t('controlLayers.selectRefImage')}
+          h="full"
+          variant="ghost"
+          aspectRatio="1/1"
+          borderWidth={1}
+          borderStyle="solid"
+          borderColor="error.300"
+          borderRadius="base"
+          icon={<PiImageBold />}
+          colorScheme="error"
+          onClick={onClick}
+          flexShrink={0}
+          data-is-open={selectedEntityId === id && isPanelOpen}
+          data-is-error={true}
+          data-is-disabled={!entity.isEnabled}
+          sx={sx}
+        />
+        <DndListDropIndicator dndState={dndListState} />
+      </Box>
     );
   }
   return (
-    <Tooltip label={warnings.length > 0 ? <RefImageWarningTooltipContent warnings={warnings} /> : undefined}>
-      <Flex
-        position="relative"
-        borderWidth={1}
-        borderStyle="solid"
-        borderRadius="base"
-        aspectRatio="1/1"
-        maxW="full"
-        maxH="full"
-        flexShrink={0}
-        sx={sx}
-        data-is-open={selectedEntityId === id && isPanelOpen}
-        data-is-error={warnings.length > 0}
-        data-is-disabled={!entity.isEnabled}
-        role="button"
-        onClick={onClick}
-        cursor="pointer"
-        overflow="hidden"
-      >
-        {imageDTO ? (
-          <img
-            src={imageDTO.image_url}
-            style={{ objectFit: 'contain', aspectRatio: '1 / 1', maxWidth: '100%', maxHeight: '100%' }}
-            height={imageDTO.height}
-            alt={imageDTO.image_name}
-          />
-        ) : (
-          <Skeleton h="full" aspectRatio="1/1" />
-        )}
-        {isIPAdapterConfig(entity.config) && !isExternalModel && (
-          <Flex
-            position="absolute"
-            inset={0}
-            fontWeight="semibold"
-            alignItems="center"
-            justifyContent="center"
-            zIndex={1}
-            data-visible={showWeightDisplay}
-            sx={weightDisplaySx}
-          >
-            <Text filter="drop-shadow(0px 0px 4px rgb(0, 0, 0)) drop-shadow(0px 0px 2px rgba(0, 0, 0, 1))">
-              {`${round(entity.config.weight * 100, 2)}%`}
-            </Text>
-          </Flex>
-        )}
-        {!entity.isEnabled && (
-          <Icon
-            position="absolute"
-            top="50%"
-            left="50%"
-            transform="translateX(-50%) translateY(-50%)"
-            filter="drop-shadow(0px 0px 4px rgb(0, 0, 0)) drop-shadow(0px 0px 2px rgba(0, 0, 0, 1))"
-            color="base.300"
-            boxSize={8}
-            as={PiEyeSlashBold}
-          />
-        )}
-        {entity.isEnabled && warnings.length > 0 && (
-          <Icon
-            position="absolute"
-            top="50%"
-            left="50%"
-            transform="translateX(-50%) translateY(-50%)"
-            filter="drop-shadow(0px 0px 4px rgb(0, 0, 0)) drop-shadow(0px 0px 2px rgba(0, 0, 0, 1))"
-            color="error.500"
-            boxSize={12}
-            as={PiExclamationMarkBold}
-          />
-        )}
-      </Flex>
-    </Tooltip>
+    <Box
+      ref={dndRef}
+      position="relative"
+      h="full"
+      aspectRatio="1/1"
+      flexShrink={0}
+      opacity={isDragging ? 0.3 : 1}
+      data-ref-image-id={id}
+      sx={wrapperSx}
+    >
+      <Tooltip label={warnings.length > 0 ? <RefImageWarningTooltipContent warnings={warnings} /> : undefined}>
+        <Flex
+          position="relative"
+          borderWidth={1}
+          borderStyle="solid"
+          borderRadius="base"
+          aspectRatio="1/1"
+          maxW="full"
+          h="full"
+          maxH="full"
+          flexShrink={0}
+          sx={sx}
+          data-is-open={selectedEntityId === id && isPanelOpen}
+          data-is-error={warnings.length > 0}
+          data-is-disabled={!entity.isEnabled}
+          role="button"
+          onClick={onClick}
+          cursor="pointer"
+          overflow="hidden"
+        >
+          {imageDTO ? (
+            <img
+              src={imageDTO.image_url}
+              style={{ objectFit: 'contain', aspectRatio: '1 / 1', maxWidth: '100%', maxHeight: '100%' }}
+              height={imageDTO.height}
+              alt={imageDTO.image_name}
+              draggable={false}
+            />
+          ) : (
+            <Skeleton h="full" aspectRatio="1/1" />
+          )}
+          {isIPAdapterConfig(entity.config) && !isExternalModel && (
+            <Flex
+              position="absolute"
+              inset={0}
+              fontWeight="semibold"
+              alignItems="center"
+              justifyContent="center"
+              zIndex={1}
+              data-visible={showWeightDisplay}
+              sx={weightDisplaySx}
+            >
+              <Text filter="drop-shadow(0px 0px 4px rgb(0, 0, 0)) drop-shadow(0px 0px 2px rgba(0, 0, 0, 1))">
+                {`${round(entity.config.weight * 100, 2)}%`}
+              </Text>
+            </Flex>
+          )}
+          {!entity.isEnabled && (
+            <Icon
+              position="absolute"
+              top="50%"
+              left="50%"
+              transform="translateX(-50%) translateY(-50%)"
+              filter="drop-shadow(0px 0px 4px rgb(0, 0, 0)) drop-shadow(0px 0px 2px rgba(0, 0, 0, 1))"
+              color="base.300"
+              boxSize={8}
+              as={PiEyeSlashBold}
+            />
+          )}
+          {entity.isEnabled && warnings.length > 0 && (
+            <Icon
+              position="absolute"
+              top="50%"
+              left="50%"
+              transform="translateX(-50%) translateY(-50%)"
+              filter="drop-shadow(0px 0px 4px rgb(0, 0, 0)) drop-shadow(0px 0px 2px rgba(0, 0, 0, 1))"
+              color="error.500"
+              boxSize={12}
+              as={PiExclamationMarkBold}
+            />
+          )}
+        </Flex>
+      </Tooltip>
+      <DndListDropIndicator dndState={dndListState} />
+    </Box>
   );
 });
 RefImagePreview.displayName = 'RefImagePreview';