UNPKG

1.47 kBTypeScriptView Raw
1import * as React from "react";
2import { BoxProps } from "../Box";
3
4interface ICircularProgress {
5 /**
6 * The size of the circular progress in CSS units
7 */
8 size?: string;
9 /**
10 * Maximum value defining 100% progress made (must be higher than 'min')
11 */
12 max?: number;
13 /**
14 * Minimum value defining 'no progress' (must be lower than 'max')
15 */
16 min?: number;
17 /**
18 * Puts the component into 'indeterminate' state; Ignores 'value' prop
19 */
20 isIndeterminate?: boolean;
21 /**
22 * The thickness of progress indicator as a ratio of `size`. Must be between `0` and `1`
23 */
24 thickness?: number;
25 /**
26 * Current progress (must be between min/max)
27 */
28 value?: number;
29 /**
30 * Angle to rotate progress indicator by
31 */
32 angle?: number;
33 /**
34 * If `true`, the cap of the progress indicator will be rounded.
35 */
36 capIsRound?: boolean;
37 /**
38 * The content of the circular progress bar. If passed, the content will be inside and centered in the progress bar.
39 */
40 children?: React.ReactNode;
41 /**
42 * The color name of the progress track. Use a color key in the theme object
43 */
44 trackColor?: string;
45 /**
46 * The color of the progress indicator. Use a color key in the theme object
47 */
48 color?: string;
49}
50
51type CircularProgressProps = BoxProps & ICircularProgress;
52
53declare const CircularProgress: React.FC<CircularProgressProps>;
54
55export default CircularProgress;
56
57export const CircularProgressLabel: React.FC<BoxProps>;