@atlaskit/progress-bar 0.5.12 → 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 +6 -0
- package/dist/cjs/version.json +1 -1
- package/dist/es2019/version.json +1 -1
- package/dist/esm/version.json +1 -1
- package/package.json +3 -11
- package/report.api.md +25 -66
- package/dist/types-ts4.0/components/progress-bar.d.ts +0 -13
- package/dist/types-ts4.0/components/success-progress-bar.d.ts +0 -12
- package/dist/types-ts4.0/components/transparent-progress-bar.d.ts +0 -12
- package/dist/types-ts4.0/index.d.ts +0 -3
- package/dist/types-ts4.0/theme.d.ts +0 -17
- package/dist/types-ts4.0/types.d.ts +0 -49
package/CHANGELOG.md
CHANGED
package/dist/cjs/version.json
CHANGED
package/dist/es2019/version.json
CHANGED
package/dist/esm/version.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/progress-bar",
|
|
3
|
-
"version": "0.5.
|
|
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,14 +12,6 @@
|
|
|
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
|
-
"dist/types-ts4.0/index.d.ts"
|
|
20
|
-
]
|
|
21
|
-
}
|
|
22
|
-
},
|
|
23
15
|
"sideEffects": false,
|
|
24
16
|
"atlaskit:src": "src/index.tsx",
|
|
25
17
|
"homepage": "https://atlassian.design/components/progress-bar/",
|
|
@@ -36,7 +28,7 @@
|
|
|
36
28
|
"dependencies": {
|
|
37
29
|
"@atlaskit/ds-lib": "^2.1.0",
|
|
38
30
|
"@atlaskit/theme": "^12.2.0",
|
|
39
|
-
"@atlaskit/tokens": "^0.
|
|
31
|
+
"@atlaskit/tokens": "^0.11.0",
|
|
40
32
|
"@babel/runtime": "^7.0.0",
|
|
41
33
|
"@emotion/react": "^11.7.1"
|
|
42
34
|
},
|
|
@@ -44,7 +36,7 @@
|
|
|
44
36
|
"react": "^16.8.0"
|
|
45
37
|
},
|
|
46
38
|
"devDependencies": {
|
|
47
|
-
"@atlaskit/button": "^16.
|
|
39
|
+
"@atlaskit/button": "^16.4.0",
|
|
48
40
|
"@atlaskit/docs": "*",
|
|
49
41
|
"@atlaskit/section-message": "^6.3.0",
|
|
50
42
|
"@atlaskit/visual-regression": "*",
|
package/report.api.md
CHANGED
|
@@ -1,6 +1,10 @@
|
|
|
1
|
-
## API Report File for "@atlaskit/progress-bar"
|
|
1
|
+
## API Report File for "@atlaskit/progress-bar"
|
|
2
2
|
|
|
3
|
-
> Do not edit this file.
|
|
3
|
+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
<!--
|
|
6
|
+
Generated API Report version: 2.0
|
|
7
|
+
-->
|
|
4
8
|
|
|
5
9
|
[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
|
|
6
10
|
|
|
@@ -10,49 +14,23 @@
|
|
|
10
14
|
import { jsx } from '@emotion/react';
|
|
11
15
|
import { ThemeProp } from '@atlaskit/theme/components';
|
|
12
16
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
* Sets the value of the progress bar, between `0` and `1` inclusive.
|
|
16
|
-
*/
|
|
17
|
-
value?: number;
|
|
18
|
-
/**
|
|
19
|
-
* Shows the progress bar in an indeterminate state when `true`.
|
|
20
|
-
*/
|
|
21
|
-
isIndeterminate?: boolean;
|
|
22
|
-
/**
|
|
23
|
-
* Label associated with the progress bar,
|
|
24
|
-
* read by screen readers.
|
|
25
|
-
*/
|
|
17
|
+
// @public (undocumented)
|
|
18
|
+
interface CustomProgressBarProps {
|
|
26
19
|
ariaLabel?: string;
|
|
27
|
-
|
|
28
|
-
* A `testId` prop is a unique string that appears as a data attribute `data-testid` in the rendered code,
|
|
29
|
-
* serving as a hook for automated tests.
|
|
30
|
-
*/
|
|
20
|
+
isIndeterminate?: boolean;
|
|
31
21
|
testId?: string;
|
|
22
|
+
value?: number;
|
|
32
23
|
}
|
|
33
24
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
* @deprecated
|
|
37
|
-
* Theme prop is deprecated and will be removed in the future.
|
|
38
|
-
*/
|
|
39
|
-
theme?: ThemeProp<ThemeTokens, ThemeProps>;
|
|
40
|
-
/**
|
|
41
|
-
* Visual style of the progress bar.
|
|
42
|
-
*/
|
|
25
|
+
// @public (undocumented)
|
|
26
|
+
interface DefaultProgressBarProps extends CustomProgressBarProps {
|
|
43
27
|
appearance?: 'default' | 'success' | 'inverse';
|
|
28
|
+
// @deprecated (undocumented)
|
|
29
|
+
theme?: ThemeProp<ThemeTokens, ThemeProps>;
|
|
44
30
|
}
|
|
45
31
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
*
|
|
49
|
-
* A progress bar displays the status of a given process.
|
|
50
|
-
*
|
|
51
|
-
* - [Examples](https://atlassian.design/components/progress-bar/examples)
|
|
52
|
-
* - [Code](https://atlassian.design/components/progress-bar/code)
|
|
53
|
-
* - [Usage](https://atlassian.design/components/progress-bar/usage)
|
|
54
|
-
*/
|
|
55
|
-
declare const ProgressBar: ({
|
|
32
|
+
// @public
|
|
33
|
+
const ProgressBar: ({
|
|
56
34
|
appearance,
|
|
57
35
|
ariaLabel,
|
|
58
36
|
isIndeterminate,
|
|
@@ -62,33 +40,21 @@ declare const ProgressBar: ({
|
|
|
62
40
|
}: DefaultProgressBarProps) => jsx.JSX.Element;
|
|
63
41
|
export default ProgressBar;
|
|
64
42
|
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
*
|
|
68
|
-
* A success progress bar indicates the completion of a process.
|
|
69
|
-
*
|
|
70
|
-
* - [Examples](https://atlassian.design/components/progress-bar/success-progress-bar/examples)
|
|
71
|
-
* - [Code](https://atlassian.design/components/progress-bar/success-progress-bar/code)
|
|
72
|
-
*/
|
|
73
|
-
export declare const SuccessProgressBar: ({
|
|
43
|
+
// @public
|
|
44
|
+
export const SuccessProgressBar: ({
|
|
74
45
|
ariaLabel,
|
|
75
46
|
isIndeterminate,
|
|
76
47
|
testId,
|
|
77
48
|
value,
|
|
78
49
|
}: CustomProgressBarProps) => JSX.Element;
|
|
79
50
|
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
*/
|
|
83
|
-
declare type ThemeProps = {
|
|
51
|
+
// @public @deprecated (undocumented)
|
|
52
|
+
type ThemeProps = {
|
|
84
53
|
value: string | number;
|
|
85
54
|
};
|
|
86
55
|
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
* migrating to one of progress bar's variants.
|
|
90
|
-
*/
|
|
91
|
-
declare type ThemeTokens = {
|
|
56
|
+
// @public @deprecated (undocumented)
|
|
57
|
+
type ThemeTokens = {
|
|
92
58
|
container: any;
|
|
93
59
|
bar: any;
|
|
94
60
|
determinateBar: any;
|
|
@@ -96,20 +62,13 @@ declare type ThemeTokens = {
|
|
|
96
62
|
decreasingBar: any;
|
|
97
63
|
};
|
|
98
64
|
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
*
|
|
102
|
-
* A transparent progress bar is used on bold backgrounds to maintain suitable contrast.
|
|
103
|
-
*
|
|
104
|
-
* - [Examples](https://atlassian.design/components/progress-bar/transparent-progress-bar/examples)
|
|
105
|
-
* - [Code](https://atlassian.design/components/progress-bar/transparent-progress-bar/code)
|
|
106
|
-
*/
|
|
107
|
-
export declare const TransparentProgressBar: ({
|
|
65
|
+
// @public
|
|
66
|
+
export const TransparentProgressBar: ({
|
|
108
67
|
ariaLabel,
|
|
109
68
|
isIndeterminate,
|
|
110
69
|
testId,
|
|
111
70
|
value,
|
|
112
71
|
}: CustomProgressBarProps) => JSX.Element;
|
|
113
72
|
|
|
114
|
-
|
|
73
|
+
// (No @packageDocumentation comment for this package)
|
|
115
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,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
|
-
}
|