@icon/elegant-icons
v0.0.1-alpha.4
Published
Elegant Themes Icons
Downloads
1,910
Readme
@icon/elegant-icons
This repository is a module of the full standard-icons repository.
Install
This repository is distributed with npm. After installing npm, you can install @icon/elegant-icons
with this command.
npm install --save @icon/elegant-icons
Usage
There are many ways/formats of how to use elegant-icons. 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/elegant-icons/icons/arrow_up.svg" />
2 . Icons can be served from a CDN such as Unpkg. Simply use the @icon/elegant-icons
npm package in the URL like the following:
<img height="32" width="32" src="https://unpkg.com/@icon/elegant-icons/icons/arrow_up.svg" />
Icons font -- ideal when you want to include all icons at once
1 . Install @icon/elegant-icons
with this command. In the <head>
of your html, reference the location to your elegant-icons.css
.
<head>
...
<link rel="stylesheet" href="@icon/elegant-icons/elegant-icons.css">
...
</head>
2 . Use unpkg.com to load directly elegant-icons without installing anything:
<head>
...
<link rel="stylesheet" href="https://unpkg.com/@icon/elegant-icons/elegant-icons.css">
...
</head>
Place elegant-icons with
<i>
tag in your html like this. Icon class names are to be used with theei
class prefix.
<i class="ei ei-arrow_up"></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.
License
Elegant-icons is copyright by Elegant Themes, licensed under the MIT.