React LoadIndicator API

The LoadIndicator is a UI element notifying the viewer that a process is in progress.

import LoadIndicator from "devextreme-react/load-indicator"

DevExtreme widgets are integrated with many popular libraries and frameworks. See the Installation section (for JavaScript libraries) or the Prerequisites and Installation section (for ASP.NET MVC framework) to find details on setting up DevExtreme with a particular library or framework.

The following code shows how to create the LoadIndicator widget using every supported library and framework. For more details on working with widgets in these libraries and frameworks, see the Widget Basics topic for jQuery, Angular, AngularJS, Knockout or ASP.NET MVC.

jQuery
JavaScript
HTML
$(function () {
    $("#loadIndicator").dxLoadIndicator({
        visible: true
    });
});
<div id="loadIndicator"></div>
Angular
HTML
TypeScript
<dx-load-indicator [(visible)]="isLoadIndicatorVisible"></dx-load-indicator>
import { DxLoadIndicatorModule } from 'devextreme-angular';
// ...
export class AppComponent {
    isLoadIndicatorVisible = true;
}
@NgModule({
    imports: [
        // ...
        DxLoadIndicatorModule
    ],
    // ...
})
AngularJS
HTML
JavaScript
<div ng-controller="DemoController">
    <div dx-load-indicator="{
        bindingOptions: {
            visible: 'isLoadIndicatorVisible'
        }
    }"></div>
</div>
angular.module('DemoApp', ['dx'])
    .controller("DemoController", function ($scope) {
        $scope.isLoadIndicatorVisible = true;
    });
Knockout
HTML
JavaScript
<div data-bind="dxLoadIndicator: {
    visible: isLoadIndicatorVisible
}"></div>
var viewModel = {
    isLoadIndicatorVisible: ko.observable(true)
};
ko.applyBindings(viewModel);
ASP.NET MVC Controls
Razor C#
Razor VB
@(Html.DevExtreme().LoadIndicator()
    .ID("loadIndicator")
    .Visible(true)
)
@(Html.DevExtreme().LoadIndicator() _
    .ID("loadIndicator") _
    .Visible(True)
)

View Demo

See Also

Configuration

This section describes the configuration options of the LoadIndicator widget.

Name Description
elementAttr

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

Specifies the widget's height.
hint

Specifies text for a hint that appears when a user pauses on the widget.
indicatorSrc

Specifies the path to an image used as the indicator.
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. Executed when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.
onInitialized

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

A handler for the optionChanged event. Executed after an option of the widget is changed.
rtlEnabled

Switches the widget to a right-to-left representation.
visible

Specifies whether the widget is visible.
width

Specifies the widget's width.

Methods

This section describes members used to manipulate the widget.

Name Description
beginUpdate()

Prevents the widget from refreshing until the endUpdate() method is called.
defaultOptions(rule)

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

Disposes of all the resources allocated to the LoadIndicator instance.
element()

Gets the root widget element.
endUpdate()

Refreshes the widget after a call of the beginUpdate() method.
getInstance(element)

Gets the instance of a widget found using its DOM node.
instance()

Gets the widget's instance. Use it to access other methods of the widget.
off(eventName)

Detaches all event handlers from a single event.
off(eventName, eventHandler)

Detaches a particular event handler from a single event.
on(eventName, eventHandler)

Subscribes to an event.
on(events)

Subscribes to events.
option()

Gets all widget options.
option(optionName)

Gets the value of a single option.
option(optionName, optionValue)

Updates the value of a single option.
option(options)

Updates the values of several options.
repaint()

Repaints the widget. Call it if you made modifications that changed the widget's state to invalid.

Events

This section describes events fired by this widget.

Name Description
contentReady

Raised when the widget's content is ready.
disposing

Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.
initialized

Raised only once, after the widget is initialized.
optionChanged

Raised after a widget option is changed.

See Also