React-DnD的简要使用方法与API文档

前言

这是一个便于开发者操作拖拽交互的库,感觉不错!它的官方文档贼难进去,这篇文章主要是把一些常用的内容记下,希望能帮助到大家。本篇文章参考的是16.0.1版本

npm i react-dnd

1、简单示例

1.1 useDrag:让DOM允许拖拽

import React from 'react'
import { useDrag } from 'react-dnd'

export default function Player() {
  // 第一个返回值是一个对象,主要放一些拖拽物的状态。后面会介绍,先不管
  // 第二个返回值:顾名思义就是一个Ref,只要将它注入到DOM中,该DOM就会变成一个可拖拽的DOM
  const [_, dragRef] = useDrag({
      type: 'Player', // 给拖拽物命名,后面用于分辨该拖拽物是谁,支持string和symbol
      item: { id:1  }, // 拖拽物所携带的数据,让后面一些事件可以拿到数据,已达到交互的目的
    },[])

  // 由上面示例可知, useDrag所接收的参数一个是对象/函数 和一个依赖数组(可选)

  // 注入Ref,现在这个DOM就可以拖拽了
  return (
    <div ref={dragRef}></div>
  )
}

1.2 useDrop:让DOM作为拖放区域

import { useDrop } from 'react-dnd'

export const Dustbin = () => {
  const [_, dropRef] = useDrop({
    accept: ['Player'],  // 指明该区域允许接收的拖放物。可以是单个,也可以是数组
    // 里面的值就是useDrag所定义的type
    
    // 当拖拽物在这个拖放区域放下时触发,这个item就是拖拽物的item(拖拽物携带的数据)
    drop: (item) => {},
  })

  // 将ref注入进去,这个DOM就可以处理拖拽物了
  return (
    <div ref={dropRef} ></div>
  )
}

1.3. 组合:让DOM作为拖拽物和拖放区域

import React, { useRef } from 'react';
import { useDrag, useDrop } from 'react-dnd';

const Player=({onChangePosition,id})=>{
	const ref = useRef(null);

	// 1. 让DOM作为拖拽物,允许拖放
	const [_, drag] = useDrag(() => ({
	  type: 'PLAYER', 
	  item: { id:1 }  
	}));

	// 2
  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
react-dnd 是一个用于拖放操作的 React 库。它提供了一些组件和工具,使我们能够轻松地将拖动操作集成到我们的 React 应用中。 要使用 react-dnd,我们需要先安装它。可以使用 npm 命令行工具完成安装: ``` npm install --save react-dnd react-dnd-html5-backend ``` 我们需要安装 react-dndreact-dnd-html5-backend。后者是一个 HTML5 后端,它提供了一些基本的本地浏览器支持。 然后,我们需要在我们的应用程序中导入 react-dnd 的相关组件和工具。通常,我们需要导入 DragSource、DropTarget、DragDropContext 和 HTML5Backend: ``` import { DragSource, DropTarget } from 'react-dnd'; import HTML5Backend from 'react-dnd-html5-backend'; import { DragDropContext } from 'react-dnd'; ``` 接下来,我们需要创建一个 DragSource 和一个 DropTarget 组件。这些组件是我们用来定义拖放操作的核心。 DragSource 定义一个组件可以被拖动的方式,DropTarget 定义一个组件可以接收拖放的元素。 例如,创建一个简单的 DragSource 组件会像这样: ``` import { DragSource } from 'react-dnd'; const ItemTypes = { CARD: 'card' }; const cardSource = { beginDrag(props) { return { id: props.id }; } }; function collect(connect, monitor) { return { connectDragSource: connect.dragSource(), isDragging: monitor.isDragging() }; } const Card = ( <div> Drag Me! </div> ); export default DragSource(ItemTypes.CARD, cardSource, collect)(Card); ``` 这个简单的例子定义了一个拖动的卡片元素,其中 cardSource 是定义拖动行为的 Javascript 对象,beginDrag 方法返回了一个包含 id 属性的拖动项,用于标识当前拖动的卡片。 接下来,我们需要使用 DragDropContext 组件来包裹整个应用程序,并使用 HTML5Backend 作为拖放后端: ``` import { DragDropContext } from 'react-dnd'; import HTML5Backend from 'react-dnd-html5-backend'; ... export default DragDropContext(HTML5Backend)(App); ``` 这样我们就可以在应用程序中使用 DragSource 和 DropTarget 组件了。 当我们成功地拖动一个拖动源到它的目标时,它会触发 DropTarget 上的 drop 方法,我们可以在这个方法中定义我们想要发生的操作,例如重新排列、合并或删除元素。 以上就是 react-dnd 的简单使用方法。具体的实现还需要根据实际需求进行详细的设计和开发。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值