LinearProgress API
The API documentation of the LinearProgress React component. Learn more about the properties and the CSS customization points.
import LinearProgress from '@material-ui/core/LinearProgress';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
| Name | Type | Default | Description |
|---|---|---|---|
| classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
| color | enum: 'primary' | 'secondary' |
'primary' | The color of the component. It supports those theme colors that make sense for this component. |
| 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 | enum: 'determinate' | 'indeterminate' | 'buffer' | 'query' |
'indeterminate' | The variant to use. Use indeterminate or query when there is no progress value. |
The ref is forwarded to the root element.
Any other properties supplied will be provided to the root element (native element).
CSS
You can override all the class names injected by Material-UI thanks to the classes prop.
This prop accepts the following keys:
| Name | Description |
|---|---|
| root | Styles applied to the root element. |
| colorPrimary | Styles applied to the root & bar2 element if color="primary"; bar2 if variant-"buffer". |
| colorSecondary | Styles applied to the root & bar2 elements if color="secondary"; bar2 if variant="buffer". |
| determinate | Styles applied to the root element if variant="determinate". |
| indeterminate | Styles applied to the root element if variant="indeterminate". |
| buffer | Styles applied to the root element if variant="buffer". |
| query | Styles applied to the root element if variant="query". |
| dashed | Styles applied to the additional bar element if variant="buffer". |
| dashedColorPrimary | Styles applied to the additional bar element if variant="buffer" & color="primary". |
| dashedColorSecondary | Styles applied to the additional bar element if variant="buffer" & color="secondary". |
| bar | Styles applied to the layered bar1 & bar2 elements. |
| barColorPrimary | Styles applied to the bar elements if color="primary"; bar2 if variant not "buffer". |
| barColorSecondary | Styles applied to the bar elements if color="secondary"; bar2 if variant not "buffer". |
| bar1Indeterminate | Styles applied to the bar1 element if variant="indeterminate or query". |
| bar1Determinate | Styles applied to the bar1 element if variant="determinate". |
| bar1Buffer | Styles applied to the bar1 element if variant="buffer". |
| bar2Indeterminate | Styles applied to the bar2 element if variant="indeterminate or query". |
| bar2Buffer | Styles applied to the bar2 element if variant="buffer". |
Have a look at the overriding styles with classes section and the implementation of the component for more detail.
If using the overrides key of the theme,
you need to use the following style sheet name: MuiLinearProgress.
Notes
The component is fully StrictMode compatible.