# @weave-design/icons

> Weave icon assets

Latest version **1.1.0** (published 2023-04-18) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @weave-design/icons
pnpm add @weave-design/icons
yarn add @weave-design/icons
bun add @weave-design/icons
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2023-04-18 |
| First published | 2023-02-24 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 1.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 194 |
| Author | Autodesk Inc. |
| Maintainers | hig-bot, wmui51 |

## Links

- npm: https://www.npmjs.com/package/@weave-design/icons
- Repository: https://github.com/Autodesk/hig
- Homepage: https://storybook.weave.autodesk.com
- Issues: https://github.com/Autodesk/hig/issues
- npm.io page: https://npm.io/package/@weave-design/icons

## Dependencies (1)

- [emotion](https://npm.io/package/emotion.md) ^10.0.0

## Recent versions

- 1.1.0 (latest) — 2023-04-18
- 1.0.0 — 2023-02-24

## README

# Icons

This package retains the source of the library of Weave icons.
You can import individual icons to render in your app.

```jsx
import { Assets24 } from "@weave-design/icons";

const MyComponent = () => (
    <div className="my-class">
        <Assets24 />
    </div>
);

export default MyComponent
```

## Getting started

### Install the package

```bash
yarn add @weave-design/icons @weave-design/theme-context @weave-design/theme-data
```

# Developing

## Adding a New Icon

To add a new SVG icon to the library, add the `svg` file to the `src/icons` directory.

Then run the following command:

```bash
yarn build-icons
```

This will use SVGO to optimize the new icon, and update our release files. Remember to commit these changes.

## Accessing SVG source files

SVG source files for all icons are available in the `build/svg` subdirectory of the `@weave-design/icons` package (e.g. `./node_modules/@weave-design/icons/build/svg`).

## Styling

Use the `className` prop to pass in a css class name to the outermost container of the component. The class name will also pass down to most of the other styled elements within the component. 

Icons can take a `color` prop that will accept any hex code, rgb, rgba, or color string that can change the default color. Icons also has a `stylesheet` prop that accepts a function wherein you can modify its styles.

---
_Source: https://npm.io/package/@weave-design/icons · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._