Blame view

天文台pc/tianwentai-ui/node_modules/@mui/material/CircularProgress/CircularProgress.d.ts 2.77 KB
bc518174   王天杨   提交两个项目文件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
  import * as React from 'react';
  import { SxProps } from '@mui/system';
  import { OverridableStringUnion } from '@mui/types';
  import { Theme } from "../styles/index.js";
  import { InternalStandardProps as StandardProps } from "../internal/index.js";
  import { CircularProgressClasses } from "./circularProgressClasses.js";
  export interface CircularProgressPropsColorOverrides {}
  export interface CircularProgressPropsVariantOverrides {}
  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;
    /**
     * If `true`, a track circle slot is mounted to show a subtle background for the progress.
     * The `size` and `thickness` apply to the track slot to be consistent with the progress circle.
     * @default false
     */
    enableTrackSlot?: 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?: OverridableStringUnion<'determinate' | 'indeterminate', CircularProgressPropsVariantOverrides>;
  }
  
  /**
   * ## 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): React.JSX.Element;