Vue ProgressBar Props
See Also
elementAttr
Specifies the global attributes to be attached to the UI component's container element.
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;
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"
.Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.
isDirty
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
isValid
See Also
onComplete
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
onContentReady
A function that is executed when the UI component is rendered and each time the component is repainted.
Name | Type | Description |
---|---|---|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onDisposing
A function that is executed before the UI component is disposed of.
Name | Type | Description |
---|---|---|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onInitialized
Name | Type | Description |
---|---|---|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
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
<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
onOptionChanged
Name | Type | Description |
---|---|---|
value | any |
The modified property's new value. |
previousValue | any |
The UI component's previous value. |
name |
The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into. |
|
fullName |
The path to the modified property that includes all parent properties. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
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} /> ); }
onValueChanged
A function that is executed after the UI component's value is changed.
Name | Type | Description |
---|---|---|
value |
The UI component's new value. |
|
previousValue |
The UI component's previous value. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. This field is undefined if the value is changed programmatically. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
rtlEnabled
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 });
statusFormat
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.
validationError
Information on the broken validation rule. Contains the first item from the validationErrors array.
validationMessageMode
Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.
validationMessagePosition
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.
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;
validationStatus
The following table illustrates the validation status indicators:
validationStatus | Indicator |
---|---|
"pending" |
|
"valid" |
|
"invalid" |
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;
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"
.Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.
If you have technical questions, please create a support ticket in the DevExpress Support Center.