Progress Circle

Introduction

The Progress Circle component represents the progress or completion of a task or process in a circular format. It is typically used to show the progress of form completion, file uploads, or any other task that involves a sequential process. This component is included within the following NPM package: @react-form-builder/components-rsuite.

This component typically includes a circular shape with a customizable color and size, along with a percentage or label indicating the progress value. You can customize the appearance of the progress circle, including the color, size, behavior, and more. All available properties and options of this component is presented below.

Main properties

The following general properties are available within the Main tab:

Name	Type	Description
Class Prefix	string	The prefix for the CSS class names of the progress circle
Percent	number	The presented percentage value of the progress circle
Show Info	boolean	If set to true, the progress circle will display the percentage value
Status	choice	The status and the color of the progress circle (i.e., success, active, or fail)
Stroke Color	color	Sets the custom color of the progress circle's stroke
Stroke Width	number	The width of the progress circle's stroke
Gap Degree	number	The degree of the gap in the progress circle
Gap Position	choice	The position of the gap in the progress circle (i.e., top, bottom, left, right)
Stroke Linecap	choice	The shape of the progress circle's stroke linecap (i.e., butt, round, square)
Trail Color	color	The color of the progress circle's trail
Trail Width	number	The width of the progress circle's trail

At the bottom of the Main properties menu, you can find additional options:

• Render When: Provides conditional rendering for your calendar 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	number	Specifies the width for your component
  Height	number	Specifies the height for your component
  Margin top/right/bottom/left	number	Margin values for you component
  Color	string	Allows customizing the text color
  Background color	string	Enables customizing the background color