LinearProgress API
API reference docs for the React LinearProgress component. Learn about the props, CSS, and other APIs of this exported module.
Demos
Import
import LinearProgress from '@mui/material/LinearProgress';
// or
import { LinearProgress } from '@mui/material';
Learn about the difference by reading this guide on minimizing bundle size.
ARIA
If the progress bar is describing the loading progress of a particular region of a page,
you should use aria-describedby
to point to the progress bar, and set the aria-busy
attribute to true
on that region until it has finished loading.
Props of the native component are also available.
Name | Type | Default | Description |
---|---|---|---|
classes | object | - | Override or extend the styles applied to the component. See CSS classes API below for more details. |
color | 'inherit' | 'primary' | 'secondary' | string | 'primary' | The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. |
sx | Array<func | object | bool> | func | object | - | The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details. |
value | number | - | The value of the progress indicator for the determinate and buffer variants. Value between 0 and 100. |
valueBuffer | number | - | The value for the buffer variant. Value between 0 and 100. |
variant | 'buffer' | 'determinate' | 'indeterminate' | 'query' | 'indeterminate' | The variant to use. Use indeterminate or query when there is no progress value. |
ref
is forwarded to the root element.Theme default props
You can use MuiLinearProgress
to change the default props of this component with the theme.
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
Class name | Rule name | Description |
---|---|---|
.MuiLinearProgress-bar | bar | Styles applied to the layered bar1 and bar2 elements. |
.MuiLinearProgress-bar1Buffer | bar1Buffer | Styles applied to the bar1 element if variant="buffer" . |
.MuiLinearProgress-bar1Determinate | bar1Determinate | Styles applied to the bar1 element if variant="determinate" . |
.MuiLinearProgress-bar1Indeterminate | bar1Indeterminate | Styles applied to the bar1 element if variant="indeterminate or query" . |
.MuiLinearProgress-bar2Buffer | bar2Buffer | Styles applied to the bar2 element if variant="buffer" . |
.MuiLinearProgress-bar2Indeterminate | bar2Indeterminate | Styles applied to the bar2 element if variant="indeterminate or query" . |
.MuiLinearProgress-barColorPrimary | barColorPrimary | Styles applied to the bar elements if color="primary" ; bar2 if variant not "buffer". |
.MuiLinearProgress-barColorSecondary | barColorSecondary | Styles applied to the bar elements if color="secondary" ; bar2 if variant not "buffer". |
.MuiLinearProgress-buffer | buffer | Styles applied to the root element if variant="buffer" . |
.MuiLinearProgress-colorPrimary | colorPrimary | Styles applied to the root and bar2 element if color="primary" ; bar2 if variant="buffer" . |
.MuiLinearProgress-colorSecondary | colorSecondary | Styles applied to the root and bar2 elements if color="secondary" ; bar2 if variant="buffer" . |
.MuiLinearProgress-dashed | dashed | Styles applied to the additional bar element if variant="buffer" . |
.MuiLinearProgress-dashedColorPrimary | dashedColorPrimary | Styles applied to the additional bar element if variant="buffer" and color="primary" . |
.MuiLinearProgress-dashedColorSecondary | dashedColorSecondary | Styles applied to the additional bar element if variant="buffer" and color="secondary" . |
.MuiLinearProgress-determinate | determinate | Styles applied to the root element if variant="determinate" . |
.MuiLinearProgress-indeterminate | indeterminate | Styles applied to the root element if variant="indeterminate" . |
.MuiLinearProgress-query | query | Styles applied to the root element if variant="query" . |
.MuiLinearProgress-root | root | Styles applied to the root element. |
You can override the style of the component using one of these customization options:
- With a global class name.
- With a rule name as part of the component's
styleOverrides
property in a custom theme.
Source code
If you did not find the information in this page, consider having a look at the implementation of the component for more detail.