DevExtreme v23.2 is now available.

Explore our newest features/capabilities and share your thoughts with us.

Your search did not match any results.

Progress Bar

Documentation

This demo shows how to configure the ProgressBar component.

To create a ProgressBar, declare it in markup. You can specify the following properties to change the ProgressBar's numeric scale:

  • min and max
    The min and max properties limit the range of accepted values.

  • value
    This property specifies the current value. If you want to switch the ProgressBar to an indeterminate state, set the value property to false.

This demo uses the custom timer function to increase the ProgressBar's value.

When the ProgressBar reaches the maximum value, the complete event occurs. Use the onComplete function to handle it.

The progress status displays a ratio between the current and maximum values and indicates the progress. Use the showStatus property to display or hide the status string. To format the status string, use the statusFormat function.

Backend API
import React, { useCallback, useEffect, useState } from 'react'; import { Button } from 'devextreme-react/button'; import { ProgressBar } from 'devextreme-react/progress-bar'; const maxValue = 10; function formatTime(value) { return `00:00:${(`0${value}`).slice(-2)}`; } function statusFormat(ratio: number) { return `Loading: ${ratio * 100}%`; } const elementAttr = { 'aria-label': 'Progress Bar' }; let intervalId; export default function App() { const [seconds, setSeconds] = useState(maxValue); const [buttonText, setButtonText] = useState('Start progress'); const [inProgress, setInProgress] = useState(false); useEffect(() => { if (seconds === 0) { setButtonText('Restart progress'); setInProgress(!inProgress); clearInterval(intervalId); } }, [seconds]); const onButtonClick = useCallback(() => { if (inProgress) { setButtonText('Continue progress'); clearInterval(intervalId); } else { setButtonText('Stop progress'); if (seconds === 0) { setSeconds(maxValue); } intervalId = setInterval(() => { setSeconds((prevValue: number) => prevValue - 1); }, 1000); } setInProgress(!inProgress); }, [setInProgress, setButtonText, seconds, inProgress]); return ( <div className="form"> <Button id="progress-button" text={buttonText} width={200} onClick={onButtonClick} /> <div className="progress-info"> Time left {formatTime(seconds)} </div> <ProgressBar id="progress-bar-status" className={seconds === 0 ? 'complete' : ''} width="90%" min={0} max={maxValue} elementAttr={elementAttr} statusFormat={statusFormat} value={maxValue - seconds} /> </div> ); }
import React, { useCallback, useEffect, useState } from 'react'; import { Button } from 'devextreme-react/button'; import { ProgressBar } from 'devextreme-react/progress-bar'; const maxValue = 10; function formatTime(value) { return `00:00:${`0${value}`.slice(-2)}`; } function statusFormat(ratio) { return `Loading: ${ratio * 100}%`; } const elementAttr = { 'aria-label': 'Progress Bar' }; let intervalId; export default function App() { const [seconds, setSeconds] = useState(maxValue); const [buttonText, setButtonText] = useState('Start progress'); const [inProgress, setInProgress] = useState(false); useEffect(() => { if (seconds === 0) { setButtonText('Restart progress'); setInProgress(!inProgress); clearInterval(intervalId); } }, [seconds]); const onButtonClick = useCallback(() => { if (inProgress) { setButtonText('Continue progress'); clearInterval(intervalId); } else { setButtonText('Stop progress'); if (seconds === 0) { setSeconds(maxValue); } intervalId = setInterval(() => { setSeconds((prevValue) => prevValue - 1); }, 1000); } setInProgress(!inProgress); }, [setInProgress, setButtonText, seconds, inProgress]); return ( <div className="form"> <Button id="progress-button" text={buttonText} width={200} onClick={onButtonClick} /> <div className="progress-info">Time left {formatTime(seconds)}</div> <ProgressBar id="progress-bar-status" className={seconds === 0 ? 'complete' : ''} width="90%" min={0} max={maxValue} elementAttr={elementAttr} statusFormat={statusFormat} value={maxValue - seconds} /> </div> ); }
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.tsx'; ReactDOM.render( <App />, document.getElementById('app'), );
window.exports = window.exports || {}; window.config = { transpiler: 'ts', typescriptOptions: { module: 'system', emitDecoratorMetadata: true, experimentalDecorators: true, jsx: 'react', }, meta: { 'react': { 'esModule': true, }, 'typescript': { 'exports': 'ts', }, 'devextreme/time_zone_utils.js': { 'esModule': true, }, 'devextreme/localization.js': { 'esModule': true, }, 'devextreme/viz/palette.js': { 'esModule': true, }, }, paths: { 'npm:': 'https://unpkg.com/', }, defaultExtension: 'js', map: { 'ts': 'npm:plugin-typescript@4.2.4/lib/plugin.js', 'typescript': 'npm:typescript@4.2.4/lib/typescript.js', 'react': 'npm:react@17.0.2/umd/react.development.js', 'react-dom': 'npm:react-dom@17.0.2/umd/react-dom.development.js', 'prop-types': 'npm:prop-types@15.8.1/prop-types.js', 'rrule': 'npm:rrule@2.6.4/dist/es5/rrule.js', 'luxon': 'npm:luxon@1.28.1/build/global/luxon.min.js', 'es6-object-assign': 'npm:es6-object-assign@1.1.0', 'devextreme': 'npm:devextreme@23.2.5/cjs', 'devextreme-react': 'npm:devextreme-react@23.2.5/cjs', 'jszip': 'npm:jszip@3.10.1/dist/jszip.min.js', 'devextreme-quill': 'npm:devextreme-quill@1.6.4/dist/dx-quill.min.js', 'devexpress-diagram': 'npm:devexpress-diagram@2.2.5/dist/dx-diagram.js', 'devexpress-gantt': 'npm:devexpress-gantt@4.1.51/dist/dx-gantt.js', '@devextreme/runtime': 'npm:@devextreme/runtime@3.0.12', 'inferno': 'npm:inferno@7.4.11/dist/inferno.min.js', 'inferno-compat': 'npm:inferno-compat/dist/inferno-compat.min.js', 'inferno-create-element': 'npm:inferno-create-element@7.4.11/dist/inferno-create-element.min.js', 'inferno-dom': 'npm:inferno-dom/dist/inferno-dom.min.js', 'inferno-hydrate': 'npm:inferno-hydrate@7.4.11/dist/inferno-hydrate.min.js', 'inferno-clone-vnode': 'npm:inferno-clone-vnode/dist/inferno-clone-vnode.min.js', 'inferno-create-class': 'npm:inferno-create-class/dist/inferno-create-class.min.js', 'inferno-extras': 'npm:inferno-extras/dist/inferno-extras.min.js', 'devextreme-cldr-data': 'npm:devextreme-cldr-data@1.0.3', // SystemJS plugins 'plugin-babel': 'npm:systemjs-plugin-babel@0.0.25/plugin-babel.js', 'systemjs-babel-build': 'npm:systemjs-plugin-babel@0.0.25/systemjs-babel-browser.js', // Prettier 'prettier/standalone': 'npm:prettier@2.8.4/standalone.js', 'prettier/parser-html': 'npm:prettier@2.8.4/parser-html.js', }, packages: { 'devextreme': { defaultExtension: 'js', }, 'devextreme-react': { main: 'index.js', }, 'devextreme/events/utils': { main: 'index', }, 'devextreme/localization/messages': { format: 'json', defaultExtension: '', }, 'devextreme/events': { main: 'index', }, 'es6-object-assign': { main: './index.js', defaultExtension: 'js', }, }, packageConfigPaths: [ 'npm:@devextreme/*/package.json', 'npm:@devextreme/runtime@3.0.12/inferno/package.json', ], babelOptions: { sourceMaps: false, stage0: true, react: true, }, }; System.config(window.config);
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.js'; ReactDOM.render(<App />, document.getElementById('app'));
<!DOCTYPE html> <html> <head> <title>DevExtreme Demo</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/23.2.5/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="styles.css" /> <script src="https://unpkg.com/core-js@2.6.12/client/shim.min.js"></script> <script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script> <script type="text/javascript" src="config.js"></script> <script type="text/javascript"> System.import("./index.tsx"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"></div> </div> </body> </html>
.form { padding: 20% 0; text-align: center; } #progress-button { margin-bottom: 20px; } #progress-bar-status { display: inline-block; padding-top: 8px; } .complete .dx-progressbar-range { background-color: green; }