Progress

Represent pending activity or a supplied numeric progress value.

This guide covers Material UI Core with the default Emotion engine; extensions and additional demos are explicitly classified.

Use case and business boundary

Determinate values need real business progress; animations do not prove a request is running or complete.

Native composition and scope

CircularProgress, LinearProgress

Preserve native Material UI composition and types; do not substitute JGuang UI/Base UI/Radix APIs. Example entries are not extra components.

Native installation and initialization

npm install @mui/material@9.4.0 @emotion/react@11.14.0 @emotion/styled@11.14.1

Use native npm and Emotion, not an invented JGuang UI Registry URL. Place examples inside native ThemeProvider; choose CssBaseline or ScopedCssBaseline for the project. Inspect React, existing providers, lockfile and SSR first. Never overwrite files or conceal peer conflicts. This batch verified React 19.2.8; React 18 and below require matching react-is. See the included bilingual setup guide.

Practical native parameters

These selected parameters are not a flattened universal API. Preserve the native declaring owner, slot structure, nullable values and generics.

Runnable native examples

Machine keys select example entries, not universal variant props. Native demo JSX/data stay unchanged; JGuang-authored acceptance fixtures are explicitly labelled.

• Circular indeterminate · CircularIndeterminate · upstream native demo
• Circular color · CircularColor · upstream native demo
• Circular size · CircularSize · upstream native demo
• Circular determinate · CircularDeterminate · upstream native demo
• Circular custom scale · CircularCustomScale · upstream native demo
• Circular track · CircularEnableTrack · upstream native demo
• Interactive integration · CircularIntegration · upstream native demo
• Circular with label · CircularWithValueLabel · upstream native demo
• Linear indeterminate · LinearIndeterminate · upstream native demo
• Linear query · LinearQuery · upstream native demo
• Linear color · LinearColor · upstream native demo
• Linear determinate · LinearDeterminate · upstream native demo
• Linear buffer · LinearBuffer · upstream native demo
• Linear with label · LinearWithValueLabel · upstream native demo
• Linear with custom value text · LinearWithAriaValueText · upstream native demo
• Customization · CustomizedProgressBars · upstream native demo
• Delaying appearance · DelayingAppearance · upstream native demo
• High CPU load · CircularUnderLoad · upstream native demo

Actual usage example

Unmodified pinned native demo; copy its required local helper files together.

import CircularProgress from '@mui/material/CircularProgress';
import Box from '@mui/material/Box';

export default function CircularIndeterminate() {
  return (
    <Box sx={{ display: 'flex' }}>
      <CircularProgress aria-label="Loading…" />
    </Box>
  );
}

Example dependency boundaries

@mui/material/CircularProgress, @mui/material/Box, @mui/material/Stack, react, @mui/material/colors, @mui/material/Button, @mui/material/Fab, @mui/icons-material/Check, @mui/icons-material/Save, @mui/material/Typography, @mui/material/LinearProgress, @mui/material/styles, @mui/material/Fade

Direct Icons/System/Utils example imports require their matching 9.4.0 packages. Relative data/helpers are part of the example closure, not extra components. Remote images and simulated operations do not supply a backend.

Pinned upstream API metadata reference

These tables retain the upstream metadata, not a newly inferred generic type system. Conditional generics, inherited props and callback details are defined by the source declarations below. Theme defaults may override metadata defaults.

CircularProgress

import CircularProgress from '@mui/material/CircularProgress';
import { CircularProgress } from '@mui/material';

LinearProgress

import LinearProgress from '@mui/material/LinearProgress';
import { LinearProgress } from '@mui/material';

Native source declarations

Declarations/imports are extracted from pinned source without flattening unions or external inheritance. Original English comments/types are source reference, not a claim of translated upstream prose. Shared types stay in their native packages.

vendor/src/CircularProgress/CircularProgress.d.ts

import * as React from 'react';

import { SxProps } from '@mui/system';

import { OverridableStringUnion } from '@mui/types';

import { Theme } from '../styles';

import { InternalStandardProps as StandardProps } from '../internal';

import { CircularProgressClasses } from './circularProgressClasses';

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> | undefined;
  /**
   * 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
      >
    | undefined;
  /**
   * If `true`, the shrink animation is disabled.
   * This only works if variant is `indeterminate`.
   * @default false
   */
  disableShrink?: boolean | undefined;
  /**
   * 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 | undefined;
  /**
   * The maximum value for the progress indicator for the determinate variant.
   * @default 100
   */
  max?: number | undefined;
  /**
   * The minimum value for the progress indicator for the determinate variant.
   * @default 0
   */
  min?: number | undefined;
  /**
   * 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 | undefined;
  /**
   * The system prop that allows defining system overrides as well as additional CSS styles.
   */
  sx?: SxProps<Theme> | undefined;
  /**
   * The thickness of the circle.
   * @default 3.6
   */
  thickness?: number | undefined;
  /**
   * The value of the progress indicator for the determinate variant.
   * Value between `min` and `max`.
   * @default props.min ?? 0
   */
  value?: number | undefined;
  /**
   * The variant to use.
   * Use indeterminate when there is no progress value.
   * @default 'indeterminate'
   */
  variant?:
    | OverridableStringUnion<'determinate' | 'indeterminate', CircularProgressPropsVariantOverrides>
    | undefined;
}

export default function CircularProgress(props: CircularProgressProps): React.JSX.Element;

vendor/src/LinearProgress/LinearProgress.d.ts

import * as React from 'react';

import { SxProps } from '@mui/system';

import { OverridableStringUnion } from '@mui/types';

import { Theme } from '../styles';

import { InternalStandardProps as StandardProps } from '../internal';

import { LinearProgressClasses } from './linearProgressClasses';

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> | undefined;
  /**
   * 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
      >
    | undefined;
  /**
   * The maximum value for the progress indicator for the determinate and buffer variants.
   * @default 100
   */
  max?: number | undefined;
  /**
   * The minimum value for the progress indicator for the determinate and buffer variants.
   * @default 0
   */
  min?: number | undefined;
  /**
   * The system prop that allows defining system overrides as well as additional CSS styles.
   */
  sx?: SxProps<Theme> | undefined;
  /**
   * The value of the progress indicator for the determinate and buffer variants.
   * Value between `min` and `max`.
   */
  value?: number | undefined;
  /**
   * The value for the buffer variant.
   * Value between `min` and `max`.
   */
  valueBuffer?: number | undefined;
  /**
   * The variant to use.
   * Use indeterminate or query when there is no progress value.
   * @default 'indeterminate'
   */
  variant?:
    | OverridableStringUnion<
        'determinate' | 'indeterminate' | 'buffer' | 'query',
        LinearProgressPropsVariantOverrides
      >
    | undefined;
}

export default function LinearProgress(props: LinearProgressProps): React.JSX.Element;

Post-install acceptance

Run strict types, production build and real interactions. Check keyboard labels/focus, disabled/error/read-only semantics where natively supported, both themes, narrow screens and reduced motion. Verify callbacks against the real host data; do not declare installation complete from copying a prompt. Initialization fixtures also require server HTML and warning-free hydration.

Source and license

https://github.com/mui/material-ui/tree/809a7717b4c050ba3f69b75300689f07c050a16e

MIT · @mui/material@9.4.0. Vendor originals and license are preserved. Full original upstream prose remains in vendor/docs and is not represented as fully translated.