@atlaskit/progress-tracker 10.5.7 → 11.0.1

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,40 @@
1
1
  # @atlaskit/progress-tracker
2
2
 
3
+ ## 11.0.1
4
+
5
+ ### Patch Changes
6
+
7
+ - [`ee28cf33718b0`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/ee28cf33718b0) -
8
+ Add @atlassian/react-compiler-gating as a runtime dependency to enable React Compiler platform
9
+ gating.
10
+ - Updated dependencies
11
+
12
+ ## 11.0.0
13
+
14
+ ### Major Changes
15
+
16
+ - [`f2dc9097319f0`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f2dc9097319f0) - ###
17
+ Dropped support for _legacy_ Typescript 4 types. **Typescript 5 is now the new minimum**.
18
+
19
+ Removes the `typesVersions` property and `dist/types-ts4.5` directory from the dist.
20
+
21
+ Types are now exclusively via the `"types": "dist/types/index.d.ts"` property.
22
+
23
+ ```diff
24
+ - "typesVersions": {
25
+ - ">=4.5 <4.9": {
26
+ - "*": [
27
+ - "dist/types-ts4.5/*",
28
+ - "dist/types-ts4.5/index.d.ts"
29
+ - ]
30
+ - }
31
+ - },
32
+ ```
33
+
34
+ ### Patch Changes
35
+
36
+ - Updated dependencies
37
+
3
38
  ## 10.5.7
4
39
 
5
40
  ### Patch Changes
@@ -4,7 +4,7 @@
4
4
  ._1e021ssb{inset-inline-start:50%}
5
5
  ._4t3iu2gc{height:var(--ds-space-100,8px)}
