React ProgressBar API

The ProgressBar is a widget that shows current progress.

import ProgressBar from "devextreme-react/progress-bar"
Type: ProgressBarTypes.default

View Demo Read Guides

See Also

Props

An object defining configuration options for the ProgressBar widget.

Name Description
disabled

Specifies whether the widget responds to user interaction.
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.
hoverStateEnabled

Specifies whether the widget changes its state when a user pauses on it.
isValid

Specifies whether the editor's value is valid.
max

The maximum value the widget can accept.
min

The minimum value the widget can accept.
onComplete

A function that is executed when the value reaches the maximum.
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.
onValueChanged

A function that is executed after the widget's value is changed.
readOnly

Specifies whether the editor is read-only.
rtlEnabled

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

Specifies whether or not the widget displays a progress status.
statusFormat

Specifies a format for the progress status.
validationError

Specifies information on the validation error when using a custom validation engine. Should be changed at runtime along with the isValid option.
validationMessageMode

Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.
value

The current widget value.
visible

Specifies whether the widget is visible.
width

Specifies the widget's width.

See Also

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 ProgressBar 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.
reset()

Resets the value option to the default value.

See Also

Events

This section describes events fired by this widget.

Name Description
complete

Raised when the value reaches the maximum.
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.
valueChanged

Raised after the widget's value is changed.

See Also