# @igloo-ui/icons

> A set of icons handcrafted by Officevibe

Latest version **1.12.3** (published 2024-04-16) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @igloo-ui/icons
pnpm add @igloo-ui/icons
yarn add @igloo-ui/icons
bun add @igloo-ui/icons
```

## Health

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

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.12.3 |
| Published | 2024-04-16 |
| First published | 2021-08-02 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 1.3 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Groupe Officevibe Inc. |
| Maintainers | infra.admin, franckgaudin |
| Keywords | igloo-ui, icons, officevibe |

## Links

- npm: https://www.npmjs.com/package/@igloo-ui/icons
- Repository: https://github.com/gsoft-inc/ov-igloo-icons
- Homepage: https://github.com/gsoft-inc/ov-igloo-icons#readme
- Issues: https://github.com/gsoft-inc/ov-igloo-icons/issues
- npm.io page: https://npm.io/package/@igloo-ui/icons

## Dependencies (2)

- [classnames](https://npm.io/package/classnames.md) ^2.3.1
- [html-react-parser](https://npm.io/package/html-react-parser.md) ^1.2.7

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [stockfish](https://npm.io/package/stockfish.md) — 27.0K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads

## Recent versions

- 1.12.3 (latest) — 2024-04-16
- 1.12.2 — 2023-11-28
- 1.12.1 — 2023-10-31
- 1.12.0 — 2023-10-20
- 1.11.0 — 2023-07-18
- 1.10.0 — 2023-07-11
- 1.9.0 — 2023-07-07
- 1.8.0 — 2023-06-06
- 1.7.0 — 2023-05-11
- 1.6.0 — 2022-10-25
- 1.5.0 — 2022-10-06
- 1.4.0 — 2022-09-14
- 1.3.0 — 2022-07-25
- 1.2.1 — 2022-07-25
- 1.2.0 — 2022-07-12
- … 23 more at https://npm.io/package/@igloo-ui/icons/versions

## README

# `@igloo-ui/icons`

A set of icons handcrafted by Officevibe

## Getting started

To install @igloo-ui/icons in your project, you will need to run the following command using [npm](https://www.npmjs.com/):

```
npm install @igloo-ui/icons
```

If you prefer [Yarn](https://classic.yarnpkg.com/en/), use the following command instead:

```
yarn add @igloo-ui/icons
```

## Usage

Icons in this package support the following sizes: `16`, `24`, and `32` pixels. You can import an icon component into your project by referring to its name:

```js
import Alert from '@igloo-ui/icons/dist/Alert';

function MyComponent() {
  return (
    <>
      <Alert /> Uh oh, something went wrong
    </>
  );
}
```

### Changing the size

You can change the size of an icon by passing a prop `size` which takes `small`, `medium` and `large`. For example:

```js
import Clock from '@igloo-ui/icons/dist/Calendar';

function MyComponent() {
  return (
    <>
      <Calendar size="large" /> Monday, Feb 2022
    </>
  );
}
```

| Prop     | Rendered Size                |
| -------- | ---------------------------- |
| `small`  | 16px                         |
| `medium` | 24px is the **default** size |
| `Large`  | 32px                         |

### Changing the color

You can change the color of an icon by passing in a custom class name that sets this property.

First install tokens

`yarn add @igloo-ui/tokens`

For example:

```css
@import '@igloo-ui/tokens/dist/variables.css';

.my-custom-class {
  color: var(--dandelion-600);
}
```

```js
import Alert from '@igloo-ui/icons/dist/Alert';

function MyComponent() {
  return (
    <>
      <Alert className="my-custom-class" /> Uh oh, something went wrong
    </>
  );
}
```

### Accessibility

If the icon used without text, then use the `ariaLabel` prop to give the icon a text alternative. The label should describe the icon.

```js
import Alert from '@igloo-ui/icons/dist/Alert';

function MyComponent() {
  return <Alert ariaLabel=" Uh oh, something went wrong" />;
}
```

## SVG files

For projects that don’t use React, icons are also available as \*.svg files in the `dist/svg` folder.

## License

Copyright © 2019, GSoft inc. This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license at https://github.com/gsoft-inc/gsoft-license/blob/master/LICENSE.

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