0.0.3 • Published 6 years ago
@icon/mfglabs-iconset v0.0.3
@icon/mfglabs-iconset
This repository is a module of the full icon repository.
Install
This repository is distributed with npm. After installing npm, you can install @icon/mfglabs-iconset
with this command.
npm install --save @icon/mfglabs-iconset
Usage
There are many ways/formats of how to use mfglabs-iconset. 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
- 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/mfglabs-iconset/icons/cloud.svg" />
- Icons can be served from a CDN such as Unpkg. Simply use the
@icon/mfglabs-iconset
npm package in the URL like the following:
<img height="32" width="32" src="https://unpkg.com/@icon/mfglabs-iconset/icons/cloud.svg" />
Icons font -- ideal when you want to include all icons at once
- Install
@icon/mfglabs-iconset
with this command. In the<head>
of your html, reference the location to yourmfglabs-iconset.css
.
<head>
...
<link rel="stylesheet" href="@icon/mfglabs-iconset/mfglabs-iconset.css">
...
</head>
- Use unpkg.com to load directly mfglabs-iconset without installing anything:
<head>
...
<link rel="stylesheet" href="https://unpkg.com/@icon/mfglabs-iconset/mfglabs-iconset.css">
...
</head>
Place mfglabs-iconset with
<i>
tag in your html like this. Icon class names are to be used with themli
class prefix.
<i class="mli mli-cloud"></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
Mfglabs-iconset is copyright by MfgLabs.
- Mfglabs Iconset is licensed under the CC BY-SA.