# @hig/icons

> HIG icon assets

Latest version **4.5.0** (published 2022-10-21) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @hig/icons
pnpm add @hig/icons
yarn add @hig/icons
bun add @hig/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 | 4.5.0 |
| Published | 2022-10-21 |
| First published | 2018-04-11 |
| 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 | 193 |
| Author | Autodesk Inc. |
| Maintainers | hig-bot, nfiniteset, wmui51, staceyshk |

## Links

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

## Dependencies (1)

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

## Recent versions

- 4.5.0 (latest) — 2022-10-21
- 0.2.0-alpha.18da9628 (canary) — 2018-06-13
- 4.4.0 — 2022-09-29
- 4.3.0 — 2022-09-25
- 4.2.0 — 2022-09-12
- 4.1.2 — 2022-08-17
- 4.1.1 — 2022-05-25
- 4.1.0 — 2022-01-24
- 4.0.0 — 2022-01-13
- 3.4.4 — 2022-01-12
- 3.4.3 — 2022-01-12
- 3.4.2 — 2021-10-11
- 3.4.1 — 2021-06-26
- 3.4.0 — 2021-02-22
- 3.3.0 — 2020-05-15
- … 255 more at https://npm.io/package/@hig/icons/versions

## README

# Icons

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

```jsx
import { Assets24 } from "@hig/icons";

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

export default MyComponent
```

Read more about where and how to use icons on [the website](https://hig.autodesk.com/web/basics/icons).

## Getting started

### Install the package

```bash
yarn add @hig/icons @hig/theme-context @hig/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 `@hig/icons` package (e.g. `./node_modules/@hig/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/@hig/icons · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._