Open In App

jQuery UI Sortable helper Option

Improve
Improve
Like Article
Like
Save
Share
Report

jQuery UI consists of GUI widgets, visual effects, and themes implemented using HTML, CSS, and jQuery. jQuery UI is great for building UI interfaces for the webpages. The jQuery UI Sortable helper Option is used to allow a helper element to be used for dragging display.

Syntax:

Initializing the sortable with the helper option.

$( ".selector" ).sortable({
 helper: "clone"
});
  • Setting the helper option.

    $( ".selector" ).sortable( "option", "helper", "clone" );
  • Getting the helper option.

    var helper = $( ".selector" ).sortable( "option", "helper" );

This option supports multiple types:

  • String: If the value of this option is set to “clone”, then the element will be cloned and the clone will be dragged.
  • Function: This is a function that will be returning a DOM Element to use while dragging. The function receives the event and the element being sorted.

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: This example demonstrates the jQuery UI Sortable helper Option.

HTML




<!DOCTYPE html>
<html lang="en">
  
<head>
    <meta charset="utf-8">
    <link rel="stylesheet" href=
"//code.jquery.com/ui/1.12.1/themes/base/jquery-ui.css">
    <script src=
    </script>
    <script src=
    </script>
    <style>
        #sortable {
            list-style-type: none;
            width: 50%;
        }
  
        #sortable li {
            margin: 10px 0;
            padding: 0.5em;
            font-size: 25px;
            height: 20px;
        }
    </style>
</head>
  
<body>
    <center>
        <h1 style="color: green;">GeeksforGeeks</h1>
        <h3>jQuery UI Sortable helper Option</h3>
        <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>
        <input type="button" id="Button" 
               value="Value of the helper Option">
        <div id="log"></div>
    </center>
    <script>
        $(function () {
            $("#sortable").sortable({
                helper: "clone"
            });
            $("#sortable").sortable("option", "helper", "clone");
            $("#Button").on('click', function () {
                var a = $("#sortable").sortable(
                         "option", "helper");
                $("#log").html(a);
            });
        });
    </script>
</body>
  
</html>


Output:

jQuery UI Sortable helper Option

jQuery UI Sortable helper Option

Reference: https://api.jqueryui.com/sortable/#option-helper



Last Updated : 12 Feb, 2022
Like Article
Save Article
Previous
Next
Share your thoughts in the comments
Similar Reads