Vue Sortable Props

This section describes properties that configure Sortable UI component content, behavior, and appearance.

See Also
jQuery
Angular
Vue
React

allowDropInsideItem

Allows a user to drop an item inside another item.

Selector: allow-drop-inside-item
Type:

Boolean

Default Value: false

This property also requires that you handle the change of hierarchy in code. If an item is dragged within a single component, use the onReorder handler. If the item is dragged from one component to another, use the onAdd and onRemove handlers.

See Also

allowReordering

Allows a user to reorder sortable items.

Selector: allow-reordering
Type:

Boolean

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.

Selector: auto-scroll
Type:

Boolean

Default Value: true

See Also

boundary

Specifies a DOM element that limits the dragging area.

Type:

String

|

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:

String

|

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: DxCursorOffset
Type:

String

|

Object

data

A container for custom data.

Type: any | undefined
Default Value: undefined

dragDirection

Specifies the directions in which an item can be dragged.

Selector: drag-direction
Type:

DragDirection

Default Value: 'both'

dragTemplate

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

Selector: drag-template
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:

String

|

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

jQuery
index.js
index.html
$(function() {
    var treeView = $("#simple-treeview").dxTreeView({
        items: treeViewItems,
        dataStructure: "plain",
        <!-- ... -->
    }).dxTreeView("instance");

    $("#simple-treeview").dxSortable({
        filter: ".dx-treeview-item",
        allowReordering: true,
        dragTemplate: dragTemplateFunc,       
        onDragChange: function (e) {
            e.itemData = e.element.find(".dx-treeview-item")[e.fromIndex].innerText;
            // your code
        }
    });
}); 

function dragTemplateFunc(item, customContainer){
    var $customContainer = $(document.createElement("div")) 
        .text(item.itemData + ' drag template');
    return $customContainer;
}
<div class="demo-container">
    <div class="form">
        <div id="simple-treeview"></div>
    </div>
</div>
Angular
TypeScript
HTML
import { DxSortableModule, DxTreeViewModule } from "devextreme-angular";
// ...
export class AppComponent {
    onDragChange(e){
        e.itemData = this.treeViewItems[e.fromIndex].name;
        // ...
    }
}
@NgModule({
    imports: [
        // ...
        DxSortableModule,
        DxTreeViewModule
    ],
    // ...
})
<dx-sortable
    filter=".dx-treeview-item"
    [allowReordering]="true"
    (onDragChange)="onDragChange($event)"
    dragTemplate="myDragTemplate"
>
    <div *dxTemplate="let e of 'myDragTemplate'">
        <div>{{ e.itemData + " drag template" }}</div>
    </div>          
    <dx-tree-view
        id="simple-treeview"
        [items]="treeViewItems"
        dataStructure="plain"
        ...>
    </dx-tree-view>
</dx-sortable>
Vue
App.vue
<template>
    <DxSortable
        filter=".dx-treeview-item"
        :allow-reordering="true"
        @drag-change="onDragChange"
        drag-template="myDragTemplate"
    >
        <template #myDragTemplate="{ data }">
            <div>{{ data.itemData.Task_Subject}} + "drag template"</div>
        </template>        
        <DxTreeView
            id="simple-treeview"
            data-structure="plain"
            :items="treeViewItems"
        />
    </DxSortable>
</template>

<script>

import DxTreeView from 'devextreme-vue/tree-view';
import DxSortable from 'devextreme-vue/sortable';

export default {
    components: {
        DxSortable,
        DxTreeView
    },
    methods: {
        onDragChange(e) {
            e.itemData = this.treeViewItems[e.fromIndex].name;
            // ...
        }
    }
}
</script>
React
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;
ASP.NET Core Controls
Razor C#
@(Html.DevExtreme().Sortable()
    .Filter(".dx-treeview-item")
    .AllowReordering(true)
    .OnDragChange("onDragChange")
    .DragTemplate(new JS("dragTemplateFunc"))
    .Content(
        Html.DevExtreme().TreeView()
            .ID("simple-treeview")
            .DataStructure(TreeViewDataStructure.Plain)
            .DataSource(d => d.Mvc().LoadAction("GetPlainDataForDragAndDrop"))
            .DataSourceOptions(o => o.Map("mapIcons"))
    )
)

