@element-public/react-circular-progress NPM

CircularProgress

Description

Circular progress displays a specified or unspecified wait time as an animated ring.

See live demos on storybook

Install bundle from npm-e

npm i @element-public/react-components @element-public/themes

Optional: install the component individually

npm i @element-public/react-circular-progress @element-public/themes

Open ~/.npmrc in an editor and add the following line to enable the @element-public scope:

@element-public:registry=https://npm.platforms.engineering

Troubleshooting

See below if you have never installed a package from Bayer's npm-enterprise or run into the following error:

npm ERR! code E401
npm ERR! Unable to authenticate, your authentication token seems to be invalid.
npm ERR! To correct this please trying logging in again with:
npm ERR!     npm login

Setup an access token

See the devtools npm-e guide to learn how to create an access token if this is the first time you are using a npm-e package at Bayer or you do not have a line that starts with the following in your ~/.npmrc file:

//npm.platforms.engineering/:_authToken=

Notes

There are two variants of the Circular Progress indicator, Indeterminate and Determinate. Both variants represent the progress, on a scale of 0 to 1, of the completion of a task. The same objective can be accomplished with the Linear Progress indicator, depending on which fits or looks better in certain use cases. See Storybook demos for details and examples of each.

Usage

Indeterminate Circular Progress is a constantly spinning circle, as opposed to a static icon. It moves continuously, like an icon that represents something in the process of loading. Having an icon that shows active progress prevents the user from unnecessarily refreshing or navigating away from the current screen.

Determinate Circular Progress is a circle that increments periodically or when prompted by a user, as opposed to a circle that moves continuously. This indicator could be preferable to the Indeterminate Circular Progress indicator when it should only update with input or action from a user.

Circular Progress Props

Name	Type	Default	Required	Description
ariaLabel	string	'Progress Indicator'	false	Accessibility label.
className	string	undefined	false	The css class name to be passed through to the component markup.
indicatorSize	string	'lg'	false	The size of the progress indicator.Accepted Values: sm, md, lg
open	boolean	true	false	Sets the visibility of the progress indicator.
progress	number	0	false	The current progress of a determinate progress indicator. Must be between 0 and 1.
themeColor	string	'primary'	false	Color of the indicator stroke with 'primary' or 'secondary' theme color.Accepted Values: primary, secondary, primary-variant, secondary-variant, two-color, two-color-variant
variant	string	'indeterminate'	false	An indeterminate CircularProgress indicator will continue spinning until closed. A determinate CircularProgress indicator will display the current progress.Accepted Values: determinate, indeterminate

Circular Progress Deprecated Props

Name	Type	Default	Required	Deprecated	Description
size	string	undefined	false	Renamed, see indicatorSize instead.	The size of the progress indicator.

Circular Progress Breaking Changes

Description
variant: The original, pre v5, `variant` prop has been renamed to `themeColor`.

clsx prop-types @babel/runtime-corejs3 @material/circular-progress @element-public/react-common

@element-public/react-components

1.0.0

1 year ago