Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@kalamazoo/icon

stevenselcuk40SEE LICENSE IN LICENSE1.0.2TypeScript support: included

A React package that contains icons

atlaskit, ui

readme

Icon

A React package that contains icons.

Installation

yarn add @kalamazoo/icon

Usage

Detailed docs and example usage can be found here.

BEFORE YOU CHANGE ICONS

!!IMPORTANT

The icons package has a custom build process, as it generates its both stripped svgs and glyphs that are committed to the repo, so that they can be accessed as paths when published.

You will manually need to run yarn update:icons from the root repository, or yarn build from inside the icon folder whenever you make changes to icon.

New Icons should be added to /packages/core/icon/svgs_raw/.

NOTE: The reduced-ui-pack package should contain all the icons we include in this package. Make sure to rebuild the reduced-ui-pack sprite as outlined in the README.md file included within that package.

If your icon is used only in a specific context or product, place it in /icon/src/icons/subfolder and it will be namespaced appropriately.

changelog

@kalamazoo/icon

19.0.11

Patch Changes

19.0.10

Patch Changes

  • [patch]6d37081dc8:

    Upgrade prettier from 1.18 to 1.19

19.0.9

Patch Changes

  • [patch]f081cdac54:

    Upgrade prettier from 1.14 to 1.18

19.0.8

Patch Changes

  • [patch]f9b5e24662:

    @kalamazoo/icon-file-type and @kalamazoo/icon-object have been converted to TypeScript to provide static typing. Flow types are no longer provided. No API or bahavioural changes.

19.0.7

Patch Changes

  • [patch]3c7bee089a:

    @kalamazoo/icon-priority has been converted to TypeScript to provide static typing. Flow types are no longer provided. No API or bahavioural changes.

19.0.6

Patch Changes

  • [patch]097b696613:

    Components now depend on TS 3.6 internally, in order to fix an issue with TS resolving non-relative imports as relative imports

19.0.5

Patch Changes

19.0.4

Patch Changes

  • [patch]708028db86:

    Change all the imports to theme in Core to use multi entry points

19.0.3

Patch Changes

  • [patch]de35ce8c67:

    Updates component maintainers

19.0.2

19.0.1

Patch Changes

19.0.0

Major Changes

  • [major]06326ef3f7:

    @kalamazoo/icon has been converted to TypeScript to provide static typing. Flow types are no longer provided. No API or bahavioural changes.

18.0.5

Patch Changes

  • [patch]56eae512a3:

    Updated the icon for Premium and cleaned up reduced-ui-pack sprite

18.0.4

Patch Changes

  • [patch]4615439434:

    index.ts will now be ignored when publishing to npm

18.0.3

Patch Changes

18.0.2

Patch Changes

  • [patch]0d7be7e6fc:

    All icons are breaking since the Typescript conversion. Revert PR 5769#

18.0.1

18.0.0

Major Changes

  • [major]cfc3c8adb3:

    • @kalamazoo/icon has been converted to TypeScript to provide static typing. Flow types are no longer provided. No API or bahavioural changes.

17.2.0

  • [minor]70862830d6:

    • Checkbox has been converted to Typescript. Typescript consumers will now get static type safety. Flow types are no longer provided. No API or behavioural changes.

17.1.3

  • [patch]b0ef06c685:

    • This is just a safety release in case anything strange happened in in the previous one. See Pull Request #5942 for details

17.1.2

17.1.1

17.1.0

  • [minor]8f4f5d914a:

    • Updated home-circle icon and replaced home-filled icon with new home icon

17.0.2

17.0.1

17.0.0

  • [major]7c17b35107:

    • Updates react and react-dom peer dependencies to react@^16.8.0 and react-dom@^16.8.0. To use this package, please ensure you use at least this version of react and react-dom.

16.0.9

16.0.8

16.0.7

  • [patch]a143c9758f:

    • New Icon: Add the PremiumIcon

16.0.6

  • [patch]98e11001ff:

    • Removes duplicate babel-runtime dependency

16.0.5

16.0.4

16.0.3

16.0.2

16.0.1

16.0.0

15.0.3

  • [patch]1d1f6d1:

    • Make icon glyphs not import metadata

15.0.2

15.0.1

15.0.0

  • [major]ab9b69c:

    • Removed onClick prop as icon is only a presentational placeholder. Please wrap your icon in a Button or a Link component and add onClick to that instead.

14.6.1

14.6.0

  • [minor]29968f4:

    • Add a menu expand icon

14.5.0

14.4.0

14.3.0

  • [minor]dced9bf:

    • Remove StarOutlineIcon as it is not used

