@atlaskit/progress-bar 0.5.10 → 0.5.12

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/progress-bar
 
+## 0.5.12
+
+### Patch Changes
+
+- [`9827dcb82b8`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9827dcb82b8) - No-op change to introduce spacing tokens to design system components.
+
+## 0.5.11
+
+### Patch Changes
+
+- [`8cc2f888c83`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8cc2f888c83) - Upgrade Typescript from `4.3.5` to `4.5.5`
+
 ## 0.5.10
 
 ### Patch Changes

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/progress-bar",
-	"version": "0.5.10",
+	"version": "0.5.12",
 	"sideEffects": false
 }

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/progress-bar",
-	"version": "0.5.10",
+	"version": "0.5.12",
 	"sideEffects": false
 }

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/progress-bar",
-	"version": "0.5.10",
+	"version": "0.5.12",
 	"sideEffects": false
 }

package/dist/types-ts4.0/components/progress-bar.d.ts

@@ -0,0 +1,13 @@
+import { jsx } from '@emotion/react';
+import { DefaultProgressBarProps } from '../types';
+/**
+ * __Progress bar__
+ *
+ * A progress bar displays the status of a given process.
+ *
+ * - [Examples](https://atlassian.design/components/progress-bar/examples)
+ * - [Code](https://atlassian.design/components/progress-bar/code)
+ * - [Usage](https://atlassian.design/components/progress-bar/usage)
+ */
+declare const ProgressBar: ({ appearance, ariaLabel, isIndeterminate, testId, theme, value, }: DefaultProgressBarProps) => jsx.JSX.Element;
+export default ProgressBar;

package/dist/types-ts4.0/components/success-progress-bar.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+import { CustomProgressBarProps } from '../types';
+/**
+ * __Success progress bar__
+ *
+ * A success progress bar indicates the completion of a process.
+ *
+ * - [Examples](https://atlassian.design/components/progress-bar/success-progress-bar/examples)
+ * - [Code](https://atlassian.design/components/progress-bar/success-progress-bar/code)
+ */
+declare const SuccessProgressBar: ({ ariaLabel, isIndeterminate, testId, value, }: CustomProgressBarProps) => JSX.Element;
+export default SuccessProgressBar;

package/dist/types-ts4.0/components/transparent-progress-bar.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+import { CustomProgressBarProps } from '../types';
+/**
+ * __Transparent progress bar__
+ *
+ * A transparent progress bar is used on bold backgrounds to maintain suitable contrast.
+ *
+ * - [Examples](https://atlassian.design/components/progress-bar/transparent-progress-bar/examples)
+ * - [Code](https://atlassian.design/components/progress-bar/transparent-progress-bar/code)
+ */
+declare const TransparentProgressBar: ({ ariaLabel, isIndeterminate, testId, value, }: CustomProgressBarProps) => JSX.Element;
+export default TransparentProgressBar;

package/dist/types-ts4.0/index.d.ts

@@ -0,0 +1,3 @@
+export { default } from './components/progress-bar';
+export { default as SuccessProgressBar } from './components/success-progress-bar';
+export { default as TransparentProgressBar } from './components/transparent-progress-bar';

package/dist/types-ts4.0/theme.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="react" />
+import { ThemeProps, ThemeTokens } from './types';
+/**
+ * Creates the default theme, which can be customised using the `theme` prop
+ *
+ * @deprecated
+ */
+export declare const Theme: {
+    Consumer: import("react").ComponentType<{
+        children: (tokens: ThemeTokens) => import("react").ReactNode;
+    } & ThemeProps>;
+    Provider: import("react").ComponentType<{
+        children?: import("react").ReactNode;
+        value?: import("@atlaskit/theme/components").ThemeProp<ThemeTokens, ThemeProps> | undefined;
+    }>;
+    useTheme: (props: ThemeProps) => ThemeTokens;
+};

package/dist/types-ts4.0/types.d.ts

