@bigcommerce/big-design-icons
v1.2.2
Published
BigDesign Icons as React components.
Downloads
7,872
Maintainers
Keywords
Readme
BigDesign Icons
![CircleCI](https://circleci.com/gh/bigcommerce/big-design.svg?style=shield)
BigDesign Icons as React components.
Documentation
You can find documentation, list of icons, and examples on our docs page.
Quick start guide
Add BigDesign Icons and styled-components@5 to your project using npm
:
npm install @bigcommerce/big-design-icons styled-components@5
or with pnpm
:
pnpm add @bigcommerce/big-design-icons styled-components@5
Import any icon component and use it anywhere in your app.
import { StoreIcon } from '@bigcommerce/big-design-icons';
...
<App>
<StoreIcon />
</App>
Adding New Icons
To add new icons, use the built-in script to download the svg from Material Icons - Rounded:
pnpm run download
After you've searched and downloaded your icon(s), run the build script to convert your svgs into React components:
pnpm run build:icons