@commercetools-uikit/progress-bar 19.8.0 → 19.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -168,7 +168,7 @@ ProgressBar.defaultProps = defaultProps;
168
168
  var ProgressBar$1 = ProgressBar;
169
169
 
170
170
  // NOTE: This string will be replaced on build time with the package version.
171
- var version = "19.8.0";
171
+ var version = "19.10.0";
172
172
 
173
173
  exports["default"] = ProgressBar$1;
174
174
  exports.version = version;
@@ -156,7 +156,7 @@ ProgressBar.defaultProps = defaultProps;
156
156
  var ProgressBar$1 = ProgressBar;
157
157
 
158
158
  // NOTE: This string will be replaced on build time with the package version.
159
- var version = "19.8.0";
159
+ var version = "19.10.0";
160
160
 
161
161
  exports["default"] = ProgressBar$1;
162
162
  exports.version = version;
@@ -146,6 +146,6 @@ ProgressBar.defaultProps = defaultProps;
146
146
  var ProgressBar$1 = ProgressBar;
147
147
 
148
148
  // NOTE: This string will be replaced on build time with the package version.
149
- var version = "19.8.0";
149
+ var version = "19.10.0";
150
150
 
151
151
  export { ProgressBar$1 as default, version };
@@ -1,15 +1,39 @@
1
1
  import type { ReactElement, ReactNode } from 'react';
2
2
  import { type MessageDescriptor } from 'react-intl';
3
3
  export type TProgressBarProps = {
4
+ /**
5
+ * The percentage of the task completion to fill the bar.
6
+ */
4
7
  progress?: number;
8
+ /**
9
+ * The text to display alongside the bar.
10
+ */
5
11
  label?: string | ReactElement | (MessageDescriptor & {
6
12
  values?: Record<string, ReactNode>;
7
13
  }) | null;
14
+ /**
15
+ * Location of the text in relation to the bar.
16
+ */
8
17
  labelPosition?: 'top' | 'bottom' | 'left' | 'right';
18
+ /**
19
+ * The scale of the width for the label, uses values available in the Constraints.Horizontal component.
20
+ */
9
21
  labelWidth?: 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 'scale' | 'auto';
22
+ /**
23
+ * Specifies the use of light colors(default) or dark colors.
24
+ */
10
25
  isInverted?: boolean;
26
+ /**
27
+ * Specifies whether the inner bar should have the styles animated.
28
+ */
11
29
  isAnimated?: boolean;
30
+ /**
31
+ * The scale of the height for the bar, also affects the styles of the label.
32
+ */
12
33
  height?: '10' | '20';
34
+ /**
35
+ * The scale of the width for the label, uses values available in the Constraints.Horizontal component.
36
+ */
13
37
  barWidth?: 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 'scale';
14
38
  };
15
39
  declare const ProgressBar: {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@commercetools-uikit/progress-bar",
3
3
  "description": "A progress bar component used to visualize the progression of an extended operation",
4
- "version": "19.8.0",
4
+ "version": "19.10.0",
5
5
  "bugs": "https://github.com/commercetools/ui-kit/issues",
6
6
  "repository": {
7
7
  "type": "git",
@@ -21,12 +21,12 @@
21
21
  "dependencies": {
22
22
  "@babel/runtime": "^7.20.13",
23
23
  "@babel/runtime-corejs3": "^7.20.13",
24
- "@commercetools-uikit/constraints": "19.8.0",
25
- "@commercetools-uikit/design-system": "19.8.0",
26
- "@commercetools-uikit/spacings-inline": "19.8.0",
27
- "@commercetools-uikit/spacings-stack": "19.8.0",
28
- "@commercetools-uikit/text": "19.8.0",
29
- "@commercetools-uikit/utils": "19.8.0",
24
+ "@commercetools-uikit/constraints": "19.10.0",
25
+ "@commercetools-uikit/design-system": "19.10.0",
26
+ "@commercetools-uikit/spacings-inline": "19.10.0",
27
+ "@commercetools-uikit/spacings-stack": "19.10.0",
28
+ "@commercetools-uikit/text": "19.10.0",
29
+ "@commercetools-uikit/utils": "19.10.0",
30
30
  "@emotion/react": "^11.10.5",
31
31
  "lodash": "4.17.21",
32
32
  "prop-types": "15.8.1",