JavaScript/jQuery Sortable Options

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:

|

Element

|

jQuery

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:

|

Element

|

jQuery

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.

Type:

|

data

A container for custom data.

Type: any

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:

Default Value: 'both'

Accepted Values: 'both' | 'horizontal' | 'vertical'

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

Template Data:

Name	Type	Description
fromIndex	Number	The item's original position.
itemData	any	The 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.

Name

Type

Description

fromIndex

Number

The item's original position.

itemData

any

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

Default Name: undefined

dropFeedbackMode

Specifies how to highlight the item's drop position.

Type:

Default Value: 'push'

Accepted Values: 'push' | 'indicate'

This property accepts the following values:

"push"
Items move apart with animation, allowing room for the dragged item to be placed. To use this mode, ensure that the allowDropInsideItem is disabled.
"indicate"
Items do not animate, a blue square appears at the place where the dragged item is going to be placed.

elementAttr

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

Type:

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:

Default Value: '> *'

group

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

Type:

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.

View Demo

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:

|

|

Return Value:

|

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", "80%", "inherit".
Function
A function returning either of the above. For example:
JavaScript
```
height: function() {
    return window.innerHeight / 1.5;
}
```

itemOrientation

Notifies the UI component of the items' orientation.

Type:

Default Value: 'vertical'

Accepted Values: 'horizontal' | '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 if you use Angular/Vue/React. In these frameworks, the HTML markup depends on the data model and is updated automatically when you make changes.

If you use jQuery/ASP.NET, 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.

onAdd

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

Type:

Function parameters:

e:

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 a dxEvent 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.
model	Object	Model data. Available only if you use Knockout.
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:

Information about the event.

Object structure:

Name	Type	Description
component	Sortable	The UI component's instance.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	Model data. Available only if you use Knockout.

Name

Type

Description

component

Sortable

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Model data. Available only if you use Knockout.

Default Value: null

onDragChange

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

Type:

Function parameters:

e:

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 a dxEvent 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.
model	Object	Model data. Available only if you use Knockout.
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

View Demo

onDragEnd

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

Type:

Function parameters:

e:

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 a dxEvent 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.
model	Object	Model data. Available only if you use Knockout.
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

onDragMove

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

Type:

Function parameters:

e:

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 a dxEvent 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.
model	Object	Model data. Available only if you use Knockout.
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

onDragStart

A function that is called when drag gesture is initialized.

Type:

Function parameters:

e:

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 a dxEvent or a jQuery.Event when you use jQuery.
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.
model	Object	Model data. Available only if you use Knockout.

Default Value: null

onInitialized

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

Type:

Function parameters:

e:

Information about the event.

Object structure:

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

Name

Type

Description

component

Sortable

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

onOptionChanged

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

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
model	Object	Model data. Available only if you use Knockout.
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.
name	String	The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.
value	any	The modified property's new value.

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.common.css'; 
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.common.css'; 
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:

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 a dxEvent 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.
model	Object	Model data. Available only if you use Knockout.
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:

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 a dxEvent 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.
model	Object	Model data. Available only if you use Knockout.
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: