React Sortable Props

Default Value: true

This property limits row reordering to the UI and does not affect the data source. You should also handle the effects of the drag and drop to the data source in code. If users reorder items inside a single component, implement the onReorder handler.

To configure drag and drop between components, follow the instructions from the group topic.

View Demo

autoScroll

Enables automatic scrolling while dragging an item beyond the viewport.

Type:

Default Value: true

boundary

Specifies a DOM element that limits the dragging area.

Type:

|

HTMLElement | jQuery

| undefined

Default Value: undefined

This property accepts the following value types:

String
A CSS selector. For example: "#elementId".
DOM Node
An HTML DOM element. For example: document.getElementById("elementId").
jQuery
A CSS selector wrapped in a jQuery element. For example: $("#elementId").

container

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

Type:

|

HTMLElement | jQuery

| undefined

Default Value: undefined

This property accepts the following value types:

String
A CSS selector. For example: "#elementId".
DOM Node
An HTML DOM element. For example: document.getElementById("elementId").
jQuery
A CSS selector wrapped in a jQuery element. For example: $("#elementId").

cursorOffset

Specifies the cursor offset from the dragged item.

Selector: CursorOffset

Type:

|

Object

data

A container for custom data.

Type: any | undefined

Default Value: undefined

dragComponent

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

dragDirection

Specifies the directions in which an item can be dragged.

Type:

DragDirection

Default Value: 'both'

dragRender

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

dragTemplate

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

Type:

template

| undefined

Function parameters:

dragInfo:

Object

Information about the item being dragged.

Object structure:

Name	Type	Description
fromIndex	Number	The item's original position.
itemData	any	The item's data. Note that you should specify the item data manually.
itemElement	HTMLElement \| jQuery	The container of the item being dragged. It is an HTML Element or a jQuery Element when you use jQuery.

containerElement:

HTMLElement | jQuery

A container in which the template should be rendered.

Return Value:

|

Element

|

jQuery

One of the following:

HTML markup as a string
A DOM node
A DOM node wrapped in a jQuery element

Default Value: undefined

App.js


import React from 'react';
 
import TreeView from 'devextreme-react/tree-view';
import Sortable from 'devextreme-react/sortable';
import { Template } from 'devextreme-react/core/template';
 
function myDragTemplate(e) {
    return (
        e.itemData + " drag template";
    );
}
 
class App extends React.Component {
    constructor(props) {
        //...
    }        
    render() {
        return (
            <Sortable
                filter=".dx-treeview-item"
                allowReordering={true}
                onDragChange={this.onDragChange}
                dragTemplate={myDragTemplate}>
                <TreeView
                    id="simple-treeview"
                    dataStructure="plain"
                    items={this.state.treeViewItems}
                />
            </Sortable>                
        );
    }
    onDragChange = (e) => {
        e.itemData = this.state.treeViewItems[e.fromIndex].name;
        // your code
    }
}
export default App;

dropFeedbackMode

Specifies how to highlight the item's drop position.

Type:

DragHighlight

Default Value: 'push'

This property accepts the following values:

"push"
Items move apart with an animation, allowing room for the dragged item to be placed. To use this mode, ensure that the allowDropInsideItem is disabled.
"indicate"
Items are not animated and a blue square appears at the place where the dragged item is going to be placed. The source item remains in place - only the cloned item is dragged.

elementAttr

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

Selector: ElementAttr

Type:

Object

Default Value: {}

App.js


import React from 'react';
 
import Sortable from 'devextreme-react/sortable';
 
class App extends React.Component {
    sortableAttributes = {
        id: 'elementId',
        class: 'class-name'
    }
 
    render() {
        return (
            <Sortable ...
                elementAttr={this.sortableAttributes}>
            </Sortable>
        );
    }
}
export default App;

filter

Specifies a CSS selector for the items that can be dragged.

Type:

Default Value: '> *'

group

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

Type:

| undefined

Default Value: undefined

Set this property to identical values for the UI components you want to collect into a single group. This allows users to drag and drop items between components, but only in the UI. To handle drag and drop in code, implement the onAdd and onRemove handlers. Both these handlers are executed simultaneously when an item is dropped to the target component, but onAdd is executed in the target component, while onRemove is executed in the source component.

handle

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

Type:

Default Value: ''

height

Specifies the UI component's height.

Type:

|

| undefined

Default Value: undefined