14.2.1

  • [patch]d15caa6:

    • adding editor image alignment icons

14.2.0

14.1.0

14.0.3

  • [patch] Update to use babel-7 for build processes e7bb74d

14.0.2

  • [patch] Adds missing implicit @babel/runtime dependency b71751b

14.0.1

  • [patch] Change devDependency on sectionMessage to caret dependency 91a3ced

14.0.0

  • [major] Remove product logo icons from icons, recommend using @kalamazoo/logo instead 65c6514
    • The following logo exports have been removed:
      • AtlassianIcon
      • BitbucketIcon
      • ConfluenceIcon
      • HipchatIcon
      • JiraCoreIcon
      • JiraServiceDeskIcon
      • JiraSoftwareIcon
      • JiraIcon
      • StatuspageIcon
      • StrideIcon
    • Check the Upgrade Guide for more information.
  • [patch] Updated dependencies 709b239

13.9.0

13.8.1

13.8.0

  • [minor] Add the questions icon ad96a89

13.7.0

  • [minor] Add and edit star icons 55e3ec7

13.6.1

  • [patch] Adds sideEffects: false to allow proper tree shaking b5d6d04

13.6.0

  • [minor] Add static displayName prop to all icons. This results in accurate display names even after minifying and uglifying the icon variable names. a75db9d

13.5.0

  • [minor] Add the new child-issues icon 8d3f8dd

13.4.0

  • [minor] Add the new check circle outline 22af4c5

13.3.0

  • [minor] Add new icon d36f760
  • [patch] Add new icon for Roadmap 7cf05b3

13.2.6

  • [patch] Update warning message and fix test for reduced-ui-pack 4b166d8
  • [none] Updated dependencies 4b166d8

13.2.5

13.2.4

13.2.3

  • [patch] Added pointer-events: none targeting the <svg> element within the Icon component to prevent type errors in JS b755d8a
  • [none] Updated dependencies b755d8a

13.2.2

13.2.1

13.2.0

  • [minor] Add Layout Type icons for the Editor. ED-4196 259ef37
  • [none] Updated dependencies 259ef37

13.1.1

13.1.0

  • [minor] Add a new star large icon 5dd7d0e
  • [none] Updated dependencies 5dd7d0e

13.0.0

12.8.0

  • [minor] Add new media viewer icons and replace existing ones 623a2a0
  • [none] Updated dependencies 623a2a0

12.7.0

  • [minor] Add chevron large icons 086b5d7
  • [none] Updated dependencies 086b5d7

12.6.2

  • [patch] Prevent icons shrinking when they are flex-children a78cd4d
  • [none] Updated dependencies a78cd4d

12.6.1

12.6.0

  • [minor] Add a new badge id: department and suitcase e46ff5e
  • [none] Updated dependencies e46ff5e

12.5.1

  • [patch] Update to select-clear icon to allow for primaryColor and secondaryColor configuration 216b20d
  • [none] Updated dependencies 216b20d

12.5.0

  • [minor] Added select-clear icon 91ab036
  • [none] Updated dependencies 91ab036

12.4.0

  • [minor] Add the new app-switcher icon 8c0cacd
  • [none] Updated dependencies 8c0cacd

12.3.1

12.3.0

  • [minor] Object icons color updated and adding file types icons c49ce0b
  • [none] Updated dependencies c49ce0b

12.2.0

12.1.2

12.1.1

12.1.0

12.0.1

12.0.0

11.4.0

  • [minor] Update emoji and add no-image 620557e
  • [none] Updated dependencies 620557e

11.3.2

  • [patch] Update readme to be in line with other atlaskit readmes 75f016c
  • [none] Updated dependencies 75f016c

11.3.1

  • [patch] Fix unit tests 22337bd
  • [patch] Update for label with white background a0d7ed7
  • [patch] Fix whitebackground for label b8eb930
  • [patch] Fix white background for label 229a63c
  • [none] Updated dependencies 22337bd
  • [none] Updated dependencies a0d7ed7
  • [none] Updated dependencies b8eb930
  • [none] Updated dependencies 229a63c

11.3.0

11.2.0

  • [minor] Add divider from editor 5cbb8a6
  • [minor] Add divider fabric icon 8b794ed
  • [minor] Add divider icon from fabric c8adb64
  • [none] Updated dependencies 5cbb8a6
  • [none] Updated dependencies 8b794ed
  • [none] Updated dependencies c8adb64

11.1.0

11.0.1

  • [patch] ED-4228 adding icons for table floating toolbar advance options. b466410

11.0.0

  • [major] Bump to React 16.3. 4251858

