Skip to content

Properties

PropertyTypeDefault valueDescription
progressstring
number
undefinedA number between 0-100, if not supplied a continous loading-type animation will be used.
visiblebooleantrueDefines the visibility of the progress. Toggling the visible property to false will force a fade-out animation.
type'circular'
'linear'
'countdown'
'circular'Defines the type.
noAnimationbooleanfalseDisables the fade-in and fade-out animation.
size'default'
'small'
'medium'
'large'
'huge'
string
'default'Defines the size.
labelReact.ReactNodeundefinedContent of a custom label. (Overrides indicator_label and showDefaultLabel)
childrenReact.ReactNodeundefinedSame as label prop (label prop has priority)
labelDirection'horizontal'
'vertical'
'inside'
'horizontal'Sets the position of the label. 'inside' only works with `type='circular'.
showDefaultLabelbooleanfalseIf set to true a default label (from text locales) will be shown.
indicator_labelstringundefinedUse this to override the default label from text locales.
titlestringundefinedUsed to set title and aria-label. Defaults to the value of progress property, formatted as a percent.
customColorsobjectundefinedSend in custom css colors that overrides any css. See below for data structure.
customCircleWidthstringundefinedSend in custom css width for circle progress line. (undefined defaults to one eighth of the size).
Spacestring
object
Spacing properties like top or bottom are supported.

Data object customColors

PropertyTypeDefault valueDescription
linestringundefinedOverride the moving line color.
shaftstringundefinedOverride the background line color.
backgroundstringundefinedSet a background color for the center of the circle.

Deprecated properties

PropertyTypeDescription
no_animation boolean(deprecated) use noAnimation.
label_directionstring(deprecated) use labelDirection.
show_labelboolean(deprecated) use showDefaultLabel.