@atlaskit/progress-tracker 8.3.3 → 8.3.4

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,11 @@
1
1
  # @atlaskit/progress-tracker
2
2
 
3
+ ## 8.3.4
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+
3
9
  ## 8.3.3
4
10
 
5
11
  ### Patch Changes
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/progress-tracker",
3
- "version": "8.3.3",
3
+ "version": "8.3.4",
4
4
  "sideEffects": false
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/progress-tracker",
3
- "version": "8.3.3",
3
+ "version": "8.3.4",
4
4
  "sideEffects": false
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/progress-tracker",
3
- "version": "8.3.3",
3
+ "version": "8.3.4",
4
4
  "sideEffects": false
5
5
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/progress-tracker",
3
- "version": "8.3.3",
3
+ "version": "8.3.4",
4
4
  "description": "A progress tracker displays the steps and progress through a journey.",
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
  "atlassian": {
@@ -33,7 +25,7 @@
33
25
  },
34
26
  "dependencies": {
35
27
  "@atlaskit/theme": "^12.2.0",
36
- "@atlaskit/tokens": "^0.10.0",
28
+ "@atlaskit/tokens": "^0.11.0",
37
29
  "@babel/runtime": "^7.0.0",
38
30
  "@emotion/react": "^11.7.1",
39
31
  "react-transition-group": "^4.4.1"
@@ -42,7 +34,7 @@
42
34
  "react": "^16.8.0"
43
35
  },