<script>
    function onDragChange(e) {
        e.itemData = e.element.find(".dx-treeview-item")[e.fromIndex].innerText;
        // your code
    }

    function dragTemplateFunc(item, customContainer){
        var $customContainer = $(document.createElement("div")) 
            .text(item.itemData + ' drag template');
        return $customContainer;
    }        
</script>

dropFeedbackMode

Specifies how to highlight the item's drop position.

Selector: drop-feedback-mode
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: DxElementAttr
Type:

Object

Default Value: {}

jQuery
$(function(){
    $("#sortableContainer").dxSortable({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});
Angular
HTML
TypeScript
<dx-sortable ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-sortable>
import { DxSortableModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxSortableModule
    ],
    // ...
})
Vue
App.vue
<template>
    <DxSortable ...
        :element-attr="sortableAttributes">
    </DxSortable>
</template>

<script>
import DxSortable from 'devextreme-vue/sortable';

export default {
    components: {
        DxSortable
    },
    data() {
        return {
            sortableAttributes: {
                id: 'elementId',
                class: 'class-name'
            }
        }
    }
}
</script>
React
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:

String

Default Value: '> *'

group

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

Type:

String

| 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:

String

Default Value: ''

height

Specifies the UI component's height.

Type:

Number

|

String

|

Function

| undefined
Return Value:

Number

|

String

The UI component's height.

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".

  • Function (deprecated since v21.2)
    Refer to the W0017 warning description for information on how you can migrate to viewport units.

itemOrientation

Notifies the UI component of the items' orientation.

Selector: item-orientation
Type:

Orientation

Default Value: 'vertical'

moveItemOnDrop

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

Selector: move-item-on-drop
Type:

Boolean

Default Value: false

jQuery

We recommend that you set moveItemsOnDrop to true because changes to the data model do not automatically update the HTML markup. If you set this property to false, you should move DOM nodes in the onReorder function.

Angular

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

Vue

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

React

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.

Selector: @add
Type:

Function

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.

Selector: @disposing
Type:

Function

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.

Selector: @drag-change
Type:

Function

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

jQuery
index.js
index.html
$(function() {
    var treeView = $("#simple-treeview").dxTreeView({
        items: treeViewItems,
        dataStructure: "plain",
        <!-- ... -->
    }).dxTreeView("instance");

    $("#simple-treeview").dxSortable({
        filter: ".dx-treeview-item",
        allowReordering: true,
        dragTemplate: dragTemplateFunc,       
        onDragChange: function (e) {
            e.itemData = e.element.find(".dx-treeview-item")[e.fromIndex].innerText;
            // your code
        }
    });
}); 

function dragTemplateFunc(item, customContainer){
    var $customContainer = $(document.createElement("div")) 
        .text(item.itemData + ' drag template');
    return $customContainer;
}
<div class="demo-container">
    <div class="form">
        <div id="simple-treeview"></div>
    </div>
</div>
Angular
TypeScript
HTML
import { DxSortableModule, DxTreeViewModule } from "devextreme-angular";
// ...
export class AppComponent {
    onDragChange(e){
        e.itemData = this.treeViewItems[e.fromIndex].name;
        // ...
    }
}
@NgModule({
    imports: [
        // ...
        DxSortableModule,
        DxTreeViewModule
    ],
    // ...
})
<dx-sortable
    filter=".dx-treeview-item"
    [allowReordering]="true"
    (onDragChange)="onDragChange($event)"
    dragTemplate="myDragTemplate"
>
    <div *dxTemplate="let e of 'myDragTemplate'">
        <div>{{ e.itemData + " drag template" }}</div>
    </div>          
    <dx-tree-view
        id="simple-treeview"
        [items]="treeViewItems"
        dataStructure="plain"
        ...>
    </dx-tree-view>
