@atlaskit/icon-object 6.2.4 → 6.2.7

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlaskit/icon-object
 
+## 6.2.7
+
+### Patch Changes
+
+- [`f0be7593aa3`](https://bitbucket.org/atlassian/atlassian-frontend/commits/f0be7593aa3) - Internal code change turning on new linting rules.
+
+## 6.2.6
+
+### Patch Changes
+
+- [`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.
+
+## 6.2.5
+
+### Patch Changes
+
+- [`378d1cef00f`](https://bitbucket.org/atlassian/atlassian-frontend/commits/378d1cef00f) - Bump `@atlaskit/theme` to version `^11.3.0`.
+
 ## 6.2.4
 
 ### Patch Changes

package/__tests__/visual-regression/__image_snapshots__/icon-object-snapshots-test-tsx-icon-priority-snapshots-should-match-dark-mode-icons-1-snap.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:3976e9ac0796692096e936eb75935eca70183e1ed08df632563163b8c9997716
+size 8774

package/build/index.tsx

@@ -0,0 +1,45 @@
+import path from 'path';
+import { build, createIconDocs, tidy } from '@af/icon-build-process';
+import type { IconBuildConfig } from '@af/icon-build-process';
+import pkgDir from 'pkg-dir';
+import fs from 'fs-extra';
+
+const root = pkgDir.sync();
+
+const config16: IconBuildConfig = {
+  srcDir: path.resolve(root!, 'svgs_raw'),
+  processedDir: path.resolve(root!, 'svgs'),
+  destDir: path.resolve(root!, 'glyph'),
+  maxWidth: 16,
+  maxHeight: 16,
+  glob: '**/16.svg',
+  size: 'small',
+  baseIconEntryPoint: '@atlaskit/icon/base',
+  isColorsDisabled: true,
+};
+
+const config24: IconBuildConfig = {
+  srcDir: path.resolve(root!, 'svgs_raw'),
+  processedDir: path.resolve(root!, 'svgs'),
+  destDir: path.resolve(root!, 'glyph'),
+  maxWidth: 24,
+  maxHeight: 24,
+  glob: '**/24.svg',
+  size: 'medium',
+  baseIconEntryPoint: '@atlaskit/icon/base',
+  isColorsDisabled: true,
+};
+
+tidy(config16)
+  .then(() => Promise.all([build(config16), build(config24)]))
+  .then(([sixteen, twentyfour]) => {
+    const allIcons = [...sixteen, ...twentyfour];
+    const iconDocs = createIconDocs(allIcons, '@atlaskit/icon-object', {}, [
+      'object',
+      'icon-object',
+    ]);
+
+    console.log('@atlaskit-icon-object built');
+
+    return fs.outputFile(path.resolve(root!, 'src/metadata.ts'), iconDocs);
+  });

package/build/tsconfig.json

@@ -9,5 +9,9 @@
     "../src/**/*.ts",
     "../src/**/*.tsx"
   ],
-  "exclude": ["../src/**/__tests__/*"]
-}
+  "exclude": [
+    "../src/**/__tests__/*",
+    "../src/**/*.test.*",
+    "../src/**/test.*"
+  ]
+}

package/constellation/index/examples.mdx

@@ -0,0 +1,26 @@
+---
+order: 1
+---
+
+import IconObject16 from '../../examples/constellation/icon-object-16.tsx'
+import IconObject24 from '../../examples/constellation/icon-object-24.tsx'
+
+## Sizing
+
+### Small
+
+Use the small size when space is at a premium.
+
+Elements in this icon are simplified, rearranged or filled in because there is significantly less space. 
+
+This icon is designed on a 16px grid and uses 1px strokes.
+
+<Example Component={IconObject16} packageName='@atlaskit/icon-object'/>
+
+### Medium
+
+The medium size (24px) is used in common interfaces.
+
+This icon is designed on a 20px grid (on 24px artboard) and uses 2px strokes.
+
+<Example Component={IconObject24} packageName='@atlaskit/icon-object'/>

package/constellation/index/icon-explorer.mdx

@@ -0,0 +1,11 @@
+---
+order: 0
+---
+
+import IconExplorer from '@af/icon-explorer'
+
+## Icon explorer
+
+Search and copy icon import paths from the `@atlaskit/icon-object` package. Select an icon to copy import to clipboard.
+
+<IconExplorer iconType="object" />

package/constellation/index/props.mdx

@@ -0,0 +1,5 @@
+import IconObjectProps from '!!extract-react-types-loader!../../../icon/src/extract-react-types/glyph-no-color-size.tsx';
+
+## Props
+
+<PropsTable heading="" props={IconObjectProps} />

package/constellation/index/usage.mdx

@@ -0,0 +1,39 @@
+---
+order: 3
+---
+
+## Usage
+
+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.
+
+Unlike a standard icon, object icons help people identify the content type fast. This reduces cognitive load for people across products and platforms.
+
+Object icons can be in:
+- Search
+- Media cards
+- Smart cards
+- Attachment uploads
+- Activity feeds
+- Inline links
+
+## Anatomy
+
+![Icon Object Anatomy](images/icon-object-anatomy.png)
+
+## Best practices
+
+### Color
+
+Object icons are assigned specific colors. For cross-product and platform consistency, don’t change the color of the object icon.
+
+## Accessibility
+
+![Icon Object with tooltip](images/icon-object-tooltip.png)
+
+- Use object icons in combination with a title and meta-information, such as author, creation date, or sub-heading.
+- Pair object icons with [tooltips](/components/tooltip). On hover, the tooltip reveals the specific content type of the icon.
+
+## Related
+
+- [Icon](/components/icon)
+

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/icon-object",
-	"version": "6.2.4",
+	"version": "6.2.7",
 	"sideEffects": false
 }

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/icon-object",
-	"version": "6.2.4",
+	"version": "6.2.7",
 	"sideEffects": false
 }

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/icon-object",
-	"version": "6.2.4",
+	"version": "6.2.7",
 	"sideEffects": false
 }

package/docs/0-intro.tsx

@@ -1,22 +1,15 @@
 import React from 'react';
-import { md, Props } from '@atlaskit/docs';
-import IconExplorer from '../examples/icon-explorer';
 
-export default md`
-  ## Icon explorer
-
-  ${(
-    <p>
-      <IconExplorer />
-    </p>
-  )}
+import { md } from '@atlaskit/docs';
+import SectionMessage from '@atlaskit/section-message';
 
-  ### Props
-
-  ${(
-    <Props
-      heading=""
-      props={require('!!extract-react-types-loader!../../icon/src/extract-react-types/glyph-no-color-size.tsx')}
-    />
-  )}
+export default md`
+${(
+  <SectionMessage appearance="information">
+    This component is now documented on{' '}
+    <a href="https://atlassian.design/components/icon-object">
+      atlassian.design
+    </a>
+  </SectionMessage>
+)}
 `;

package/metadata/package.json

@@ -3,5 +3,6 @@
   "main": "../dist/cjs/entry-points/metadata.js",
   "module": "../dist/esm/entry-points/metadata.js",
   "module:es2019": "../dist/es2019/entry-points/metadata.js",
+  "sideEffects": false,
   "types": "../dist/types/entry-points/metadata.d.ts"
 }

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@atlaskit/icon-object",
-  "version": "6.2.4",
-  "description": "An object icon is used to represent an entity specific to a product, such as a pull request for Bitbucket.",
+  "version": "6.2.7",
+  "description": "An object icon is used to represent an Atlassian-specific content type.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
-  "repository": "https://bitbucket.org/atlassian/atlassian-frontend",
+  "repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
+  "homepage": "https://atlassian.design/components/icon-object/",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
-  "atlaskit:src": "src/index.ts",
+  "atlaskit:src": "src/index.tsx",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "module:es2019": "dist/es2019/index.js",
@@ -16,22 +17,22 @@
   "sideEffects": false,
   "atlassian": {
     "team": "Design System Team",
-    "inPublicMirror": true,
     "releaseModel": "scheduled",
     "website": {
-      "name": "Icon Object"
+      "name": "Icon object",
+      "category": "Components"
     }
   },
   "af:exports": {
-    "./metadata": "./src/entry-points/metadata.ts",
+    "./metadata": "./src/entry-points/metadata.tsx",
     "./glyph": "./glyph",
-    ".": "./src/index.ts"
+    ".": "./src/index.tsx"
   },
   "scripts": {
-    "build-glyphs": "ts-node --project ../../../tsconfig.node.json ./build/index.ts"
+    "build-glyphs": "ts-node --project ../../../tsconfig.node.json ./build/index.tsx"
   },
   "dependencies": {
-    "@atlaskit/icon": "^21.5.0",
+    "@atlaskit/icon": "^21.10.0",
     "@babel/runtime": "^7.0.0"
   },
   "peerDependencies": {
@@ -39,20 +40,21 @@
   },
   "devDependencies": {
     "@af/icon-build-process": "^0.3.0",
-    "@atlaskit/build-utils": "*",
-    "@atlaskit/button": "^15.1.0",
+    "@af/icon-explorer": "^0.0.5",
+    "@atlaskit/button": "^16.3.0",
     "@atlaskit/docs": "*",
-    "@atlaskit/modal-dialog": "^11.7.0",
+    "@atlaskit/modal-dialog": "^12.2.0",
+    "@atlaskit/section-message": "^6.1.0",
     "@atlaskit/ssr": "*",
     "@atlaskit/textfield": "^5.0.0",
-    "@atlaskit/theme": "^11.0.0",
-    "@atlaskit/tooltip": "^17.2.0",
+    "@atlaskit/theme": "^12.1.0",
+    "@atlaskit/tooltip": "^17.5.0",
     "@atlaskit/visual-regression": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@emotion/styled": "^10.0.7",
     "enzyme": "^3.10.0",
     "fs-extra": "^4.0.2",
-    "jscodeshift": "^0.11.0",
+    "jscodeshift": "^0.13.0",
     "pkg-dir": "^4.2.0",
     "react-dom": "^16.8.0"
   },
@@ -60,5 +62,15 @@
     "atlaskit",
     "ui"
   ],
+  "techstack": {
+    "@repo/internal": {
+      "design-system": "v1",
+      "dom-events": "use-bind-event-listener",
+      "theming": "tokens",
+      "styling": [
+        "static"
+      ]
+    }
+  },
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"
 }

package/report.api.md

@@ -0,0 +1,11 @@
+## API Report File for "@atlaskit/icon-object"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+import { default as default_2 } from '@atlaskit/icon/base';
+
+export default default_2;
+
+export {};
+```

package/__tests__/visual-regression/__image_snapshots__/icon-object-snapshots-test-ts-icon-priority-snapshots-should-match-dark-mode-icons-1-snap.png

@@ -1,3 +0,0 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:ee1d20a907fb171f742ef62fa8f4624c01316db5a5458620e46e067401d978ec
-size 8775