React Draggable API

Enables automatic scrolling while dragging an item beyond the viewport.

Specifies a DOM element that limits the dragging area.

Allows a user to drag clones of items instead of actual items.

Specifies a custom container in which the draggable item should be rendered.

Specifies the cursor offset from the dragged item.

A container for custom data.

An alias for the dragTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

Specifies the directions in which an item can be dragged.

An alias for the dragTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

Specifies custom markup to be shown instead of the item being dragged.

Specifies the global attributes to be attached to the UI component's container element.

Allows you to group several UI components, so that users can drag and drop items between them.

Specifies a CSS selector (ID or class) that should act as the drag handle(s) for the item(s).

Specifies the UI component's height.

A function that is executed before the UI component is disposed of.

A function that is called when a drag gesture is finished.

A function that is called every time a draggable item is moved.

A function that is called when a drag gesture is initialized.

A function used in JavaScript frameworks to save the UI component instance.

A function that is executed after a UI component property is changed.

Switches the UI component to a right-to-left representation.

Specifies the distance in pixels from the edge of viewport at which scrolling should start. Applies only if autoScroll is true.

Specifies the scrolling speed when dragging an item beyond the viewport. Applies only if autoScroll is true.

Specifies the UI component's width.

Postpones rendering that can negatively affect performance until the endUpdate() method is called.

Specifies the device-dependent default configuration properties for this component.

Disposes of all the resources allocated to the Draggable instance.

Gets the root UI component element.

Refreshes the UI component after a call of the beginUpdate() method.

Gets the instance of a UI component found using its DOM node.

Gets the UI component's instance. Use it to access other methods of the UI component.

Detaches all event handlers from a single event.

Detaches a particular event handler from a single event.

Subscribes to an event.

Subscribes to events.

Gets all UI component properties.

Gets the value of a single property.

Updates the value of a single property.

Updates the values of several properties.

Resets a property to its default value.

Raised before the UI component is disposed of.

Raised when drag gesture is finished.

Raised every time a draggable item is moved.

Raised when drag gesture is initialized.

Raised only once, after the UI component is initialized.

Raised after a UI component property is changed.