Need help with Easy-DnD?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

rlemaigre
209 Stars 22 Forks MIT License 157 Commits 26 Opened issues

Description

A drag and drop implementation for Vue.js 2 https://codesandbox.io/s/easy-dnd-demo-9mbij https://codesandbox.io/s/easy-dnd-demo-2-xnqbz

Services available

!
?

Need anything else?

Contributors list

Easy-DnD is a drag and drop implementation for Vue.js 2 that uses only standard mouse events instead of the HTML5 drag and drop API, which is impossible to work with. Think of it as a way to transfer data from some components to others using the mouse or support for a mouse assisted copy/cut - paste. It also allows for lists to be reordered by drag and drop.

Demos

These demos are meant to be pretty and reflect real life examples. For more barebones examples, see the manual.

The following demo features list reordering, drag and drop between two lists, custom drag images and custom feedback when inserting new items. It uses Vuetify components.

https://codesandbox.io/s/easy-dnd-demo-9mbij

demo

The following demo features drag and drop between a table and a list, custom drag images and a custom style for drop areas when the drop is allowed. It uses Vuetify components.

https://codesandbox.io/s/easy-dnd-demo-2-xnqbz

demo

The following demo features nested drop lists and a custom drag image. It is a tool to design dashboards by WYSIWYG. New widgets can be dragged into the dashboard from the palette on the left and widgets can be moved around by drag and drop.

demo

Installation

Install via npm or yarn

# Use npm
npm install vue-easy-dnd --save

Use yarn

yarn add vue-easy-dnd

Manual

Overview

There are four components : Drag, Drop, DropMask and DropList.

The Drag component is meant to define an area from which data can be exported. The Drop component is meant to define an area into which data can be imported. Drop components can be nested forming hierarchies of arbitrary depth. The DropMask component is meant to create an island insensitive to drag and drop on top of a Drop component. The DropList component is a special kind of drop component that displays a list of items that supports dragging into and reordering.

Events

All events carry the current state of the drag operation by means of the following properties :

  • type
    : the type of the data being transferred
  • data
    : the data being transferred
  • position
    : the current position of the mouse cursor
  • top
    : the foremost Drop component currently under the mouse cursor if any
  • previousTop
    : for dragenter and dragleave, the previous value of top if any
  • source
    : the Drag component where the drag originated
  • success
    : whether the drag completed successfully or not
  • native
    : the associated mouse event (or touch event). Can be mousedown/touchstart, mousemove/touchmove or mouseup/touchend.

Drag components emit the following events :

  • dragstart
    : triggered when a drag operation starts
  • dragend
    : triggered when a drag operation terminates (whether successfully or not)
  • cut
    /
    copy
    : triggered when a drag operation completes successfully on a Drop component that requires the data to be removed / copied

Drop components emit the following events :

  • dragenter
    : triggered when the mouse enters a Drop component
  • dragleave
    : triggered when the mouse leaves a Drop component
  • dragover
    : triggered when the mouse moves over a Drop component
  • drop
    : triggered when a drop operation completes on a Drop component

DropList components emit the following events (in addition to the ones emitted by Drop components) :

  • insert
    : triggered when data is to be inserted into the list (properties :
    type
    ,
    data
    and
    index
    )
  • reorder
    : triggers when data needs to be reordered (properties :
    from
    ,
    to
    and
    apply
    - apply is a function that applies the required reordering to the given array)

Data

Export : the data being exported when a drag operation originates from a Drag component is defined by mean of its

data
property.

Import : when a drag operation terminates in a Drop components, its

drop
event is triggered and the event carries the
data
to be imported.

Modes

A drag and drop can occur in several possible modes, depending on its effect on the origin of the drag :

  • copy
    (the default) : if the source of the drag is unaffected by the drag operation,
  • cut
    : if the source of the drag is to be removed when the drag operation completes.

Drop components must declare what mode must be triggered when data is dropped into them using the

mode
property.

When a drag operation completes on a Drop component that declares the

cut
(respectively
copy
) mode, a
cut
(respectively
copy
) event is emitted on the Drag component from which the drag operation originated. This gives the opportunity to the surroundings of the Drag component to react to the drop that just happened, for example by removing the data that has been dropped in case of the
cut
event.