</dx-sortable>
Vue
App.vue
<template>
    <DxSortable
        filter=".dx-treeview-item"
        :allow-reordering="true"
        @drag-change="onDragChange"
        :drag-template="myDragTemplate"
    >
        <template #myDragTemplate="{ data }">
            <div>{{ data.itemData.Task_Subject}} + "drag template"</div>
        </template>        
        <DxTreeView
            id="simple-treeview"
            data-structure="plain"
            :items="treeViewItems"
        />
    </DxSortable>
</template>

<script>

import DxTreeView from 'devextreme-vue/tree-view';
import DxSortable from 'devextreme-vue/sortable';

export default {
    components: {
        DxSortable,
        DxTreeView
    },
    methods: {
        onDragChange(e) {
            e.itemData = this.treeViewItems[e.fromIndex].name;
            // ...
        }
    }
}
</script>
React
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;
ASP.NET Core Controls
Razor C#
@(Html.DevExtreme().Sortable()
    .Filter(".dx-treeview-item")
    .AllowReordering(true)
    .OnDragChange("onDragChange")
    .DragTemplate(new JS("dragTemplateFunc"))
    .Content(
        Html.DevExtreme().TreeView()
            .ID("simple-treeview")
            .DataStructure(TreeViewDataStructure.Plain)
            .DataSource(d => d.Mvc().LoadAction("GetPlainDataForDragAndDrop"))
            .DataSourceOptions(o => o.Map("mapIcons"))
    )
)

<script>
    function onDragChange(e) {
        e.itemData = e.element.find(".dx-treeview-item")[e.fromIndex].innerText;
        // your code
    }

    function dragTemplateFunc(item, customContainer){
        var $customContainer = $(document.createElement("div")) 
            .text(item.itemData + ' drag template');
        return $customContainer;
    }        
</script>

onDragEnd

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

Selector: @drag-end
Type:

Function

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

jQuery
index.js
index.html
$(function() {
    var treeView = $("#simple-treeview").dxTreeView({
        items: treeViewItems,
        dataStructure: "plain",
        <!-- ... -->
    }).dxTreeView("instance");

    $("#simple-treeview").dxSortable({
        filter: ".dx-treeview-item",
        allowReordering: true,
        dragTemplate: dragTemplateFunc,       
        onDragEnd: function (e) {
            e.itemData = e.element.find(".dx-treeview-item")[e.fromIndex].innerText;
            // your code
        }
    });
}); 

function dragTemplateFunc(item, customContainer){
    var $customContainer = $(document.createElement("div")) 
        .text(item.itemData + ' drag template');
    return $customContainer;
}
<div class="demo-container">
    <div class="form">
        <div id="simple-treeview"></div>
    </div>
</div>
Angular
TypeScript
HTML
import { DxSortableModule, DxTreeViewModule } from "devextreme-angular";
// ...
export class AppComponent {
    onDragEnd(e){
        e.itemData = this.treeViewItems[e.fromIndex].name;
        // ...
    }
}
@NgModule({
    imports: [
        // ...
        DxSortableModule,
        DxTreeViewModule
    ],
    // ...
})
<dx-sortable
    filter=".dx-treeview-item"
    [allowReordering]="true"
    (onDragEnd)="onDragEnd($event)"
    dragTemplate="myDragTemplate"
>
    <div *dxTemplate="let e of 'myDragTemplate'">
        <div>{{ e.itemData + " drag template" }}</div>
    </div>          
    <dx-tree-view
        id="simple-treeview"
        [items]="treeViewItems"
        dataStructure="plain"
        ...>
    </dx-tree-view>
</dx-sortable>
Vue
App.vue
<template>
    <DxSortable
        filter=".dx-treeview-item"
        :allow-reordering="true"
        @drag-end="onDragEnd"
        :drag-template="myDragTemplate"
    >
        <template #myDragTemplate="{ data }">
            <div>{{ data.itemData.Task_Subject}} + "drag template"</div>
        </template>        
        <DxTreeView
            id="simple-treeview"
            data-structure="plain"
            :items="treeViewItems"
        />
    </DxSortable>
</template>

<script>

import DxTreeView from 'devextreme-vue/tree-view';
import DxSortable from 'devextreme-vue/sortable';