44
36
  "devDependencies": {
45
- "@atlaskit/button": "^16.3.0",
37
+ "@atlaskit/button": "^16.4.0",
46
38
  "@atlaskit/docs": "*",
47
39
  "@atlaskit/ds-lib": "^2.0.1",
48
40
  "@atlaskit/icon": "^21.11.0",
package/report.api.md CHANGED
@@ -1,6 +1,10 @@
1
- ## API Report File for "@atlaskit/progress-tracker".
1
+ ## API Report File for "@atlaskit/progress-tracker"
2
2
 
3
- > Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
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,14 +14,18 @@
10
14
  import { jsx } from '@emotion/react';
11
15
  import { PureComponent } from 'react';
12
16
 
13
- declare interface LinkComponentProps {
17
+ // @public (undocumented)
18
+ interface LinkComponentProps {
19
+ // (undocumented)
14
20
  item: Stage;
15
21
  }
16
22
 
17
- export declare class ProgressTracker extends PureComponent<
23
+ // @public (undocumented)
24
+ export class ProgressTracker extends PureComponent<
18
25
  ProgressTrackerProps,
19
26
  State
20
27
  > {
28
+ // (undocumented)
21
29
  static defaultProps: {
22
30
  items: never[];
23
31
  spacing: string;
@@ -27,6 +35,9 @@ export declare class ProgressTracker extends PureComponent<
27
35
  animated: boolean;
28
36
  label: string;
29
37
  };
38
+ // (undocumented)
39
+ render(): jsx.JSX.Element;
40
+ // (undocumented)
30
41
  state: {
31
42
  prevStages: {
32
43
  percentageComplete: number;
@@ -38,69 +49,65 @@ export declare class ProgressTracker extends PureComponent<
38
49
  onClick?: (() => void) | undefined;
39
50
  }[];
40
51
  };
52
+ // (undocumented)
41
53
  UNSAFE_componentWillReceiveProps(nextProps: ProgressTrackerProps): void;
42
- render(): jsx.JSX.Element;
43
54
  }
44
55
 
45
- export declare interface ProgressTrackerProps {
46
- /**
47
- * Ordered list of stage data
48
- */
56
+ // @public (undocumented)
57
+ export interface ProgressTrackerProps {
58
+ animated: boolean;
49
59
  items: Stages;
50
- /**
51
- * Margin spacing type between steps
52
- */
53
- spacing: Spacing;
54
- /**
55
- * Render prop to specify custom implementations of components
56
- */
60
+ label?: string;
57
61
  render: ProgressTrackerStageRenderProp;
58
- /**
59
- * Turns off transition animations if set to false
60
- */
61
- animated: boolean;
62
- /**
63
- * 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
64
- */
62
+ spacing: Spacing;
65
63
  testId?: string;
66
- /**
67
- * Text to be used as an aria-label of progress tracker
68
- */
69
- label?: string;
70
64
  }
71
65
 
72
- declare interface ProgressTrackerStageRenderProp {
66
+ // @public (undocumented)
67
+ interface ProgressTrackerStageRenderProp {
68
+ // (undocumented)
73
69
  link: (props: LinkComponentProps) => JSX.Element;
74
70
  }
75
71
 
76
- declare type Spacing = keyof typeof spacing;
72
+ // @public (undocumented)
73
+ type Spacing = keyof typeof spacing;
77
74
 
78
- /**
79
- * Ideally these are exported by @atlaskit/page
80
- */
81
- declare const spacing: {
75
+ // @public
76
+ const spacing: {
82
77
  readonly comfortable: number;
83
78
  readonly cosy: number;
84
79
  readonly compact: number;
85
80
  };
86
81
 
87
- export declare interface Stage {
82
+ // @public (undocumented)
83
+ export interface Stage {
84
+ // (undocumented)
85
+ href?: string;
86
+ // (undocumented)
88
87
  id: string;
88
+ // (undocumented)
89
89
  label: string;
90
- percentageComplete: number;
91
- status: Status;
90
+ // (undocumented)
92
91
  noLink?: boolean;
93
- href?: string;
92
+ // (undocumented)
94
93
  onClick?: () => void;
94
+ // (undocumented)
95
+ percentageComplete: number;
96
+ // (undocumented)
97
+ status: Status;
95
98
  }
96
99
 
97
- export declare type Stages = Stage[];
100
+ // @public (undocumented)
101
+ export type Stages = Stage[];
98
102
 
99
- declare interface State {
103
+ // @public (undocumented)
104
+ interface State {
105
+ // (undocumented)
100
106
  prevStages: Stages;
101
107
  }
102
108
 
103
- declare type Status = 'unvisited' | 'visited' | 'current' | 'disabled';
109
+ // @public (undocumented)
110
+ type Status = 'unvisited' | 'visited' | 'current' | 'disabled';
104
111
 
105
- export {};
112
+ // (No @packageDocumentation comment for this package)
106
113
  ```
@@ -1,10 +0,0 @@
1
- export declare const defaultGridSize: number;
2
- /**
3
- * Ideally these are exported by @atlaskit/page
4
- */
5
- export declare const spacing: {
6
- readonly comfortable: number;
7
- readonly cosy: number;
8
- readonly compact: number;
9
- };
10
- export declare type Spacing = keyof typeof spacing;
@@ -1,3 +0,0 @@
1
- export { default as ProgressTracker } from './progress-tracker';
2
- export type { ProgressTrackerProps } from './progress-tracker';
3
- export type { Stages, Stage } from './types';
@@ -1,13 +0,0 @@
1
- import { jsx } from '@emotion/react';
2
- interface StageBarProps {
3
- testId?: string;
4
- percentageComplete: number;
5
- }
6
- /**
7
- * __Progress bar__
8
- *
9
- * A progress bar describes the horizontal tracking bar that traverses each individual step.
10
- *
11
- */
12
- declare const ProgressBar: ({ percentageComplete, testId }: StageBarProps) => jsx.JSX.Element;
13
- export default ProgressBar;
@@ -1,14 +0,0 @@
1
- export declare const TRANSITION_SPEED = 300;
2
- export declare const LINEAR_TRANSITION_SPEED = 50;
3
- export declare const ANIMATION_EASE_OUT = "cubic-bezier(0.15,1,0.3,1)";
4
- export declare const varSpacing = "--ds--pt--sp";
5
- export declare const varTransitionSpeed = "--ds--pt--ts";
6
- export declare const varTransitionDelay = "--ds--pt--td";
7
- export declare const varTransitionEasing = "--ds--pt--te";
8
- export declare const varMarkerColor = "--ds--pt--mc";
9
- export declare const varBackgroundColor = "--ds--pt--bg";
10
- export declare const SEMI_BOLD_FONT_WEIGHT = "600";
11
- export declare const REGULAR_FONT_WEIGHT = "400";
12
- export declare const HALF_GRID_SIZE: number;
13
- export declare const PROGRESS_BAR_HEIGHT: number;
14
- export declare const LABEL_TOP_SPACING: number;
@@ -1,10 +0,0 @@
1
- /** @jsx jsx */
2
- import { FC } from 'react';
3
- import { Stage } from '../types';
4
- /**
5
- * __Progress tracker link__
6
- */
7
- declare const Link: FC<Stage & {
8
- testId?: string;
9
- }>;
10
- export default Link;
@@ -1,11 +0,0 @@
1
- /** @jsx jsx */
2
- import { FC } from 'react';
3
- /**
4
- * __Progress marker__
5
- *
6
- * Similar to `@atlaskit/progress-indicator`, a small visual circle marker
7
- */
8
- declare const ProgressMarker: FC<{
9
- testId?: string;
10
- }>;
11
- export default ProgressMarker;
@@ -1,18 +0,0 @@
1
- /** @jsx jsx */
2
- import { PureComponent } from 'react';
3
- import { jsx } from '@emotion/react';
4
- import type { ProgressTrackerStageProps } from './types';
5
- interface State {
6
- transitioning: boolean;
7
- oldMarkerColor?: string;
8
- oldPercentageComplete: number;
9
- }
10
- export type { ProgressTrackerStageProps };
11
- export default class ProgressTrackerStage extends PureComponent<ProgressTrackerStageProps, State> {
12
- constructor(props: ProgressTrackerStageProps);
13
- UNSAFE_componentWillMount(): void;
14
- UNSAFE_componentWillReceiveProps(): void;
15
- shouldShowLink(): boolean;
16
- onEntered: () => void;
17
- render(): jsx.JSX.Element;
18
- }
@@ -1,27 +0,0 @@
1
- import type { ProgressTrackerStageRenderProp, Stage } from '../types';
2
- export interface ProgressTrackerStageProps {
3
- /**
4
- * stage data passed to each `ProgressTrackerStage` component
5
- */
6
- item: Stage;
7
- /**
8
- * render prop to specify how to render components
9
- */
10
- render: ProgressTrackerStageRenderProp;
11
- /**
12
- * An internal hook applied to key elements for automated testing
13
- */
14
- testId?: string;
15
- /**
16
- * delay before transitioning in ms
17
- */
18
- transitionDelay: number;
19
- /**
20
- * speed at which to transition in ms
21
- */
22
- transitionSpeed: number;
23
- /**
24
- * interface of easing for transition
25
- */
26
- transitionEasing: string;
27
- }
@@ -1,4 +0,0 @@
1
- import type { Status } from '../types';
2
- export declare const getMarkerColor: (status: Status) => "var(--ds-icon-subtle)" | "var(--ds-icon-brand)" | undefined;
3
- export declare const getTextColor: (status: Status) => "var(--ds-text)" | "var(--ds-text-subtlest)" | "var(--ds-text-brand)" | "var(--ds-text-disabled)" | undefined;
4
- export declare const getFontWeight: (status: Status) => "600" | "400" | undefined;
@@ -1,58 +0,0 @@
1
- /** @jsx jsx */
2
- import { PureComponent } from 'react';
3
- import { jsx } from '@emotion/react';
4
- import type { LinkComponentProps, ProgressTrackerStageRenderProp, Spacing, Stages } from './types';
5
- export interface ProgressTrackerProps {
6
- /**
7
- * Ordered list of stage data
8
- */
9
- items: Stages;
10
- /**
11
- * Margin spacing type between steps
12
- */
13
- spacing: Spacing;
14
- /**
15
- * Render prop to specify custom implementations of components
16
- */
17
- render: ProgressTrackerStageRenderProp;
18
- /**
19
- * Turns off transition animations if set to false
20
- */
21
- animated: boolean;
22
- /**
23
- * 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
24
- */
25
- testId?: string;
26
- /**
27
- * Text to be used as an aria-label of progress tracker
28
- */
29
- label?: string;
30
- }
31
- interface State {
32
- prevStages: Stages;
33
- }
34
- export default class ProgressTracker extends PureComponent<ProgressTrackerProps, State> {
35
- static defaultProps: {
36
- items: never[];
37
- spacing: string;
38
- render: {
39
- link: ({ item }: LinkComponentProps) => jsx.JSX.Element;
40
- };
41
- animated: boolean;
42
- label: string;
43
- };
44
- state: {
45
- prevStages: {
46
- percentageComplete: number;
47
- id: string;
48
- label: string;
49
- status: import("./types").Status;
50
- noLink?: boolean | undefined;
51
- href?: string | undefined;
52
- onClick?: (() => void) | undefined;
53
- }[];
54
- };
55
- UNSAFE_componentWillReceiveProps(nextProps: ProgressTrackerProps): void;
56
- render(): jsx.JSX.Element;
57
- }
58
- export {};
@@ -1,26 +0,0 @@
1
- /// <reference types="react" />
2
- /**
3
- * Ideally these are exported by @atlaskit/page
4
- */
5
- export type { Spacing } from './constants';
6
- export declare type Status = 'unvisited' | 'visited' | 'current' | 'disabled';
7
- /**
8
- * @deprecated
9
- */
10
- export declare type StatusType = Status;
11
- export interface Stage {
12
- id: string;
13
- label: string;
14
- percentageComplete: number;
15
- status: Status;
16
- noLink?: boolean;
17
- href?: string;
18
- onClick?: () => void;
19
- }
20
- export declare type Stages = Stage[];
21
- export interface LinkComponentProps {
22
- item: Stage;
23
- }
24
- export interface ProgressTrackerStageRenderProp {
25
- link: (props: LinkComponentProps) => JSX.Element;
26
- }