CircularProgress
Introduction
The CircularProgress component displays a circular loading indicator for indeterminate or determinate progress. It is commonly used to indicate loading states, progress of operations, or waiting periods in applications. The component follows Material Design guidelines for progress indicators with smooth animations and visual feedback.
The CircularProgress component is based on Material UI CircularProgress. It is included within the following NPM package: @react-form-builder/components-material-ui.
The CircularProgress component can be styled and configured to fit specific design and functionality requirements by using various properties that are presented and described below.
Main properties
The following general properties are available within the Main tab:
| Name | Type | Description |
|---|---|---|
| Value | number | The value of the progress indicator for determinate variant (0 to 100) |
| Thickness | number | The thickness of the circular progress in pixels |
| Variant | 'determinate' | 'indeterminate' | The variant of the progress indicator |
| Color | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | 'inherit' | The color of the component |
| Disable shrink | boolean | If true, the shrink animation is disabled (indeterminate variant only) |
At the bottom of the Main properties menu, you can find additional options:
- Render When: Provides conditional rendering for your component as described in the corresponding chapter.
- HTML attributes: Allows you to provide custom HTML attributes for your form.
Style properties
These are properties that allow to customize the size, color and other style properties of your component:
- For Device: You can provide component's style customization for all devices or specific devices by using this dropdown list. Refer to Adaptive Layout for more details.
- Component > Class Name: Add a class name for your component for the subsequent styling if necessary.
-
Wrapper: The options below enable you to tailor the appearance of your component and customize it for a specific device type, as selected in the For Device property:
Name Type Description Width numberSpecifies the width for your component Height numberSpecifies the height for your component Margin top/right/bottom/left numberMargin values for you component Color stringAllows customizing the text color Background color stringEnables customizing the background color