jQuery UI Sortable containment Option

Last Updated : 25 Jan, 2022

jQuery UI is a web-based technology and consists of GUI widgets, visual effects, and themes implemented using the jQuery, JavaScript Library. jQuery UI is the best tool for building UI interfaces for the webpages. It can also be used to build highly interactive web applications or can be used to add widgets easily.

In this article, we will learn how to use the jQuery UI Sortable containment Option. Using this option, we can define a bounding box that the sortable items are constrained to while dragging. The default value of this option is false.

This option accepts the following multiple types supported:

Element: This option also accepts an element to use as the container.
Selector: This option also accepts a selector specifying an element to use as the container.
String: This option also accepts a string identifying an element to use as the container. The Possible values accepted are: “parent”, “document”, “window”.

Syntax:

The containment option takes the above-defined type value and the syntax is as follows.

$( ".selector" ).sortable({
    containment: "parent"
});

Get the containment option

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

Set the containment option

$( ".selector" ).sortable( "option", 
    "containment", "parent" );

CDN Link: The following jQuery Mobile scripts will be needed for your project so we need to add these scripts to your project.

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

Example: This example describes the uses of the jQuery UI Sortable containment Option.

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; 
            padding: 0.5em; 
            font-size: 25px; 
            height: 20px; 
            background-color: green; 
        } 
        #gfg { 
            margin-left: 50px; 
        } 
        #btn { 
            margin-left: 50px; 
            padding: 0.5; 
            font-size: 20px; 
            height: 40px; 
            width: 40%; 
        } 
    </style> 
  
    <script> 
        $(function () { 
            $("#btn").on('click', function () { 
                var containment = $("#sortable") 
                .sortable( "option", "containment" ); 
                document.getElementById('gfg').innerHTML += 
                "Containment Value : " + containment; 
            }); 
        }); 
  
        $(function () { 
            $("#sortable").sortable(); 
        }); 
    </script> 
</head> 
  
<body> 
    <center> 
        <h1 style="color: green;"> 
            GeeksforGeeks 
        </h1> 
  
        <h3>jQuery UI Sortable containment Option</h3> 
  
        <ul id="sortable"> 
            <li id='hndl'>Geeks1</li> 
            <li>Geeks2</li> 
            <li>Geeks3</li> 
        </ul> 
          
        <input type="button" id="btn"
            value="Get Containment"> 
          
        <h3><span id="gfg"></span></h3> 
    </center> 
</body> 
  
</html> 