export default {
    components: {
        DxSortable,
        DxTreeView
    },
    data() {
        return {
            myDragTemplate: "myDragTemplate",
            //...
        };
    },        
    methods: {
        onDragEnd(e) {
            e.itemData = this.treeViewItems[e.fromIndex].name;
            // ...
        }
    }
}
</script>
React
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;
ASP.NET Core Controls
Razor C#
@(Html.DevExtreme().Sortable()
    .Filter(".dx-treeview-item")
    .AllowReordering(true)
    .OnDragEnd("onDragEnd")
    .DragTemplate(new JS("dragTemplateFunc"))
    .Content(
        Html.DevExtreme().TreeView()
            .ID("simple-treeview")
            .DataStructure(TreeViewDataStructure.Plain)
            .DataSource(d => d.Mvc().LoadAction("GetPlainDataForDragAndDrop"))
            .DataSourceOptions(o => o.Map("mapIcons"))
    )
)

<script>
    function onDragEnd(e) {
        e.itemData = e.element.find(".dx-treeview-item")[e.fromIndex].innerText;
        // your code
    }

    function dragTemplateFunc(item, customContainer){
        var $customContainer = $(document.createElement("div")) 
            .text(item.itemData + ' drag template');
        return $customContainer;
    }        
</script>

onDragMove

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

Selector: @drag-move
Type:

Function

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

jQuery
index.js
index.html
$(function() {
    var treeView = $("#simple-treeview").dxTreeView({
        items: treeViewItems,
        dataStructure: "plain",
        <!-- ... -->
    }).dxTreeView("instance");

    $("#simple-treeview").dxSortable({
        filter: ".dx-treeview-item",
        allowReordering: true,
        dragTemplate: dragTemplateFunc,       
        onDragMove: function (e) {
            e.itemData = e.element.find(".dx-treeview-item")[e.fromIndex].innerText;
            // your code
        }
    });
}); 

function dragTemplateFunc(item, customContainer){
    var $customContainer = $(document.createElement("div")) 
        .text(item.itemData + ' drag template');
    return $customContainer;
}
<div class="demo-container">
    <div class="form">
        <div id="simple-treeview"></div>
    </div>
</div>
Angular
TypeScript
HTML
import { DxSortableModule, DxTreeViewModule } from "devextreme-angular";
// ...
export class AppComponent {
    onDragMove(e){
        e.itemData = this.treeViewItems[e.fromIndex].name;
        // ...
    }
}
@NgModule({
    imports: [
        // ...
        DxSortableModule,
        DxTreeViewModule
    ],
    // ...
})
<dx-sortable
    filter=".dx-treeview-item"
    [allowReordering]="true"
    (onDragMove)="onDragMove($event)"
    dragTemplate="myDragTemplate"
>
    <div *dxTemplate="let e of 'myDragTemplate'">
        <div>{{ e.itemData + " drag template" }}</div>
    </div>          
    <dx-tree-view
        id="simple-treeview"
        [items]="treeViewItems"
        dataStructure="plain"
        ...>
    </dx-tree-view>
</dx-sortable>
Vue
App.vue
<template>
    <DxSortable
        filter=".dx-treeview-item"
        :allow-reordering="true"
        @drag-move="onDragMove"
        :drag-template="myDragTemplate"
    >
        <template #myDragTemplate="{ data }">
            <div>{{ data.itemData.Task_Subject}} + "drag template"</div>
        </template>        
        <DxTreeView
            id="simple-treeview"
            data-structure="plain"
            :items="treeViewItems"
        />
    </DxSortable>
</template>

<script>

import DxTreeView from 'devextreme-vue/tree-view';
import DxSortable from 'devextreme-vue/sortable';

