@material/linear-progress
Advanced tools
The Material Components for the web linear progress indicator component
@material/linear-progress is a Material Design component for displaying linear progress indicators. It provides a visual representation of the progress of a task, making it easy to integrate with React applications and ensuring a consistent look and feel with other Material Design components.
Indeterminate Progress
This feature allows you to display an indeterminate progress bar, which is useful when the duration of the task is unknown.
import React from 'react';
import { LinearProgress } from '@material-ui/core';
function IndeterminateProgress() {
return <LinearProgress />;
}
export default IndeterminateProgress;Determinate Progress
This feature allows you to display a determinate progress bar, which is useful when you can track the progress of a task.
import React, { useState } from 'react';
import { LinearProgress } from '@material-ui/core';
function DeterminateProgress() {
const [progress, setProgress] = useState(0);
React.useEffect(() => {
const timer = setInterval(() => {
setProgress((oldProgress) => {
if (oldProgress === 100) {
return 0;
}
const diff = Math.random() * 10;
return Math.min(oldProgress + diff, 100);
});
}, 500);
return () => {
clearInterval(timer);
};
}, []);
return <LinearProgress variant="determinate" value={progress} />;
}
export default DeterminateProgress;Buffer Progress
This feature allows you to display a buffer progress bar, which is useful when you want to show both the progress and the buffer of a task.
import React, { useState } from 'react';
import { LinearProgress } from '@material-ui/core';
function BufferProgress() {
const [progress, setProgress] = useState(0);
const [buffer, setBuffer] = useState(10);
React.useEffect(() => {
const timer = setInterval(() => {
setProgress((oldProgress) => {
if (oldProgress === 100) {
return 0;
}
const diff = Math.random() * 10;
return Math.min(oldProgress + diff, 100);
});
setBuffer((oldBuffer) => {
if (oldBuffer === 100) {
return 10;
}
const diff = Math.random() * 10;
return Math.min(oldBuffer + diff, 100);
});
}, 500);
return () => {
clearInterval(timer);
};
}, []);
return <LinearProgress variant="buffer" value={progress} valueBuffer={buffer} />;
}
export default BufferProgress;Query Progress
This feature allows you to display a query progress bar, which is useful when you want to indicate that a task is being queried.
import React from 'react';
import { LinearProgress } from '@material-ui/core';
function QueryProgress() {
return <LinearProgress variant="query" />;
}
export default QueryProgress;react-loader-spinner provides a collection of customizable loading spinners for React applications. It offers a variety of spinner types, including linear progress bars, and is highly customizable in terms of size, color, and animation speed. Compared to @material/linear-progress, it provides more variety in loading indicators but may not adhere strictly to Material Design guidelines.
react-progressbar.js is a React wrapper for ProgressBar.js, a library for creating animated progress bars. It supports linear and circular progress bars with customizable animations and styles. While it offers more animation options compared to @material/linear-progress, it may require more effort to integrate seamlessly with Material Design components.
nprogress is a simple and lightweight progress bar library for web applications. It is often used for indicating page load progress and can be easily integrated with React. However, it lacks the variety of progress bar types and customization options available in @material/linear-progress.
The MDC Linear Progress component is a spec-aligned linear progress indicator component adhering to the Material Design progress & activity requirements.
npm install @material/linear-progress
<div role="progressbar" class="mdc-linear-progress" aria-label="Example Progress Bar" aria-valuemin="0" aria-valuemax="1" aria-valuenow="0">
<div class="mdc-linear-progress__buffer">
<div class="mdc-linear-progress__buffer-bar"></div>
<div class="mdc-linear-progress__buffer-dots"></div>
</div>
<div class="mdc-linear-progress__bar mdc-linear-progress__primary-bar">
<span class="mdc-linear-progress__bar-inner"></span>
</div>
<div class="mdc-linear-progress__bar mdc-linear-progress__secondary-bar">
<span class="mdc-linear-progress__bar-inner"></span>
</div>
</div>
Progress bars conform to the WAI-ARIA Progressbar Specification. The supported ARIA attributes for this progress bar are:
| Attribute | Description |
|---|---|
aria-label | Label indicating how the progress bar should be announced to the user. |
aria-valuemin | The minimum numeric value of the progress bar, which should always be 0. |
aria-valuemax | The maximum numeric value of the progress bar, which should always be 1. |
aria-valuenow | A numeric value between aria-valuemin and aria-valuemax indicating the progress value of the primary progress bar. This attribute is removed in indeterminate progress bars. |
Note that aria-label, aria-valuemin, and aria-valuemax are static and must be configured in the HTML. aria-valuenow is updated dynamically by the foundation when the progress value is updated in determinate progress bars.
The direction of the progress bar follows the dir attribute on its nearest ancestor. For example, setting dir="rtl" on the progress root reverses the direction of the indicator.
Where multiple dir attributes are specified in the tree, the one on the progress bar root takes precedence.
@use "@material/linear-progress";
@include linear-progress.core-styles;
import { MDCLinearProgress } from '@material/linear-progress';
const linearProgress = new MDCLinearProgress(document.querySelector('.mdc-linear-progress'));
See Importing the JS component for more information on how to import JavaScript.
The provided modifiers are:
| Class | Description |
|---|---|
mdc-linear-progress--indeterminate | Puts the linear progress indicator in an indeterminate state. |
mdc-linear-progress--closed | Hides the linear progress indicator. |
| Mixin | Description |
|---|---|
bar-color($color) | Sets the color of the progress bar |
buffer-color($color) | Sets the color of the buffer bar and dots |
MDC Linear Progress ships with an MDCLinearProgressFoundation class that external frameworks and libraries can
use to integrate the component. As with all foundation classes, an adapter object must be provided.
The adapter for linear progress must provide the following functions, with correct signatures:
| Method Signature | Description |
|---|---|
addClass(className: string) => void | Adds a class to the root element. |
removeAttribute(attributeName: string) => void | Removes the specified attribute from the root element. |
removeClass(className: string) => void | Removes a class from the root element. |
hasClass(className: string) => boolean | Returns boolean indicating whether the root element has a given class. |
forceLayout() => void | Force-trigger a layout on the root element. This is needed to restart animations correctly. |
setAttribute(attributeName: string, value: string) => void | Sets the specified attribute on the root element. |
setBufferBarStyle(styleProperty: string, value: string) => void | Sets the inline style on the buffer bar. |
setPrimaryBarStyle(styleProperty: string, value: string) => void | Sets the inline style on the primary bar. |
attachResizeObserver(callback: ResizeObserverCallback) => ResizeObserver | null | Returns a ResizeObserver that has had observe called on the root with the given callback (for animation performance gains on modern browsers). null if ResizeObserver is not implemented or polyfilled. |
setStyle(styleProperty: string, value: string) => void | Sets the inline style on the root element. |
getWidth() => number | Returns the width of the root. |
MDC Linear Progress Foundation exposes the following methods:
| Method Signature | Description |
|---|---|
setDeterminate(value: boolean) => void | Toggles the component between the determinate and indeterminate state. |
setProgress(value: number) => void | Sets the progress bar to this value. Value should be between [0, 1]. |
setBuffer(value: number) => void | Sets the buffer bar to this value. Value should be between [0, 1]. |
open() => void | Puts the component in the open state. |
close() => void | Puts the component in the closed state. |
MDC Linear Progress exposes the following methods:
| Method Signature | Description |
|---|---|
set determinate(value: boolean) => void | Toggles the component between the determinate and indeterminate state. |
set progress(value: number) => void | Sets the progress bar to this value. Value should be between [0, 1]. |
set buffer(value: number) => void | Sets the buffer bar to this value. Value should be between [0, 1]. |
open() => void | Puts the component in the open state. |
close() => void | Puts the component in the closed state. |
10.0.0 (2021-02-05)
thumb. (489d4c2)pointer-events: none instead of visibility: hidden to hide the value indicator container. Adding visibility: hidden removes the exit animation since the value indicator is immediately hidden. (a94bd8d)transform-origin on tooltip surface so tooltip entrance animation has a direction based on its alignment with the anchor element. (623af86)scroll and resize events. This ensures that the tooltip remains pinned to the anchor element despite page movement. (a415276)hide and isShown methods in the MDCTooltip component. This allows MDC clients to create their own class to enforce only one tooltip being shown at a time. (c5e18b0)deep-get() API from mdc-theme, use sass:map's get() API instead.FAQs
The Material Components for the web linear progress indicator component
The npm package @material/linear-progress receives a total of 604,037 weekly downloads. As such, @material/linear-progress popularity was classified as popular.
We found that @material/linear-progress demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 15 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.