react-grid-layout /react-draggable

React draggable component

★ 9,290⑂ 1,048👁 70⑃ 292● 520▤ 52
JavaScriptMITCreated 2014-07-24
下载:2.2.32.2.3 ↓2.2.32016-12-08
+0
日增长
9,290
stars
1,048
forks
70
watchers
292
prs
520
issues
52
releases

README

React-Draggable






A simple component for making elements draggable.

[Demo | Changelog]


  


jsx

  I can now be moved around!



 Table of Contents

- Installation
- Compatibility
- Quick Start
- API
  - Draggable
  - DraggableCore
- Using nodeRef
- Controlled vs. Uncontrolled
- Content Security Policy
- Contributing

 Installation

bash
npm install react-draggable
 or
yarn add react-draggable


js
// ES Modules
import Draggable from 'react-draggable';
import { DraggableCore } from 'react-draggable';

// CommonJS
const Draggable = require('react-draggable');
const { DraggableCore } = require('react-draggable');


TypeScript types are included.

 Compatibility

| Version | React Version |
|---------|---------------|
| 4.x     | 16.3+         |
| 3.x     | 15 - 16       |
| 2.x     | 0.14 - 15     |

 Quick Start

jsx
import React, { useRef } from 'react';
import Draggable from 'react-draggable';

function App() {
  const nodeRef = useRef(null);

  return (
    
      Drag me!
    
  );
}


View the Demo and its source for more examples.

 API

 

A  element wraps an existing element and extends it with new event handlers and styles. It does not create a wrapper element in the DOM.

Draggable items are moved using CSS Transforms. This allows items to be dragged regardless of their current positioning (relative, absolute, or static). Elements can also be moved between drags without incident.

If the item you are dragging already has a CSS Transform applied, it will be overwritten by . Use an intermediate wrapper (...) in this case.

 Props

ts
type DraggableEventHandler = (e: Event, data: DraggableData) = void | false;

type DraggableData = {
  node: HTMLElement,
  x: number, y: number,
  deltaX: number, deltaY: number,
  lastX: number, lastY: number,
};


| Prop | Type | Default | Description |
|------|------|---------|-------------|
| allowAnyClick | boolean | false | Allow dragging on non-left-button clicks |
| allowMobileScroll | boolean | false | Don't prevent touchstart, allowing scrolling inside containers |
| axis | 'both' \| 'x' \| 'y' \| 'none' | 'both' | Axis to allow dragging on |
| bounds | object \| string | - | Restrict movement. Use 'parent', a CSS selector, or {left, top, right, bottom} |
| cancel | string | - | CSS selector for elements that should not initiate drag |
| defaultClassName | string | 'react-draggable' | Class name applied to the element |
| defaultClassNameDragging | string | 'react-draggable-dragging' | Class name applied while dragging |
| defaultClassNameDragged | string | 'react-draggable-dragged' | Class name applied after drag |
| defaultPosition | {x: number, y: number} | {x: 0, y: 0} | Starting position |
| disabled | boolean | false | Disable dragging |
| enableUserSelectHack | boolean | true | Add user-select: none while dragging |
| grid | [number, number] | - | Snap to grid [x, y] |
| handle | string | - | CSS selector for the drag handle |
| nodeRef | React.RefObject | - | Ref to the DOM element. R

Top issues

Discussions

Latest release

2.2.3 v2.2.3 2016-12-08
- Bugfix: Fix an issue with the entire window scrolling on a drag on iDevices. Thanks @JaneCoder. See 183

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON