19.2.0 • Published 4 days ago

@commercetools-uikit/progress-bar v19.2.0

Weekly downloads
-
License
MIT
Repository
github
Last release
4 days ago

ProgressBar

Description

A progress bar component used to visualize the progression of an extended operation

Installation

yarn add @commercetools-uikit/progress-bar
npm --save install @commercetools-uikit/progress-bar

Additionally install the peer dependencies (if not present)

yarn add react
npm --save install react

Usage

import ProgressBar from '@commercetools-uikit/progress-bar';

const Example = () => <ProgressBar label={`${50}% completed`} progress={50} />;

export default Example;

Properties

PropsTypeRequiredDefaultDescription
progressnumber0The percentage of the task completion to fill the bar.
labelunionPossible values:, string, ReactElement, (MessageDescriptor & { values?: Record<string, ReactNode> }), nullnullThe text to display alongside the bar.
labelPositionunionPossible values:'top' , 'bottom' , 'left' , 'right''top'Location of the text in relation to the bar.
labelWidthunionPossible values:, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 'scale', 'auto''scale'The scale of the width for the label, uses values available in the Constraints.Horizontal component.
isInvertedbooleanfalseSpecifies the use of light colors(default) or dark colors.
isAnimatedbooleantrueSpecifies whether the inner bar should have the styles animated.
heightunionPossible values:'10' , '20''20'The scale of the height for the bar, also affects the styles of the label.
barWidthunionPossible values:4 , 5 , 6 , 7 , 8 , 9 , 10 , 11 , 12 , 13 , 14 , 15 , 16 , 'scale'6The scale of the width for the label, uses values available in the Constraints.Horizontal component.
19.2.0

4 days ago

19.1.0

16 days ago

19.0.0

1 month ago

18.5.0

2 months ago

18.4.0

2 months ago

18.3.0

2 months ago

18.2.0

2 months ago

18.1.0

3 months ago

18.0.0

3 months ago

17.1.0

3 months ago