This property accepts a value of one of the following types:

Number
The height in pixels.
String
A CSS-accepted measurement of height. For example, "55px", "20vh", "80%", "inherit".

itemOrientation

Notifies the UI component of the items' orientation.

Type:

Orientation

Default Value: 'vertical'

moveItemOnDrop

Moves an element in the HTML markup when it is dropped.

Type:

Default Value: false

We recommend that you set this property to false. In React, the HTML markup depends on the data model and is updated automatically when you make changes.

onAdd

A function that is called when a new item is added.

Type:

Function parameters:

e:

AddEvent

Information about the event that caused the function's execution.

Object structure:

Name	Type	Description
component	Sortable	The UI component that raised the event.
dropInsideItem	Boolean	Indicates if the dragged item is dropped inside another item.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
event	Event (jQuery or EventObject)	The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.
fromComponent	Sortable \| Draggable	The instance of the item's source UI component.
fromData	any	Custom data associated with the source UI component.
fromIndex	Number	The item's original position. If the item is dragged from another UI component, the value is -1.
itemData	any	The dragged item's data.
itemElement	HTMLElement \| jQuery	The container of the item being dragged. It is an HTML Element or a jQuery Element when you use jQuery.
toComponent	Sortable \| Draggable	The instance of the item's target UI component.
toData	any	Custom data associated with the target UI component.
toIndex	Number	The position in which the item is placed. If the item is dragged away from the UI component, the value is -1.

Default Value: null

onDisposing

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

Type:

Function parameters:

e:

DisposingEvent

Information about the event.

Object structure:

Name	Type	Description
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	Sortable	The UI component's instance.

Default Value: null

onDragChange

A function that is called when the dragged item's position in the list is changed.

Type:

Function parameters:

e:

DragChangeEvent

Information about the event that caused the function's execution.

Object structure:

Name	Type	Description
cancel	Boolean	Allows you to cancel the gesture.
component	Sortable	The UI component that raised the event.
dropInsideItem	Boolean	Indicates if the dragged item is dropped inside another item.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
event	Event (jQuery or EventObject)	The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.
fromComponent	Sortable \| Draggable	The instance of the item's source UI component. Works only for element drag and drop between components.
fromData	any	Custom data associated with the source UI component. Works only for element drag and drop between components.
fromIndex	Number	The item's original position. If the item is dragged from another UI component, the value is -1.
itemData	any	The item's data before the drag operation. Note that you should specify the item data manually.
itemElement	HTMLElement \| jQuery	The container of the item being dragged. It is an HTML Element or a jQuery Element when you use jQuery.
toComponent	Sortable \| Draggable	The instance of the item's target UI component. Works only for element drag and drop between components.
toData	any	Custom data associated with the target UI component. Works only for element drag and drop between components.
toIndex	Number	The position in which the item is placed. If the item is dragged away from the UI component, the value is -1.

Default Value: null

View Demo

App.js


import React from 'react';
 
import TreeView from 'devextreme-react/tree-view';
import Sortable from 'devextreme-react/sortable';
import { Template } from 'devextreme-react/core/template';
 
function myDragTemplate(e) {
    return (
        e.itemData + " drag template";
    );
}
 
class App extends React.Component {
    constructor(props) {
        //...
    }        
    render() {
        return (
            <Sortable
                filter=".dx-treeview-item"
                allowReordering={true}
                onDragChange={this.onDragChange}
                dragTemplate={myDragTemplate}>
                <TreeView
                    id="simple-treeview"
                    dataStructure="plain"
                    items={this.state.treeViewItems}
                />
            </Sortable>                
        );
    }
    onDragChange = (e) => {
        e.itemData = this.state.treeViewItems[e.fromIndex].name;
        // your code
    }
}
export default App;

onDragEnd

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

Type:

Function parameters:

e:

DragEndEvent

Information about the event that caused the function's execution.

Object structure:

Name	Type	Description
cancel	Boolean	Allows you to cancel the gesture.
component	Sortable	The UI component that raised the event.
dropInsideItem	Boolean	Indicates if the dragged item is dropped inside another item.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
event	Event (jQuery or EventObject)	The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.
fromComponent	Sortable \| Draggable	The instance of the item's source UI component. Works only for element drag and drop between components.
fromData	any	Custom data associated with the source UI component. Works only for element drag and drop between components.
fromIndex	Number	The item's original position. If the item is dragged from another UI component, the value is -1.
itemData	any	The item's data before the drag operation. Note that you should specify the item data manually.
itemElement	HTMLElement \| jQuery	The container of the item being dragged. It is an HTML Element or a jQuery Element when you use jQuery.
toComponent	Sortable \| Draggable	The instance of the item's target UI component. Works only for element drag and drop between components.
toData	any	Custom data associated with the target UI component. Works only for element drag and drop between components.
toIndex	Number	The position in which the item is placed. If the item is dragged away from the UI component, the value is -1.

Default Value: null

View Demo

App.js


import React from 'react';
 
import TreeView from 'devextreme-react/tree-view';
import Sortable from 'devextreme-react/sortable';
import { Template } from 'devextreme-react/core/template';
 
function myDragTemplate(e) {
    return (
        e.itemData + " drag template";
    );
}
 
class App extends React.Component {
    constructor(props) {
        //...
    }        
    render() {
        return (
            <Sortable
                filter=".dx-treeview-item"
                allowReordering={true}
                onDragEnd={this.onDragEnd}
                dragTemplate={myDragTemplate}>
                <TreeView
                    id="simple-treeview"
                    dataStructure="plain"
                    items={this.state.treeViewItems}
                />
            </Sortable>                
        );
    }
    onDragEnd = (e) => {
        e.itemData = this.state.treeViewItems[e.fromIndex].name;
        // your code
    }
}
export default App;

onDragMove

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

Type:

Function parameters:

e:

DragMoveEvent

Information about the event that caused the function's execution.

Object structure:

Name	Type	Description
cancel	Boolean	Allows you to cancel the gesture.
component	Sortable	The UI component that raised the event.
dropInsideItem	Boolean	Indicates if the dragged item is dropped inside another item.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
event	Event (jQuery or EventObject)	The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.
fromComponent	Sortable \| Draggable	The instance of the item's source UI component. Works only for element drag and drop between components.
fromData	any	Custom data associated with the source UI component. Works only for element drag and drop between components.
fromIndex	Number	The item's original position. If the item is dragged from another UI component, the value is -1.
itemData	any	The item's data before the drag operation. Note that you should specify the item data manually.
itemElement	HTMLElement \| jQuery	The container of the item being dragged. It is an HTML Element or a jQuery Element when you use jQuery.
toComponent	Sortable \| Draggable	The instance of the item's target UI component. Works only for element drag and drop between components.
toData	any	Custom data associated with the target UI component. Works only for element drag and drop between components.
toIndex	Number	The position in which the item is placed. If the item is dragged away from the UI component, the value is -1.

Default Value: null

App.js


import React from 'react';
 
import TreeView from 'devextreme-react/tree-view';
import Sortable from 'devextreme-react/sortable';
import { Template } from 'devextreme-react/core/template';
 
function myDragTemplate(e) {
    return (
        e.itemData + " drag template";
    );
}
 
class App extends React.Component {
    constructor(props) {
        //...
    }        
    render() {
        return (
            <Sortable
                filter=".dx-treeview-item"
                allowReordering={true}
                onDragMove={this.onDragMove}
                dragTemplate={myDragTemplate}>
                <TreeView
                    id="simple-treeview"
                    dataStructure="plain"
                    items={this.state.treeViewItems}
                />
            </Sortable>                
        );
    }
    onDragMove = (e) => {
        e.itemData = this.state.treeViewItems[e.fromIndex].name;
        // your code
    }
}
export default App;

onDragStart

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

Type:

Function parameters:

e:

DragStartEvent

Information about the event that caused the function's execution.

Object structure:

Name	Type	Description
cancel	Boolean	Allows you to cancel the gesture.
component	Sortable	The UI component that raised the event.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
event	Event (jQuery or EventObject)	The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.
fromData	any	Custom data associated with the source UI component. Works only for element drag and drop between components.
fromIndex	Number	The item's original position. If the item is dragged from another UI component, the value is -1.
itemData	any	The item's data before the drag operation. Note that you should specify the item data manually.
itemElement	HTMLElement \| jQuery	The container of the item being dragged. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

App.js


import React from 'react';
 
import TreeView from 'devextreme-react/tree-view';
import Sortable from 'devextreme-react/sortable';
import { Template } from 'devextreme-react/core/template';
 
function myDragTemplate(e) {
    return (
        e.itemData + " drag template";
    );
}
 
