Calcite UI Icons
A collection of SVG illustrations for use in product and workflows.
Web Component
For web apps, the easiest way to use calcite-ui-icons is with calcite-components. The calcite-icon component will handle fetching and rendering any icon from this set with the following api:
Installation
npm install @esri/calcite-ui-icons --save
Sprite packages
Furthermore, sprites are available in 3 packages and live outside the icons/
directory:
- sprite-16.svg
- sprite-24.svg
- sprite-32.svg
Alternative filled versions of the outlined icons have -f
appended to their name, and are included in the sprites above.
Icons in the sprite have an id
of the individual SVG file name.
JavaScript Exports
The icons are also made available as named ES6 exports. This way you can import just the icons you need into your app:
The icon names will be lower camel case. If the icon name starts with a number (ex. 2d-explore, 3d-glasses) prefix the name with i
. This is due to the fact that JavaScript variables cannot begin with a number. If the icon is a filled alternate, it will have F
at the end of the variable name.
If your build system does not perform tree shaking and dead code removal, there is a chance that importing the icons using this syntax will make your bundle extremely large. If that is the case, you can also import icons directly:
Some icons use multiple paths and opacity in their construction, for these the data structure will be as follows:
Note: It is not recommended to import the entire library of icons. This will have negative performance implications. Use the technique above to select only the icons your users actually need to download.
TypeScript
Types are also available for projects leveraging TypeScript. CalciteIconPath
describes all exported icons (both single and multipath) while CalciteMultiPathEntry
describes an individual path from a multipath icon.
JSON Format
All icons are also provided as part of a JSON file. If you installed via npm, you can import the full icon data set using the following:
This will give you an object containing all the icons in the library at all sizes:
Note: path data omitted for brevity.
Most icons will have simple strings as path data, but some will be more complex as they need to store not only path, but opacity as well for multiple shapes. Icons of this structure will be annotated with the multiPath
flag.
Individual icons structure
All the individual SVG icons have a common file structure.
This is what the close-16.svg
looks like:
None of the icons have stroke
attributes. The fill
attribute can be defined with css:
All the other styling properties applicable to the whole svg element are applicable.
Build PNG icons for mobile and desktop
For convenient use in iOS & desktop application projects, you can convert all icons to PNG.
First, run npm install
:
Then:
To create Xcode image sets (for use with iOS, macOS, iPadOS) with a default size:
To create Xcode image sets with a specified size (e.g. 44x44):
To create versions for use on desktop in one size:
To create versions for use on desktop in sizes ranging from 16 to 64, run: