76 lines
2.3 KiB
Markdown
76 lines
2.3 KiB
Markdown
# @icon/dripicons
|
|
|
|
[](https://www.npmjs.org/package/@icon/dripicons)
|
|
|
|
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/dripicons` with this command.
|
|
|
|
```bash
|
|
npm install --save @icon/dripicons
|
|
```
|
|
|
|
## Usage
|
|
|
|
There are many ways/formats of how to use dripicons. 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/dripicons/icons/alarm.svg" />
|
|
```
|
|
|
|
2 . Icons can be served from a CDN such as [Unpkg][Unpkg]. Simply use the `@icon/dripicons` npm package in the URL like the following:
|
|
|
|
```
|
|
<img height="32" width="32" src="https://unpkg.com/@icon/dripicons/icons/alarm.svg" />
|
|
```
|
|
|
|
### Icons font -- ideal when you want to include all icons at once
|
|
|
|
1 . Install `@icon/dripicons` with this command. In the `<head>` of your html, reference the location to your `dripicons.css`.
|
|
|
|
```
|
|
<head>
|
|
...
|
|
<link rel="stylesheet" href="@icon/dripicons/dripicons.css">
|
|
...
|
|
</head>
|
|
```
|
|
|
|
2 . Use [unpkg.com][Unpkg] to load directly dripicons without installing anything:
|
|
|
|
```
|
|
<head>
|
|
...
|
|
<link rel="stylesheet" href="https://unpkg.com/@icon/dripicons/dripicons.css">
|
|
...
|
|
</head>
|
|
```
|
|
|
|
> Place dripicons with `<i>` tag in your html like this. Icon class names are to be used with the `dripicons` class prefix.
|
|
|
|
```
|
|
<i class="dripicons dripicons-alarm"></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
|
|
|
|
Dripicons is copyright by Amit Jakhu, licensed under the [CC-BY-4.0][license].
|
|
|
|
[license]: http://creativecommons.org/licenses/by-sa/4.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 |