class App extends React.Component {
    constructor(props) {
        //...
    }        
    render() {
        return (
            <Sortable
                filter=".dx-treeview-item"
                allowReordering={true}
                onDragStart={this.onDragStart}
                dragTemplate={myDragTemplate}>
                <TreeView
                    id="simple-treeview"
                    dataStructure="plain"
                    items={this.state.treeViewItems}
                />
            </Sortable>                
        );
    }
    onDragStart = (e) => {
        e.itemData = this.state.treeViewItems[e.fromIndex].name;
        // your code
    }
}
export default App;

onInitialized

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

Type:

Function parameters:

e:

InitializedEvent

Information about the event.

Object structure:

Name	Type	Description
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	Sortable	The UI component's instance.

Default Value: null

App.js


import Sortable from 'devextreme-react/sortable';
 
class App extends React.Component {
    constructor(props) {
        super(props);
 
        this.saveInstance = this.saveInstance.bind(this);
    }
 
    saveInstance(e) {
        this.sortableInstance = e.component;
    }
 
    render() {
        return (
            <div>
                <Sortable onInitialized={this.saveInstance} />
            </div>
        );
    }
}

onOptionChanged

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

Type:

Function parameters:

e:

OptionChangedEvent

Information about the event.

Object structure:

Name	Type	Description
value	any	The modified property's new value.
previousValue	any	The UI component's previous value.
name	String	The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.
fullName	String	The path to the modified property that includes all parent properties.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	Sortable	The UI component's instance.

Default Value: null

The following example shows how to subscribe to component property changes:

App.js


import React from 'react';  
import 'devextreme/dist/css/dx.light.css'; 
 
import Sortable from 'devextreme-react/sortable'; 
 
const handlePropertyChange = (e) => {
    if(e.name === "changedProperty") {
        // handle the property change here
    }
}
 
export default function App() { 
    return ( 
        <Sortable ...
            onOptionChanged={handlePropertyChange}
        />        
    ); 
}

onRemove

A function that is called when a draggable item is removed.

Type:

Function parameters:

e:

RemoveEvent

Information about the event that caused the function's execution.

Object structure:

Name	Type	Description
component	Sortable	The UI component that raised the event.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
event	Event (jQuery or EventObject)	The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.
fromComponent	Sortable \| Draggable	The instance of the item's source UI component.
fromData	any	Custom data associated with the source UI component.
fromIndex	Number	The item's original position. If the item is dragged from another UI component, the value is -1.
itemData	any	The dragged item's data.
itemElement	HTMLElement \| jQuery	The container of the item being dragged. It is an HTML Element or a jQuery Element when you use jQuery.
toComponent	Sortable \| Draggable	The instance of the item's target UI component.
toData	any	Custom data associated with the target UI component.
toIndex	Number	The position in which the item is placed. If the item is dragged away from the UI component, the value is -1.

Default Value: null

onReorder

A function that is called when the draggable items are reordered.

Type:

Function parameters:

e:

ReorderEvent

Information about the event that caused the function's execution.

Object structure:

Name	Type	Description
component	Sortable	The UI component that raised the event.
dropInsideItem	Boolean	Indicates if the dragged item is dropped inside another item.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
event	Event (jQuery or EventObject)	The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.
fromComponent	Sortable \| Draggable	The instance of the item's source UI component.
fromData	any	Custom data associated with the source UI component.
fromIndex	Number	The item's original position. If the item is dragged from another UI component, the value is -1.
itemData	any	The dragged item's data.
itemElement	HTMLElement \| jQuery	The container of the item being dragged. It is an HTML Element or a jQuery Element when you use jQuery.
promise	Promise<void> (jQuery or native)	Assign a Promise to this field to perform an asynchronous operation.
toComponent	Sortable \| Draggable	The instance of the item's target UI component.
toData	any	Custom data associated with the target UI component.
toIndex	Number	The position in which the item is placed. If the item is dragged away from the UI component, the value is -1.

Default Value: null

rtlEnabled

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

Type:

DataGrid Demo Navigation UI Demo Editors Demo

Default Value: false

When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

JavaScript


DevExpress.config({
    rtlEnabled: true
});

scrollSensitivity

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

Type:

Default Value: 60

scrollSpeed

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

Type:

Default Value: 30

width

Specifies the UI component's width.

Type:

|