Getting Started with ASP.NET MVC Spinner Control

9 Dec 20243 minutes to read

This section briefly explains about how to include ASP.NET MVC Spinner control in your ASP.NET MVC application using Visual Studio.

Prerequisites

System requirements for ASP.NET MVC controls

Create ASP.NET MVC application with HTML helper

Install ASP.NET MVC package in the application

To add ASP.NET MVC controls in the application, open the NuGet package manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), search for Syncfusion.EJ2.MVC5 and then install it.

Install-Package Syncfusion.EJ2.MVC5 -Version 28.1.33

NOTE

Syncfusion® ASP.NET MVC controls are available in nuget.org. Refer to NuGet packages topic to learn more about installing NuGet packages in various OS environments. The Syncfusion.EJ2.MVC5 NuGet package has dependencies, Newtonsoft.Json for JSON serialization and Syncfusion.Licensing for validating Syncfusion® license key.

Add namespace

Add Syncfusion.EJ2 namespace reference in Web.config under Views folder.

<namespaces>
    <add namespace="Syncfusion.EJ2"/>
</namespaces>

Add stylesheet and script resources

Here, the theme and script is referred using CDN inside the <head> of ~/Pages/Shared/_Layout.cshtml file as follows,

<head>
    ...
    <!-- Syncfusion ASP.NET MVC controls styles -->
    <link rel="stylesheet" href="https://cdn.syncfusion.com/ej2/28.1.33/fluent.css" />
    <!-- Syncfusion ASP.NET MVC controls scripts -->
    <script src="https://cdn.syncfusion.com/ej2/28.1.33/dist/ej2.min.js"></script>
</head>

NOTE

Checkout the Themes topic to learn different ways (CDN, NPM package, and CRG) to refer styles in ASP.NET MVC application, and to have the expected appearance for Syncfusion® ASP.NET MVC controls. Checkout the Adding Script Reference topic to learn different approaches for adding script references in your ASP.NET MVC application.

Register Syncfusion® script manager

Also, register the script manager EJS().ScriptManager() at the end of <body> in the ~/Pages/Shared/_Layout.cshtml file as follows.

<body>
...
    <!-- Syncfusion ASP.NET MVC Script Manager -->
    @Html.EJS().ScriptManager()
</body>

Add ASP.NET MVC Spinner Control

Initialize the Spinner using createSpinner method and show/hide the spinner using showSpinner and hideSpinner methods accordingly. Set the target to the spinner to render it based on specific target.

Now, add the Spinner using Syncfusion® Essential® JavaScript library in ~/Views/Home/Index.cshtml page.

....
<div id="container" style="position:center; height: 300px;">
    <p>If you click the <b>Show Spinner</b> button you can create the <b>ASP.NET MVC Spinner component</b>  </p>
    <button id="showSpinnerButton">Show Spinner</button>
</div>

<script>

    var spinTarget = document.getElementById('container');
        ej.popups.createSpinner({
            target: spinTarget
        });

    // Attach a click event handler to the "Show Spinner" button
    document.getElementById('showSpinnerButton').addEventListener('click', function () {
        ej.popups.showSpinner(spinTarget);
                setInterval(function () {
                    //hideSpinner() method is used to hide the Spinner
                    ej.popups.hideSpinner(spinTarget);
                }, 5000);
    });
</script>
  • Show and hide this spinner by using showSpinner and hideSpinner methods for loading in your page.