@mui/material
Version:
Material UI is an open-source React component library that implements Google's Material Design. It's comprehensive and can be used in production out of the box.
57 lines (56 loc) • 2.18 kB
TypeScript
import * as React from 'react';
import { SxProps } from '@mui/system';
import { OverridableStringUnion } from '@mui/types';
import { InternalStandardProps as StandardProps, Theme } from "../index.js";
import { LinearProgressClasses } from "./linearProgressClasses.js";
export interface LinearProgressPropsColorOverrides {}
export interface LinearProgressPropsVariantOverrides {}
export interface LinearProgressProps extends StandardProps<React.HTMLAttributes<HTMLSpanElement>, 'children'> {
/**
* Override or extend the styles applied to the component.
*/
classes?: Partial<LinearProgressClasses>;
/**
* The color of the component.
* It supports both default and custom theme colors, which can be added as shown in the
* [palette customization guide](https://mui.com/material-ui/customization/palette/#custom-colors).
* @default 'primary'
*/
color?: OverridableStringUnion<'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | 'inherit', LinearProgressPropsColorOverrides>;
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx?: SxProps<Theme>;
/**
* The value of the progress indicator for the determinate and buffer variants.
* Value between 0 and 100.
*/
value?: number;
/**
* The value for the buffer variant.
* Value between 0 and 100.
*/
valueBuffer?: number;
/**
* The variant to use.
* Use indeterminate or query when there is no progress value.
* @default 'indeterminate'
*/
variant?: OverridableStringUnion<'determinate' | 'indeterminate' | 'buffer' | 'query', LinearProgressPropsVariantOverrides>;
}
/**
* ## 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.
*
* Demos:
*
* - [Progress](https://mui.com/material-ui/react-progress/)
*
* API:
*
* - [LinearProgress API](https://mui.com/material-ui/api/linear-progress/)
*/
export default function LinearProgress(props: LinearProgressProps): React.JSX.Element;