Angular Sortable API

Sortable is a user interface utility that allows a widget's items to be reordered via drag and drop gestures.

import { DxSortableModule } from "devextreme-angular"
Type: DxSortableTypes.default

View Demo

Configuration

This section describes options that configure Sortable widget content, behavior, and appearance.

Name Description
allowDropInsideItem

Allows a user to drop an item inside another item.
allowReordering

Allows a user to reorder sortable items.
autoScroll

Enables automatic scrolling while dragging an item beyond the viewport.
boundary

Specifies a DOM element that limits the dragging area.
container

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

Specifies the cursor offset from the dragged item.
data

A container for custom data.
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.
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.
dropFeedbackMode

Specifies how to highlight the item's drop position.
elementAttr

Specifies the attributes to be attached to the widget's root element.
filter

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

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

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

Specifies the widget's height.
itemOrientation

Notifies the widget of the items' orientation.
moveItemOnDrop

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

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

A function that is executed before the widget is disposed of.
onDragChange

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

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

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

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

A function used in JavaScript frameworks to save the widget instance.
onOptionChanged

A function that is executed after a widget option is changed.
onRemove

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

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

Switches the widget to a right-to-left representation.
scrollSensitivity

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

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

Specifies the widget's width.

See Also

Methods

Methods of the DomComponent object.

Name Description
beginUpdate()

Prevents the widget from refreshing until the endUpdate() method is called.
defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.
dispose()

Disposes of all the resources allocated to the Sortable instance.
element()

Gets the root widget element.
endUpdate()

Refreshes the widget after a call of the beginUpdate() method.
getInstance(element)

Gets the instance of a widget found using its DOM node.
instance()

Gets the widget's instance. Use it to access other methods of the widget.
off(eventName)

Detaches all event handlers from a single event.
off(eventName, eventHandler)

Detaches a particular event handler from a single event.
on(eventName, eventHandler)

Subscribes to an event.
on(events)

Subscribes to events.
option()

Gets all widget options.
option(optionName)

Gets the value of a single option.
option(optionName, optionValue)

Updates the value of a single option.
option(options)

Updates the values of several options.
resetOption(optionName)

Resets an option to its default value.

Events

This section describes events raised by the Sortable widget.

Name Description
add

Raised when a new item is added.
disposing

Raised before the widget is disposed of.
dragChange

Raised when the dragged item's position in the list is changed.
dragEnd

Raised when drag gesture is finished.
dragMove

Raised every time a draggable item is moved.
dragStart

Raised when drag gesture is initialized.
initialized

Raised only once, after the widget is initialized.
optionChanged

Raised after a widget option is changed.
remove

Raised when a draggable item is removed.
reorder

Raised when the draggable items are reordered.

See Also