@element-public/react-linear-progress NPM

LinearProgress

Description

Linear progress displays a specified or unspecified wait time as an animated line.

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-linear-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 Linear Progress indicator, Indeterminate and Determinate. Both variants represent the progress, on a scale of 0 to 1, of the completion of a task. The buffer bar is a secondary bar to indicate the amount of buffered data. The buffer bar shows the maximum width of the progress bar, which is 1 by default. Buffer is only used with the determinate Linear Progress indicator. Both the buffer bar and progress bar can be set to update from left to right or right to left with the reversed prop.

Progress toward a goal can also be represented with the Circular Progress indicator, depending on which fits or looks better in certain use cases. See Storybook demos for details and examples of each.

Usage

Indeterminate Linear Progress is a constantly moving line segment, as opposed to a static line. Having a symbol that shows active progress prevents the user from unnecessarily refreshing or navigating away from the current screen.

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

Linear Progress Props

Name	Type	Default	Required	Description
ariaLabel	string	'Progress Indicator'	false	Accessibility label.
buffer	number	1	false	The buffer bar is a secondary bar to indicate the amount of buffered data (useful for video playback indicators). Buffer bar shows maximum width of linearProgress bar. Buffer is only used for determinate progress bar.
className	string	undefined	false	The css class name to be passed through to the component markup.
open	boolean	true	false	Puts the component in the open or closed state.
progress	number	0	false	The current progress of a determinate progress indicator. Must be between 0 and 1. Progress is only used for determinate progress bar.
reversed	boolean	false	false	Reverses the direction of the linear progress indicator.
themeColor	string	'primary'	false	Color of the indicator stroke with 'primary' or 'secondary' theme color.Accepted Values: primary, secondary, primary-variant, secondary-variant
variant	string	'indeterminate'	false	An indeterminate LinearProgress indicator will continue animating until closed. A determinate LinearProgress indicator will display the current progress.Accepted Values: determinate, indeterminate

Linear Progress Deprecated Props

Name	Type	Default	Required	Deprecated	Description
indeterminate	boolean	undefined	false	Use `variant='indeterminate'` instead.	Toggles the component between the determinate (when a known percentage has been completed) and indeterminate state (a continuously animated indicator used when there is no known percentage of completion).

Linear Progress Breaking Changes

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

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

@element-public/react-components

1.0.0

11 months ago