@carbon/icon-build-helpers

Build helpers for the Carbon Design System icon library

Getting started

To install @carbon/icon-build-helpers in your project, you will need to run the following command using npm:

npm install -S @carbon/icon-build-helpers

If you prefer Yarn, use the following command instead:

yarn add @carbon/icon-build-helpers

Usage

@carbon/icon-build-helpers is a private module in the Carbon Design System monorepo. The purpose of this module is to centralize tooling for:

• Searching a directory of .svg assets and structuring them in terms of size and prefixes
• Custom builders for various libraries, which currently include:
  • Vanilla
  • React
• Implementing repo status checks in CI around icon metadata files, namely metadata.yml and categories.yml

As a result, these file power the generation of the following SVG-based projects:

• @carbon/icons
• @carbon/icons-react
• @carbon/pictograms
• @carbon/pictograms-react

🙌 Contributing

We're always looking for contributors to help us fix bugs, build new features, or help us improve the project documentation. If you're interested, definitely check out our Contributing Guide! 👀

📝 License

Licensed under the Apache 2.0 License.