@atlaskit/progress-bar 0.6.1 → 0.6.3
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 +12 -0
- package/dist/cjs/components/progress-bar.js +2 -2
- package/dist/cjs/version.json +1 -1
- package/dist/es2019/components/progress-bar.js +2 -2
- package/dist/es2019/version.json +1 -1
- package/dist/esm/components/progress-bar.js +2 -2
- package/dist/esm/version.json +1 -1
- package/dist/types-ts4.5/components/progress-bar.d.ts +13 -0
- package/dist/types-ts4.5/components/success-progress-bar.d.ts +12 -0
- package/dist/types-ts4.5/components/transparent-progress-bar.d.ts +12 -0
- package/dist/types-ts4.5/index.d.ts +3 -0
- package/dist/types-ts4.5/theme.d.ts +17 -0
- package/dist/types-ts4.5/types.d.ts +49 -0
- package/package.json +4 -4
- package/report.api.md +13 -0
- package/tmp/api-report-tmp.d.ts +53 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# @atlaskit/progress-bar
|
|
2
2
|
|
|
3
|
+
## 0.6.3
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [`599bfe90ee3`](https://bitbucket.org/atlassian/atlassian-frontend/commits/599bfe90ee3) - Internal change to use shape tokens. There is no expected visual change.
|
|
8
|
+
|
|
9
|
+
## 0.6.2
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- [`9d00501a414`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9d00501a414) - Ensure legacy types are published for TS 4.5-4.8
|
|
14
|
+
|
|
3
15
|
## 0.6.1
|
|
4
16
|
|
|
5
17
|
### Patch Changes
|
|
@@ -40,7 +40,7 @@ var containerStyles = (0, _react2.css)({
|
|
|
40
40
|
height: 6,
|
|
41
41
|
position: 'relative',
|
|
42
42
|
background: "var(--ds-background-neutral, ".concat(_colors.N40A, ")"),
|
|
43
|
-
borderRadius:
|
|
43
|
+
borderRadius: "var(--ds-border-radius, 3px)",
|
|
44
44
|
overflow: 'hidden'
|
|
45
45
|
});
|
|
46
46
|
var containerAppearance = {
|
|
@@ -69,7 +69,7 @@ var barStyles = (0, _react2.css)({
|
|
|
69
69
|
display: 'block',
|
|
70
70
|
height: 6,
|
|
71
71
|
position: 'absolute',
|
|
72
|
-
borderRadius:
|
|
72
|
+
borderRadius: "var(--ds-border-radius, 3px)"
|
|
73
73
|
});
|
|
74
74
|
var determinateBarStyles = (0, _react2.css)({
|
|
75
75
|
transition: 'width 0.2s'
|
package/dist/cjs/version.json
CHANGED
|
@@ -31,7 +31,7 @@ const containerStyles = css({
|
|
|
31
31
|
height: 6,
|
|
32
32
|
position: 'relative',
|
|
33
33
|
background: `var(--ds-background-neutral, ${N40A})`,
|
|
34
|
-
borderRadius:
|
|
34
|
+
borderRadius: "var(--ds-border-radius, 3px)",
|
|
35
35
|
overflow: 'hidden'
|
|
36
36
|
});
|
|
37
37
|
const containerAppearance = {
|
|
@@ -60,7 +60,7 @@ const barStyles = css({
|
|
|
60
60
|
display: 'block',
|
|
61
61
|
height: 6,
|
|
62
62
|
position: 'absolute',
|
|
63
|
-
borderRadius:
|
|
63
|
+
borderRadius: "var(--ds-border-radius, 3px)"
|
|
64
64
|
});
|
|
65
65
|
const determinateBarStyles = css({
|
|
66
66
|
transition: 'width 0.2s'
|
package/dist/es2019/version.json
CHANGED
|
@@ -32,7 +32,7 @@ var containerStyles = css({
|
|
|
32
32
|
height: 6,
|
|
33
33
|
position: 'relative',
|
|
34
34
|
background: "var(--ds-background-neutral, ".concat(N40A, ")"),
|
|
35
|
-
borderRadius:
|
|
35
|
+
borderRadius: "var(--ds-border-radius, 3px)",
|
|
36
36
|
overflow: 'hidden'
|
|
37
37
|
});
|
|
38
38
|
var containerAppearance = {
|
|
@@ -61,7 +61,7 @@ var barStyles = css({
|
|
|
61
61
|
display: 'block',
|
|
62
62
|
height: 6,
|
|
63
63
|
position: 'absolute',
|
|
64
|
-
borderRadius:
|
|
64
|
+
borderRadius: "var(--ds-border-radius, 3px)"
|
|
65
65
|
});
|
|
66
66
|
var determinateBarStyles = css({
|
|
67
67
|
transition: 'width 0.2s'
|
package/dist/esm/version.json
CHANGED
|
@@ -0,0 +1,13 @@
|
|
|
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;
|
|
@@ -0,0 +1,12 @@
|
|
|
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;
|
|
@@ -0,0 +1,12 @@
|
|
|
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;
|
|
@@ -0,0 +1,17 @@
|
|
|
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
|
+
};
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import { ThemeProp } from '@atlaskit/theme/components';
|
|
2
|
+
/**
|
|
3
|
+
* @deprecated
|
|
4
|
+
*/
|
|
5
|
+
export 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 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
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/progress-bar",
|
|
3
|
-
"version": "0.6.
|
|
3
|
+
"version": "0.6.3",
|
|
4
4
|
"description": "A progress bar communicates the status of a system process.",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
"atlassian": {
|
|
27
27
|
"team": "Design System Team",
|
|
28
28
|
"deprecatedAutoEntryPoints": true,
|
|
29
|
-
"releaseModel": "
|
|
29
|
+
"releaseModel": "continuous",
|
|
30
30
|
"website": {
|
|
31
31
|
"name": "Progress bar",
|
|
32
32
|
"category": "Components"
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
"dependencies": {
|
|
36
36
|
"@atlaskit/ds-lib": "^2.2.0",
|
|
37
37
|
"@atlaskit/theme": "^12.5.0",
|
|
38
|
-
"@atlaskit/tokens": "^1.
|
|
38
|
+
"@atlaskit/tokens": "^1.11.0",
|
|
39
39
|
"@babel/runtime": "^7.0.0",
|
|
40
40
|
"@emotion/react": "^11.7.1"
|
|
41
41
|
},
|
|
@@ -43,12 +43,12 @@
|
|
|
43
43
|
"react": "^16.8.0"
|
|
44
44
|
},
|
|
45
45
|
"devDependencies": {
|
|
46
|
-
"@atlaskit/button": "^16.7.0",
|
|
47
46
|
"@atlaskit/docs": "*",
|
|
48
47
|
"@atlaskit/section-message": "^6.4.0",
|
|
49
48
|
"@atlaskit/visual-regression": "*",
|
|
50
49
|
"@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
|
|
51
50
|
"@testing-library/react": "^12.1.5",
|
|
51
|
+
"jest-axe": "^4.0.0",
|
|
52
52
|
"react-dom": "^16.8.0",
|
|
53
53
|
"typescript": "~4.9.5"
|
|
54
54
|
},
|
package/report.api.md
CHANGED
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
### Table of contents
|
|
9
9
|
|
|
10
10
|
- [Main Entry Types](#main-entry-types)
|
|
11
|
+
- [Peer Dependencies](#peer-dependencies)
|
|
11
12
|
|
|
12
13
|
### Main Entry Types
|
|
13
14
|
|
|
@@ -79,3 +80,15 @@ export const TransparentProgressBar: ({
|
|
|
79
80
|
```
|
|
80
81
|
|
|
81
82
|
<!--SECTION END: Main Entry Types-->
|
|
83
|
+
|
|
84
|
+
### Peer Dependencies
|
|
85
|
+
|
|
86
|
+
<!--SECTION START: Peer Dependencies-->
|
|
87
|
+
|
|
88
|
+
```json
|
|
89
|
+
{
|
|
90
|
+
"react": "^16.8.0"
|
|
91
|
+
}
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
<!--SECTION END: Peer Dependencies-->
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
## API Report File for "@atlaskit/progress-bar"
|
|
2
|
+
|
|
3
|
+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
|
|
7
|
+
/// <reference types="react" />
|
|
8
|
+
|
|
9
|
+
import { jsx } from '@emotion/react';
|
|
10
|
+
import { ThemeProp } from '@atlaskit/theme/components';
|
|
11
|
+
|
|
12
|
+
// @public (undocumented)
|
|
13
|
+
interface CustomProgressBarProps {
|
|
14
|
+
ariaLabel?: string;
|
|
15
|
+
isIndeterminate?: boolean;
|
|
16
|
+
testId?: string;
|
|
17
|
+
value?: number;
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
// @public (undocumented)
|
|
21
|
+
interface DefaultProgressBarProps extends CustomProgressBarProps {
|
|
22
|
+
appearance?: 'default' | 'inverse' | 'success';
|
|
23
|
+
// @deprecated (undocumented)
|
|
24
|
+
theme?: ThemeProp<ThemeTokens, ThemeProps>;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
// @public
|
|
28
|
+
const ProgressBar: ({ appearance, ariaLabel, isIndeterminate, testId, theme, value, }: DefaultProgressBarProps) => jsx.JSX.Element;
|
|
29
|
+
export default ProgressBar;
|
|
30
|
+
|
|
31
|
+
// @public
|
|
32
|
+
export const SuccessProgressBar: ({ ariaLabel, isIndeterminate, testId, value, }: CustomProgressBarProps) => JSX.Element;
|
|
33
|
+
|
|
34
|
+
// @public @deprecated (undocumented)
|
|
35
|
+
type ThemeProps = {
|
|
36
|
+
value: number | string;
|
|
37
|
+
};
|
|
38
|
+
|
|
39
|
+
// @public @deprecated (undocumented)
|
|
40
|
+
type ThemeTokens = {
|
|
41
|
+
container: any;
|
|
42
|
+
bar: any;
|
|
43
|
+
determinateBar: any;
|
|
44
|
+
increasingBar: any;
|
|
45
|
+
decreasingBar: any;
|
|
46
|
+
};
|
|
47
|
+
|
|
48
|
+
// @public
|
|
49
|
+
export const TransparentProgressBar: ({ ariaLabel, isIndeterminate, testId, value, }: CustomProgressBarProps) => JSX.Element;
|
|
50
|
+
|
|
51
|
+
// (No @packageDocumentation comment for this package)
|
|
52
|
+
|
|
53
|
+
```
|