AutoComplete TextBox with ASP.NET MVC and jQuery

jQuery UI has an AutoComplete widget. The autocomplete widget is quite nice and straight forward to use. In this post, how to integrate the AutoComplete widget with an ASP.NET MVC application.

The first step is to add the jQuery scripts and styles. With ASP.NET MVC 4, the following code does the work:

@Styles.Render("~/Content/themes/base/css")
@Scripts.Render("~/bundles/jquery")    
@Scripts.Render("~/bundles/jqueryui")

Using the AutoComplete widget is also simple. You will have to add a textbox and attach the AutoComplete widget to the textbox. The only parameter that is required for the widget to function is source. For this example, we will get the data for the AutoComplete functionality from a MVC action method.

$(document).ready(function () {
    $('#tags').autocomplete(
        {
            source: '@Url.Action("TagSearch", "Home")'
    });
})

In the above code, the textbox with id=tags is attached with the AutoComplete widget. The source points to the URL of TagSearch action in the HomeController: /Home/TagSearch. The HTML of the textbox is below:

<input type="text" id="tags" />

When the user types some text in the textbox, the action method - TagSearch is called with a parameter in the request body. The parameter name is term. So, your action method should have the following signature:

public ActionResult TagSearch(string term)
{
    // Get Tags from database
    string[] tags = { "ASP.NET", "WebForms", 
                    "MVC", "jQuery", "ActionResult", 
                    "MangoDB", "Java", "Windows" };
    return this.Json(tags.Where(t => t.StartsWith(term)), 
                    JsonRequestBehavior.AllowGet);
}

With the above code, the AutoComplete functionality is complete. Quite simple, right?



<!doctype html>




<html lang="en">




<head>




  <meta charset="utf-8">




  <title>jQuery UI Autocomplete - Default functionality</title>




  <link rel="stylesheet" href="//code.jquery.com/ui/1.11.2/themes/smoothness/jquery-ui.css">




  <script src="//code.jquery.com/jquery-1.10.2.js"></script>




  <script src="//code.jquery.com/ui/1.11.2/jquery-ui.js"></script>




  <link rel="stylesheet" href="/resources/demos/style.css">




  <script>




  $(function() {




    var availableTags = [




      "ActionScript",




      "AppleScript",




      "Asp",




      "BASIC",




      "C",




      "C++",




      "Clojure",




      "COBOL",




      "ColdFusion",




      "Erlang",




      "Fortran",




      "Groovy",




      "Haskell",




      "Java",




      "JavaScript",




      "Lisp",




      "Perl",




      "PHP",




      "Python",




      "Ruby",




      "Scala",




      "Scheme"




    ];




    $( "#tags" ).autocomplete({




      source: availableTags




    });




  });




  </script>




</head>




<body>




 




<div class="ui-widget">




  <label for="tags">Tags: </label>




  <input id="tags">




</div>




 




 




</body>




</html>

Comments