@atlaskit/progress-tracker 8.2.4 → 8.2.5
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 +6 -4
- package/report.api.md +103 -0
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,11 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/progress-tracker",
|
|
3
|
-
"version": "8.2.
|
|
3
|
+
"version": "8.2.5",
|
|
4
4
|
"description": "A progress tracker displays the steps and progress through a journey.",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
7
7
|
},
|
|
8
|
-
"repository": "https://bitbucket.org/atlassian/atlassian-frontend",
|
|
8
|
+
"repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
|
|
9
9
|
"author": "Atlassian Pty Ltd",
|
|
10
10
|
"license": "Apache-2.0",
|
|
11
11
|
"main": "dist/cjs/index.js",
|
|
@@ -18,7 +18,8 @@
|
|
|
18
18
|
"team": "Design System Team",
|
|
19
19
|
"releaseModel": "scheduled",
|
|
20
20
|
"website": {
|
|
21
|
-
"name": "Progress tracker"
|
|
21
|
+
"name": "Progress tracker",
|
|
22
|
+
"category": "Components"
|
|
22
23
|
}
|
|
23
24
|
},
|
|
24
25
|
"dependencies": {
|
|
@@ -44,13 +45,14 @@
|
|
|
44
45
|
"react-dom": "^16.8.0",
|
|
45
46
|
"react-router-dom": "^4.2.2",
|
|
46
47
|
"react-test-renderer": "^16.8.0",
|
|
47
|
-
"typescript": "4.
|
|
48
|
+
"typescript": "4.3.5"
|
|
48
49
|
},
|
|
49
50
|
"techstack": {
|
|
50
51
|
"@atlassian/frontend": {
|
|
51
52
|
"import-structure": "atlassian-conventions"
|
|
52
53
|
},
|
|
53
54
|
"@repo/internal": {
|
|
55
|
+
"dom-events": "use-bind-event-listener",
|
|
54
56
|
"design-system": "v1",
|
|
55
57
|
"theming": "tokens",
|
|
56
58
|
"styling": [
|
package/report.api.md
ADDED
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
## API Report File for "@atlaskit/progress-tracker"
|
|
2
|
+
|
|
3
|
+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
/// <reference types="react" />
|
|
7
|
+
|
|
8
|
+
import { PureComponent } from 'react';
|
|
9
|
+
|
|
10
|
+
declare interface LinkComponentProps {
|
|
11
|
+
item: Stage;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
export declare class ProgressTracker extends PureComponent<
|
|
15
|
+
ProgressTrackerProps,
|
|
16
|
+
State
|
|
17
|
+
> {
|
|
18
|
+
static defaultProps: {
|
|
19
|
+
items: never[];
|
|
20
|
+
spacing: string;
|
|
21
|
+
render: {
|
|
22
|
+
link: ({ item }: LinkComponentProps) => JSX.Element;
|
|
23
|
+
};
|
|
24
|
+
animated: boolean;
|
|
25
|
+
label: string;
|
|
26
|
+
};
|
|
27
|
+
state: {
|
|
28
|
+
prevStages: {
|
|
29
|
+
percentageComplete: number;
|
|
30
|
+
id: string;
|
|
31
|
+
label: string;
|
|
32
|
+
status: Status;
|
|
33
|
+
noLink?: boolean | undefined;
|
|
34
|
+
href?: string | undefined;
|
|
35
|
+
onClick?: (() => void) | undefined;
|
|
36
|
+
}[];
|
|
37
|
+
};
|
|
38
|
+
UNSAFE_componentWillReceiveProps(nextProps: ProgressTrackerProps): void;
|
|
39
|
+
render(): JSX.Element;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
export declare interface ProgressTrackerProps {
|
|
43
|
+
/**
|
|
44
|
+
* Ordered list of stage data
|
|
45
|
+
*/
|
|
46
|
+
items: Stages;
|
|
47
|
+
/**
|
|
48
|
+
* Margin spacing type between steps
|
|
49
|
+
*/
|
|
50
|
+
spacing: Spacing;
|
|
51
|
+
/**
|
|
52
|
+
* Render prop to specify custom implementations of components
|
|
53
|
+
*/
|
|
54
|
+
render: ProgressTrackerStageRenderProp;
|
|
55
|
+
/**
|
|
56
|
+
* Turns off transition animations if set to false
|
|
57
|
+
*/
|
|
58
|
+
animated: boolean;
|
|
59
|
+
/**
|
|
60
|
+
* A `testId` prop is provided for specified elements, which is a unique string that appears as a data attribute `data-testid` in the rendered code, serving as a hook for automated tests
|
|
61
|
+
*/
|
|
62
|
+
testId?: string;
|
|
63
|
+
/**
|
|
64
|
+
* Text to be used as an aria-label of progress tracker
|
|
65
|
+
*/
|
|
66
|
+
label?: string;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
declare interface ProgressTrackerStageRenderProp {
|
|
70
|
+
link: (props: LinkComponentProps) => JSX.Element;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
declare type Spacing = keyof typeof spacing;
|
|
74
|
+
|
|
75
|
+
/**
|
|
76
|
+
* Ideally these are exported by @atlaskit/page
|
|
77
|
+
*/
|
|
78
|
+
declare const spacing: {
|
|
79
|
+
readonly comfortable: number;
|
|
80
|
+
readonly cosy: number;
|
|
81
|
+
readonly compact: number;
|
|
82
|
+
};
|
|
83
|
+
|
|
84
|
+
export declare interface Stage {
|
|
85
|
+
id: string;
|
|
86
|
+
label: string;
|
|
87
|
+
percentageComplete: number;
|
|
88
|
+
status: Status;
|
|
89
|
+
noLink?: boolean;
|
|
90
|
+
href?: string;
|
|
91
|
+
onClick?: () => void;
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
export declare type Stages = Stage[];
|
|
95
|
+
|
|
96
|
+
declare interface State {
|
|
97
|
+
prevStages: Stages;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
declare type Status = 'unvisited' | 'visited' | 'current' | 'disabled';
|
|
101
|
+
|
|
102
|
+
export {};
|
|
103
|
+
```
|