@atlaskit/progress-tracker 8.5.5 → 8.5.6

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/progress-tracker
 
+## 8.5.6
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 8.5.5
 
 ### Patch Changes

package/dist/cjs/progress-tracker.js

@@ -32,7 +32,7 @@ var containerStyles = (0, _react2.css)({
   gap: "var(".concat(_constants2.varSpacing, ")"),
   listStyleType: 'none',
   '&&': {
-    marginTop: "var(--ds-space-500, 40px)"
+    marginBlockStart: "var(--ds-space-500, 40px)"
   }
 });
 var ProgressTracker = exports.default = /*#__PURE__*/function (_PureComponent) {
@@ -95,13 +95,13 @@ var ProgressTracker = exports.default = /*#__PURE__*/function (_PureComponent) {
           transitionSpeed = progressChanges > 1 ? _constants2.LINEAR_TRANSITION_SPEED : _constants2.TRANSITION_SPEED;
           if (stage.percentageComplete < _this3.state.prevStages[index].percentageComplete) {
             /**
-             * load each transition sequentially in reverse
+             * Load each transition sequentially in reverse.
              */
             transitionDelay = (stepsBack - 1) * transitionSpeed;
             stepsBack -= 1;
           } else if (stage.percentageComplete > _this3.state.prevStages[index].percentageComplete) {
             /**
-             * load each transition sequentially
+             * Load each transition sequentially.
              */
             transitionDelay = (totalStepsForward - stepsForward) * transitionSpeed;
             stepsForward -= 1;

package/dist/es2019/progress-tracker.js

@@ -17,7 +17,7 @@ const containerStyles = css({
   gap: `var(${varSpacing})`,
   listStyleType: 'none',
   '&&': {
-    marginTop: "var(--ds-space-500, 40px)"
+    marginBlockStart: "var(--ds-space-500, 40px)"
   }
 });
 export default class ProgressTracker extends PureComponent {
@@ -57,13 +57,13 @@ export default class ProgressTracker extends PureComponent {
         transitionSpeed = progressChanges > 1 ? LINEAR_TRANSITION_SPEED : TRANSITION_SPEED;
         if (stage.percentageComplete < this.state.prevStages[index].percentageComplete) {
           /**
-           * load each transition sequentially in reverse
+           * Load each transition sequentially in reverse.
            */
           transitionDelay = (stepsBack - 1) * transitionSpeed;
           stepsBack -= 1;
         } else if (stage.percentageComplete > this.state.prevStages[index].percentageComplete) {
           /**
-           * load each transition sequentially
+           * Load each transition sequentially.
            */
           transitionDelay = (totalStepsForward - stepsForward) * transitionSpeed;
           stepsForward -= 1;

package/dist/esm/progress-tracker.js

@@ -27,7 +27,7 @@ var containerStyles = css({
   gap: "var(".concat(varSpacing, ")"),
   listStyleType: 'none',
   '&&': {
-    marginTop: "var(--ds-space-500, 40px)"
+    marginBlockStart: "var(--ds-space-500, 40px)"
   }
 });
 var ProgressTracker = /*#__PURE__*/function (_PureComponent) {
@@ -90,13 +90,13 @@ var ProgressTracker = /*#__PURE__*/function (_PureComponent) {
           transitionSpeed = progressChanges > 1 ? LINEAR_TRANSITION_SPEED : TRANSITION_SPEED;
           if (stage.percentageComplete < _this3.state.prevStages[index].percentageComplete) {
             /**
-             * load each transition sequentially in reverse
+             * Load each transition sequentially in reverse.
              */
             transitionDelay = (stepsBack - 1) * transitionSpeed;
             stepsBack -= 1;
           } else if (stage.percentageComplete > _this3.state.prevStages[index].percentageComplete) {
             /**
-             * load each transition sequentially
+             * Load each transition sequentially.
              */
             transitionDelay = (totalStepsForward - stepsForward) * transitionSpeed;
             stepsForward -= 1;

package/dist/types/progress-tracker.d.ts

@@ -4,27 +4,27 @@ import { jsx } from '@emotion/react';
 import type { LinkComponentProps, ProgressTrackerStageRenderProp, Spacing, Stages } from './types';
 export interface ProgressTrackerProps {
     /**
-     * Ordered list of stage data
+     * Ordered list of stage data.
      */
     items: Stages;
     /**
-     * Margin spacing type between steps
+     * Sets the amount of spacing between the steps.
      */
     spacing: Spacing;
     /**
-     * Render prop to specify custom implementations of components
+     * Render prop to specify custom implementations of components.
      */
     render: ProgressTrackerStageRenderProp;
     /**
-     * Turns off transition animations if set to false
+     * Turns off transition animations if set to false.
      */
     animated: boolean;
     /**
-     * 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
+     * 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.
      */
     testId?: string;
     /**
-     * Text to be used as an aria-label of progress tracker
+     * Text to be used as both the visual label and aria-label of a step in the progress tracker.
      */
     label?: string;
 }

package/dist/types-ts4.5/progress-tracker.d.ts

@@ -4,27 +4,27 @@ import { jsx } from '@emotion/react';
 import type { LinkComponentProps, ProgressTrackerStageRenderProp, Spacing, Stages } from './types';
 export interface ProgressTrackerProps {
     /**
-     * Ordered list of stage data
+     * Ordered list of stage data.
      */
     items: Stages;
     /**
-     * Margin spacing type between steps
+     * Sets the amount of spacing between the steps.
      */
     spacing: Spacing;
     /**
-     * Render prop to specify custom implementations of components
+     * Render prop to specify custom implementations of components.
      */
     render: ProgressTrackerStageRenderProp;
     /**
-     * Turns off transition animations if set to false
+     * Turns off transition animations if set to false.
      */
     animated: boolean;
     /**
-     * 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
+     * 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.
      */
     testId?: string;
     /**
-     * Text to be used as an aria-label of progress tracker
+     * Text to be used as both the visual label and aria-label of a step in the progress tracker.
      */
     label?: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/progress-tracker",
-  "version": "8.5.5",
+  "version": "8.5.6",
   "description": "A progress tracker displays the steps and progress through a journey.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -26,10 +26,10 @@
     }
   },
   "dependencies": {
-    "@atlaskit/ds-explorations": "^3.0.0",
-    "@atlaskit/primitives": "^1.6.0",
+    "@atlaskit/ds-explorations": "^3.2.0",
+    "@atlaskit/primitives": "^2.0.0",
     "@atlaskit/theme": "^12.6.0",
-    "@atlaskit/tokens": "^1.26.0",
+    "@atlaskit/tokens": "^1.35.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1",
     "react-transition-group": "^4.4.1"
@@ -46,6 +46,7 @@
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@testing-library/react": "^12.1.5",
     "@testing-library/user-event": "^14.4.3",
+    "@types/react-transition-group": "^2.0.6",
     "jest-in-case": "^1.0.2",
     "react-dom": "^16.8.0",
     "react-router-dom": "^4.2.2",

package/tmp/api-report-tmp.d.ts

@@ -1,106 +0,0 @@
-## API Report File for "@atlaskit/progress-tracker"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-/// <reference types="react" />
-
-import { jsx } from '@emotion/react';
-import { PureComponent } from 'react';
-
-// @public (undocumented)
-interface LinkComponentProps {
-    // (undocumented)
-    item: Stage;
-}
-
-// @public (undocumented)
-export class ProgressTracker extends PureComponent<ProgressTrackerProps, State> {
-    // (undocumented)
-    static defaultProps: {
-        items: never[];
-        spacing: string;
-        render: {
-            link: ({ item }: LinkComponentProps) => jsx.JSX.Element;
-        };
-        animated: boolean;
-        label: string;
-    };
-    // (undocumented)
-    render(): jsx.JSX.Element;
-    // (undocumented)
-    state: {
-        prevStages: {
-            percentageComplete: number;
-            id: string;
-            label: string;
-            status: Status;
-            noLink?: boolean | undefined;
-            href?: string | undefined;
-            onClick?: (() => void) | undefined;
-        }[];
-    };
-    // (undocumented)
-    UNSAFE_componentWillReceiveProps(nextProps: ProgressTrackerProps): void;
-}
-
-// @public (undocumented)
-export interface ProgressTrackerProps {
-    animated: boolean;
-    items: Stages;
-    label?: string;
-    render: ProgressTrackerStageRenderProp;
-    spacing: Spacing;
-    testId?: string;
-}
-
-// @public (undocumented)
-interface ProgressTrackerStageRenderProp {
-    // (undocumented)
-    link: (props: LinkComponentProps) => JSX.Element;
-}
-
-// @public (undocumented)
-type Spacing = keyof typeof spacing;
-
-// @public
-const spacing: {
-    readonly comfortable: "var(--ds-space-500)";
-    readonly cosy: "var(--ds-space-200)";
-    readonly compact: "var(--ds-space-050)";
-};
-
-// @public (undocumented)
-export interface Stage {
-    // (undocumented)
-    href?: string;
-    // (undocumented)
-    id: string;
-    // (undocumented)
-    label: string;
-    // (undocumented)
-    noLink?: boolean;
-    // (undocumented)
-    onClick?: () => void;
-    // (undocumented)
-    percentageComplete: number;
-    // (undocumented)
-    status: Status;
-}
-
-// @public (undocumented)
-export type Stages = Stage[];
-
-// @public (undocumented)
-interface State {
-    // (undocumented)
-    prevStages: Stages;
-}
-
-// @public (undocumented)
-type Status = 'current' | 'disabled' | 'unvisited' | 'visited';
-
-// (No @packageDocumentation comment for this package)
-
-```