Beautiful and accessible drag and drop for lists with Vue
Play with this example if you want!
- Beautiful and natural movement of items 💐
- Accessible: powerful keyboard and screen reader support ♿️
- Extremely performant 🚀
- Clean and powerful api which is simple to get started with
- Plays extremely well with standard browser interactions
- Unopinionated styling
- No creation of additional wrapper dom nodes - flexbox and focus management friendly!
We have created a free course on egghead.io 🥚 to help you get started with vue-beautiful-dnd as quickly as possible.
- Vertical lists ↕
- Horizontal lists ↔
- Movement between lists (▤ ↔ ▤)
- Virtual list support 👾 - unlocking 10,000 items @ 60fps
- Combining items
- Mouse 🐭, keyboard 🎹♿️ and touch 👉📱 (mobile, tablet and so on) support
- Multi drag support
- Incredible screen reader support ♿️ - we provide an amazing experience for english screen readers out of the box 📦. We also provide complete customisation control and internationalisation support for those who need it 💖
- Conditional dragging and conditional dropping
- Multiple independent lists on the one page
- Flexible item sizes - the draggable items can have different heights (vertical lists) or widths (horizontal lists)
- Add and remove items during a drag
- Compatible with semantic
<table>reordering - table pattern - Auto scrolling - automatically scroll containers and the window as required during a drag (even with keyboard 🔥)
- Custom drag handles - you can drag a whole item by just a part of it
- Able to move the dragging item to another element while dragging (clone, portal) - Reparenting your
<Draggable /> - Create scripted drag and drop experiences 🎮
- Allows extensions to support for any input type you like 🕹
- 🌲 Tree support through the
@atlaskit/treepackage - A
<Droppable />list can be a scroll container (without a scrollable parent) or be the child of a scroll container (that also does not have a scrollable parent) - Independent nested lists - a list can be a child of another list, but you cannot drag items from the parent list into a child list
- Server side rendering (SSR) compatible - see resetServerContext()
- Plays well with nested interactive elements by default
vue-beautiful-dnd exists to create beautiful drag and drop for lists that anyone can use - even people who cannot see. For a good overview of the history and motivations of the project you can take a look at these external resources:
- Installation
- Examples and samples
- Get started
- Design principles
- Animations
- Accessibility
- Browser support
The ways in which somebody can start and control a drag
- Mouse dragging 🐭
- Touch dragging 👉📱
- Keyboard dragging 🎹♿️
- Create your own sensor (allows for any input type as well as scripted experiences)
<DragDropContext />- Wraps the part of your application you want to have drag and drop enabled for<Droppable />- An area that can be dropped into. Contains<Draggable />s<Draggable />- What can be dragged aroundresetServerContext()- Utility for server side rendering (SSR)
<DragDropContext />responders -onDragStart,onDragUpdate,onDragEndandonBeforeDragStart- Combining
<Draggable />s - Common setup issues
- Using
innerRef - Setup problem detection and error recovery
- Rules for
draggableIdanddroppableIds - Browser focus retention
- Customising or skipping the drop animation
- Auto scrolling
- Controlling the screen reader
- Use the html5
doctype TypeScriptandflow: type information- Dragging
<svg>s - Avoiding image flickering
- Non-visible preset styles
- How we detect scroll containers
- How we use dom events - Useful if you need to build on top of
vue-beautiful-dnd - Adding
<Draggable />s during a drag (11.x behaviour) -⚠️ Advanced - Setting up Content Security Policy
- Virtual lists 👾
- Multi drag
- Tables
- Reparenting a
<Draggable />- Using our cloning API or your own portal
Chad McCaulley