@atlaskit/icon-lab 6.14.0 → 7.1.0
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 +45 -0
- package/core/text-review.d.ts +13 -0
- package/core/text-review.js +29 -0
- package/deprecated-map/package.json +1 -8
- package/dist/cjs/metadata-core.js +11 -2
- package/dist/es2019/metadata-core.js +11 -2
- package/dist/esm/metadata-core.js +11 -2
- package/dist/types/metadata-core.d.ts +1 -1
- package/metadata/package.json +1 -8
- package/package.json +11 -19
- package/svgs/core/text-review.svg +1 -0
- package/dist/types-ts4.5/deprecated-core.d.ts +0 -13
- package/dist/types-ts4.5/deprecated-utility.d.ts +0 -13
- package/dist/types-ts4.5/entry-points/deprecated-map.d.ts +0 -2
- package/dist/types-ts4.5/entry-points/metadata.d.ts +0 -1
- package/dist/types-ts4.5/index.d.ts +0 -1
- package/dist/types-ts4.5/metadata-core.d.ts +0 -57
- package/dist/types-ts4.5/metadata-utility.d.ts +0 -63
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,50 @@
|
|
|
1
1
|
# @atlaskit/icon-lab
|
|
2
2
|
|
|
3
|
+
## 7.1.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- [`47fda51eceac5`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/47fda51eceac5) -
|
|
8
|
+
This release adds icons in `@atlaskit/icon-lab`.
|
|
9
|
+
|
|
10
|
+
### Added:
|
|
11
|
+
|
|
12
|
+
**`@atlaskit/icon-lab/core`**
|
|
13
|
+
- `text-review`
|
|
14
|
+
|
|
15
|
+
### Patch Changes
|
|
16
|
+
|
|
17
|
+
- [`ee28cf33718b0`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/ee28cf33718b0) -
|
|
18
|
+
Add @atlassian/react-compiler-gating as a runtime dependency to enable React Compiler platform
|
|
19
|
+
gating.
|
|
20
|
+
- Updated dependencies
|
|
21
|
+
|
|
22
|
+
## 7.0.0
|
|
23
|
+
|
|
24
|
+
### Major Changes
|
|
25
|
+
|
|
26
|
+
- [`f2dc9097319f0`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f2dc9097319f0) - ###
|
|
27
|
+
Dropped support for _legacy_ Typescript 4 types. **Typescript 5 is now the new minimum**.
|
|
28
|
+
|
|
29
|
+
Removes the `typesVersions` property and `dist/types-ts4.5` directory from the dist.
|
|
30
|
+
|
|
31
|
+
Types are now exclusively via the `"types": "dist/types/index.d.ts"` property.
|
|
32
|
+
|
|
33
|
+
```diff
|
|
34
|
+
- "typesVersions": {
|
|
35
|
+
- ">=4.5 <4.9": {
|
|
36
|
+
- "*": [
|
|
37
|
+
- "dist/types-ts4.5/*",
|
|
38
|
+
- "dist/types-ts4.5/index.d.ts"
|
|
39
|
+
- ]
|
|
40
|
+
- }
|
|
41
|
+
- },
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### Patch Changes
|
|
45
|
+
|
|
46
|
+
- Updated dependencies
|
|
47
|
+
|
|
3
48
|
## 6.14.0
|
|
4
49
|
|
|
5
50
|
### Minor Changes
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
|
|
3
|
+
* @codegen <<SignedSource::77e85d3c1ac467b7ddba7979c0c18b4c>>
|
|
4
|
+
* @codegenCommand yarn build:icon-glyphs
|
|
5
|
+
*/
|
|
6
|
+
|
|
7
|
+
import type { NewCoreIconProps } from '@atlaskit/icon/base-new';
|
|
8
|
+
|
|
9
|
+
declare const TextReviewIcon: {
|
|
10
|
+
(props: NewCoreIconProps): JSX.Element;
|
|
11
|
+
displayName: string;
|
|
12
|
+
};
|
|
13
|
+
export default TextReviewIcon;
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
|
|
3
|
+
* @codegen <<SignedSource::b4ce9c9788c029867762cd394d7428d0>>
|
|
4
|
+
* @codegenCommand yarn build:icon-glyphs
|
|
5
|
+
*/
|
|
6
|
+
"use strict";
|
|
7
|
+
|
|
8
|
+
Object.defineProperty(exports, "__esModule", {
|
|
9
|
+
value: true
|
|
10
|
+
});
|
|
11
|
+
exports.default = void 0;
|
|
12
|
+
var _react = _interopRequireDefault(require("react"));
|
|
13
|
+
var _baseNew = _interopRequireDefault(require("@atlaskit/icon/base-new"));
|
|
14
|
+
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
|
|
15
|
+
/**
|
|
16
|
+
* Icon: "TextReview".
|
|
17
|
+
* Category: single-purpose
|
|
18
|
+
* Location: @atlaskit/icon-lab
|
|
19
|
+
* Usage guidance: Editor action for reviewing text
|
|
20
|
+
* - [Examples](https://atlaskit.atlassian.com/packages/design-system/icon)
|
|
21
|
+
* - [Code](https://atlaskit.atlassian.com/packages/design-system/icon/docs/custom-icons)
|
|
22
|
+
*/
|
|
23
|
+
const TextReviewIcon = props => /*#__PURE__*/_react.default.createElement(_baseNew.default, Object.assign({
|
|
24
|
+
name: "TextReviewIcon",
|
|
25
|
+
dangerouslySetGlyph: `<path fill="currentcolor" d="m15.002 13.934-1.061 1.06-2.121-2.12 1.06-1.062z"/><path fill="currentcolor" d="M12.25 10a2.25 2.25 0 1 0-4.5 0 2.25 2.25 0 0 0 4.5 0m1.5 0a3.75 3.75 0 1 1-7.5 0 3.75 3.75 0 0 1 7.5 0M4.5 7.25v1.5H1v-1.5zm0 5.25V14H1v-1.5zM15 2v1.5H1V2z"/>`
|
|
26
|
+
// eslint-disable-next-line @repo/internal/react/no-unsafe-spread-props
|
|
27
|
+
}, props));
|
|
28
|
+
TextReviewIcon.displayName = 'TextReviewIcon';
|
|
29
|
+
var _default = exports.default = TextReviewIcon;
|
|
@@ -6,12 +6,5 @@
|
|
|
6
6
|
"sideEffects": [
|
|
7
7
|
"**/*.compiled.css"
|
|
8
8
|
],
|
|
9
|
-
"types": "../dist/types/entry-points/deprecated-map.d.ts"
|
|
10
|
-
"typesVersions": {
|
|
11
|
-
">=4.5 <5.9": {
|
|
12
|
-
"*": [
|
|
13
|
-
"../dist/types-ts4.5/entry-points/deprecated-map.d.ts"
|
|
14
|
-
]
|
|
15
|
-
}
|
|
16
|
-
}
|
|
9
|
+
"types": "../dist/types/entry-points/deprecated-map.d.ts"
|
|
17
10
|
}
|
|
@@ -9,7 +9,7 @@ exports.default = void 0;
|
|
|
9
9
|
*
|
|
10
10
|
* To change the format of this file, modify `createIconDocsNew` in icon-build-process/src/create-icon-docs.tsx.
|
|
11
11
|
*
|
|
12
|
-
* @codegen <<SignedSource::
|
|
12
|
+
* @codegen <<SignedSource::d57e8c1bcc50d513fe7e337d262fa51e>>
|
|
13
13
|
* @codegenCommand yarn build:icon-glyphs
|
|
14
14
|
*/
|
|
15
15
|
|
|
@@ -2612,7 +2612,7 @@ var metadata = {
|
|
|
2612
2612
|
package: '@atlaskit/icon-lab/core/journeys',
|
|
2613
2613
|
categorization: 'single-purpose',
|
|
2614
2614
|
usage: 'Reserved for representing Journeys in JSM.',
|
|
2615
|
-
team: 'JSM
|
|
2615
|
+
team: 'JSM Grape Soju',
|
|
2616
2616
|
status: 'published'
|
|
2617
2617
|
},
|
|
2618
2618
|
kanban: {
|
|
@@ -4012,6 +4012,15 @@ var metadata = {
|
|
|
4012
4012
|
team: 'Editor AI',
|
|
4013
4013
|
status: 'published'
|
|
4014
4014
|
},
|
|
4015
|
+
'text-review': {
|
|
4016
|
+
keywords: ['text-review', 'textreview', 'icon', 'icon-lab', 'examine', 'text', 'review'],
|
|
4017
|
+
componentName: 'TextReviewIcon',
|
|
4018
|
+
package: '@atlaskit/icon-lab/core/text-review',
|
|
4019
|
+
categorization: 'single-purpose',
|
|
4020
|
+
usage: 'Editor action for reviewing text',
|
|
4021
|
+
team: 'Editor',
|
|
4022
|
+
status: 'published'
|
|
4023
|
+
},
|
|
4015
4024
|
'text-small': {
|
|
4016
4025
|
keywords: ['text-small', 'textsmall', 'icon', 'icon-lab', 'text style', 'sm', 'text small'],
|
|
4017
4026
|
componentName: 'TextSmallIcon',
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*
|
|
4
4
|
* To change the format of this file, modify `createIconDocsNew` in icon-build-process/src/create-icon-docs.tsx.
|
|
5
5
|
*
|
|
6
|
-
* @codegen <<SignedSource::
|
|
6
|
+
* @codegen <<SignedSource::d57e8c1bcc50d513fe7e337d262fa51e>>
|
|
7
7
|
* @codegenCommand yarn build:icon-glyphs
|
|
8
8
|
*/
|
|
9
9
|
|
|
@@ -2606,7 +2606,7 @@ const metadata = {
|
|
|
2606
2606
|
package: '@atlaskit/icon-lab/core/journeys',
|
|
2607
2607
|
categorization: 'single-purpose',
|
|
2608
2608
|
usage: 'Reserved for representing Journeys in JSM.',
|
|
2609
|
-
team: 'JSM
|
|
2609
|
+
team: 'JSM Grape Soju',
|
|
2610
2610
|
status: 'published'
|
|
2611
2611
|
},
|
|
2612
2612
|
kanban: {
|
|
@@ -4006,6 +4006,15 @@ const metadata = {
|
|
|
4006
4006
|
team: 'Editor AI',
|
|
4007
4007
|
status: 'published'
|
|
4008
4008
|
},
|
|
4009
|
+
'text-review': {
|
|
4010
|
+
keywords: ['text-review', 'textreview', 'icon', 'icon-lab', 'examine', 'text', 'review'],
|
|
4011
|
+
componentName: 'TextReviewIcon',
|
|
4012
|
+
package: '@atlaskit/icon-lab/core/text-review',
|
|
4013
|
+
categorization: 'single-purpose',
|
|
4014
|
+
usage: 'Editor action for reviewing text',
|
|
4015
|
+
team: 'Editor',
|
|
4016
|
+
status: 'published'
|
|
4017
|
+
},
|
|
4009
4018
|
'text-small': {
|
|
4010
4019
|
keywords: ['text-small', 'textsmall', 'icon', 'icon-lab', 'text style', 'sm', 'text small'],
|
|
4011
4020
|
componentName: 'TextSmallIcon',
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*
|
|
4
4
|
* To change the format of this file, modify `createIconDocsNew` in icon-build-process/src/create-icon-docs.tsx.
|
|
5
5
|
*
|
|
6
|
-
* @codegen <<SignedSource::
|
|
6
|
+
* @codegen <<SignedSource::d57e8c1bcc50d513fe7e337d262fa51e>>
|
|
7
7
|
* @codegenCommand yarn build:icon-glyphs
|
|
8
8
|
*/
|
|
9
9
|
|
|
@@ -2606,7 +2606,7 @@ var metadata = {
|
|
|
2606
2606
|
package: '@atlaskit/icon-lab/core/journeys',
|
|
2607
2607
|
categorization: 'single-purpose',
|
|
2608
2608
|
usage: 'Reserved for representing Journeys in JSM.',
|
|
2609
|
-
team: 'JSM
|
|
2609
|
+
team: 'JSM Grape Soju',
|
|
2610
2610
|
status: 'published'
|
|
2611
2611
|
},
|
|
2612
2612
|
kanban: {
|
|
@@ -4006,6 +4006,15 @@ var metadata = {
|
|
|
4006
4006
|
team: 'Editor AI',
|
|
4007
4007
|
status: 'published'
|
|
4008
4008
|
},
|
|
4009
|
+
'text-review': {
|
|
4010
|
+
keywords: ['text-review', 'textreview', 'icon', 'icon-lab', 'examine', 'text', 'review'],
|
|
4011
|
+
componentName: 'TextReviewIcon',
|
|
4012
|
+
package: '@atlaskit/icon-lab/core/text-review',
|
|
4013
|
+
categorization: 'single-purpose',
|
|
4014
|
+
usage: 'Editor action for reviewing text',
|
|
4015
|
+
team: 'Editor',
|
|
4016
|
+
status: 'published'
|
|
4017
|
+
},
|
|
4009
4018
|
'text-small': {
|
|
4010
4019
|
keywords: ['text-small', 'textsmall', 'icon', 'icon-lab', 'text style', 'sm', 'text small'],
|
|
4011
4020
|
componentName: 'TextSmallIcon',
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*
|
|
4
4
|
* To change the format of this file, modify `createIconDocsNew` in icon-build-process/src/create-icon-docs.tsx.
|
|
5
5
|
*
|
|
6
|
-
* @codegen <<SignedSource::
|
|
6
|
+
* @codegen <<SignedSource::d57e8c1bcc50d513fe7e337d262fa51e>>
|
|
7
7
|
* @codegenCommand yarn build:icon-glyphs
|
|
8
8
|
*/
|
|
9
9
|
interface metadata {
|
package/metadata/package.json
CHANGED
|
@@ -6,12 +6,5 @@
|
|
|
6
6
|
"sideEffects": [
|
|
7
7
|
"**/*.compiled.css"
|
|
8
8
|
],
|
|
9
|
-
"types": "../dist/types/entry-points/metadata.d.ts"
|
|
10
|
-
"typesVersions": {
|
|
11
|
-
">=4.5 <5.9": {
|
|
12
|
-
"*": [
|
|
13
|
-
"../dist/types-ts4.5/entry-points/metadata.d.ts"
|
|
14
|
-
]
|
|
15
|
-
}
|
|
16
|
-
}
|
|
9
|
+
"types": "../dist/types/entry-points/metadata.d.ts"
|
|
17
10
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/icon-lab",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "7.1.0",
|
|
4
4
|
"description": "An icon package for public icon contributions",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -38,7 +38,8 @@
|
|
|
38
38
|
"build-glyphs": "ts-node --project ../../../tsconfig.node.json ./build/index.tsx"
|
|
39
39
|
},
|
|
40
40
|
"dependencies": {
|
|
41
|
-
"@atlaskit/icon": "^
|
|
41
|
+
"@atlaskit/icon": "^36.0.0",
|
|
42
|
+
"@atlassian/react-compiler-gating": "^0.2.0",
|
|
42
43
|
"@babel/runtime": "^7.0.0"
|
|
43
44
|
},
|
|
44
45
|
"peerDependencies": {
|
|
@@ -47,15 +48,14 @@
|
|
|
47
48
|
"devDependencies": {
|
|
48
49
|
"@af/icon-build-process": "workspace:^",
|
|
49
50
|
"@af/visual-regression": "workspace:^",
|
|
50
|
-
"@atlaskit/button": "^
|
|
51
|
-
"@atlaskit/code": "^
|
|
52
|
-
"@atlaskit/heading": "^
|
|
53
|
-
"@atlaskit/modal-dialog": "^
|
|
54
|
-
"@atlaskit/primitives": "^
|
|
55
|
-
"@atlaskit/textfield": "^
|
|
56
|
-
"@atlaskit/tokens": "^
|
|
57
|
-
"@atlaskit/tooltip": "^
|
|
58
|
-
"@atlassian/react-compiler-gating": "workspace:^",
|
|
51
|
+
"@atlaskit/button": "^24.1.0",
|
|
52
|
+
"@atlaskit/code": "^18.0.0",
|
|
53
|
+
"@atlaskit/heading": "^6.0.0",
|
|
54
|
+
"@atlaskit/modal-dialog": "^16.0.0",
|
|
55
|
+
"@atlaskit/primitives": "^20.0.0",
|
|
56
|
+
"@atlaskit/textfield": "^9.0.0",
|
|
57
|
+
"@atlaskit/tokens": "^15.0.0",
|
|
58
|
+
"@atlaskit/tooltip": "^23.0.0",
|
|
59
59
|
"@atlassian/ssr-tests": "workspace:^",
|
|
60
60
|
"@compiled/react": "^0.20.0",
|
|
61
61
|
"@testing-library/react": "^16.3.0",
|
|
@@ -86,13 +86,5 @@
|
|
|
86
86
|
"deprecation": "no-deprecated-imports"
|
|
87
87
|
}
|
|
88
88
|
},
|
|
89
|
-
"typesVersions": {
|
|
90
|
-
">=4.5 <5.4": {
|
|
91
|
-
"*": [
|
|
92
|
-
"dist/types-ts4.5/*",
|
|
93
|
-
"dist/types-ts4.5/index.d.ts"
|
|
94
|
-
]
|
|
95
|
-
}
|
|
96
|
-
},
|
|
97
89
|
"homepage": "https://atlaskit.atlassian.com/packages/design-system/icon-lab"
|
|
98
90
|
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<svg width="16" height="16" fill="none" viewBox="0 0 16 16"><path fill="currentcolor" d="m15.002 13.934-1.061 1.06-2.121-2.12 1.06-1.062z"/><path fill="currentcolor" d="M12.25 10a2.25 2.25 0 1 0-4.5 0 2.25 2.25 0 0 0 4.5 0m1.5 0a3.75 3.75 0 1 1-7.5 0 3.75 3.75 0 0 1 7.5 0M4.5 7.25v1.5H1v-1.5zm0 5.25V14H1v-1.5zM15 2v1.5H1V2z"/></svg>
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
|
|
3
|
-
*
|
|
4
|
-
* To change the format of this file, modify `createDeprecatedIconDocs` in icon-build-process/src/create-deprecated-icon-docs.tsx.
|
|
5
|
-
*
|
|
6
|
-
* @codegen <<SignedSource::76fab6ad916e9e2ad7e252306192ad79>>
|
|
7
|
-
* @codegenCommand yarn build:icon-glyphs
|
|
8
|
-
*/
|
|
9
|
-
declare const deprecatedIcons: Record<string, {
|
|
10
|
-
message: string;
|
|
11
|
-
unfixable?: boolean;
|
|
12
|
-
}>;
|
|
13
|
-
export default deprecatedIcons;
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
|
|
3
|
-
*
|
|
4
|
-
* To change the format of this file, modify `createDeprecatedIconDocs` in icon-build-process/src/create-deprecated-icon-docs.tsx.
|
|
5
|
-
*
|
|
6
|
-
* @codegen <<SignedSource::8445ed95dffea52ddea417fc5752ff90>>
|
|
7
|
-
* @codegenCommand yarn build:icon-glyphs
|
|
8
|
-
*/
|
|
9
|
-
declare const deprecatedIcons: Record<string, {
|
|
10
|
-
message: string;
|
|
11
|
-
unfixable?: boolean;
|
|
12
|
-
}>;
|
|
13
|
-
export default deprecatedIcons;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { default } from '../metadata-core';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { default as metadata } from './entry-points/metadata';
|
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
|
|
3
|
-
*
|
|
4
|
-
* To change the format of this file, modify `createIconDocsNew` in icon-build-process/src/create-icon-docs.tsx.
|
|
5
|
-
*
|
|
6
|
-
* @codegen <<SignedSource::008bc20aa9b7cbdbfc570d8ba3f1af54>>
|
|
7
|
-
* @codegenCommand yarn build:icon-glyphs
|
|
8
|
-
*/
|
|
9
|
-
interface metadata {
|
|
10
|
-
/**
|
|
11
|
-
* Default component name for the icon
|
|
12
|
-
*/
|
|
13
|
-
componentName: string;
|
|
14
|
-
/**
|
|
15
|
-
* Package path to the icon component
|
|
16
|
-
*/
|
|
17
|
-
package: string;
|
|
18
|
-
/**
|
|
19
|
-
* The category of the icon:
|
|
20
|
-
* - 'single-purpose' icons should only be used for the purposes listed in the 'usage' field
|
|
21
|
-
* - 'multi-purpose' icons are designed for various use cases and don't have the same usage restrictions
|
|
22
|
-
*/
|
|
23
|
-
categorization: 'single-purpose' | 'multi-purpose';
|
|
24
|
-
/**
|
|
25
|
-
* Usage guidelines for the icon. For single-purpose icons,
|
|
26
|
-
*/
|
|
27
|
-
usage?: string;
|
|
28
|
-
/**
|
|
29
|
-
* Additional keywords used to assist in search/lookup of an icon
|
|
30
|
-
*/
|
|
31
|
-
keywords: string[];
|
|
32
|
-
/**
|
|
33
|
-
* The name of the team owning the icon
|
|
34
|
-
*/
|
|
35
|
-
team: string;
|
|
36
|
-
/**
|
|
37
|
-
* The status of the icon
|
|
38
|
-
*/
|
|
39
|
-
status?: 'draft' | 'ready-to-publish' | 'published' | 'modified' | 'deprecated';
|
|
40
|
-
/**
|
|
41
|
-
* Contact slack channel for the team owning the icon
|
|
42
|
-
*/
|
|
43
|
-
slackChannel?: string;
|
|
44
|
-
/**
|
|
45
|
-
* A replacement icon if this icon has been deprecated
|
|
46
|
-
*/
|
|
47
|
-
replacement?: {
|
|
48
|
-
name: string;
|
|
49
|
-
location: '@atlaskit/icon' | '@atlaskit/icon-lab' | '@atlassian/icon-private';
|
|
50
|
-
};
|
|
51
|
-
/**
|
|
52
|
-
* Whether the icon should be recommended as a small icon
|
|
53
|
-
*/
|
|
54
|
-
shouldRecommendSmallIcon?: boolean;
|
|
55
|
-
}
|
|
56
|
-
declare const metadata: Record<string, metadata>;
|
|
57
|
-
export default metadata;
|
|
@@ -1,63 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
|
|
3
|
-
*
|
|
4
|
-
* To change the format of this file, modify `createIconDocsNew` in icon-build-process/src/create-icon-docs.tsx.
|
|
5
|
-
*
|
|
6
|
-
* @codegen <<SignedSource::04af6dfad1ade5135739e980e9e566f4>>
|
|
7
|
-
* @codegenCommand yarn build:icon-glyphs
|
|
8
|
-
*/
|
|
9
|
-
interface metadata {
|
|
10
|
-
/**
|
|
11
|
-
* Default component name for the icon
|
|
12
|
-
*/
|
|
13
|
-
componentName: string;
|
|
14
|
-
/**
|
|
15
|
-
* Package path to the icon component
|
|
16
|
-
*/
|
|
17
|
-
package: string;
|
|
18
|
-
/**
|
|
19
|
-
* The category of the icon:
|
|
20
|
-
* - 'single-purpose' icons should only be used for the purposes listed in the 'usage' field
|
|
21
|
-
* - 'multi-purpose' icons are designed for various use cases and don't have the same usage restrictions
|
|
22
|
-
* - 'utility' icons are used for utility purposes
|
|
23
|
-
*/
|
|
24
|
-
categorization: 'single-purpose' | 'multi-purpose' | 'utility';
|
|
25
|
-
/**
|
|
26
|
-
* The type of the icon - either a 16px 'core' icon, or a 12px 'utility' icon
|
|
27
|
-
*/
|
|
28
|
-
type: 'core' | 'utility';
|
|
29
|
-
/**
|
|
30
|
-
* Usage guidelines for the icon. For single-purpose icons,
|
|
31
|
-
*/
|
|
32
|
-
usage?: string;
|
|
33
|
-
/**
|
|
34
|
-
* Additional keywords used to assist in search/lookup of an icon
|
|
35
|
-
*/
|
|
36
|
-
keywords: string[];
|
|
37
|
-
/**
|
|
38
|
-
* The name of the team owning the icon
|
|
39
|
-
*/
|
|
40
|
-
team: string;
|
|
41
|
-
/**
|
|
42
|
-
* The status of the icon
|
|
43
|
-
*/
|
|
44
|
-
status?: 'draft' | 'ready-to-publish' | 'published' | 'modified' | 'deprecated';
|
|
45
|
-
/**
|
|
46
|
-
* Contact slack channel for the team owning the icon
|
|
47
|
-
*/
|
|
48
|
-
slackChannel?: string;
|
|
49
|
-
/**
|
|
50
|
-
* A replacement icon if this icon has been deprecated
|
|
51
|
-
*/
|
|
52
|
-
replacement?: {
|
|
53
|
-
name: string;
|
|
54
|
-
type: 'core' | 'utility';
|
|
55
|
-
location: '@atlaskit/icon' | '@atlaskit/icon-lab' | '@atlassian/icon-private';
|
|
56
|
-
};
|
|
57
|
-
/**
|
|
58
|
-
* Whether the icon should be recommended as a small icon
|
|
59
|
-
*/
|
|
60
|
-
shouldRecommendSmallIcon?: boolean;
|
|
61
|
-
}
|
|
62
|
-
declare const metadata: Record<string, metadata>;
|
|
63
|
-
export default metadata;
|