@stead/icon-build-helpers
v0.1.9
Published
Build helpers for the Stead Design System icon library
Downloads
2
Readme
@stead/icon-build-helpers
Build helpers for the Stead Design System icon library
Getting started
To install @stead/icon-build-helpers
in your project, you will need to run
the following command using npm:
npm install -S @stead/icon-build-helpers
If you prefer Yarn, use the following command instead:
yarn add @stead/icon-build-helpers
Usage
@stead/icon-build-helpers
is a private module in the Stead 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
andcategories.yml
As a result, these file power the generation of the following SVG-based projects:
@stead/icons
@stead/icons-react
@stead/pictograms
@stead/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.