open-index/open-npm huggingface dataset:
npm package: @icon/unicons
Description: Ready to use font icons for your next project
Author: Iconscout
Latest version: 3.0.6-alpha.0

# @icon/unicons

[![npm version](https://img.shields.io/npm/v/@icon/unicons.svg)](https://www.npmjs.org/package/@icon/unicons)

This repository is a module of the full [standard-icons][standard-icons] repository.

## Install

This repository is distributed with [npm]. After [installing npm][install-npm], you can install `@icon/unicons` with this command.

```bash
npm install --save @icon/unicons
```

## Usage

There are many ways/formats of how to use unicons. The fastest and recommended way is via SVG directly. Or use the webfont version if you want to include all icons at once:

### SVG icons -- when you need just a few icons in your project

1 . If you want to use just a few icons. Find the icons you need in "icons" folder. Then use them as regular images:

```
<img height="32" width="32" src="@icon/unicons/icons/heart.svg" />
```

2 . Icons can be served from a CDN such as [Unpkg][Unpkg]. Simply use the `@icon/unicons` npm package in the URL like the following:

```
<img height="32" width="32" src="https://unpkg.com/@icon/unicons/icons/heart.svg" />
```

### Icons font -- ideal when you want to include all icons at once

1 . Install `@icon/unicons` with this command. In the `<head>` of your html, reference the location to your `unicons.css`.

```
<head>
...
<link rel="stylesheet" href="@icon/unicons/unicons.css">
...
</head>
```

2 . Use [unpkg.com][Unpkg] to load directly unicons without installing anything:

```
<head>
...
<link rel="stylesheet" href="https://unpkg.com/@icon/unicons/unicons.css">
...
</head>
```

> Place unicons with `<i>` tag in your html like this. Icon class names are to be used with the `uil` class prefix.

```
<i class="uil uil-heart"></i>
```


## Bugs, Ideas, Pull Requests

If you have any ideas or found bugs, please send me Pull Requests or let me know with [GitHub Issues][github issues].

## License

Unicons is copyright by Iconscout, licensed under the [Apache-2.0][license].

[Apache-2.0]: https://opensource.org/licenses/Apache-2.0
[standard-icons]: https://github.com/thecreation/standard-icons
[npm]: https://www.npmjs.com/
[install-npm]: https://docs.npmjs.com/getting-started/installing-node
[sass]: http://sass-lang.com/
[github issues]: https://github.com/thecreation/standard-icons/issues
[Unpkg]: https://unpkg.com