An object defining configuration properties for the ProgressBar UI component.
Specifies whether the UI component responds to user interaction.
Specifies the global attributes to be attached to the UI component's container element.
Selector: DxElementAttr
Default Value: {}
jQuery$(function(){ $("#progressBarContainer").dxProgressBar({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });Angular
<dx-progress-bar ... [elementAttr]="{ id: 'elementId', class: 'class-name' }"> </dx-progress-bar>
import { DxProgressBarModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxProgressBarModule ], // ... })Vue
<template> <DxProgressBar ... :element-attr="progressBarAttributes"> </DxProgressBar> </template> <script> import DxProgressBar from 'devextreme-vue/progress-bar'; export default { components: { DxProgressBar }, data() { return { progressBarAttributes: { id: 'elementId', class: 'class-name' } } } } </script>React
import React from 'react'; import ProgressBar from 'devextreme-react/progress-bar'; class App extends React.Component { progressBarAttributes = { id: 'elementId', class: 'class-name' } render() { return ( <ProgressBar ... elementAttr={this.progressBarAttributes}> </ProgressBar> ); } } export default App;
Specifies the UI component's height.
This property accepts a value of one of the following types:
Number
The height in pixels.
String
A CSS-accepted measurement of height. For example, "55px"
, "20vh"
, "80%"
, "inherit"
.
Specifies text for a hint that appears when a user pauses on the UI component.
Specifies whether the UI component changes its state when a user pauses on it.
Selector: hover-state-enabled
Default Value: false
Specifies whether the component's current value differs from the initial value.
Selector: is-dirty
Default Value: false
This property is a read-only flag. You can use it to check if the editor value changed.
jQuery$(() => { const progressBar = $('#progressBar').dxProgressBar({ // ... }).dxProgressBar('instance'); $('#button').dxButton({ // ... onClick () { if (progressBar.option('isDirty')) { DevExpress.ui.notify("Do not forget to save changes", "warning", 500); } } }); });Angular
import { Component, ViewChild } from '@angular/core'; import { DxProgressBarComponent, DxButtonModule } from 'devextreme-angular'; import notify from 'devextreme/ui/notify'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { @ViewChild('progressBarRef', { static: false }) progressBar: DxProgressBarComponent; onClick () { if (this.progressBar.instance.option('isDirty')) { notify("Do not forget to save changes", "warning", 500); } } }
<dx-progress-bar ... #progressBarRef > </dx-progress-bar> <dx-button ... (onClick)="onClick($event)" > </dx-button>Vue
<template> <DxProgressBar ... :ref="progressBarRef" > </DxProgressBar> <DxButton ... @click="onClick" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxProgressBar from 'devextreme-vue/progress-bar'; import DxButton from 'devextreme-vue/button'; import notify from 'devextreme/ui/notify'; export default { components: { DxProgressBar, DxButton }, data() { return { progressBarRef } }, methods: { onClick () { if (this.progressBar.option('isDirty')) { notify("Do not forget to save changes", "warning", 500); } } }, computed: { progressBar: function() { return this.$refs[progressBarRef].instance; } } } </script>React
import React, { useRef } from 'react'; import ProgressBar from 'devextreme-react/progress-bar'; import Button from 'devextreme-react/button'; import 'devextreme/dist/css/dx.light.css'; const App = () => { const progressBarRef = useRef(null); const onClick = () => { if (this.progressBarRef.current.instance().option('isDirty')) { notify("Do not forget to save changes", "warning", 500); } }; return ( <ProgressBar ... ref={progressBarRef} > </ProgressBar> <Button ... onClick={onClick} /> ); }; export default App;See Also
Specifies or indicates whether the editor's value is valid.
Selector: is-valid
Default Value: true
The maximum value the UI component can accept.
The minimum value the UI component can accept.
A function that is executed when the value reaches the maximum.
Selector: @complete
Function parameters:Information about the event.
Object structure:
Default Value: null
A function that is executed when the UI component is rendered and each time the component is repainted.
Selector: @content-ready
Function parameters:Information about the event.
Object structure:
Default Value: null
A function that is executed before the UI component is disposed of.
Selector: @disposing
Function parameters:Information about the event.
Object structure:
Default Value: null
A function used in JavaScript frameworks to save the UI component instance.
Selector: @initialized
Function parameters:Information about the event.
Object structure:
Default Value: null
Angular<dx-progress-bar ... (onInitialized)="saveInstance($event)"> </dx-progress-bar>
import { Component } from "@angular/core"; import ProgressBar from "devextreme/ui/data_grid"; // ... export class AppComponent { progressBarInstance: ProgressBar; saveInstance (e) { this.progressBarInstance = e.component; } }Vue
App.vue (Composition API)
<template> <div> <DxProgressBar ... @initialized="saveInstance"> </DxProgressBar> </div> </template> <script> import DxProgressBar from 'devextreme-vue/progress-bar'; export default { components: { DxProgressBar }, data: function() { return { progressBarInstance: null }; }, methods: { saveInstance: function(e) { this.progressBarInstance = e.component; } } }; </script>
<template> <div> <DxProgressBar ... @initialized="saveInstance"> </DxProgressBar> </div> </template> <script setup> import DxProgressBar from 'devextreme-vue/progress-bar'; let progressBarInstance = null; const saveInstance = (e) => { progressBarInstance = e.component; } </script>React
import ProgressBar from 'devextreme-react/progress-bar'; class App extends React.Component { constructor(props) { super(props); this.saveInstance = this.saveInstance.bind(this); } saveInstance(e) { this.progressBarInstance = e.component; } render() { return ( <div> <ProgressBar onInitialized={this.saveInstance} /> </div> ); } }See Also jQuery
A function that is executed after a UI component property is changed.
Selector: @option-changed
Function parameters:Information about the event.
Object structure:
Name Type Description value anyThe modified property's new value.
previousValue anyThe UI component's previous value.
nameThe modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.
fullNameThe path to the modified property that includes all parent properties.
elementThe UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
componentThe UI component's instance.
Default Value: null
The following example shows how to subscribe to component property changes:
jQuery$(function() { $("#progressBarContainer").dxProgressBar({ // ... onOptionChanged: function(e) { if(e.name === "changedProperty") { // handle the property change here } } }); });Angular
<dx-progress-bar ... (onOptionChanged)="handlePropertyChange($event)"> </dx-progress-bar>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // ... handlePropertyChange(e) { if(e.name === "changedProperty") { // handle the property change here } } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxProgressBarModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxProgressBarModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }Vue
<template> <DxProgressBar ... @option-changed="handlePropertyChange" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxProgressBar from 'devextreme-vue/progress-bar'; export default { components: { DxProgressBar }, // ... methods: { handlePropertyChange: function(e) { if(e.name === "changedProperty") { // handle the property change here } } } } </script>React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import ProgressBar from 'devextreme-react/progress-bar'; const handlePropertyChange = (e) => { if(e.name === "changedProperty") { // handle the property change here } } export default function App() { return ( <ProgressBar ... onOptionChanged={handlePropertyChange} /> ); }
A function that is executed after the UI component's value is changed.
Selector: @value-changed
Function parameters:Information about the event.
Object structure:
Default Value: null
Specifies whether the editor is read-only.
Selector: read-only
Default Value: false
Switches the UI component to a right-to-left representation.
Selector: rtl-enabled
Default Value: false
When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.
DevExpress.config({ rtlEnabled: true });
DataGrid Demo Navigation UI Demo Editors Demo
Specifies whether or not the UI component displays a progress status.
Selector: show-status
Default Value: true
Specifies a format for the progress status.
Selector: status-format
Function parameters:The ratio of the current progress to the entire range. (From 0 to 1)
The UI component's value.
The customized progress status string.
Default Value: function(ratio, value) { return 'Progress: ' + Math.round(ratio * 100) + '%' }
A function passed to this property should take on a numeric value and return a formatted value. For instance, you can add a "%" sign after a value. In this case, the function passed to the statusFormat property should look like the following.
function(ratio, value) { return ratio * 100 + "% (" + value + ")"; }
The function may also return a string containing a Globalize format pattern.
Information on the broken validation rule. Contains the first item from the validationErrors array.
Selector: validation-error
Type: any
Default Value: null
An array of validation errors.
Selector: validation-errors
Default Value: null
ProgressBar updates this property automatically as it validates values. You can also update validationErrors manually to display custom errors and implement custom validation logic. The following code snippet demonstrates how to define items in this array:
jQuery$('#progress-bar').dxProgressBar({ isValid: false, validationErrors: [{ message: "Custom validation error" }], })Angular
<dx-progress-bar [isValid]="false" [validationErrors]="validationErrors" ></dx-progress-bar>
import { DxProgressBarComponent } from 'devextreme-angular/ui/progress-bar' export class AppComponent { validationErrors = [ { message: 'Custom validation error' } ]; }Vue
<script setup lang="ts"> import { DxProgressBar } from 'devextreme-vue/progress-bar'; const validationErrors = [ { message: 'Custom validation error' } ]; </script> <template> <DxProgressBar :is-valid="false" :validation-errors="validationErrors" /> </template>React
import { ProgressBar } from 'devextreme-react/progress-bar'; const validationErrors = [ { message: 'Custom validation error' } ]; function App(): JSX.Element { return ( <ProgressBar isValid={false} validationErrors={validationErrors} /> ) }
Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.
Selector: validation-message-mode
Default Value: 'auto'
The following property values are possible:
Specifies the position of a validation message relative to the component. The validation message describes the validation rules that this component's value does not satisfy.
Selector: validation-message-position
Default Value: 'bottom'
The following example positions a validation message at the component's right:
jQuery$(function() { $("#progressBarContainer").dxProgressBar({ // ... validationMessagePosition: 'right' }).dxValidator({ validationRules: [{ type: 'required', message: 'Required', }], }); });Angular
<dx-progress-bar ... validationMessagePosition="right"> <dx-validator> <dxi-validation-rule type="required" message="Required" > </dxi-validation-rule> </dx-validator> </dx-progress-bar>Vue
<template> <DxProgressBar ... validation-message-position="right" > <DxValidator> <DxRequiredRule message="Required" /> </DxValidator> </DxProgressBar> </template> <script> // ... </script>React
import React from 'react'; // ... function App() { return ( <ProgressBar ... validationMessagePosition="right" > <Validator> <RequiredRule message="Required" /> </Validator> </ProgressBar> ); }; export default App;
Indicates or specifies the current validation status.
Selector: validation-status
Default Value: 'valid'
The following table illustrates the validation status indicators:
When you assign "invalid" to validationStatus, you can also use the validationErrors array to set an error message as shown below:
jQuery$(function() { const progressBar = $("#progressBarContainer").dxProgressBar({ // ... }).dxProgressBar("instance"); function setInvalidStatus(message) { progressBar.option({ validationStatus: "invalid", validationErrors: [{ message: message }] }); } });Angular
<dx-progress-bar [validationStatus]="validationStatus" [validationErrors]="validationErrors"> </dx-progress-bar>
// ... export class AppComponent { validationStatus: string = "valid"; validationErrors: any; // ... setInvalidStatus(message) { this.validationStatus = "invalid"; this.validationErrors = [{ message: message }]; } }Vue
<template> <DxProgressBar ... :validation-status="validationStatus" :validation-errors="validationErrors" /> </template> <script> // ... export default { // ... data() { return { validationStatus: "valid", validationErrors: [] } }, methods: { setInvalidStatus(message) { this.validationStatus = "invalid"; this.validationErrors = [{ message: message }]; } } } </script>React
import React, { useState } from 'react'; // ... function App() { const [validationStatus, setValidationStatus] = useState("valid"); const [validationErrors, setValidationErrors] = useState([]); const setInvalidStatus = message => { setValidationStatus("invalid"); setValidationErrors([{ message: message }]); } return ( <ProgressBar validationStatus={validationStatus} validationErrors={validationErrors} /> ); }; export default App;
The current UI component value.
To create the indeterminate ProgressBar, assign false to the value property.
Specifies whether the UI component is visible.
Specifies the UI component's width.
This property accepts a value of one of the following types:
Number
The width in pixels.
String
A CSS-accepted measurement of width. For example, "55px"
, "20vw"
, "80%"
, "auto"
, "inherit"
.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4