If a drag operation originates from a Drag components that doesn't declare a listener for the

cut
event, then dropping is forbidden on a Drop component that declares the
cut
mode.

The following demo illustrates modes in action :

https://codesandbox.io/s/example-2-r8n1k

demo

Types

A drag operation may have a type. The type is a data structure (can be a simple string) that defines the kind of data being transfered. The type of a drag operation is defined by the Drag component that initiates it using the

type
prop.

A Drop component is said to participate in a drag operation if it accepts its type (the default is to accept any type). The type(s) a Drop component accepts can be defined by mean of the

accepts-type
prop (can be a string, an array of strings or a function that takes the type as parameter and returns a boolean).

As far as Easy-DnD is concerned, if a Drop component doesn't accept the type of the current drag operation, it behaves like any other part of the page that is not sensitive to drag and drop. It is ignored during the drag, no special CSS classes are applied, no special cursors / drag images are displayed and no special events are triggered.

The following demo illustrates the use of types. There are two types in use : 'string' and 'number'. The Drag components that contain '1' and '2' are of type 'number', the ones containing 'a' and 'b' are of type 'string'. The two Drop components on the left accept numbers, the ones on the right accept strings. When you drag a number/string (respectively), only Drop components that accept numbers/strings (respectively) react (i.e. drag images, CSS classes, cursors are applied). The other ones are left alone.

https://codesandbox.io/s/example-3-g7io8

demo

Restricting droppable data

Drop components can restrict the data they accept by mean of the

accepts-data
prop (a function that takes the data and type as parameter and returns a boolean).

The following demo defines five Drag components that can be dragged into three Drop components, one that accepts even numbers, one that accepts odd numbers and one that accepts any number but removes them once the drag is complete.

https://codesandbox.io/s/easy-dnd-demo-fo078

demo

Mouse cursor

If a drag isn't in progress, the cursor turns into

grab
when the mouse is over a Drag component. If a drag is in progress, the cursor turns into
grabbing
, unless it is over a Drop component that accepts the type of the current drag operation. Then, it turns into
pointer
if the Drop component accepts the data being dragged, and into
not-allowed
otherwise.

Drag image

During the drag, an image may move along the mouse cursor. Easy-DnD makes it so that this image is always on top of everything else.

Drag components provide the

drag-image
slot that can be used to set the default image displayed during the drag operation :
  • if the slot isn't defined, the image is a clone of the Drag component.
  • if the slot is defined and empty, there is no image.
  • if the slot is not empty, a clone of its content is used.

Drop and DropList components provide the

drag-image
slot (props :
data
and
type
) that can be used to set the image to be displayed when the mouse is over them, if they participates in the current drag operation (i.e. accept its type) :
  • if the slot isn't defined, the default image set by the Drag component is used.
  • if the slot is defined and empty, there is no image.
  • if the slot is not empty, a clone of its content is used.

DropList components additionaly provide the

reordering-drag-image
slot (prop :
item
subject to reordering) that behaves the same way as
drag-image
but controls the drag image to be displayed during list reordering.

The position of the drag image relative to the mouse cursor can be controlled by CSS using the transform property.

The following demo illustrate the use of custom drag images, nested Drop components and a mask :

https://codesandbox.io/s/example-4-6h8zy

demo

CSS classes

A Drag component is assigned the class

drag-in
when the mouse is over it and a drag operation isn't in progress,
drag-out
otherwise. Depending on the mode of the Drop component currently under the mouse cursor, the source Drag component is also assigned the classes
drag-mode-copy
,
drag-mode-cut
and
drag-mode-reordering
.

During a drag operation, the Drop components on the page are assigned several CSS classes :

  • for all Drop components :
    type-allowed
    if the Drop component accepts the type of the drag operation,
    type-forbidden
    otherwise
  • for the Drop components that participate in the drag operation (i.e. accepts its type) :
    • drop-in
      when the mouse is over one that is foremost at the current mouse position (remember Drop components can be nested),
      drop-out
      otherwise
    • drop-allowed
      when the Drop component accepts the data and the source of the drag accepts its mode,
      drop-forbidden
      otherwise

