ProgressBar

The ProgressBar is a widget that shows current progress.

Included in: dx.mobile.js, dx.web.js, dx.viz-web.js, dx.all.js
Module: ui/progress_bar
ProgressBar interactive configuration
Copy Code
Copy to Codepen
$("#progressbar").dxProgressBar({
});

                    

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

  • jQuery
    Use the dxProgressBar jQuery plug-in.

    HTML
    <div id="progressBar"></div>
    JavaScript
    $("#progressBar").dxProgressBar({
        min: 0,
        max: 1000,
        showStatus: true,
        statusFormat: function(ratio, value) {
            return ratio * 100 + "% (" + value + ")";
        }
    });
  • Knockout
    Add a div element and apply the dxProgressBar binding to this element.

    HTML
    <div data-bind="dxProgressBar: {
        min: 0,
        max: 1000,
        showStatus: true,
        statusFormat: function(ratio, value) {
            return ratio * 100 + "% (" + value + ")";
        }
    }"></div>
  • AngularJS
    Add a div element and apply the dx-progress-bar directive to this element.

    HTML
    <div dx-progress-bar="{
        min: 0,
        max: 1000,
        showStatus: true,
        statusFormat: function(ratio, value) {
            return ratio * 100 + "% (" + value + ")";
        }
    }"></div>

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 Installation article.

You can find detailed information on the principles of working with the widget in the dxProgressBar section of the Editor Widgets article.

View Demo

Configuration

An object defining configuration options for the ProgressBar widget.

Name Description
disabled

A Boolean value specifying whether or not the widget can respond to user interaction.

height

Specifies 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.

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 handler for the complete event.

onDisposing

A handler for the disposing event.

onInitialized

A handler for the initialized event.

onOptionChanged

A handler for the optionChanged event.

onValueChanged

A handler for the valueChanged event.

readOnly

A Boolean value specifying whether or not the widget is read-only.

rtlEnabled

Specifies whether or not the current component supports 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

Holds the object that defines the error that occurred during validation.

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

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

width

Specifies 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.

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.

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()

Redraws the widget.

reset()

Resets the editor's value to undefined.

Events

This section describes events fired by this widget.

Name Description
complete

Fires after the value option value has reached the max option value.

disposing

Fires when the widget is being removed.

initialized

Fires when the widget is initialized.

optionChanged

Fires after an option of the component is changed.

valueChanged

Fires when the editor value changes.