10.13.0

  • [minor] Add indeterminate checkbox icon 27f4e40

10.12.2

  • [patch] add horizontal rule toolbar item 48c36f4

10.12.1

  • [patch] Re-releasing due to potentially broken babel release 9ed0bba

10.12.0

  • [minor] Update styled-components dependency to support versions 1.4.6 - 3 ceccf30

10.11.0

  • [minor] Create skeleton representations of various components cd628e4

10.10.1

  • [patch] update atlaskit src for internal consumption 4601bf0

10.10.0

  • [minor] Added 42 new icons for Objects e00ff79

10.9.3

  • [patch] removed role props to make it more accessible 88cc276

10.9.2

10.9.1

  • [patch] Packages Flow types for elements components 3111e74

10.9.0

  • [minor] New emoji-add icon b8b1b51

10.8.0

  • [minor] added editor/success icon, updated a few other editor icons 911074c

10.7.1

  • [patch] Resolved low hanging flow errors in field-base field-text comment icon item and website, $ 007de27

10.7.0

  • [minor] Add React 16 support. 12ea6e4

10.6.0

  • [minor] Updated switcher icon 2815441

10.5.0

  • [minor] Move icon and reduced-ui pack to new repo, update build process b3977f3

10.4.0 (2017-12-08)

  • feature; added new media layout icons for the editor (issues closed: ak-4012) (ee770f5)

10.3.3 (2017-12-05)

  • bug fix; fix product icon gradients not appearing with default icon colour (013f52a)
  • bug fix; fix icon gradients not applying properly in safari in some cases (issues closed: ak-3744) (e35edf8)

10.3.2 (2017-11-23)

  • bug fix; remove theme package direct references (0f99302)

10.3.1 (2017-11-20)

  • bug fix; fS-3907 Use content attribute instead of description for Tooltip (25c9604)
  • bug fix; fS-3907 Bump tooltip version in icon, item and util-shared-styles (6d20540)

10.3.0 (2017-11-16)

  • feature; new and updated icons for the editor (issues closed: ak-3720) (2c709e2)

10.2.0 (2017-11-15)

  • feature; added a new prop for icons to make them more performant. (7dc38f7)
  • feature; icon component performance improved and the glyph can now be passed as a string. (317274c)

10.1.3 (2017-11-09)

  • bug fix; add missing color props (f186c02)

10.1.2 (2017-10-26)

  • bug fix; fix to rebuild stories (793b2a7)

10.1.1 (2017-10-22)

  • bug fix; update styled component dependency and react peerDep (39f3286)

10.1.0 (2017-10-10)

  • feature; added 8 new icons, updated 4 others (issues closed: ak-3590) (0cff900)

10.0.0 (2017-09-25)

  • breaking; Removing the "editor/expand" icon. Use the appropriate chevron-up/chevron-down icons instead. (dc2f175)
  • breaking; removing the "expand" icon in preference to using the chevron ones instead (issues closed: ak-2157) (dc2f175)

9.0.1 (2017-09-15)

  • bug fix; removed glitched path from the People icon (issues closed: ak-3524) (bb1da8a)

9.0.0 (2017-09-11)

  • breaking; The company/product icons (AtlassianIcon, BitbucketIcon, ConfluenceIcon, HipchatIcon, JiraIcon) have (8a502b1)
  • breaking; new company and product icons added (8a502b1)

8.1.0 (2017-08-28)

  • feature; added switcher icon back (de848a6)

8.0.1 (2017-08-21)

  • bug fix; fix PropTypes warning (040d579)

8.0.0 (2017-08-17)

  • bug fix; fixing the devDep for icon on itself (b3db177)
  • bug fix; fixed icon build script (10aea52)
  • feature; updated stories for icons and updated the build step for reduced-ui-pack icons (0ad9eea)
  • breaking; Some icons have been deleted, and some are now 2-colours (733dbd3)
  • breaking; icon audit and improvement (733dbd3)

7.1.0 (2017-08-11)

  • bug fix; make theme import absolute (5ef8926)
  • feature; support dark mode (6701273)

7.0.2 (2017-07-24)

  • fix; use class transform in loose mode in babel to improve load performance in apps (fde719a)
  • fix; icons no longer grow massively in Webkit or when font size bumped (adfb57e)

7.0.1 (2017-06-28)

  • fix; changed icon wrapper display from inline-flex to inline-block (64dc3de)

7.0.0 (2017-06-08)

  • fix; refactored icon module and build process (a68abba)
  • breaking; Module no longer exports named exports. Import a specific icon like so: import AtlassianIcon from '@kalamazoo/icon/glyph/atlassian';
  • ISSUES CLOSED: AK-2388

