@atlaskit/progress-indicator 9.3.0 → 9.3.2

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,17 @@
1
1
  # @atlaskit/progress-indicator
2
2
 
3
+ ## 9.3.2
4
+
5
+ ### Patch Changes
6
+
7
+ - [`9827dcb82b8`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9827dcb82b8) - No-op change to introduce spacing tokens to design system components.
8
+
9
+ ## 9.3.1
10
+
11
+ ### Patch Changes
12
+
13
+ - [`8cc2f888c83`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8cc2f888c83) - Upgrade Typescript from `4.3.5` to `4.5.5`
14
+
3
15
  ## 9.3.0
4
16
 
5
17
  ### Minor Changes
@@ -32,7 +32,8 @@ var commonStyles = (0, _react.css)({
32
32
  }
33
33
  });
34
34
  var buttonStyles = (0, _react.css)({
35
- padding: 0,
35
+ // TODO Delete this comment after verifying spacing token -> previous value `0`
36
+ padding: "var(--ds-scale-0, 0px)",
36
37
  border: 0,
37
38
  cursor: 'pointer',
38
39
  outline: 0
@@ -35,7 +35,7 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
35
35
 
36
36
  /** @jsx jsx */
37
37
  var packageName = "@atlaskit/progress-indicator";
38
- var packageVersion = "9.3.0";
38
+ var packageVersion = "9.3.2";
39
39
  var containerStyles = (0, _react2.css)({
40
40
  display: 'flex',
41
41
  justifyContent: 'center',
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/progress-indicator",
3
- "version": "9.3.0",
3
+ "version": "9.3.2",
4
4
  "sideEffects": false
5
5
  }
@@ -20,7 +20,8 @@ const commonStyles = css({
20
20
  }
21
21
  });
22
22
  const buttonStyles = css({
23
- padding: 0,
23
+ // TODO Delete this comment after verifying spacing token -> previous value `0`
24
+ padding: "var(--ds-scale-0, 0px)",
24
25
  border: 0,
25
26
  cursor: 'pointer',
26
27
  outline: 0
@@ -9,7 +9,7 @@ import { getBgColor } from './appearances';
9
9
  import { sizes, spacingDivision, varDotsMargin, varDotsSize } from './constants';
10
10
  import { ButtonIndicator, PresentationalIndicator } from './indicator';
11
11
  const packageName = "@atlaskit/progress-indicator";
12
- const packageVersion = "9.3.0";
12
+ const packageVersion = "9.3.2";
13
13
  const containerStyles = css({
14
14
  display: 'flex',
15
15
  justifyContent: 'center',
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/progress-indicator",
3
- "version": "9.3.0",
3
+ "version": "9.3.2",
4
4
  "sideEffects": false
5
5
  }
@@ -20,7 +20,8 @@ var commonStyles = css({
20
20
  }
21
21
  });
22
22
  var buttonStyles = css({
23
- padding: 0,
23
+ // TODO Delete this comment after verifying spacing token -> previous value `0`
24
+ padding: "var(--ds-scale-0, 0px)",
24
25
  border: 0,
25
26
  cursor: 'pointer',
26
27
  outline: 0
@@ -11,7 +11,7 @@ import { getBgColor } from './appearances';
11
11
  import { sizes, spacingDivision, varDotsMargin, varDotsSize } from './constants';
12
12
  import { ButtonIndicator, PresentationalIndicator } from './indicator';
13
13
  var packageName = "@atlaskit/progress-indicator";
14
- var packageVersion = "9.3.0";
14
+ var packageVersion = "9.3.2";
15
15
  var containerStyles = css({
16
16
  display: 'flex',
17
17
  justifyContent: 'center',
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/progress-indicator",
3
- "version": "9.3.0",
3
+ "version": "9.3.2",
4
4
  "sideEffects": false
5
5
  }
@@ -0,0 +1,2 @@
1
+ import type { DotsAppearance } from './types';
2
+ export declare const getBgColor: (appearance: DotsAppearance, isSelected: boolean) => import("@atlaskit/theme").ThemedValue<"var(--ds-background-neutral)"> | import("@atlaskit/theme").ThemedValue<"var(--ds-icon-subtle)"> | import("@atlaskit/theme").ThemedValue<"var(--ds-icon)"> | import("@atlaskit/theme").ThemedValue<"var(--ds-icon-discovery)"> | import("@atlaskit/theme").ThemedValue<"var(--ds-icon-inverse)"> | import("@atlaskit/theme").ThemedValue<"var(--ds-icon-brand)">;
@@ -0,0 +1,12 @@
1
+ export declare const sizes: {
2
+ small: number;
3
+ default: number;
4
+ large: number;
5
+ };
6
+ export declare const spacingDivision: {
7
+ comfortable: number;
8
+ cozy: number;
9
+ compact: number;
10
+ };
11
+ export declare const varDotsSize = "--ds-dots-size";
12
+ export declare const varDotsMargin = "--ds-dots-margin";
@@ -0,0 +1,15 @@
1
+ /** @jsx jsx */
2
+ import type { HTMLAttributes } from 'react';
3
+ import { jsx } from '@emotion/react';
4
+ /**
5
+ * __Presentational indicator__
6
+ *
7
+ * A presentational indicator with no interactivity
8
+ */
9
+ export declare const PresentationalIndicator: (props: HTMLAttributes<HTMLDivElement>) => jsx.JSX.Element;
10
+ /**
11
+ * __Button indicator__
12
+ *
13
+ * An interactive indicator.
14
+ */
15
+ export declare const ButtonIndicator: (props: HTMLAttributes<HTMLButtonElement>) => jsx.JSX.Element;
@@ -0,0 +1,10 @@
1
+ /** @jsx jsx */
2
+ import { FC } from 'react';
3
+ import type { ProgressDotsProps } from '../types';
4
+ /**
5
+ * __ProgressDots__
6
+ *
7
+ * A progress indicator shows the user where they are along the steps of a journey.
8
+ */
9
+ declare const ProgressDots: FC<ProgressDotsProps>;
10
+ export default ProgressDots;
@@ -0,0 +1,3 @@
1
+ export declare type DotsAppearance = 'default' | 'help' | 'inverted' | 'primary';
2
+ export declare type Spacing = 'comfortable' | 'cozy' | 'compact';
3
+ export declare type Size = 'small' | 'default' | 'large';
@@ -0,0 +1,2 @@
1
+ export { default as ProgressIndicator } from './components/progress-dots';
2
+ export type { ProgressDotsProps } from './types';
@@ -0,0 +1,44 @@
1
+ /// <reference types="react" />
2
+ import type { UIAnalyticsEvent } from '@atlaskit/analytics-next';
3
+ import type { DotsAppearance, Size, Spacing } from './components/types';
4
+ export interface ProgressDotsProps {
5
+ /**
6
+ * The color of the indicators
7
+ */
8
+ appearance?: DotsAppearance;
9
+ /**
10
+ * The aria-controls text applied to each indicator, appended by the index
11
+ */
12
+ ariaControls?: string;
13
+ /**
14
+ * The aria-label text applied to each indicator, appended by the index
15
+ */
16
+ ariaLabel?: string;
17
+ /**
18
+ * Function called when an indicator is selected
19
+ */
20
+ onSelect?: (eventData: {
21
+ event: React.MouseEvent<HTMLButtonElement>;
22
+ index: number;
23
+ }, analyticsEvent: UIAnalyticsEvent) => void;
24
+ /**
25
+ * Which indicator is currently selected
26
+ */
27
+ selectedIndex: number;
28
+ /**
29
+ * Corresponds to the width & height of each indicator
30
+ */
31
+ size?: Size;
32
+ /**
33
+ * How much of a gutter is desired between indicators
34
+ */
35
+ spacing?: Spacing;
36
+ /**
37
+ * A hook for automated tests.
38
+ */
39
+ testId?: string;
40
+ /**
41
+ * An array of values mapped over to create the indicators
42
+ */
43
+ values: any[];
44
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/progress-indicator",
3
- "version": "9.3.0",
3
+ "version": "9.3.2",
4
4
  "description": "A progress indicator shows the user where they are along the steps of a journey.",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -12,9 +12,18 @@
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
+ },
15
23
  "sideEffects": false,
16
24
  "atlaskit:src": "src/index.tsx",
17
25
  "atlassian": {
26
+ "disableProductCI": true,
18
27
  "team": "Design System Team",
19
28
  "releaseModel": "scheduled",
20
29
  "website": {
@@ -25,7 +34,7 @@
25
34
  "dependencies": {
26
35
  "@atlaskit/analytics-next": "^8.0.0",
27
36
  "@atlaskit/ds-lib": "^2.1.0",
28
- "@atlaskit/focus-ring": "^1.0.0",
37
+ "@atlaskit/focus-ring": "^1.1.0",
29
38
  "@atlaskit/theme": "^12.2.0",
30
39
  "@atlaskit/tokens": "^0.10.0",
31
40
  "@babel/runtime": "^7.0.0",
@@ -38,18 +47,18 @@
38
47
  "devDependencies": {
39
48
  "@atlaskit/button": "^16.3.0",
40
49
  "@atlaskit/docs": "*",
41
- "@atlaskit/section-message": "^6.2.0",
50
+ "@atlaskit/section-message": "^6.3.0",
42
51
  "@atlaskit/ssr": "*",
43
52
  "@atlaskit/visual-regression": "*",
44
53
  "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
45
- "@testing-library/react": "^8.0.1",
54
+ "@testing-library/react": "^12.1.5",
46
55
  "@types/jscodeshift": "^0.11.0",
47
56
  "enzyme": "^3.10.0",
48
57
  "jscodeshift": "^0.13.0",
49
58
  "react-dom": "^16.8.0",
50
59
  "react-lorem-component": "^0.13.0",
51
60
  "styled-components": "^3.2.6",
52
- "typescript": "4.3.5"
61
+ "typescript": "4.5.5"
53
62
  },
54
63
  "techstack": {
55
64
  "@atlassian/frontend": {
@@ -64,6 +73,7 @@
64
73
  "emotion"
65
74
  ],
66
75
  "analytics": "analytics-next",
76
+ "design-tokens": "spacing",
67
77
  "theming": "tokens",
68
78
  "deprecation": "no-deprecated-imports"
69
79
  }
package/report.api.md CHANGED
@@ -1,6 +1,8 @@
1
- ## API Report File for "@atlaskit/progress-indicator"
1
+ ## API Report File for "@atlaskit/progress-indicator".
2
2
 
3
- > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
3
+ > Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
4
6
 
5
7
  ```ts
6
8
  /// <reference types="react" />
@@ -4,5 +4,12 @@
4
4
  "module": "../dist/esm/types.js",
5
5
  "module:es2019": "../dist/es2019/types.js",
6
6
  "sideEffects": false,
7
- "types": "../dist/types/types.d.ts"
7
+ "types": "../dist/types/types.d.ts",
8
+ "typesVersions": {
9
+ ">=4.0 <4.5": {
10
+ "*": [
11
+ "../dist/types-ts4.0/types.d.ts"
12
+ ]
13
+ }
14
+ }
8
15
  }