JavaScript/jQuery Sortable Options
This section describes properties that configure Sortable UI component content, behavior, and appearance.
allowDropInsideItem
allowReordering
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.
dragTemplate
Name | Type | Description |
---|---|---|
fromIndex |
The item's original position. |
|
itemData | any |
The item's data. Note that you should specify the item data manually. |
itemElement |
The container of the item being dragged. It is an HTML Element or a jQuery Element when you use jQuery. |
dropFeedbackMode
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.
group
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.
height
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.
moveItemOnDrop
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
Name | Type | Description |
---|---|---|
component |
The UI component that raised the event. |
|
dropInsideItem |
Indicates if the dragged item is dropped inside another item. |
|
element |
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 | | |
The instance of the item's source UI component. |
fromData | any |
Custom data associated with the source UI component. |
fromIndex |
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 |
The container of the item being dragged. It is an HTML Element or a jQuery Element when you use jQuery. |
|
toComponent | | |
The instance of the item's target UI component. |
toData | any |
Custom data associated with the target UI component. |
toIndex |
The position in which the item is placed. If the item is dragged away from the UI component, the value is -1. |
onDisposing
A function that is executed before the UI component is disposed of.
Name | Type | Description |
---|---|---|
element |
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. |
onDragChange
Name | Type | Description |
---|---|---|
cancel |
Allows you to cancel the gesture. |
|
component | Sortable |
The UI component that raised the event. |
dropInsideItem |
Indicates if the dragged item is dropped inside another item. |
|
element |
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 | | |
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 |
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 |
The container of the item being dragged. It is an HTML Element or a jQuery Element when you use jQuery. |
|
toComponent | | |
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 |
The position in which the item is placed. If the item is dragged away from the UI component, the value is -1. |
onDragEnd
Name | Type | Description |
---|---|---|
cancel |
Allows you to cancel the gesture. |
|
component | Sortable |
The UI component that raised the event. |
dropInsideItem |
Indicates if the dragged item is dropped inside another item. |
|
element |
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 | | |
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 |
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 |
The container of the item being dragged. It is an HTML Element or a jQuery Element when you use jQuery. |
|
toComponent | | |
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 |
The position in which the item is placed. If the item is dragged away from the UI component, the value is -1. |
onDragMove
Name | Type | Description |
---|---|---|
cancel |
Allows you to cancel the gesture. |
|
component | Sortable |
The UI component that raised the event. |
dropInsideItem |
Indicates if the dragged item is dropped inside another item. |
|
element |
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 | | |
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 |
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 |
The container of the item being dragged. It is an HTML Element or a jQuery Element when you use jQuery. |
|
toComponent | | |
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 |
The position in which the item is placed. If the item is dragged away from the UI component, the value is -1. |
onDragStart
Name | Type | Description |
---|---|---|
cancel |
Allows you to cancel the gesture. |
|
component | Sortable |
The UI component that raised the event. |
element |
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 |
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 |
The container of the item being dragged. It is an HTML Element or a jQuery Element when you use jQuery. |
onInitialized
Name | Type | Description |
---|---|---|
element |
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. |
onOptionChanged
Name | Type | Description |
---|---|---|
value | any |
The modified property's new value. |
previousValue | any |
The UI component's previous value. |
name |
The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into. |
|
fullName |
The path to the modified property that includes all parent properties. |
|
element |
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. |
onRemove
Name | Type | Description |
---|---|---|
component | Sortable |
The UI component that raised the event. |
element |
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 | | |
The instance of the item's source UI component. |
fromData | any |
Custom data associated with the source UI component. |
fromIndex |
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 |
The container of the item being dragged. It is an HTML Element or a jQuery Element when you use jQuery. |
|
toComponent | | |
The instance of the item's target UI component. |
toData | any |
Custom data associated with the target UI component. |
toIndex |
The position in which the item is placed. If the item is dragged away from the UI component, the value is -1. |
onReorder
Name | Type | Description |
---|---|---|
component | Sortable |
The UI component that raised the event. |
dropInsideItem |
Indicates if the dragged item is dropped inside another item. |
|
element |
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 | | |
The instance of the item's source UI component. |
fromData | any |
Custom data associated with the source UI component. |
fromIndex |
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 |
The container of the item being dragged. It is an HTML Element or a jQuery Element when you use jQuery. |
|
promise |
Assign a Promise to this field to perform an asynchronous operation. |
|
toComponent | | |
The instance of the item's target UI component. |
toData | any |
Custom data associated with the target UI component. |
toIndex |
The position in which the item is placed. If the item is dragged away from the UI component, the value is -1. |
rtlEnabled
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.
- 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.
scrollSpeed
Specifies the scrolling speed when dragging an item beyond the viewport. Applies only if autoScroll is true.
width
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.