JSPM

@procore/core-icons

10.0.1-rc.3+4186fe8ee
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2391
  • Score
    100M100P100Q132335F
  • License SEE LICENSE IN LICENSE

Icon set to be used in all core components

Package Exports

  • @procore/core-icons
  • @procore/core-icons/dist
  • @procore/core-icons/dist/icons/index

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@procore/core-icons) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

CORE Icons npm npm

A set of SVGs turned into a web compatible @font-face.

Requirements

Node 6+ NPM or Yarn

Developing

To get started, type the following from the root directory:

yarn
yarn dev

Building

yarn build

Updating Icons from Figma

  1. Clone the repo

  2. cd to project folder root

  3. Set the FIGMA_TOKEN and GH_TOKEN env variables in the .env file. You can get these from Figma and Github.

  4. Run the command node scripts/update_icons_from_figma.js

  5. Commit and open a pull request with the updated icons.

Updating Icons from IcoMoon (Deprecated)

## Updating in IcoMoon

1. Name icons according to the following naming convention:

tool-?[name]-[shape]-[o]-[direction]

2. Select the entire font set and select "Generate Font"

3. Download the font archive

4. If icons have not yet been updated in the current prerelease, the src/selection-old.json file must be replaced with the src/selection.json. Otherwise nothing needs to be done on this step.

5. Extract the downloaded font archive contents into the src folder, overwriting the existing files.

6. Check on localhost that the icons appear on the Icons docs

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/procore/core. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The package is available under the Procore Developers License

About Procore

Procore Logo

CORE Icons is maintained by Procore Technologies.

Procore - building the software that builds the world.

Learn more about the #1 most widely used construction management software at procore.com