@atlaskit/progress-bar 0.5.11 → 0.5.13

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.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @atlaskit/progress-bar
2
2
 
3
+ ## 0.5.13
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+
9
+ ## 0.5.12
10
+
11
+ ### Patch Changes
12
+
13
+ - [`9827dcb82b8`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9827dcb82b8) - No-op change to introduce spacing tokens to design system components.
14
+
3
15
  ## 0.5.11
4
16
 
5
17
  ### Patch Changes
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/progress-bar",
3
- "version": "0.5.11",
3
+ "version": "0.5.13",
4
4
  "sideEffects": false
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/progress-bar",
3
- "version": "0.5.11",
3
+ "version": "0.5.13",
4
4
  "sideEffects": false
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/progress-bar",
3
- "version": "0.5.11",
3
+ "version": "0.5.13",
4
4
  "sideEffects": false
5
5
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/progress-bar",
3
- "version": "0.5.11",
3
+ "version": "0.5.13",
4
4
  "description": "A progress bar displays the status of a given process.",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -12,17 +12,11 @@
12
12
  "module": "dist/esm/index.js",
13
13
  "module:es2019": "dist/es2019/index.js",
14
14
  "types": "dist/types/index.d.ts",
15
- "typesVersions": {
16
- ">=4.0 <4.5": {
17
- "*": [
18
- "dist/types-ts4.0/*"
19
- ]
20
- }
21
- },
22
15
  "sideEffects": false,
23
16
  "atlaskit:src": "src/index.tsx",
24
17
  "homepage": "https://atlassian.design/components/progress-bar/",
25
18
  "atlassian": {
19
+ "disableProductCI": true,
26
20
  "team": "Design System Team",
27
21
  "deprecatedAutoEntryPoints": true,
28
22
  "releaseModel": "scheduled",
@@ -34,7 +28,7 @@
34
28
  "dependencies": {
35
29
  "@atlaskit/ds-lib": "^2.1.0",
36
30
  "@atlaskit/theme": "^12.2.0",
37
- "@atlaskit/tokens": "^0.10.0",
31
+ "@atlaskit/tokens": "^0.11.0",
38
32
  "@babel/runtime": "^7.0.0",
39
33
  "@emotion/react": "^11.7.1"
40
34
  },
@@ -42,9 +36,9 @@
42
36
  "react": "^16.8.0"
43
37
  },
