77 lines
2.4 KiB
TypeScript
77 lines
2.4 KiB
TypeScript
|
import * as React from 'react';
|
||
|
|
import { SxProps } from '@mui/system';
|
||
|
|
import { OverridableStringUnion } from '@mui/types';
|
||
|
|
import { InternalStandardProps as StandardProps, Theme } from '..';
|
||
|
|
import { CircularProgressClasses } from './circularProgressClasses';
|
||
|
|
|
||
|
|
export interface CircularProgressPropsColorOverrides {}
|
||
|
|
|
||
|
|
export interface CircularProgressProps
|
||
|
|
extends StandardProps<React.HTMLAttributes<HTMLSpanElement>, 'children'> {
|
||
|
|
/**
|
||
|
|
* Override or extend the styles applied to the component.
|
||
|
|
*/
|
||
|
|
classes?: Partial<CircularProgressClasses>;
|
||
|
|
/**
|
||
|
|
* 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',
|
||
|
|
CircularProgressPropsColorOverrides
|
||
|
|
>;
|
||
|
|
/**
|
||
|
|
* If `true`, the shrink animation is disabled.
|
||
|
|
* This only works if variant is `indeterminate`.
|
||
|
|
* @default false
|
||
|
|
*/
|
||
|
|
disableShrink?: boolean;
|
||
|
|
/**
|
||
|
|
* The size of the component.
|
||
|
|
* If using a number, the pixel unit is assumed.
|
||
|
|
* If using a string, you need to provide the CSS unit, for example '3rem'.
|
||
|
|
* @default 40
|
||
|
|
*/
|
||
|
|
size?: number | string;
|
||
|
|
/**
|
||
|
|
* The system prop that allows defining system overrides as well as additional CSS styles.
|
||
|
|
*/
|
||
|
|
sx?: SxProps<Theme>;
|
||
|
|
/**
|
||
|
|
* The thickness of the circle.
|
||
|
|
* @default 3.6
|
||
|
|
*/
|
||
|
|
thickness?: number;
|
||
|
|
/**
|
||
|
|
* The value of the progress indicator for the determinate variant.
|
||
|
|
* Value between 0 and 100.
|
||
|
|
* @default 0
|
||
|
|
*/
|
||
|
|
value?: number;
|
||
|
|
/**
|
||
|
|
* The variant to use.
|
||
|
|
* Use indeterminate when there is no progress value.
|
||
|
|
* @default 'indeterminate'
|
||
|
|
*/
|
||
|
|
variant?: 'determinate' | 'indeterminate';
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* ## 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:
|
||
|
|
*
|
||
|
|
* - [CircularProgress API](https://mui.com/material-ui/api/circular-progress/)
|
||
|
|
*/
|
||
|
|
export default function CircularProgress(props: CircularProgressProps): JSX.Element;
|