export default {
    components: {
        DxSortable,
        DxTreeView
    },
    data() {
        return {
            myDragTemplate: "myDragTemplate",
            //...
        };
    },        
    methods: {
        onDragMove(e) {
            e.itemData = this.treeViewItems[e.fromIndex].name;
            // ...
        }
    }
}
</script>
React
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;
ASP.NET Core Controls
Razor C#
@(Html.DevExtreme().Sortable()
    .Filter(".dx-treeview-item")
    .AllowReordering(true)
    .OnDragMove("onDragMove")
    .DragTemplate(new JS("dragTemplateFunc"))
    .Content(
        Html.DevExtreme().TreeView()
            .ID("simple-treeview")
            .DataStructure(TreeViewDataStructure.Plain)
            .DataSource(d => d.Mvc().LoadAction("GetPlainDataForDragAndDrop"))
            .DataSourceOptions(o => o.Map("mapIcons"))
    )
)

<script>
    function onDragMove(e) {
        e.itemData = e.element.find(".dx-treeview-item")[e.fromIndex].innerText;
        // your code
    }

    function dragTemplateFunc(item, customContainer){
        var $customContainer = $(document.createElement("div")) 
            .text(item.itemData + ' drag template');
        return $customContainer;
    }        
</script>

onDragStart

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

Selector: @drag-start
Type:

Function

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

jQuery
index.js
index.html
$(function() {
    var treeView = $("#simple-treeview").dxTreeView({
        items: treeViewItems,
        dataStructure: "plain",
        <!-- ... -->
    }).dxTreeView("instance");

    $("#simple-treeview").dxSortable({
        filter: ".dx-treeview-item",
        allowReordering: true,
        dragTemplate: dragTemplateFunc,       
        onDragStart: function (e) {
            e.itemData = e.element.find(".dx-treeview-item")[e.fromIndex].innerText;
            // your code
        }
    });
}); 

function dragTemplateFunc(item, customContainer){
    var $customContainer = $(document.createElement("div")) 
        .text(item.itemData + ' drag template');
    return $customContainer;
}
<div class="demo-container">
    <div class="form">
        <div id="simple-treeview"></div>
    </div>
</div>
Angular
TypeScript
HTML
import { DxSortableModule, DxTreeViewModule } from "devextreme-angular";
// ...
export class AppComponent {
    onDragStart(e){
        e.itemData = this.treeViewItems[e.fromIndex].name;
        // ...
    }
}
@NgModule({
    imports: [
        // ...
        DxSortableModule,
        DxTreeViewModule
    ],
    // ...
})
<dx-sortable
    filter=".dx-treeview-item"
    [allowReordering]="true"
    (onDragStart)="onDragStart($event)"
    dragTemplate="myDragTemplate"
>
    <div *dxTemplate="let e of 'myDragTemplate'">
        <div>{{ e.itemData + " drag template" }}</div>
    </div>          
    <dx-tree-view
        id="simple-treeview"
        [items]="treeViewItems"
        dataStructure="plain"
        ...>
    </dx-tree-view>
</dx-sortable>
Vue
App.vue
<template>
    <DxSortable
        filter=".dx-treeview-item"
        :allow-reordering="true"
        @drag-start="onDragStart"
        :drag-template="myDragTemplate"
    >
        <template #myDragTemplate="{ data }">
            <div>{{ data.itemData.Task_Subject}} + "drag template"</div>
        </template>        
        <DxTreeView
            id="simple-treeview"
            data-structure="plain"
            :items="treeViewItems"
        />
    </DxSortable>
</template>

<script>

import DxTreeView from 'devextreme-vue/tree-view';
import DxSortable from 'devextreme-vue/sortable';

export default {
    components: {
        DxSortable,
        DxTreeView
    },
    data() {
        return {
            myDragTemplate: "myDragTemplate",
            //...
        };
    },
    methods: {
        onDragStart(e) {
            e.itemData = this.treeViewItems[e.fromIndex].name;
            // ...
        }
    }
}
</script>
React
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;
ASP.NET Core Controls
Razor C#
@(Html.DevExtreme().Sortable()
    .Filter(".dx-treeview-item")
    .AllowReordering(true)
    .OnDragStart("onDragStart")
    .DragTemplate(new JS("dragTemplateFunc"))
    .Content(
        Html.DevExtreme().TreeView()
            .ID("simple-treeview")
            .DataStructure(TreeViewDataStructure.Plain)
            .DataSource(d => d.Mvc().LoadAction("GetPlainDataForDragAndDrop"))
            .DataSourceOptions(o => o.Map("mapIcons"))
    )
)

