@atlaskit/icon 22.3.0 → 22.3.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,14 @@
1
1
  # @atlaskit/icon
2
2
 
3
+ ## 22.3.1
4
+
5
+ ### Patch Changes
6
+
7
+ - [#104222](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/104222)
8
+ [`cabed929cdde`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/cabed929cdde) -
9
+ Fix bug where utility icons incorrectly allowed the 'spacing' prop to be set. Utility icons only
10
+ support 'none' spacing and the prop type has been removed"
11
+
3
12
  ## 22.3.0
4
13
 
5
14
  ### Minor Changes
@@ -0,0 +1,28 @@
1
+ {
2
+ "extends": "../../../../tsconfig.products.json",
3
+ "compilerOptions": {
4
+ "declaration": true,
5
+ "target": "es5",
6
+ "outDir": "../../../../../tsDist/@atlaskit__icon/app",
7
+ "composite": true,
8
+ "rootDir": "../",
9
+ "baseUrl": "../"
10
+ },
11
+ "include": [
12
+ "../src/**/*.ts",
13
+ "../src/**/*.tsx"
14
+ ],
15
+ "exclude": [
16
+ "../src/**/__tests__/*",
17
+ "../src/**/*.test.*",
18
+ "../src/**/test.*"
19
+ ],
20
+ "references": [
21
+ {
22
+ "path": "../../../platform/feature-flags/afm-jira/tsconfig.json"
23
+ },
24
+ {
25
+ "path": "../../tokens/afm-jira/tsconfig.json"
26
+ }
27
+ ]
28
+ }
@@ -1,4 +1,5 @@
1
- import core, {
1
+ import type {
2
+ default as core,
2
3
  API,
3
4
  FileInfo,
4
5
  ImportSpecifier,
@@ -6,7 +7,7 @@ import core, {
6
7
  ImportDefaultSpecifier,
7
8
  Options,
8
9
  } from 'jscodeshift';
9
- import { Collection } from 'jscodeshift/src/Collection';
10
+ import { type Collection } from 'jscodeshift/src/Collection';
10
11
 
11
12
  export const packageName = '@atlaskit/icon';
12
13
 
@@ -92,7 +92,7 @@ var Icon = exports.Icon = /*#__PURE__*/(0, _react.memo)(function Icon(props) {
92
92
  _ref$color = _ref.color,
93
93
  color = _ref$color === void 0 ? "var(--ds-icon, #44546F)" : _ref$color,
94
94
  _ref$spacing = _ref.spacing,
95
- spacing = _ref$spacing === void 0 ? 'none' : _ref$spacing,
95
+ providedSpacing = _ref$spacing === void 0 ? 'none' : _ref$spacing,
96
96
  testId = _ref.testId,
97
97
  label = _ref.label,
98
98
  LEGACY_secondaryColor = _ref.LEGACY_secondaryColor,
@@ -118,6 +118,9 @@ var Icon = exports.Icon = /*#__PURE__*/(0, _react.memo)(function Icon(props) {
118
118
  testId: testId
119
119
  });
120
120
  }
121
+
122
+ // Utility icons don't have 'spacing' as a type, but in case it's provided, we default to 'none'
123
+ var spacing = type === 'utility' ? 'none' : providedSpacing;
121
124
  var baseSize = baseSizeMap[type];
122
125
  var size = type === 'utility' ? 'utility' : shouldScale ? 'scale' : spacing;
123
126
  var viewBoxPadding = spacing === 'spacious' ? 4 : 0;
@@ -103,7 +103,9 @@ var Icon = exports.Icon = /*#__PURE__*/(0, _react.memo)(function Icon(props) {
103
103
  "data-testid": testId,
104
104
  role: label ? 'img' : undefined,
105
105
  "aria-label": label ? label : undefined,
106
- "aria-hidden": label ? undefined : true,
106
+ "aria-hidden": label ? undefined : true
107
+ // eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop -- Ignored via go/DSP-18766
108
+ ,
107
109
  style: {
108
110
  '--icon-primary-color': primaryColor,
109
111
  '--icon-secondary-color': secondaryColor || (0, _utils.getBackground)()
@@ -84,7 +84,7 @@ const baseSizeMap = {
84
84
  export const Icon = /*#__PURE__*/memo(function Icon(props) {
85
85
  const {
86
86
  color = "var(--ds-icon, #44546F)",
87
- spacing = 'none',
87
+ spacing: providedSpacing = 'none',
88
88
  testId,
89
89
  label,
90
90
  LEGACY_secondaryColor,
@@ -112,6 +112,9 @@ export const Icon = /*#__PURE__*/memo(function Icon(props) {
112
112
  testId: testId
113
113
  });
114
114
  }
115
+
116
+ // Utility icons don't have 'spacing' as a type, but in case it's provided, we default to 'none'
117
+ const spacing = type === 'utility' ? 'none' : providedSpacing;
115
118
  const baseSize = baseSizeMap[type];
116
119
  const size = type === 'utility' ? 'utility' : shouldScale ? 'scale' : spacing;
117
120
  const viewBoxPadding = spacing === 'spacious' ? 4 : 0;
@@ -96,7 +96,9 @@ export const Icon = /*#__PURE__*/memo(function Icon(props) {
96
96
  "data-testid": testId,
97
97
  role: label ? 'img' : undefined,
98
98
  "aria-label": label ? label : undefined,
99
- "aria-hidden": label ? undefined : true,
99
+ "aria-hidden": label ? undefined : true
100
+ // eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop -- Ignored via go/DSP-18766
101
+ ,
100
102
  style: {
101
103
  '--icon-primary-color': primaryColor,
102
104
  '--icon-secondary-color': secondaryColor || getBackground()
@@ -86,7 +86,7 @@ export var Icon = /*#__PURE__*/memo(function Icon(props) {
86
86
  _ref$color = _ref.color,
87
87
  color = _ref$color === void 0 ? "var(--ds-icon, #44546F)" : _ref$color,
88
88
  _ref$spacing = _ref.spacing,
89
- spacing = _ref$spacing === void 0 ? 'none' : _ref$spacing,
89
+ providedSpacing = _ref$spacing === void 0 ? 'none' : _ref$spacing,
90
90
  testId = _ref.testId,
91
91
  label = _ref.label,
92
92
  LEGACY_secondaryColor = _ref.LEGACY_secondaryColor,
@@ -112,6 +112,9 @@ export var Icon = /*#__PURE__*/memo(function Icon(props) {
112
112
  testId: testId
113
113
  });
114
114
  }
115
+
116
+ // Utility icons don't have 'spacing' as a type, but in case it's provided, we default to 'none'
117
+ var spacing = type === 'utility' ? 'none' : providedSpacing;
115
118
  var baseSize = baseSizeMap[type];
116
119
  var size = type === 'utility' ? 'utility' : shouldScale ? 'scale' : spacing;
117
120
  var viewBoxPadding = spacing === 'spacious' ? 4 : 0;
@@ -98,7 +98,9 @@ export var Icon = /*#__PURE__*/memo(function Icon(props) {
98
98
  "data-testid": testId,
99
99
  role: label ? 'img' : undefined,
100
100
  "aria-label": label ? label : undefined,
101
- "aria-hidden": label ? undefined : true,
101
+ "aria-hidden": label ? undefined : true
102
+ // eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop -- Ignored via go/DSP-18766
103
+ ,
102
104
  style: {
103
105
  '--icon-primary-color': primaryColor,
104
106
  '--icon-secondary-color': secondaryColor || getBackground()
@@ -1,5 +1,5 @@
1
1
  import type { Size } from '../types';
2
- import { CSSObject } from '@emotion/react';
2
+ import { type CSSObject } from '@emotion/react';
3
3
  export declare const commonSVGStyles: CSSObject;
4
4
  export declare const sizeStyleMap: {
5
5
  small: import("@emotion/react").SerializedStyles;
@@ -1,5 +1,5 @@
1
1
  import type { Size } from '../types';
2
- import { CSSObject } from '@emotion/react';
2
+ import { type CSSObject } from '@emotion/react';
3
3
  export declare const commonSVGStyles: CSSObject;
4
4
  export declare const sizeStyleMap: {
5
5
  small: import("@emotion/react").SerializedStyles;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/icon",
3
- "version": "22.3.0",
3
+ "version": "22.3.1",
4
4
  "description": "An icon is a visual representation of a command, device, directory, or common action.",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
package/utility/add.d.ts CHANGED
@@ -3,7 +3,7 @@ import React from 'react';
3
3
  import Icon from '@atlaskit/icon/UNSAFE_base-new';
4
4
 
5
5
  declare const AddIcon: {
6
- (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'type'>): JSX.Element;
6
+ (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'spacing' | 'type'>): JSX.Element;
7
7
  displayName: string;
8
8
  };
9
9
  export default AddIcon;
@@ -3,7 +3,7 @@ import React from 'react';
3
3
  import Icon from '@atlaskit/icon/UNSAFE_base-new';
4
4
 
5
5
  declare const CheckCircleIcon: {
6
- (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'type'>): JSX.Element;
6
+ (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'spacing' | 'type'>): JSX.Element;
7
7
  displayName: string;
8
8
  };
9
9
  export default CheckCircleIcon;
@@ -3,7 +3,7 @@ import React from 'react';
3
3
  import Icon from '@atlaskit/icon/UNSAFE_base-new';
4
4
 
5
5
  declare const CheckMarkIcon: {
6
- (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'type'>): JSX.Element;
6
+ (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'spacing' | 'type'>): JSX.Element;
7
7
  displayName: string;
8
8
  };
9
9
  export default CheckMarkIcon;
@@ -3,7 +3,7 @@ import React from 'react';
3
3
  import Icon from '@atlaskit/icon/UNSAFE_base-new';
4
4
 
5
5
  declare const ChevronDownIcon: {
6
- (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'type'>): JSX.Element;
6
+ (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'spacing' | 'type'>): JSX.Element;
7
7
  displayName: string;
8
8
  };
9
9
  export default ChevronDownIcon;
@@ -3,7 +3,7 @@ import React from 'react';
3
3
  import Icon from '@atlaskit/icon/UNSAFE_base-new';
4
4
 
5
5
  declare const ChevronLeftIcon: {
6
- (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'type'>): JSX.Element;
6
+ (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'spacing' | 'type'>): JSX.Element;
7
7
  displayName: string;
8
8
  };
9
9
  export default ChevronLeftIcon;
@@ -3,7 +3,7 @@ import React from 'react';
3
3
  import Icon from '@atlaskit/icon/UNSAFE_base-new';
4
4
 
5
5
  declare const ChevronRightIcon: {
6
- (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'type'>): JSX.Element;
6
+ (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'spacing' | 'type'>): JSX.Element;
7
7
  displayName: string;
8
8
  };
9
9
  export default ChevronRightIcon;
@@ -3,7 +3,7 @@ import React from 'react';
3
3
  import Icon from '@atlaskit/icon/UNSAFE_base-new';
4
4
 
5
5
  declare const ChevronUpIcon: {
6
- (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'type'>): JSX.Element;
6
+ (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'spacing' | 'type'>): JSX.Element;
7
7
  displayName: string;
8
8
  };
9
9
  export default ChevronUpIcon;
@@ -3,7 +3,7 @@ import React from 'react';
3
3
  import Icon from '@atlaskit/icon/UNSAFE_base-new';
4
4
 
5
5
  declare const CrossCircleIcon: {
6
- (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'type'>): JSX.Element;
6
+ (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'spacing' | 'type'>): JSX.Element;
7
7
  displayName: string;
8
8
  };
9
9
  export default CrossCircleIcon;
@@ -3,7 +3,7 @@ import React from 'react';
3
3
  import Icon from '@atlaskit/icon/UNSAFE_base-new';
4
4
 
5
5
  declare const CrossIcon: {
6
- (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'type'>): JSX.Element;
6
+ (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'spacing' | 'type'>): JSX.Element;
7
7
  displayName: string;
8
8
  };
9
9
  export default CrossIcon;
@@ -3,7 +3,7 @@ import React from 'react';
3
3
  import Icon from '@atlaskit/icon/UNSAFE_base-new';
4
4
 
5
5
  declare const ErrorIcon: {
6
- (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'type'>): JSX.Element;
6
+ (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'spacing' | 'type'>): JSX.Element;
7
7
  displayName: string;
8
8
  };
9
9
  export default ErrorIcon;
@@ -3,7 +3,7 @@ import React from 'react';
3
3
  import Icon from '@atlaskit/icon/UNSAFE_base-new';
4
4
 
5
5
  declare const InformationIcon: {
6
- (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'type'>): JSX.Element;
6
+ (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'spacing' | 'type'>): JSX.Element;
7
7
  displayName: string;
8
8
  };
9
9
  export default InformationIcon;
@@ -3,7 +3,7 @@ import React from 'react';
3
3
  import Icon from '@atlaskit/icon/UNSAFE_base-new';
4
4
 
5
5
  declare const LinkExternalIcon: {
6
- (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'type'>): JSX.Element;
6
+ (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'spacing' | 'type'>): JSX.Element;
7
7
  displayName: string;
8
8
  };
9
9
  export default LinkExternalIcon;
@@ -3,7 +3,7 @@ import React from 'react';
3
3
  import Icon from '@atlaskit/icon/UNSAFE_base-new';
4
4
 
5
5
  declare const LockLockedIcon: {
6
- (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'type'>): JSX.Element;
6
+ (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'spacing' | 'type'>): JSX.Element;
7
7
  displayName: string;
8
8
  };
9
9
  export default LockLockedIcon;
@@ -3,7 +3,7 @@ import React from 'react';
3
3
  import Icon from '@atlaskit/icon/UNSAFE_base-new';
4
4
 
5
5
  declare const LockUnlockedIcon: {
6
- (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'type'>): JSX.Element;
6
+ (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'spacing' | 'type'>): JSX.Element;
7
7
  displayName: string;
8
8
  };
9
9
  export default LockUnlockedIcon;
@@ -3,7 +3,7 @@ import React from 'react';
3
3
  import Icon from '@atlaskit/icon/UNSAFE_base-new';
4
4
 
5
5
  declare const ShowMoreHorizontalIcon: {
6
- (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'type'>): JSX.Element;
6
+ (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'spacing' | 'type'>): JSX.Element;
7
7
  displayName: string;
8
8
  };
9
9
  export default ShowMoreHorizontalIcon;
@@ -3,7 +3,7 @@ import React from 'react';
3
3
  import Icon from '@atlaskit/icon/UNSAFE_base-new';
4
4
 
5
5
  declare const ShowMoreVerticalIcon: {
6
- (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'type'>): JSX.Element;
6
+ (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'spacing' | 'type'>): JSX.Element;
7
7
  displayName: string;
8
8
  };
9
9
  export default ShowMoreVerticalIcon;
@@ -3,7 +3,7 @@ import React from 'react';
3
3
  import Icon from '@atlaskit/icon/UNSAFE_base-new';
4
4
 
5
5
  declare const StarStarredIcon: {
6
- (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'type'>): JSX.Element;
6
+ (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'spacing' | 'type'>): JSX.Element;
7
7
  displayName: string;
8
8
  };
9
9
  export default StarStarredIcon;
@@ -3,7 +3,7 @@ import React from 'react';
3
3
  import Icon from '@atlaskit/icon/UNSAFE_base-new';
4
4
 
5
5
  declare const StarUnstarredIcon: {
6
- (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'type'>): JSX.Element;
6
+ (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'spacing' | 'type'>): JSX.Element;
7
7
  displayName: string;
8
8
  };
9
9
  export default StarUnstarredIcon;
@@ -3,7 +3,7 @@ import React from 'react';
3
3
  import Icon from '@atlaskit/icon/UNSAFE_base-new';
4
4
 
5
5
  declare const WarningIcon: {
6
- (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'type'>): JSX.Element;
6
+ (props: Omit<React.ComponentProps<typeof Icon>, 'dangerouslySetGlyph' | 'spacing' | 'type'>): JSX.Element;
7
7
  displayName: string;
8
8
  };
9
9
  export default WarningIcon;