6
6
  ._bfhk1856{background-color:var(--ds-background-brand-bold,#1868db)}
7
+ ._bfhk187o{background-color:var(--ds-background-disabled,#0515240f)}
7
8
  ._bfhk1aqn{background-color:var(--ds-background-neutral-bold,#292a2e)}
8
- ._bfhkby5v{background-color:var(--ds-background-disabled,#17171708)}
9
9
  ._kqswstnw{position:absolute}
10
10
  ._t9ec157a{transform:translate(-50%,calc(var(--ds-space-250, 20px)*-1))}
@@ -16,7 +16,7 @@ var markerColor = {
16
16
  unvisited: "_bfhk1aqn",
17
17
  current: "_bfhk1856",
18
18
  visited: "_bfhk1856",
19
- disabled: "_bfhkby5v"
19
+ disabled: "_bfhk187o"
20
20
  };
21
21
 
22
22
  /**
@@ -4,7 +4,7 @@
4
4
  ._1e021ssb{inset-inline-start:50%}
5
5
  ._4t3iu2gc{height:var(--ds-space-100,8px)}
6
6
  ._bfhk1856{background-color:var(--ds-background-brand-bold,#1868db)}
7
+ ._bfhk187o{background-color:var(--ds-background-disabled,#0515240f)}
7
8
  ._bfhk1aqn{background-color:var(--ds-background-neutral-bold,#292a2e)}
8
- ._bfhkby5v{background-color:var(--ds-background-disabled,#17171708)}
9
9
  ._kqswstnw{position:absolute}
10
10
  ._t9ec157a{transform:translate(-50%,calc(var(--ds-space-250, 20px)*-1))}
@@ -8,7 +8,7 @@ const markerColor = {
8
8
  unvisited: "_bfhk1aqn",
9
9
  current: "_bfhk1856",
10
10
  visited: "_bfhk1856",
11
- disabled: "_bfhkby5v"
11
+ disabled: "_bfhk187o"
12
12
  };
13
13
 
14
14
  /**
@@ -4,7 +4,7 @@
4
4
  ._1e021ssb{inset-inline-start:50%}
5
5
  ._4t3iu2gc{height:var(--ds-space-100,8px)}
6
6
  ._bfhk1856{background-color:var(--ds-background-brand-bold,#1868db)}
7
+ ._bfhk187o{background-color:var(--ds-background-disabled,#0515240f)}
7
8
  ._bfhk1aqn{background-color:var(--ds-background-neutral-bold,#292a2e)}
8
- ._bfhkby5v{background-color:var(--ds-background-disabled,#17171708)}
9
9
  ._kqswstnw{position:absolute}
10
10
  ._t9ec157a{transform:translate(-50%,calc(var(--ds-space-250, 20px)*-1))}
@@ -8,7 +8,7 @@ var markerColor = {
8
8
  unvisited: "_bfhk1aqn",
9
9
  current: "_bfhk1856",
10
10
  visited: "_bfhk1856",
11
- disabled: "_bfhkby5v"
11
+ disabled: "_bfhk187o"
12
12
  };
13
13
 
14
14
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/progress-tracker",
3
- "version": "10.5.7",
3
+ "version": "11.0.1",
4
4
  "description": "A progress tracker displays the steps and progress through a journey.",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -31,9 +31,10 @@
31
31
  }
32
32
  },
33
33
  "dependencies": {
34
- "@atlaskit/css": "^0.19.0",
35
- "@atlaskit/primitives": "^19.0.0",
36
- "@atlaskit/tokens": "^13.0.0",
34
+ "@atlaskit/css": "^1.0.0",
35
+ "@atlaskit/primitives": "^20.0.0",
36
+ "@atlaskit/tokens": "^15.0.0",
37
+ "@atlassian/react-compiler-gating": "^0.2.0",
37
38
  "@babel/runtime": "^7.0.0",
38
39
  "@compiled/react": "^0.20.0"
39
40
  },
@@ -44,17 +45,17 @@
44
45
  "@af/accessibility-testing": "workspace:^",
45
46
  "@af/integration-testing": "workspace:^",
46
47
  "@af/visual-regression": "workspace:^",
47
- "@atlaskit/button": "^23.11.0",
48
- "@atlaskit/docs": "^11.7.0",
49
- "@atlaskit/icon": "^34.0.0",
50
- "@atlaskit/link": "^3.4.0",
51
- "@atlaskit/section-message": "^8.12.0",
52
- "@atlassian/react-compiler-gating": "workspace:^",
48
+ "@atlaskit/button": "^24.1.0",
49
+ "@atlaskit/docs": "^12.0.0",
50
+ "@atlaskit/icon": "^36.0.0",
51
+ "@atlaskit/link": "^4.0.0",
52
+ "@atlaskit/section-message": "^9.1.0",
53
53
  "@atlassian/ssr-tests": "workspace:^",
54
54
  "@atlassian/structured-docs-types": "workspace:^",
55
55
  "@testing-library/react": "^16.3.0",
56
56
  "@testing-library/user-event": "^14.4.3",
57
57
  "jest-in-case": "^1.0.2",
58
+ "react": "^18.2.0",
58
59
  "react-dom": "^18.2.0"
59
60
  },
60
61
  "techstack": {
@@ -77,13 +78,5 @@
77
78
  "ui-components": "primitives"
78
79
  }
79
80
  },
80
- "typesVersions": {
81
- ">=4.5 <4.9": {
82
- "*": [
83
- "dist/types-ts4.5/*",
84
- "dist/types-ts4.5/index.d.ts"
85
- ]
86
- }
87
- },
88
81
  "homepage": "https://atlassian.design/components/progress-tracker/"
89
82
  }
@@ -1,47 +1,49 @@
1
1
  import path from 'path';
2
2
 
3
- import type { ComponentStructuredContentSource } from '@atlassian/structured-docs-types';
3
+ import type { StructuredContentSource } from '@atlassian/structured-docs-types/types';
4
4
 
5
- const documentation: ComponentStructuredContentSource[] = [
6
- {
7
- name: 'ProgressTracker',
8
- description: 'A component for tracking progress through multi-step processes.',
9
- status: 'general-availability',
10
- import: {
5
+ const documentation: StructuredContentSource = {
6
+ components: [
7
+ {
11
8
  name: 'ProgressTracker',
12
- package: '@atlaskit/progress-tracker',
13
- type: 'named',
14
- packagePath: path.resolve(__dirname),
15
- packageJson: require('./package.json'),
16
- },
17
- usageGuidelines: [
18
- 'Use for multi-step workflows',
19
- 'Provide clear progress tracking',
20
- 'Handle progress updates appropriately',
21
- 'Consider progress completion states',
22
- ],
23
- contentGuidelines: [
24
- 'Use clear, descriptive step labels',
25
- 'Provide meaningful progress descriptions',
26
- 'Use appropriate progress terminology',
27
- 'Keep progress information concise',
28
- ],
29
- accessibilityGuidelines: [
30
- 'Ensure progress is announced by screen readers',
31
- 'Use appropriate progress indicators',
32
- 'Provide clear progress context',
33
- 'Consider progress timing and updates',
34
- ],
35
- examples: [
36
- {
37
- name: 'Progress Tracker',
38
- description: 'Progress Tracker example',
39
- source: path.resolve(__dirname, './examples/ai/progress-tracker.tsx'),
9
+ description: 'A component for tracking progress through multi-step processes.',
10
+ status: 'general-availability',
11
+ import: {
12
+ name: 'ProgressTracker',
13
+ package: '@atlaskit/progress-tracker',
14
+ type: 'named',
15
+ packagePath: path.resolve(__dirname),
16
+ packageJson: require('./package.json'),
40
17
  },
41
- ],
42
- keywords: ['progress', 'tracker', 'steps', 'completion', 'workflow'],
43
- categories: ['feedback'],
44
- },
45
- ];
18
+ usageGuidelines: [
19
+ 'Use for multi-step workflows',
20
+ 'Provide clear progress tracking',
21
+ 'Handle progress updates appropriately',
22
+ 'Consider progress completion states',
23
+ ],
24
+ contentGuidelines: [
25
+ 'Use clear, descriptive step labels',
26
+ 'Provide meaningful progress descriptions',
27
+ 'Use appropriate progress terminology',
28
+ 'Keep progress information concise',
29
+ ],
30
+ accessibilityGuidelines: [
31
+ 'Ensure progress is announced by screen readers',
32
+ 'Use appropriate progress indicators',
33
+ 'Provide clear progress context',
34
+ 'Consider progress timing and updates',
35
+ ],
36
+ examples: [
37
+ {
38
+ name: 'Progress Tracker',
39
+ description: 'Progress Tracker example',
40
+ source: path.resolve(__dirname, './examples/ai/progress-tracker.tsx'),
41
+ },
42
+ ],
43
+ keywords: ['progress', 'tracker', 'steps', 'completion', 'workflow'],
44
+ categories: ['feedback'],
45
+ },
46
+ ],
47
+ };
46
48
 
47
49
  export default documentation;
@@ -6,12 +6,5 @@
6
6
  "sideEffects": [
7
7
  "**/*.compiled.css"
8
8
  ],
9
- "types": "../dist/types/types.d.ts",
10
- "typesVersions": {
11
- ">=4.5 <5.9": {
12
- "*": [
13
- "../dist/types-ts4.5/types.d.ts"
14
- ]
15
- }
16
- }
9
+ "types": "../dist/types/types.d.ts"
17
10
  }
@@ -1,3 +0,0 @@
1
- export { default as ProgressTracker } from './progress-tracker';
2
- export type { ProgressTrackerProps } from './progress-tracker';
3
- export type { Stages, Stage, Status } from './types';
@@ -1,12 +0,0 @@
1
- interface StageBarProps {
2
- testId?: string;
3
- percentageComplete: number;
4
- }
5
- /**
6
- * __Progress bar__
7
- *
8
- * A progress bar describes the horizontal tracking bar that traverses each individual step.
9
- *
10
- */
11
- declare const ProgressBar: ({ percentageComplete, testId }: StageBarProps) => JSX.Element;
12
- export default ProgressBar;
@@ -1,9 +0,0 @@
1
- import { type FC } from 'react';
2
- import { type Stage } from '../types';
3
- /**
4
- * __Progress tracker link__
5
- */
6
- declare const Link: FC<Stage & {
7
- testId?: string;
8
- }>;
9
- export default Link;
@@ -1,16 +0,0 @@
1
- /**
2
- * @jsxRuntime classic
3
- * @jsx jsx
4
- */
5
- import { type FC } from 'react';
6
- import type { Status } from '../types';
7
- /**
8
- * __Progress marker__
9
- *
10
- * Similar to `@atlaskit/progress-indicator`, a small visual circle marker
11
- */
12
- declare const ProgressMarker: FC<{
13
- testId?: string;
14
- status: Status;
15
- }>;
16
- export default ProgressMarker;
@@ -1,22 +0,0 @@
1
- /**
2
- * @jsxRuntime classic
3
- * @jsx jsx
4
- */
5
- import { PureComponent } from 'react';
6
- import type { ProgressTrackerStageProps } from './types';
7
- interface State {
8
- transitioning: boolean;
9
- oldMarkerColor?: string;
10
- oldPercentageComplete: number;
11
- }
12
- export default class ProgressTrackerStage extends PureComponent<ProgressTrackerStageProps, State> {
13
- private animationTimeoutId?;
14
- constructor(props: ProgressTrackerStageProps);
15
- componentDidUpdate(prevProps: ProgressTrackerStageProps): void;
16
- componentWillUnmount(): void;
17
- startTransition(): void;
18
- shouldShowLink(): boolean;
19
- onEntered: () => void;
20
- render(): JSX.Element;
21
- }
22
- export {};
@@ -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,43 +0,0 @@
1
- import type { ProgressTrackerStageRenderProp, Spacing, Stages } from './types';
2
- export interface ProgressTrackerProps {
3
- /**
4
- * Ordered list of stage data.
5
- */
6
- items: Stages;
7
- /**
8
- * Sets the amount of spacing between the steps.
9
- */
10
- spacing?: Spacing;
11
- /**
12
- * @deprecated
13
- *
14
- * Render prop to specify custom implementations of components.
15
- *
16
- * Note this is deprecated and will be removed in a future version.
17
- * Links inside progress tracker can be configured using [App Provider](https://atlassian.design/components/app-provider) instead.
18
- */
19
- render?: ProgressTrackerStageRenderProp;
20
- /**
21
- * Turns off transition animations if set to false.
22
- */
23
- animated?: boolean;
24
- /**
25
- * 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.
26
- */
27
- testId?: string;
28
- /**
29
- * Use this to provide an aria-label for the overall progress tracker, so that people who use assistive technology get an overview of the tracker's purpose. For example, "Sign up progress".
30
- */
31
- label?: string;
32
- }
33
- /**
34
- * __Progress tracker__
35
- *
36
- * A progress tracker displays the steps and progress through a journey.
37
- *
38
- * - [Examples](https://atlassian.design/components/progress-tracker/examples)
39
- * - [Code](https://atlassian.design/components/progress-tracker/code)
40
- * - [Usage](https://atlassian.design/components/progress-tracker/usage)
41
- */
42
- declare const ProgressTracker: ({ items, spacing, render, animated, testId, label, }: ProgressTrackerProps) => JSX.Element;
43
- export default ProgressTracker;
@@ -1,25 +0,0 @@
1
- /**
2
- * Ideally these are exported by @atlaskit/page
3
- */
4
- export type Spacing = 'comfortable' | 'cozy' | 'compact';
5
- export type Status = 'unvisited' | 'visited' | 'current' | 'disabled';
6
- /**
7
- * @deprecated
8
- */
9
- export type StatusType = Status;
10
- export interface Stage {
11
- id: string;
12
- label: string;
13
- percentageComplete: number;
14
- status: Status;
15
- noLink?: boolean;
16
- href?: string;
17
- onClick?: () => void;
18
- }
19
- export type Stages = Stage[];
20
- export interface LinkComponentProps {
21
- item: Stage;
22
- }
23
- export interface ProgressTrackerStageRenderProp {
24
- link: (props: LinkComponentProps) => JSX.Element;
25
- }
package/offerings.json DELETED
@@ -1,34 +0,0 @@
1
- [
2
- {
3
- "name": "ProgressTracker",
4
- "package": "@atlaskit/progress-tracker",
5
- "import": {
6
- "name": "ProgressTracker",
7
- "package": "@atlaskit/progress-tracker",
8
- "type": "named"
9
- },
10
- "keywords": ["progress", "tracker", "steps", "completion", "workflow"],
11
- "categories": ["feedback"],
12
- "shortDescription": "A component for tracking progress through multi-step processes.",
13
- "status": "general-availability",
14
- "accessibilityGuidelines": [
15
- "Ensure progress is announced by screen readers",
16
- "Use appropriate progress indicators",
17
- "Provide clear progress context",
18
- "Consider progress timing and updates"
19
- ],
20
- "usageGuidelines": [
21
- "Use for multi-step workflows",
22
- "Provide clear progress tracking",
23
- "Handle progress updates appropriately",
24
- "Consider progress completion states"
25
- ],
26
- "contentGuidelines": [
27
- "Use clear, descriptive step labels",
28
- "Provide meaningful progress descriptions",
29
- "Use appropriate progress terminology",
30
- "Keep progress information concise"
31
- ],
32
- "examples": ["./examples/ai/progress-tracker.tsx"]
33
- }
34
- ]