<script>
    function onDragStart(e) {
        e.itemData = e.element.find(".dx-treeview-item")[e.fromIndex].innerText;
        // your code
    }

    function dragTemplateFunc(item, customContainer){
        var $customContainer = $(document.createElement("div")) 
            .text(item.itemData + ' drag template');
        return $customContainer;
    }        
</script>

onInitialized

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

Selector: @initialized
Type:

Function

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

Angular
app.component.html
app.component.ts
<dx-sortable ...
    (onInitialized)="saveInstance($event)">
</dx-sortable>
import { Component } from "@angular/core";
import Sortable from "devextreme/ui/data_grid";
// ...
export class AppComponent {
    sortableInstance: Sortable;
    saveInstance (e) {
        this.sortableInstance = e.component;
    }
}
Vue
App.vue (Options API)
App.vue (Composition API)
<template>
    <div>
        <DxSortable ...
            @initialized="saveInstance">
        </DxSortable>
    </div>
</template>

<script>
import DxSortable from 'devextreme-vue/sortable';

export default {
    components: {
        DxSortable
    },
    data: function() {
        return {
            sortableInstance: null
        };
    },
    methods: {
        saveInstance: function(e) {
            this.sortableInstance = e.component;
        }
    }
};
</script>
<template>
    <div>
        <DxSortable ...
            @initialized="saveInstance">
        </DxSortable>
    </div>
</template>

<script setup>
import DxSortable from 'devextreme-vue/sortable';

let sortableInstance = null;

const saveInstance = (e) => {
    sortableInstance = e.component;
}
</script>
React
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>
        );
    }
}
See Also
jQuery
  • Get a UI component Instance in jQuery
Angular
  • Get a UI component Instance in Angular
Vue
  • Get a UI component Instance in Vue
React
  • Get a UI component Instance in React

onOptionChanged

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

Selector: @option-changed
Type:

Function

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:

jQuery
index.js
$(function() {
    $("#sortableContainer").dxSortable({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-sortable ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-sortable>
import { Component } from '@angular/core'; 

@Component({ 
    selector: 'app-root', 
    templateUrl: './app.component.html', 
    styleUrls: ['./app.component.css'] 
}) 

export class AppComponent { 
    // ...
    handlePropertyChange(e) {
        if(e.name === "changedProperty") { 
            // handle the property change here
        }
    }
}
import { BrowserModule } from '@angular/platform-browser'; 
import { NgModule } from '@angular/core'; 
import { AppComponent } from './app.component'; 
import { DxSortableModule } from 'devextreme-angular'; 

@NgModule({ 
    declarations: [ 
        AppComponent 
    ], 
    imports: [ 
        BrowserModule, 
        DxSortableModule 
    ], 
    providers: [ ], 
    bootstrap: [AppComponent] 
}) 

export class AppModule { }
Vue
App.vue
<template> 
    <DxSortable ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script>  
import 'devextreme/dist/css/dx.light.css'; 
import DxSortable from 'devextreme-vue/sortable'; 

export default { 
    components: { 
        DxSortable
    }, 
    // ...
    methods: { 
        handlePropertyChange: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    } 
} 
</script>
React
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.

Selector: @remove
Type:

Function

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.

Selector: @reorder
Type:

Function

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.

Selector: rtl-enabled
Type:

Boolean

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
});

DataGrid Demo Navigation UI Demo Editors Demo

scrollSensitivity

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

Selector: scroll-sensitivity
Type:

Number

Default Value: 60

See Also

scrollSpeed

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

Selector: scroll-speed
Type:

Number

Default Value: 30

See Also

width

Specifies the UI component's width.

Type:

Number

|

String

|

Function

| undefined
Return Value:

Number

|

String

The UI component's width.

Default Value: undefined

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

  • Number
    The width in pixels.

  • String
    A CSS-accepted measurement of width. For example, "55px", "20vw", "80%", "auto", "inherit".

  • Function (deprecated since v21.2)
    Refer to the W0017 warning description for information on how you can migrate to viewport units.