6.6.0 (2017-05-31)

  • fix; add prop-types as a dependency to avoid React 15.x warnings (92598eb)
  • feature; added log-in icon to @atlaskit/icon and @atlaskit/reduced-ui-pack (aa72586)

6.5.4 (2017-05-12)

  • fix; add package name and version to the hashing of classnames in @atlaskit/icon to preve (a28bfe5)

6.5.3 (2017-05-10)

  • fix; do not import whole icon in media-card (cc5ec63)

6.5.2 (2017-04-27)

  • fix; update legal copy to be more clear. Not all modules include ADG license. (f3a945e)

6.4.0 (2017-04-26)

  • fix; fixed bug in the new ExampleWithCode story type (f30a4d3)
  • fix; checkbox icon now correctly a 2-colour icon again (470642e)
  • fix; icon SVG files updated. Fills made to be transparent for 2-color icons, and some ico (264bb97)
  • fix; update legal copy and fix broken links for component README on npm. New contribution and (0b3e454)
  • feature; Adds switcher icon (220cc33)
  • feature; icons now have a primaryColor and secondaryColor prop (9768e00)

6.3.2 (2017-04-24)

  • fix; fixing improper PropType for a prop 'glyph' (cff41c5)

6.3.1 (2017-04-20)

  • fix; fixes regressions where styles werent being loaded causing sizing to be broken (1de6d0c)

6.3.0 (2017-04-20)

  • feature; removed explicit style! imports, set style-loader in webpack config (891fc3c)

6.1.0 (2017-04-19)

  • feature; refactoring Icon to reduce bundle size and code complexity (43c61f5)

6.0.1 (2017-04-18)

  • fix; update icon stories to use new readme component (1cdfa6d)
  • feature; add media services scale large and small icons (3bd9d86)

5.0.0 (2017-03-28)

  • fix; remove icon baseline alignment story (876c682)
  • fix; use new 24px artboard size in 'too big' story (404e6e0)
  • feature; bulk icon update (76367b5)
  • feature; update default icon sizes (90850bd)
  • breaking; default SVG artboard sizes are now 24px, with some icons such as editor on the 16px artboard.
  • breaking; icons are no longer guaranteed to baseline-align with sibling content. use flexbox to control alignment.
  • ISSUES CLOSED: AK-1924
  • breaking; This icon released contains a large amount of breaking naming changes due to deletions and renames. Please update to this new major version and ensure your application is using the correct icon exports via linting.
  • ISSUES CLOSED: AK-1924

3.0.3 (2017-03-23)

  • fix; Empty commit to release the component (49c08ee)
  • feature; icon sizes changed to be on grid (f6748ea)
  • breaking; Icon sizes changed. This does not change the default sizes, only the ones when there is a size prop specified.
  • ISSUES CLOSED: AK-1515

3.0.1 (2017-03-21)

  • fix; maintainers for all the packages were added (261d00a)

3.0.0 (2017-03-03)

  • feature; move service desk icons out of the servicedesk directory (f959e6b)
  • breaking; Service desk icons now live in the root icons directory
  • ISSUES CLOSED: AK-1858

2.5.5 (2017-02-28)

  • fix; dummy commit to release stories (3df5d9f)

2.5.3 (2017-02-28)

  • fix; dummy commit to fix broken stories and missing registry pages (a31e92a)

2.5.3 (2017-02-28)

  • fix; dummy commit to release stories for components (a105c02)

2.5.2 (2017-02-28)

  • fix; removes jsdoc annotations from icons and removes scripts used to generate Icons.md (e5302a0)

2.5.1 (2017-02-27)

  • fix; update flag's icon dependency to latest (32885ce)

2.4.3 (2017-02-20)

  • fix; change directory icon specific names to generic icon names (13bb38a)

2.4.1 (2017-02-20)

  • fix; fix fill color typo in jira/addon icon (8900095)
  • fix; copy in-code comment about reduced-ui-pack to readme (24e2c37)
  • fix; use correctly scoped package names in npm docs (91dbd2f)
  • feature; add icons for directory privacy levels (fb5f89b)

2.4.0 (2017-02-16)

  • feature; Force icons version bump to get mediakit icons (64bf24e)

2.3.3 (2017-02-07)

  • fix; Rearrange tsconfig.json organisation to allow per-package configuration. (6c6992d)

2.3.1 (2017-02-06)

  • fix; Updates packages to use scoped ak packages (26285cb)
  • fix; Fixes invite team icon for icons (3b66fd7)