DevExtreme v24.1 is now available.

Explore our newest features/capabilities and share your thoughts with us.

Your search did not match any results.

React List - Item Drag & Drop

This demo shows how to enable item drag and drop in the List component. You can reorder items or drag and drop them between two separate lists. Use the handles on the right side of items to initiate drag and drop.

Backend API
import React, { useCallback, useState } from 'react'; import List, { IItemDraggingProps, ItemDragging } from 'devextreme-react/list'; import { plannedTasks, doingTasks } from './data.ts'; const App = () => { const [plannedTasksState, setPlannedTasksState] = useState(plannedTasks); const [doingTasksState, setDoingTasksState] = useState(doingTasks); const onDragStart = useCallback<IItemDraggingProps['onDragStart']>((e) => { e.itemData = e.fromData === 'plannedTasks' ? plannedTasksState[e.fromIndex] : doingTasksState[e.fromIndex]; }, [plannedTasksState, doingTasksState]); const onAdd = useCallback<IItemDraggingProps['onAdd']>((e) => { const tasks = e.toData === 'plannedTasks' ? plannedTasksState : doingTasksState; const updatedTasks = [...tasks]; updatedTasks.splice(e.toIndex, 0, e.itemData); if (e.toData === 'plannedTasks') { setPlannedTasksState(updatedTasks); } else { setDoingTasksState(updatedTasks); } }, [setPlannedTasksState, setDoingTasksState, plannedTasksState, doingTasksState]); const onRemove = useCallback<IItemDraggingProps['onRemove']>((e) => { const tasks = e.fromData === 'plannedTasks' ? plannedTasksState : doingTasksState; const updatedTasks = [...tasks]; updatedTasks.splice(e.fromIndex, 1); if (e.fromData === 'plannedTasks') { setPlannedTasksState(updatedTasks); } else { setDoingTasksState(updatedTasks); } }, [setPlannedTasksState, setDoingTasksState, plannedTasksState, doingTasksState]); const onReorder = useCallback((e) => { if (e.fromData === e.toData) { const updateTasks = (tasks) => { const updatedTasks = [...tasks]; const [movedTask] = updatedTasks.splice(e.fromIndex, 1); updatedTasks.splice(e.toIndex, 0, movedTask); return updatedTasks; }; if (e.fromData === 'plannedTasks') { setPlannedTasksState((prevTasks) => updateTasks(prevTasks)); } else { setDoingTasksState((prevTasks) => updateTasks(prevTasks)); } } else { onRemove(e); onAdd(e); } }, [onAdd, onRemove]); return ( <div className="widget-container"> <List dataSource={plannedTasksState} keyExpr="id"> <ItemDragging allowReordering={true} group="tasks" data="plannedTasks" onDragStart={onDragStart} onAdd={onAdd} onRemove={onRemove} onReorder={onReorder}> </ItemDragging> </List> <List dataSource={doingTasksState} keyExpr="id"> <ItemDragging allowReordering={true} group="tasks" data="doingTasks" onDragStart={onDragStart} onAdd={onAdd} onRemove={onRemove} onReorder={onReorder}> </ItemDragging> </List> </div> ); }; export default App;
import React, { useCallback, useState } from 'react'; import List, { ItemDragging } from 'devextreme-react/list'; import { plannedTasks, doingTasks } from './data.js'; const App = () => { const [plannedTasksState, setPlannedTasksState] = useState(plannedTasks); const [doingTasksState, setDoingTasksState] = useState(doingTasks); const onDragStart = useCallback( (e) => { e.itemData = e.fromData === 'plannedTasks' ? plannedTasksState[e.fromIndex] : doingTasksState[e.fromIndex]; }, [plannedTasksState, doingTasksState], ); const onAdd = useCallback( (e) => { const tasks = e.toData === 'plannedTasks' ? plannedTasksState : doingTasksState; const updatedTasks = [...tasks]; updatedTasks.splice(e.toIndex, 0, e.itemData); if (e.toData === 'plannedTasks') { setPlannedTasksState(updatedTasks); } else { setDoingTasksState(updatedTasks); } }, [setPlannedTasksState, setDoingTasksState, plannedTasksState, doingTasksState], ); const onRemove = useCallback( (e) => { const tasks = e.fromData === 'plannedTasks' ? plannedTasksState : doingTasksState; const updatedTasks = [...tasks]; updatedTasks.splice(e.fromIndex, 1); if (e.fromData === 'plannedTasks') { setPlannedTasksState(updatedTasks); } else { setDoingTasksState(updatedTasks); } }, [setPlannedTasksState, setDoingTasksState, plannedTasksState, doingTasksState], ); const onReorder = useCallback( (e) => { if (e.fromData === e.toData) { const updateTasks = (tasks) => { const updatedTasks = [...tasks]; const [movedTask] = updatedTasks.splice(e.fromIndex, 1); updatedTasks.splice(e.toIndex, 0, movedTask); return updatedTasks; }; if (e.fromData === 'plannedTasks') { setPlannedTasksState((prevTasks) => updateTasks(prevTasks)); } else { setDoingTasksState((prevTasks) => updateTasks(prevTasks)); } } else { onRemove(e); onAdd(e); } }, [onAdd, onRemove], ); return ( <div className="widget-container"> <List dataSource={plannedTasksState} keyExpr="id" > <ItemDragging allowReordering={true} group="tasks" data="plannedTasks" onDragStart={onDragStart} onAdd={onAdd} onRemove={onRemove} onReorder={onReorder} ></ItemDragging> </List> <List dataSource={doingTasksState} keyExpr="id" > <ItemDragging allowReordering={true} group="tasks" data="doingTasks" onDragStart={onDragStart} onAdd={onAdd} onRemove={onRemove} onReorder={onReorder} ></ItemDragging> </List> </div> ); }; export default App;
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.tsx'; ReactDOM.render( <App />, document.getElementById('app'), );
export const doingTasks = [{ id: 1, text: 'Prepare 2019 Financial' }, { id: 2, text: 'Prepare 2019 Marketing Plan' }, { id: 3, text: 'Update Personnel Files' }, { id: 4, text: 'Review Health Insurance Options Under the Affordable Care Act' }]; export const plannedTasks = [{ id: 5, text: 'New Brochures' }, { id: 6, text: '2019 Brochure Designs' }, { id: 7, text: 'Brochure Design Review' }, { id: 8, text: 'Website Re-Design Plan' }, { id: 9, text: 'Rollout of New Website and Marketing Brochures' }, { id: 10, text: 'Create 2018 Sales Report' }, { id: 11, text: 'Direct vs Online Sales Comparison Report' }, { id: 12, text: 'Review 2018 Sales Report and Approve 2019 Plans' }, { id: 13, text: 'Submit Signed NDA' }, { id: 14, text: 'Update Revenue Projections' }, { id: 15, text: 'Review Revenue Projections' }, { id: 16, text: 'Comment on Revenue Projections' }, { id: 17, text: 'Scan Health Insurance Forms' }, { id: 18, text: 'Sign Health Insurance Forms' }, { id: 19, text: 'Follow up with West Coast Stores' }, { id: 20, text: 'Follow up with East Coast Stores' }, { id: 21, text: 'Submit Refund Report for 2019 Recall' }, { id: 22, text: 'Give Final Approval for Refunds' }, { id: 23, text: 'Prepare Product Recall Report' }, { id: 24, text: 'Review Product Recall Report by Engineering Team' }, { id: 25, text: 'Review Training Course for any Omissions' }, { id: 26, text: 'Review Overtime Report' }, { id: 27, text: 'Submit Overtime Request Forms' }, { id: 28, text: 'Overtime Approval Guidelines' }, { id: 29, text: 'Create Report on Customer Feedback' }, { id: 30, text: 'Review Customer Feedback Report' }];
window.exports = window.exports || {}; window.config = { transpiler: 'ts', typescriptOptions: { module: 'system', emitDecoratorMetadata: true, experimentalDecorators: true, jsx: 'react', }, meta: { 'react': { 'esModule': true, }, 'typescript': { 'exports': 'ts', }, 'devextreme/time_zone_utils.js': { 'esModule': true, }, 'devextreme/localization.js': { 'esModule': true, }, 'devextreme/viz/palette.js': { 'esModule': true, }, }, paths: { 'npm:': 'https://unpkg.com/', }, defaultExtension: 'js', map: { 'ts': 'npm:plugin-typescript@4.2.4/lib/plugin.js', 'typescript': 'npm:typescript@4.2.4/lib/typescript.js', 'react': 'npm:react@17.0.2/umd/react.development.js', 'react-dom': 'npm:react-dom@17.0.2/umd/react-dom.development.js', 'prop-types': 'npm:prop-types@15.8.1/prop-types.js', 'rrule': 'npm:rrule@2.6.4/dist/es5/rrule.js', 'luxon': 'npm:luxon@1.28.1/build/global/luxon.min.js', 'es6-object-assign': 'npm:es6-object-assign@1.1.0', 'devextreme': 'npm:devextreme@24.1.7/cjs', 'devextreme-react': 'npm:devextreme-react@24.1.7/cjs', 'jszip': 'npm:jszip@3.10.1/dist/jszip.min.js', 'devextreme-quill': 'npm:devextreme-quill@1.7.1/dist/dx-quill.min.js', 'devexpress-diagram': 'npm:devexpress-diagram@2.2.12/dist/dx-diagram.js', 'devexpress-gantt': 'npm:devexpress-gantt@4.1.56/dist/dx-gantt.js', '@devextreme/runtime': 'npm:@devextreme/runtime@3.0.13', 'inferno': 'npm:inferno@7.4.11/dist/inferno.min.js', 'inferno-compat': 'npm:inferno-compat/dist/inferno-compat.min.js', 'inferno-create-element': 'npm:inferno-create-element@7.4.11/dist/inferno-create-element.min.js', 'inferno-dom': 'npm:inferno-dom/dist/inferno-dom.min.js', 'inferno-hydrate': 'npm:inferno-hydrate@7.4.11/dist/inferno-hydrate.min.js', 'inferno-clone-vnode': 'npm:inferno-clone-vnode/dist/inferno-clone-vnode.min.js', 'inferno-create-class': 'npm:inferno-create-class/dist/inferno-create-class.min.js', 'inferno-extras': 'npm:inferno-extras/dist/inferno-extras.min.js', 'devextreme-cldr-data': 'npm:devextreme-cldr-data@1.0.3', // SystemJS plugins 'plugin-babel': 'npm:systemjs-plugin-babel@0.0.25/plugin-babel.js', 'systemjs-babel-build': 'npm:systemjs-plugin-babel@0.0.25/systemjs-babel-browser.js', // Prettier 'prettier/standalone': 'npm:prettier@2.8.8/standalone.js', 'prettier/parser-html': 'npm:prettier@2.8.8/parser-html.js', }, packages: { 'devextreme': { defaultExtension: 'js', }, 'devextreme-react': { main: 'index.js', }, 'devextreme/events/utils': { main: 'index', }, 'devextreme/localization/messages': { format: 'json', defaultExtension: 'json', }, 'devextreme/events': { main: 'index', }, 'es6-object-assign': { main: './index.js', defaultExtension: 'js', }, }, packageConfigPaths: [ 'npm:@devextreme/*/package.json', 'npm:@devextreme/runtime@3.0.13/inferno/package.json', ], babelOptions: { sourceMaps: false, stage0: true, react: true, }, }; System.config(window.config);
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.js'; ReactDOM.render(<App />, document.getElementById('app'));
export const doingTasks = [ { id: 1, text: 'Prepare 2019 Financial' }, { id: 2, text: 'Prepare 2019 Marketing Plan' }, { id: 3, text: 'Update Personnel Files' }, { id: 4, text: 'Review Health Insurance Options Under the Affordable Care Act' }, ]; export const plannedTasks = [ { id: 5, text: 'New Brochures' }, { id: 6, text: '2019 Brochure Designs' }, { id: 7, text: 'Brochure Design Review' }, { id: 8, text: 'Website Re-Design Plan' }, { id: 9, text: 'Rollout of New Website and Marketing Brochures' }, { id: 10, text: 'Create 2018 Sales Report' }, { id: 11, text: 'Direct vs Online Sales Comparison Report' }, { id: 12, text: 'Review 2018 Sales Report and Approve 2019 Plans' }, { id: 13, text: 'Submit Signed NDA' }, { id: 14, text: 'Update Revenue Projections' }, { id: 15, text: 'Review Revenue Projections' }, { id: 16, text: 'Comment on Revenue Projections' }, { id: 17, text: 'Scan Health Insurance Forms' }, { id: 18, text: 'Sign Health Insurance Forms' }, { id: 19, text: 'Follow up with West Coast Stores' }, { id: 20, text: 'Follow up with East Coast Stores' }, { id: 21, text: 'Submit Refund Report for 2019 Recall' }, { id: 22, text: 'Give Final Approval for Refunds' }, { id: 23, text: 'Prepare Product Recall Report' }, { id: 24, text: 'Review Product Recall Report by Engineering Team' }, { id: 25, text: 'Review Training Course for any Omissions' }, { id: 26, text: 'Review Overtime Report' }, { id: 27, text: 'Submit Overtime Request Forms' }, { id: 28, text: 'Overtime Approval Guidelines' }, { id: 29, text: 'Create Report on Customer Feedback' }, { id: 30, text: 'Review Customer Feedback Report' }, ];
<!DOCTYPE html> <html lang="en"> <head> <title>DevExtreme Demo</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=5.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/24.1.7/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="styles.css" /> <script src="https://unpkg.com/core-js@2.6.12/client/shim.min.js"></script> <script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script> <script type="text/javascript" src="config.js"></script> <script type="text/javascript"> System.import("./index.tsx"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"></div> </div> </body> </html>
.widget-container { display: flex; } .widget-container > * { height: 400px; width: 50%; padding: 10px; } .dx-scrollview-content { min-height: 380px; }

The following steps describe how to configure this functionality:

  1. Enable item drag and drop
    Set the itemDragging.allowReordering to true.

  2. Add the lists to the same group
    Set the group property of both components to the same value to allow a user to drag and drop items between them.

  3. Reorder list items in code
    Use the onDragStart event handler to store the dragged item's data. When a user drops the item, the onRemove and onAdd functions allow you to remove the item from its initial position and add it to the new location.