jQuery UI Sortable sort Event

Last Updated : 13 Dec, 2021

jQuery UI consists of GUI widgets, visual effects, and themes implemented using Query JavaScript Library. jQuery UI is great for building UI interfaces for the webpages. It can be used to build highly interactive web applications or can be used to add widgets easily.

The jQuery UI Sortable sort event is used to trigger during the list items sorting.

Syntax:

Initialize the sortable widget with the sort callback function:

$(".selector").selectable({
    sort: function( event, ui ) {}
});

Bind an event listener to the sort event:

$( ".selector" ).on( "sort", function( event, ui ) {} );

Parameters:

event: This event is triggered when the user stopped the sorting with a position change of DOM.
ui: This is of type object with below-given options.
- helper: The jQuery object representing the sorted helper.
- item: The jQuery object representing the current dragged item.
- offset: The current absolute position of the helper object which is represented as { top, left }.
- position: The current position of the helper object which is represented as { top, left }.
- originalPosition: The original position of the helper object which is represented as { top, left }.

CDN Link: First, add jQuery UI scripts needed for your project.

<link rel=”stylesheet” href=”//code.jquery.com/ui/1.12.1/themes/smoothness/jquery-ui.css”>
<script src=”//code.jquery.com/jquery-1.12.4.js”></script>
<script src=”//code.jquery.com/ui/1.12.1/jquery-ui.js”></script>

Example:

HTML

<!DOCTYPE html> 
<html lang="en"> 
  
<head> 
    <meta charset="utf-8"> 
    <link rel="stylesheet" href= 
"https//code.jquery.com/ui/1.12.1/themes/base/jquery-ui.css"> 
    <script src= 
"https://code.jquery.com/jquery-1.12.4.js"> 
    </script> 
    <script src= 
"https://code.jquery.com/ui/1.12.1/jquery-ui.js"> 
    </script> 
  
    <style> 
        #sortable { 
            list-style-type: none; 
            width: 50%; 
        } 
  
        #sortable li { 
            margin: 10px 0; 
            padding: 0.5em; 
            font-size: 25px; 
            height: 20px; 
        } 
    </style> 
  
    <script> 
        $(function () { 
            $("#sortable").sortable({ 
                sort: function( event, ui ) { 
                    alert("Sort Event Triggered!") 
                } 
            }); 
        }); 
    </script> 
</head> 
  
<body> 
    <center> 
        <h1 style="color: green;"> 
            GeeksforGeeks 
        </h1> 
  
        <h4>jQuery UI Sortable sort Event</h4> 
  
        <ul id="sortable"> 
            <li class="ui-state-default">BCD</li> 
            <li class="ui-state-default">CAB</li> 
            <li class="ui-state-default">BAC</li> 
            <li class="ui-state-default">BCA</li> 
            <li class="ui-state-default">ABC</li> 
        </ul> 
    </center> 
</body> 
  
</html>