LoadPanel

The LoadPanel is an overlay widget notifying the viewer that loading is in progress.

Included in: dx.mobile.js, dx.web.js, dx.viz-web.js, dx.all.js
Module: ui/load_panel
Export: default
LoadPanel interactive configuration
Copy Code
Copy to Codepen
$("#loadpanel").dxLoadPanel({
});

                    

You can create the widget using one of the following approaches.

  • jQuery

    HTML
    JavaScript
    <div id="loadPanel"></div>
    $(function () {
        $("#loadPanel").dxLoadPanel({
            closeOnOutsideClick: true,
            visible: true
        });
    });
  • Angular

    HTML
    JavaScript
    <dx-load-panel
        [closeOnOutsideClick]="true"
        [(visible)]="isLoadPanelVisible">
    </dx-load-panel>
    export class AppComponent {
        isLoadPanelVisible = true;
    }
  • AngularJS

    HTML
    JavaScript
    <div ng-controller="DemoController">
        <div dx-load-panel="{
            closeOnOutsideClick: true,
            bindingOptions: {
                visible: 'isLoadPanelVisible'
            }
        }"></div>
    </div>
    angular.module('DemoApp', ['dx'])
        .controller('DemoController', function DemoController($scope) {
            $scope.isLoadPanelVisible = true;
        });
  • Knockout

    HTML
    JavaScript
    <div data-bind="dxLoadPanel: {
        closeOnOutsideClick: true,
        visible: isLoadPanelVisible
    }"></div>
    var viewModel = {
        isLoadPanelVisible: ko.observable(true)
    };
    ko.applyBindings(viewModel);
  • ASP.NET MVC Wrappers

    Razor C#
    Razor VB
    @(Html.DevExtreme().LoadPanel()
        .ID("loadPanel")
        .CloseOnOutsideClick(true)
        .Visible(true)
    )
    @(Html.DevExtreme().LoadPanel() _
        .ID("loadPanel") _
        .CloseOnOutsideClick(True) _
        .Visible(True)
    )

Note that DevExtreme widgets require you to link the jQuery library to your application. If you use the Knockout or AngularJS approach, the Knockout or AngularJS library is also required. For detailed information on linking these libraries to your project, refer to the topics in the Installation section.

View Demo

See Also

Configuration

An object that defines configuration options for the LoadPanel widget.

Name Description
animation

Configures widget visibility animations. This object contains two fields: show and hide.

closeOnOutsideClick

A Boolean value specifying whether or not the widget is closed if a user clicks outside of the overlapping window.

deferRendering

Specifies whether widget content is rendered when the widget is shown or when rendering the widget.

delay

The delay in milliseconds after which the load panel is displayed.

elementAttr

Specifies the attributes to be attached to the widget's root element.

focusStateEnabled

Specifies whether or not the widget can be focused.

height

The height of the widget.

hint

Specifies the text of the hint displayed for the widget.

hoverStateEnabled

A Boolean value specifying whether or not the widget changes its state when being hovered by an end user.

indicatorSrc

A URL pointing to an image to be used as a load indicator.

maxHeight

Specifies the maximum height the widget can reach while resizing.

maxWidth

Specifies the maximum width the widget can reach while resizing.

message

The text displayed in the load panel.

minHeight

Specifies the minimum height the widget can reach while resizing.

minWidth

Specifies the minimum width the widget can reach while resizing.

onContentReady

A handler for the contentReady event. Executed when the widget's content is ready. This handler may be executed multiple times during the widget's lifetime depending on the number of times its content changes.

onDisposing

A handler for the disposing event.

onHidden

A handler for the hidden event.

onHiding

A handler for the hiding event.

onInitialized

A handler for the initialized event. Executed only once, after the widget is initialized.

onOptionChanged

A handler for the optionChanged event.

onShowing

A handler for the showing event.

onShown

A handler for the shown event.

position

An object defining widget positioning options.

rtlEnabled

Specifies whether or not the current component supports a right-to-left representation.

shading

A Boolean value specifying whether or not the main screen is inactive while the widget is active.

shadingColor

Specifies the shading color.

showIndicator

A Boolean value specifying whether or not to show a load indicator.

showPane

A Boolean value specifying whether or not to show the pane behind the load indicator.

visible

A Boolean value specifying whether or not the widget is visible.

width

The width of the widget.

Methods

This section describes members used to manipulate the widget.

Name Description
beginUpdate()

Prevents the component from refreshing until the endUpdate() method is called.

content()

An HTML element of the widget.

defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.

element()

Returns the root HTML element of the widget.

endUpdate()

Enables the component to refresh after the beginUpdate() method call.

hide()

Hides the widget.

instance()

Returns an instance of this component class.

off(eventName)

Detaches all event handlers from the specified event.

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

on(eventName, eventHandler)

Subscribes to a specified event.

on(events)

Subscribes to the specified events.

option()

Returns the configuration options of this component.

option(optionName)

Gets the value of the specified configuration option of this component.

option(optionName, optionValue)

Sets a value to the specified configuration option of this component.

option(options)

Sets one or more options of this component.

repaint()

Recalculates the overlay's size and position.

show()

Shows the widget.

toggle(showing)

Toggles the visibility of the widget.

Events

This section describes events fired by this widget.

Name Description
contentReady

Raised when the widget's content is ready.

disposing

Fires when the widget is being removed.

hidden

Fires after the overlay is hidden.

hiding

Fires before hiding the overlay.

initialized

Raised only once, after the widget is initialized.

optionChanged

Fires after an option of the component is changed.

showing

Fires before showing the overlay.

shown

Fires after the overlay is shown.