Holokit Icon Components and files

This package contains a collection of React components and other files for displaying icons.

Layout

This directory is split into a few sub-directories:

• resources
• src
  • generated
  • Icon

The resources directory contains the icons.json file. This file is a record of the icons that we currently have, and is used to build the icon source. The src/generated directory contains the artifacts of the icon build process, and the src/Icon directory contains the Icon React component itself, as well as the associated styles and types.

Adding an Icon

Icons an be added by adding a record to the icons.json file, and making sure to include the correct svgs in the top level resources/icons directory. Inside of this directory, there are subdirectories for each of the sizes. Design will provide svgs at each size.

Optional key values in icons.json include only and excludes. These exist to selectively designate what size we have for this icon.