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"

Type: LoadIndicatorTypes.default

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 function that is executed when the widget's content is ready and each time the content is changed.
onDisposing	A function that is executed before the widget is disposed of.
onInitialized	A function used in JavaScript frameworks to save the widget instance.
onOptionChanged	A function that is executed after a widget option 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.

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 without reloading data. Call it to update the widget's markup.

This section describes events fired by this widget.

Name	Description
contentReady	Raised when the widget's content is ready.
disposing	Raised before the widget is disposed of.
initialized	Raised only once, after the widget is initialized.
optionChanged	Raised after a widget option is changed.