Load Panel

The LoadPanel is an overlay component used to notify users that a process is in progress. In this demo, you can see how to initialize and configure the component.

Backend API

​x
 
<div id="container">    <div class="header">John Heart</div>​    @(Html.DevExtreme().Button()        .Text("Load Data")        .OnClick("button_click")    )​    <div id="employee">        <p>            Birth date: <b class="birth-date"></b>        </p>        <p class="address">            Address:<br />            <b class="city"></b><br />            <span class="zipcode"></span>            <span class="address-info"></span>        </p>        <p>            Phone:            <b class="mobile-phone"></b><br />            Email: <b class="email"></b>        </p>    </div>​    @(Html.DevExtreme().LoadPanel()        .ID("loadPanel")        .ShadingColor("rgba(0,0,0,0.4)")        .Position(p => p.Of("#employee"))        .Visible(false)        .ShowIndicator(true)        .ShowPane(true)        .Shading(true)        .HideOnOutsideClick(false)        .OnShown("loadPanel_shown")        .OnHidden("loadPanel_hidden")    )​    <div class="options">        <div class="caption">Options</div>        <div class="option">            @(Html.DevExtreme().CheckBox()                .Value(true)                .Text("With indicator")                .OnValueChanged("withIndicator_checkBox_valueChanged")            )        </div>        <div class="option">            @(Html.DevExtreme().CheckBox()                .Value(true)                .Text("With overlay")                .OnValueChanged("withOverlay_checkBox_valueChanged")            )        </div>        <div class="option">            @(Html.DevExtreme().CheckBox()                .Value(true)                .Text("With pane")                .OnValueChanged("withPane_checkBox_valueChanged")            )        </div>        <div class="option">            @(Html.DevExtreme().CheckBox()                .Value(false)                .Text("Hide on outside click")                .OnValueChanged("hideOnOutsideClick_checkBox_valueChanged")            )        </div>    </div></div>​<script src="~/data/employee.js"></script>​<script>​    function getLoadPanelInstance() {        return $("#loadPanel").dxLoadPanel("instance");    }​    function showEmployeeInfo(employee) {        $(".birth-date").text(employee.Birth_Date || "");        $(".city").text(employee.City || "");        $(".zipcode").text(employee.Zipcode || "");        $(".address-info").text(employee.Address || "");        $(".mobile-phone").text(employee.Mobile_Phone || "");        $(".email").text(employee.Email || "");    }​    function button_click() {        getLoadPanelInstance().show();        showEmployeeInfo({});    }​    function loadPanel_shown(e) {        setTimeout(function() {            e.component.hide();        }, 3000);    }​    function loadPanel_hidden() {        showEmployeeInfo(employee);    }​    function withIndicator_checkBox_valueChanged(e) {        getLoadPanelInstance().option("showIndicator", e.value);    }​    function withOverlay_checkBox_valueChanged(e) {        getLoadPanelInstance().option("shading", e.value);    }​    function withPane_checkBox_valueChanged(e) {        getLoadPanelInstance().option("showPane", e.value);    }​    function hideOnOutsideClick_checkBox_valueChanged(e) {        getLoadPanelInstance().option("hideOnOutsideClick", e.value);    }​</script>​

xxxxxxxxxx
 
using Microsoft.AspNetCore.Mvc;using System;using System.Collections.Generic;using System.Linq;​namespace DevExtreme.NETCore.Demos.Controllers {    public class LoadPanelController : Controller {        public ActionResult Overview() {            return View();        }    }}

xxxxxxxxxx
 
var employee = {    "Full_Name":"John Heart",    "Title":"CEO",    "Birth_Date":"03/16/1964",    "Prefix":"Mr.",    "Address":"351 S Hill St.",    "City":"Los Angeles",    "Zipcode":90013,    "Email":"jheart@dx-email.com",    "Skype":"jheart_DX_skype",    "Home_Phone":"(213) 555-9208",    "Mobile_Phone":"(213) 555-9392"};

xxxxxxxxxx
 
.header {    font-size: 34px;    display: inline-block;    vertical-align: middle;    padding: 10px;    margin: 0;    }​#employee {    margin: 20px 0;    -webkit-touch-callout: none;    -webkit-user-select: none;    -khtml-user-select: none;    -moz-user-select: none;    -ms-user-select: none;    user-select: none;    border-top: 1px solid lightgray;    border-bottom: 1px solid lightgray;}​#employee > p {    padding: 10px 20px;    margin: 0;    }​.address {    height: 60px;}​.options {     padding: 20px;     background-color: rgba(191, 191, 191, 0.15);     margin-top: 20px;}​.caption {    font-size: 18px;    font-weight: 500;}​.option {    margin-top: 10px;}

Show and Hide the Indicator and Pane

LoadPanel elements (a message and an animated load indicator) are displayed on a pane. If you want to hide it, set the showPane property to false. You can also disable the showIndicator property to hide the animated load indicator. In this case, the LoadPanel displays only the message. In this demo, you can use the "With indicator" and "With pane" checkboxes to change the visibility of the load indicator and pane.

Configure the Background Shade

When LoadPanel is displayed, it shades the background. Use the shadingColor property to specify the color of the shade. You can also specify the element that should be shaded. For this, assign the element's CSS selector to the container property. If you do not want to shade the background, disable the shading property. In this demo, you can uncheck the "With overlay" checkbox to do it.

Show and Hide LoadPanel

To change the LoadPanel visibility in code, use the visible property. Alternatively, you can call the show() and hide() or toggle(showing) methods.

Users can hide LoadPanel when they click outside it if you enable the hideOnOutsideClick property. Use the "Hide on outside click" checkbox to control this functionality in this demo.

LoadPanel also allows you to handle the show and hide events. Use the onShowing and onHiding functions to handle the events before they occur and possibily cancel them. Use the onShown and onHidden functions to perform required actions after the events are raised.