@@ -0,0 +1,49 @@
+import { ThemeProp } from '@atlaskit/theme/components';
+/**
+ * @deprecated
+ */
+export declare type ThemeProps = {
+    value: string | number;
+};
+/**
+ * @deprecated This allows for users to customize the theme. This is being deprecated, please consider
+ * migrating to one of progress bar's variants.
+ */
+export declare type ThemeTokens = {
+    container: any;
+    bar: any;
+    determinateBar: any;
+    increasingBar: any;
+    decreasingBar: any;
+};
+export interface CustomProgressBarProps {
+    /**
+     * Sets the value of the progress bar, between `0` and `1` inclusive.
+     */
+    value?: number;
+    /**
+     * Shows the progress bar in an indeterminate state when `true`.
+     */
+    isIndeterminate?: boolean;
+    /**
+     * Label associated with the progress bar,
+     * read by screen readers.
+     */
+    ariaLabel?: string;
+    /**
+     * A `testId` prop 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;
+}
+export interface DefaultProgressBarProps extends CustomProgressBarProps {
+    /**
+     * @deprecated
+     * Theme prop is deprecated and will be removed in the future.
+     */
+    theme?: ThemeProp<ThemeTokens, ThemeProps>;
+    /**
+     * Visual style of the progress bar.
+     */
+    appearance?: 'default' | 'success' | 'inverse';
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/progress-bar",
-  "version": "0.5.10",
+  "version": "0.5.12",
   "description": "A progress bar displays the status of a given process.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -12,10 +12,19 @@
   "module": "dist/esm/index.js",
   "module:es2019": "dist/es2019/index.js",
   "types": "dist/types/index.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "dist/types-ts4.0/*",
+        "dist/types-ts4.0/index.d.ts"
+      ]
+    }
+  },
   "sideEffects": false,
   "atlaskit:src": "src/index.tsx",
   "homepage": "https://atlassian.design/components/progress-bar/",
   "atlassian": {
+    "disableProductCI": true,
     "team": "Design System Team",
     "deprecatedAutoEntryPoints": true,
     "releaseModel": "scheduled",
@@ -37,12 +46,12 @@
   "devDependencies": {
     "@atlaskit/button": "^16.3.0",
     "@atlaskit/docs": "*",
-    "@atlaskit/section-message": "^6.2.0",
+    "@atlaskit/section-message": "^6.3.0",
     "@atlaskit/visual-regression": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
-    "@testing-library/react": "^8.0.1",
+    "@testing-library/react": "^12.1.5",
     "react-dom": "^16.8.0",
-    "typescript": "4.3.5"
+    "typescript": "4.5.5"
   },
   "keywords": [
     "atlaskit",
@@ -56,6 +65,7 @@
     "@repo/internal": {
       "dom-events": "use-bind-event-listener",
       "design-system": "v1",
+      "design-tokens": "spacing",
       "theming": "tokens",
       "deprecation": "no-deprecated-imports",
       "styling": [

package/report.api.md

@@ -1,55 +1,85 @@
-## API Report File for "@atlaskit/progress-bar"
+## API Report File for "@atlaskit/progress-bar".
 
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+> Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
+
+[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
 
 ```ts
-import { default as React_2 } from 'react';
+/// <reference types="react" />
+
+import { jsx } from '@emotion/react';
 import { ThemeProp } from '@atlaskit/theme/components';
 
 declare interface CustomProgressBarProps {
   /**
-   * Current progress, a number between 0 and 1.
+   * Sets the value of the progress bar, between `0` and `1` inclusive.
    */
-  value: number;
+  value?: number;
   /**
-   * When true the component is in indeterminate state.
+   * Shows the progress bar in an indeterminate state when `true`.
    */
-  isIndeterminate: boolean;
+  isIndeterminate?: boolean;
   /**
-   * The aria-label attribute associated with the progress bar.
+   * Label associated with the progress bar,
+   * read by screen readers.
    */
   ariaLabel?: string;
+  /**
+   * A `testId` prop 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;
 }
 
 declare interface DefaultProgressBarProps extends CustomProgressBarProps {
   /**
-   * The theme the component should use. NOTE: This is being deprecated and will be removed after 13 May 2022. Please consider migrating to
-   * one of progress bar's variants.
+   * @deprecated
+   * Theme prop is deprecated and will be removed in the future.
    */
   theme?: ThemeProp<ThemeTokens, ThemeProps>;
+  /**
+   * Visual style of the progress bar.
+   */
+  appearance?: 'default' | 'success' | 'inverse';
 }
 
-declare class ProgressBar extends React_2.PureComponent<
-  DefaultProgressBarProps
-> {
-  static defaultProps: {
-    value: number;
-    isIndeterminate: boolean;
-  };
-  render(): JSX.Element;
-}
+/**
+ * __Progress bar__
+ *
+ * A progress bar displays the status of a given process.
+ *
+ * - [Examples](https://atlassian.design/components/progress-bar/examples)
+ * - [Code](https://atlassian.design/components/progress-bar/code)
+ * - [Usage](https://atlassian.design/components/progress-bar/usage)
+ */
+declare const ProgressBar: ({
+  appearance,
+  ariaLabel,
+  isIndeterminate,
+  testId,
+  theme,
+  value,
+}: DefaultProgressBarProps) => jsx.JSX.Element;
 export default ProgressBar;
 
-export declare class SuccessProgressBar extends React_2.PureComponent<
-  CustomProgressBarProps
-> {
-  static defaultProps: {
-    value: number;
-    isIndeterminate: boolean;
-  };
-  render(): JSX.Element;
-}
+/**
+ * __Success progress bar__
+ *
+ * A success progress bar indicates the completion of a process.
+ *
+ * - [Examples](https://atlassian.design/components/progress-bar/success-progress-bar/examples)
+ * - [Code](https://atlassian.design/components/progress-bar/success-progress-bar/code)
+ */
+export declare const SuccessProgressBar: ({
+  ariaLabel,
+  isIndeterminate,
+  testId,
+  value,
+}: CustomProgressBarProps) => JSX.Element;
 
+/**
+ * @deprecated
+ */
 declare type ThemeProps = {
   value: string | number;
 };
@@ -66,15 +96,20 @@ declare type ThemeTokens = {
   decreasingBar: any;
 };
 
-export declare class TransparentProgressBar extends React_2.PureComponent<
-  CustomProgressBarProps
-> {
-  static defaultProps: {
-    value: number;
-    isIndeterminate: boolean;
-  };
-  render(): JSX.Element;
-}
+/**
+ * __Transparent progress bar__
+ *
+ * A transparent progress bar is used on bold backgrounds to maintain suitable contrast.
+ *
+ * - [Examples](https://atlassian.design/components/progress-bar/transparent-progress-bar/examples)
+ * - [Code](https://atlassian.design/components/progress-bar/transparent-progress-bar/code)
+ */
+export declare const TransparentProgressBar: ({
+  ariaLabel,
+  isIndeterminate,
+  testId,
+  value,
+}: CustomProgressBarProps) => JSX.Element;
 
 export {};
 ```

package/theme/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/theme.js",
   "module:es2019": "../dist/es2019/theme.js",
   "sideEffects": false,
-  "types": "../dist/types/theme.d.ts"
+  "types": "../dist/types/theme.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/theme.d.ts"
+      ]
+    }
+  }
 }

package/types/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/types.js",
   "module:es2019": "../dist/es2019/types.js",
   "sideEffects": false,
-  "types": "../dist/types/types.d.ts"
+  "types": "../dist/types/types.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/types.d.ts"
+      ]
+    }
+  }
 }