44
38
  "devDependencies": {
45
- "@atlaskit/button": "^16.3.0",
39
+ "@atlaskit/button": "^16.4.0",
46
40
  "@atlaskit/docs": "*",
47
- "@atlaskit/section-message": "^6.2.0",
41
+ "@atlaskit/section-message": "^6.3.0",
48
42
  "@atlaskit/visual-regression": "*",
49
43
  "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
50
44
  "@testing-library/react": "^12.1.5",
@@ -63,6 +57,7 @@
63
57
  "@repo/internal": {
64
58
  "dom-events": "use-bind-event-listener",
65
59
  "design-system": "v1",
60
+ "design-tokens": "spacing",
66
61
  "theming": "tokens",
67
62
  "deprecation": "no-deprecated-imports",
68
63
  "styling": [
package/report.api.md CHANGED
@@ -2,63 +2,59 @@
2
2
 
3
3
  > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
4
 
5
+ <!--
6
+ Generated API Report version: 2.0
7
+ -->
8
+
9
+ [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
10
+
5
11
  ```ts
6
- import { default as React_2 } from 'react';
12
+ /// <reference types="react" />
13
+
14
+ import { jsx } from '@emotion/react';
7
15
  import { ThemeProp } from '@atlaskit/theme/components';
8
16
 
9
- declare interface CustomProgressBarProps {
10
- /**
11
- * Current progress, a number between 0 and 1.
12
- */
13
- value: number;
14
- /**
15
- * When true the component is in indeterminate state.
16
- */
17
- isIndeterminate: boolean;
18
- /**
19
- * The aria-label attribute associated with the progress bar.
20
- */
17
+ // @public (undocumented)
18
+ interface CustomProgressBarProps {
21
19
  ariaLabel?: string;
20
+ isIndeterminate?: boolean;
21
+ testId?: string;
22
+ value?: number;
22
23
  }
23
24
 
24
- declare interface DefaultProgressBarProps extends CustomProgressBarProps {
25
- /**
26
- * The theme the component should use. NOTE: This is being deprecated and will be removed after 13 May 2022. Please consider migrating to
27
- * one of progress bar's variants.
28
- */
25
+ // @public (undocumented)
26
+ interface DefaultProgressBarProps extends CustomProgressBarProps {
27
+ appearance?: 'default' | 'success' | 'inverse';
28
+ // @deprecated (undocumented)
29
29
  theme?: ThemeProp<ThemeTokens, ThemeProps>;
30
30
  }
31
31
 
32
- declare class ProgressBar extends React_2.PureComponent<
33
- DefaultProgressBarProps
34
- > {
35
- static defaultProps: {
36
- value: number;
37
- isIndeterminate: boolean;
38
- };
39
- render(): JSX.Element;
40
- }
32
+ // @public
33
+ const ProgressBar: ({
34
+ appearance,
35
+ ariaLabel,
36
+ isIndeterminate,
37
+ testId,
38
+ theme,
39
+ value,
40
+ }: DefaultProgressBarProps) => jsx.JSX.Element;
41
41
  export default ProgressBar;
42
42
 
43
- export declare class SuccessProgressBar extends React_2.PureComponent<
44
- CustomProgressBarProps
45
- > {
46
- static defaultProps: {
47
- value: number;
48
- isIndeterminate: boolean;
49
- };
50
- render(): JSX.Element;
51
- }
43
+ // @public
44
+ export const SuccessProgressBar: ({
45
+ ariaLabel,
46
+ isIndeterminate,
47
+ testId,
48
+ value,
49
+ }: CustomProgressBarProps) => JSX.Element;
52
50
 
53
- declare type ThemeProps = {
51
+ // @public @deprecated (undocumented)
52
+ type ThemeProps = {
54
53
  value: string | number;
55
54
  };
56
55
 
57
- /**
58
- * @deprecated This allows for users to customize the theme. This is being deprecated, please consider
59
- * migrating to one of progress bar's variants.
60
- */
61
- declare type ThemeTokens = {
56
+ // @public @deprecated (undocumented)
57
+ type ThemeTokens = {
62
58
  container: any;
63
59
  bar: any;
64
60
  determinateBar: any;
@@ -66,15 +62,13 @@ declare type ThemeTokens = {
66
62
  decreasingBar: any;
67
63
  };
68
64
 
69
- export declare class TransparentProgressBar extends React_2.PureComponent<
70
- CustomProgressBarProps
71
- > {
72
- static defaultProps: {
73
- value: number;
74
- isIndeterminate: boolean;
75
- };
76
- render(): JSX.Element;
77
- }
65
+ // @public
66
+ export const TransparentProgressBar: ({
67
+ ariaLabel,
68
+ isIndeterminate,
69
+ testId,
70
+ value,
71
+ }: CustomProgressBarProps) => JSX.Element;
78
72
 
79
- export {};
73
+ // (No @packageDocumentation comment for this package)
80
74
  ```
@@ -1,13 +0,0 @@
1
- import { jsx } from '@emotion/react';
2
- import { DefaultProgressBarProps } from '../types';
3
- /**
4
- * __Progress bar__
5
- *
6
- * A progress bar displays the status of a given process.
7
- *
8
- * - [Examples](https://atlassian.design/components/progress-bar/examples)
9
- * - [Code](https://atlassian.design/components/progress-bar/code)
10
- * - [Usage](https://atlassian.design/components/progress-bar/usage)
11
- */
12
- declare const ProgressBar: ({ appearance, ariaLabel, isIndeterminate, testId, theme, value, }: DefaultProgressBarProps) => jsx.JSX.Element;
13
- export default ProgressBar;
@@ -1,12 +0,0 @@
1
- /// <reference types="react" />
2
- import { CustomProgressBarProps } from '../types';
3
- /**
4
- * __Success progress bar__
5
- *
6
- * A success progress bar indicates the completion of a process.
7
- *
8
- * - [Examples](https://atlassian.design/components/progress-bar/success-progress-bar/examples)
9
- * - [Code](https://atlassian.design/components/progress-bar/success-progress-bar/code)
10
- */
11
- declare const SuccessProgressBar: ({ ariaLabel, isIndeterminate, testId, value, }: CustomProgressBarProps) => JSX.Element;
12
- export default SuccessProgressBar;
@@ -1,12 +0,0 @@
1
- /// <reference types="react" />
2
- import { CustomProgressBarProps } from '../types';
3
- /**
4
- * __Transparent progress bar__
5
- *
6
- * A transparent progress bar is used on bold backgrounds to maintain suitable contrast.
7
- *
8
- * - [Examples](https://atlassian.design/components/progress-bar/transparent-progress-bar/examples)
9
- * - [Code](https://atlassian.design/components/progress-bar/transparent-progress-bar/code)
10
- */
11
- declare const TransparentProgressBar: ({ ariaLabel, isIndeterminate, testId, value, }: CustomProgressBarProps) => JSX.Element;
12
- export default TransparentProgressBar;
@@ -1,3 +0,0 @@
1
- export { default } from './components/progress-bar';
2
- export { default as SuccessProgressBar } from './components/success-progress-bar';
3
- export { default as TransparentProgressBar } from './components/transparent-progress-bar';
@@ -1,17 +0,0 @@
1
- /// <reference types="react" />
2
- import { ThemeProps, ThemeTokens } from './types';
3
- /**
4
- * Creates the default theme, which can be customised using the `theme` prop
5
- *
6
- * @deprecated
7
- */
8
- export declare const Theme: {
9
- Consumer: import("react").ComponentType<{
10
- children: (tokens: ThemeTokens) => import("react").ReactNode;
11
- } & ThemeProps>;
12
- Provider: import("react").ComponentType<{
13
- children?: import("react").ReactNode;
14
- value?: import("@atlaskit/theme/components").ThemeProp<ThemeTokens, ThemeProps> | undefined;
15
- }>;
16
- useTheme: (props: ThemeProps) => ThemeTokens;
17
- };
@@ -1,49 +0,0 @@
1
- import { ThemeProp } from '@atlaskit/theme/components';
2
- /**
3
- * @deprecated
4
- */
5
- export declare type ThemeProps = {
6
- value: string | number;
7
- };
8
- /**
9
- * @deprecated This allows for users to customize the theme. This is being deprecated, please consider
10
- * migrating to one of progress bar's variants.
11
- */
12
- export declare type ThemeTokens = {
13
- container: any;
14
- bar: any;
15
- determinateBar: any;
16
- increasingBar: any;
17
- decreasingBar: any;
18
- };
19
- export interface CustomProgressBarProps {
20
- /**
21
- * Sets the value of the progress bar, between `0` and `1` inclusive.
22
- */
23
- value?: number;
24
- /**
25
- * Shows the progress bar in an indeterminate state when `true`.
26
- */
27
- isIndeterminate?: boolean;
28
- /**
29
- * Label associated with the progress bar,
30
- * read by screen readers.
31
- */
32
- ariaLabel?: string;
33
- /**
34
- * A `testId` prop is a unique string that appears as a data attribute `data-testid` in the rendered code,
35
- * serving as a hook for automated tests.
36
- */
37
- testId?: string;
38
- }
39
- export interface DefaultProgressBarProps extends CustomProgressBarProps {
40
- /**
41
- * @deprecated
42
- * Theme prop is deprecated and will be removed in the future.
43
- */
44
- theme?: ThemeProp<ThemeTokens, ThemeProps>;
45
- /**
46
- * Visual style of the progress bar.
47
- */
48
- appearance?: 'default' | 'success' | 'inverse';
49
- }