@atlaskit/icon-object 6.2.5 → 6.2.6

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,11 @@
1
1
  # @atlaskit/icon-object
2
2
 
3
+ ## 6.2.6
4
+
5
+ ### Patch Changes
6
+
7
+ - [`b3e5a62a9e3`](https://bitbucket.org/atlassian/atlassian-frontend/commits/b3e5a62a9e3) - Adds `static` techstack to package, enforcing stricter style linting. In this case the package already satisfied this requirement so there have been no changes to styles.
8
+
3
9
  ## 6.2.5
4
10
 
5
11
  ### Patch Changes
@@ -1,3 +1,3 @@
1
1
  version https://git-lfs.github.com/spec/v1
2
- oid sha256:ee1d20a907fb171f742ef62fa8f4624c01316db5a5458620e46e067401d978ec
3
- size 8775
2
+ oid sha256:3976e9ac0796692096e936eb75935eca70183e1ed08df632563163b8c9997716
3
+ size 8774
@@ -0,0 +1,26 @@
1
+ ---
2
+ order: 1
3
+ ---
4
+
5
+ import IconObject16 from '../../examples/constellation/icon-object-16.tsx'
6
+ import IconObject24 from '../../examples/constellation/icon-object-24.tsx'
7
+
8
+ ## Sizing
9
+
10
+ ### Small
11
+
12
+ Use the small size when space is at a premium.
13
+
14
+ Elements in this icon are simplified, rearranged or filled in because there is significantly less space.
15
+
16
+ This icon is designed on a 16px grid and uses 1px strokes.
17
+
18
+ <Example Component={IconObject16} packageName='@atlaskit/icon-object'/>
19
+
20
+ ### Medium
21
+
22
+ The medium size (24px) is used in common interfaces.
23
+
24
+ This icon is designed on a 20px grid (on 24px artboard) and uses 2px strokes.
25
+
26
+ <Example Component={IconObject24} packageName='@atlaskit/icon-object'/>
@@ -0,0 +1,11 @@
1
+ ---
2
+ order: 0
3
+ ---
4
+
5
+ import IconExplorer from '@af/icon-explorer'
6
+
7
+ ## Icon explorer
8
+
9
+ Search and copy icon import paths from the `@atlaskit/icon-object` package. Select an icon to copy import to clipboard.
10
+
11
+ <IconExplorer iconType="object" />
@@ -0,0 +1,3 @@
1
+ import IconObjectProps from '!!extract-react-types-loader!../../../icon/src/extract-react-types/glyph-no-color-size.tsx';
2
+
3
+ <PropsTable heading="" props={IconObjectProps} />
@@ -0,0 +1,39 @@
1
+ ---
2
+ order: 3
3
+ ---
4
+
5
+ ## Usage
6
+
7
+ Object icons represent an Atlassian-specific content type. They can trigger actions such as opening a page in Confluence, an issue in Jira, or a pull request in Bitbucket.
8
+
9
+ Unlike a standard icon, object icons help people identify the content type fast. This reduces cognitive load for people across products and platforms.
10
+
11
+ Object icons can be in:
12
+ - Search
13
+ - Media cards
14
+ - Smart cards
15
+ - Attachment uploads
16
+ - Activity feeds
17
+ - Inline links
18
+
19
+ ## Anatomy
20
+
21
+ ![Icon Object Anatomy](images/icon-object-anatomy.png)
22
+
23
+ ## Best practices
24
+
25
+ ### Color
26
+
27
+ Object icons are assigned specific colors. For cross-product and platform consistency, don’t change the color of the object icon.
28
+
29
+ ## Accessibility
30
+
31
+ ![Icon Object with tooltip](images/icon-object-tooltip.png)
32
+
33
+ - Use object icons in combination with a title and meta-information, such as author, creation date, or sub-heading.
34
+ - Pair object icons with [tooltips](/components/tooltip). On hover, the tooltip reveals the specific content type of the icon.
35
+
36
+ ## Related
37
+
38
+ - [Icon](/components/icon)
39
+
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/icon-object",
3
- "version": "6.2.5",
3
+ "version": "6.2.6",
4
4
  "sideEffects": false
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/icon-object",
3
- "version": "6.2.5",
3
+ "version": "6.2.6",
4
4
  "sideEffects": false
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/icon-object",
3
- "version": "6.2.5",
3
+ "version": "6.2.6",
4
4
  "sideEffects": false
5
5
  }