DropMask component

The following demo illustrates the use of a DropMask :

https://codesandbox.io/s/example-1-gvwsw

demo

DropList component

The DropList component is a special Drop component so it inherits all the props and events of the Drop component. It can be used when the result of a drag operation is to import data into the component as an item in a list at a specific index or to allow the user to reorder a list of items using drag and drop.

Comparing to the Drop component, there are two more props : *

items
: the array of items to be rendered *
no-animations
: when set to true, disables animations

Comparing to the Drop component, there are two more events : *

insert
: emitted when the user drops data into the DropList. If no listener is provided for this event, the list cannot be inserted into. *
reorder
: emitted when the user reorders the list. If no listener is provided for this event, the list cannot be reordered.

Comparing to the Drop component, there are four more slots : *

item
: used to render each list item. It has two properties,
item
and
reorder
. Reorder is true when the item is the one subject to reordering. Don't forget to provide a key for the content of this slot !! *
feedback
: used to render a placeholder to show the position where the new item would be inserted if the drag operation ended at the current mouse position. It has two properties :
type
and
data
. Don't forget to provide a key for the content of this slot !! *
reordering-drag-image
: defines the drag image to be used when reordering the list (see drag image section above). *
reordering-feedback
: used to control the feedback used during reordering * if this slot isn't defined, then the items switch positions during reordering to display in real time the order that will be achieved if the drag terminates at the current position * if this slot is defined, then its content is inserted into the list to display the new location of the item being dragged (for an example of this, see nested drop lists)

Keys on items and feedback are used to disallow the drop if it would create duplicates and result in errors.

The

tag
prop can be used to customize the root of the template, just like it can be with drop components, but it can only refer to an HTML element, not a Vue component (this is a restriction of Vue transition-groups - there is nothing I can do about it). However, when the no-animations prop is set to true, this restriction is lifted, and you can use any Vue component.

The following demo features drag and drop from one list to another and list reordering.

https://codesandbox.io/s/droplist-ozs8b

demo

Nested DropLists

Drop lists can be nested providing the following conditions are satisfied :

  • the
    row
    or
    column
    props must be defined to inform the drop list components of the direction the items are lining up (mandatory)
  • for lists that support reordering, the
    reordering-feedback
    slot must be defined (advisable)
  • both the
    feedback
    and
    reordering-feedback
    slots must take no space in the layout (for example,
    flex: 0 0 0; align-self: strech; outline: 1px solid blue;
    ) (advisable)

Example :

https://codesandbox.io/s/nested-drop-lists-nw605

demo

Tags

Drag and Drop components support the

tag
prop that can be used to control the HTML tag (or Vue component) that will serve as root of the template. In case of tags that are Vue components, all props, listeners and slots function as they normally would. When using Vue components as tags, make sure their templates have a default slot defined (
).

DragAwareMixin

A mixin is available to make components sensitive to drag operations. It adds the following computed to components that incorporate it, reflecting the current state of the drag :

  • dragInProgress
    : true if a drag operation is in progress, false otherwise
  • dragType
    : the type of the current drag operation
  • dragData
    : the data of the current drag operation
  • dragPosition
    : the current position of the mouse relative to the document
  • dragSource
    : the Drag component from which the drag operation originated
  • dragTop
    : the foremost Drop component under the mouse if any

The following demo displays information about the current drag operation when it is in progress :

https://codesandbox.io/s/example-5-j8qo9

demo

Miscellaneous

The

disabled
prop can be used to temporarily disable drag on Drag components.

On Drag and Drop components, the

drag-image-opacity
prop can be used to control the opacity of the drag image.

On Drag components, if the

go-back
prop is set to true, then if a drag is not successful, the drag image will go back to where the drag originated.

https://codesandbox.io/s/example-1-l6p54

demo

Faq

Does it support IE 11 ?

Yes with a polyfill for custom events such as https://www.npmjs.com/package/custom-event-polyfill

Does it support touch devices ?

Yes.

Does it support SSR ?

Yes.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.