使用react-dnd編寫一個可拖拽排列的list

更新時間：2024年03月15日 11:15:01 作者：利器之路

這篇文章主要為大家詳細介紹了如何使用react-dnd編寫一個可拖拽排列的list,文中的示例代碼講解詳細,感興趣的小伙伴可以跟隨小編一起學習一下

這個是atlassian用來開發(fā)jira看板功能的庫，有動畫效果，很漂亮，確實對得起這個包的名字。優(yōu)點是相對易用，而且好看，缺點是僅適合開發(fā)list一類的組件，而且?guī)啄昵熬鸵呀?jīng)不再維護了，對于新版的函數(shù)式react可能不太兼容。

dnd-kit這個是atlassian在棄用react-beautiful-dnd后重新維護的一個版本，效果是一樣的美麗，如果是web端的，還是很推薦的。
reat-dnd這是個比較全面的dnd庫，可以實現(xiàn)各種功能，要注意的是這是基于H5的開發(fā)，如果你開發(fā)的端不是H5，可能不適用。

react-dnd的官方文檔介紹了如何做一個棋盤，類似的，這篇文章將介紹如何用react-dnd做一個draggable list。

Draggable

首先將list中的每一個item做成draggable組件。

引入useDrag：

// ListItem.tsx
import { styled } from '@mui/material/styles';
import * as React from 'react';
import { useDrag } from 'react-dnd';

const StyledListItem = styled('div', {
  shouldForwardProp: prop => prop !== 'isDragging'
})<{ isDragging: boolean }>(({ isDragging, theme }) => ({
  opacity: isDragging ? 0.5 : 1,
  border: '1px blue solid',
}));

const ListItem = () => {
  const [{isDragging}, dragRef] = useDrag(() => ({
    type: 'listItem',
    collect: monitor => ({
      isDragging: !!monitor.isDragging(),
    }),
  }))

  return (
    <StyledListItem ref={dragRef} isDragging={isDragging}>
      list item
    </StyledListItem>
  )
}

export default ListItem;

這樣我們在demo中就能看到，這個組件就可以用鼠標拖了:

Droppable

我們再將list容器做成droppable組件，這樣draggable組件才可以放在droppable的list里。

引入useDrop：

// SortableList.tsx
import React, { forwardRef } from 'react';
import { useDrop } from 'react-dnd';
import ListItem from './components/listItem';

const SortableList = () => {

  const canMoveItem = () => {
    console.log('canMoveItem')
    return true;    //<--- 具體邏輯后面再寫，這里先設為true，即容器內(nèi)部一直是可以drop的。
  }

  const moveItem = () => {
    console.log('moveItem');    //<--- 具體邏輯后面再寫。
  }

  const [{ isOver, canDrop }, dropRef] = useDrop(
    () => ({
      accept: 'listItem',
      canDrop: () => canMoveItem(),
      drop: () => moveItem(),
      collect: (monitor) => ({
        isOver: !!monitor.isOver(),
        canDrop: !!monitor.canDrop()
      })
    }),
    [canMoveItem, moveItem]
  )
  
  return (
    <div>
      isOver: {String(isOver)}<br />
      canDrop: {String(canDrop)}
      <div
        ref={dropRef}
        style={{
          position: 'relative',
          width: '600px',
          height: '400px',
          border: '2px purple solid'
        }}
      >
        <ListItem></ListItem>
      </div>
    </div>
  );
}

export default SortableList;

這樣頁面上，我再容器內(nèi)部拖動時，isOver為true，canDrop為true，拖到容器外isOver就變成false了：

既是draggable，又是droppable

當有多個list item，可以通過拖拽調(diào)整順序，這樣我需要將list item也變成droppable：

// ListItem.tsx
// 將list item也變成droppable
const [spec, dropRef] = useDrop({
    accept: 'listItem',
    hover: (item, monitor) => {
        const dragIndex = item.index
        const hoverIndex = index
        const hoverBoundingRect = ref.current?.getBoundingClientRect()
        const hoverMiddleY = (hoverBoundingRect.bottom - hoverBoundingRect.top) / 2
        const hoverActualY = monitor.getClientOffset().y - hoverBoundingRect.top

        // 如果是向下拖，只有當hover的坐標小于自身高度的一半時，繼續(xù)保持drag，否則相當于要挪動其他的list item，給當前的item騰個地方
        // if dragging down, continue only when hover is smaller than middle Y
        if (dragIndex < hoverIndex && hoverActualY < hoverMiddleY) return
        // 如果是向上拖，只有當hover的坐標大于自身高度的一半時，繼續(xù)保持drag，否則相當于要挪動其他的list item，給當前的item騰個地方
        if (dragIndex > hoverIndex && hoverActualY > hoverMiddleY) return
        moveListItem(dragIndex, hoverIndex)
        item.index = hoverIndex
    },
});

那么如何讓一個list item既是draggable，又是droppable呢？用以下方式：

// ListItem.tsx
const ref = useRef(null);

const dragDropRef = dragRef(dropRef(ref))

重排list

上一步我們把moveListItem傳給了父組件，那么在父組件中，我們可以這樣來改變list的順序：

// Mock data
const PETS = [
  { id: 1, name: 'dog' },
  { id: 2, name: 'cat' },
  { id: 3, name: 'fish' },
  { id: 4, name: 'hamster' },
]

// SortableList.tsx
const moveListItem = useCallback(
    (dragIndex, hoverIndex) => {
        console.log({dragIndex, hoverIndex})
        const dragItem = pets[dragIndex]
        const hoverItem = pets[hoverIndex]
        // 將PETS數(shù)組中，drag的item和hover的item交換位置
        setPets(pets => {
            const updatedPets = [...pets]
            updatedPets[dragIndex] = hoverItem
            updatedPets[hoverIndex] = dragItem
            return updatedPets
        })
    },
    [pets],
)

這樣我們就能得到這樣的效果：