package/docs/0-intro.tsx CHANGED
@@ -1,22 +1,15 @@
1
1
  import React from 'react';
2
- import { md, Props } from '@atlaskit/docs';
3
- import IconExplorer from '../examples/icon-explorer';
4
2
 
5
- export default md`
6
- ## Icon explorer
7
-
8
- ${(
9
- <p>
10
- <IconExplorer />
11
- </p>
12
- )}
3
+ import { md } from '@atlaskit/docs';
4
+ import SectionMessage from '@atlaskit/section-message';
13
5
 
14
- ### Props
15
-
16
- ${(
17
- <Props
18
- heading=""
19
- props={require('!!extract-react-types-loader!../../icon/src/extract-react-types/glyph-no-color-size.tsx')}
20
- />
21
- )}
6
+ export default md`
7
+ ${(
8
+ <SectionMessage appearance="information">
9
+ This component is now documented on{' '}
10
+ <a href="https://atlassian.design/components/icon-object">
11
+ atlassian.design
12
+ </a>
13
+ </SectionMessage>
14
+ )}
22
15
  `;
package/package.json CHANGED
@@ -1,11 +1,12 @@
1
1
  {
2
2
  "name": "@atlaskit/icon-object",
3
- "version": "6.2.5",
4
- "description": "An object icon is used to represent an entity specific to a product, such as a pull request for Bitbucket.",
3
+ "version": "6.2.6",
4
+ "description": "An object icon is used to represent an Atlassian-specific content type.",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
7
7
  },
8
8
  "repository": "https://bitbucket.org/atlassian/atlassian-frontend",
9
+ "homepage": "https://atlassian.design/components/icon-object/",
9
10
  "author": "Atlassian Pty Ltd",
10
11
  "license": "Apache-2.0",
11
12
  "atlaskit:src": "src/index.ts",
@@ -16,10 +17,9 @@
16
17
  "sideEffects": false,
17
18
  "atlassian": {
18
19
  "team": "Design System Team",
19
- "inPublicMirror": true,
20
20
  "releaseModel": "scheduled",
21
21
  "website": {
22
- "name": "Icon Object"
22
+ "name": "Icon object"
23
23
  }
24
24
  },
25
25
  "af:exports": {
@@ -31,7 +31,7 @@
31
31
  "build-glyphs": "ts-node --project ../../../tsconfig.node.json ./build/index.ts"
32
32
  },
33
33
  "dependencies": {
34
- "@atlaskit/icon": "^21.5.0",
34
+ "@atlaskit/icon": "^21.10.0",
35
35
  "@babel/runtime": "^7.0.0"
36
36
  },
37
37
  "peerDependencies": {
@@ -39,14 +39,15 @@
39
39
  },
40
40
  "devDependencies": {
41
41
  "@af/icon-build-process": "^0.3.0",
42
- "@atlaskit/build-utils": "*",
43
- "@atlaskit/button": "^15.1.0",
42
+ "@af/icon-explorer": "^0.0.2",
43
+ "@atlaskit/button": "^16.2.0",
44
44
  "@atlaskit/docs": "*",
45
- "@atlaskit/modal-dialog": "^11.7.0",
45
+ "@atlaskit/modal-dialog": "^12.2.0",
46
+ "@atlaskit/section-message": "^6.1.0",
46
47
  "@atlaskit/ssr": "*",
47
48
  "@atlaskit/textfield": "^5.0.0",
48
- "@atlaskit/theme": "^11.3.0",
49
- "@atlaskit/tooltip": "^17.2.0",
49
+ "@atlaskit/theme": "^12.1.0",
50
+ "@atlaskit/tooltip": "^17.5.0",
50
51
  "@atlaskit/visual-regression": "*",
51
52
  "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
52
53
  "@emotion/styled": "^10.0.7",
@@ -60,5 +61,13 @@
60
61
  "atlaskit",
61
62
  "ui"
62
63
  ],
64
+ "techstack": {
65
+ "@repo/internal": {
66
+ "theming": "tokens",
67
+ "styling": [
68
+ "static"
69
+ ]
70
+ }
71
+ },
63
72
  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"
64
73
  }