1
1
mirror of https://github.com/namibia/file-icon-vectors.git synced 2024-09-29 21:19:02 +00:00
file-icon-vectors/README.md

95 lines
4.1 KiB
Markdown
Raw Normal View History

2018-06-12 13:46:48 +00:00
# File Vector Icons
A collection of file type SVG icons, licensed MIT and available for free use for your applications.
2018-06-12 13:46:48 +00:00
* If you have [feedback, bugs or requests](https://github.com/dmhendricks/file-icon-vectors/issues), please feel free to post them.
* I paid to license many of the icons used in these sets. [Donations](https://paypal.me/danielhendricks) are appreciated.
2018-01-28 21:15:46 +00:00
[![Author](https://img.shields.io/badge/author-Daniel%20M.%20Hendricks-lightgrey.svg?colorB=9900cc )](https://www.danhendricks.com?utm_source=github.com&utm_medium=campaign&utm_content=button&utm_campaign=file-icon-vectors)
2018-01-28 21:47:08 +00:00
[![Release](https://img.shields.io/github/release/dmhendricks/file-icon-vectors.svg)](https://github.com/dmhendricks/file-icon-vectors/releases)
2018-06-12 11:00:03 +00:00
[![License](https://img.shields.io/badge/license-MIT-yellow.svg)](https://raw.githubusercontent.com/dmhendricks/file-icon-vectors/master/LICENSE)
2017-09-23 06:19:24 +00:00
[![Total Downloads](https://img.shields.io/packagist/dt/dmhendricks/file-icon-vectors.svg)](https://packagist.org/packages/dmhendricks/file-icon-vectors)
[![Bower](https://img.shields.io/bower/v/file-icon-vectors.svg)](https://github.com/dmhendricks/file-icon-vectors)
2018-01-28 21:15:46 +00:00
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/danielhendricks)
2017-09-17 17:19:39 +00:00
[![Twitter](https://img.shields.io/twitter/url/https/github.com/dmhendricks/file-icon-vectors.svg?style=social)](https://twitter.com/danielhendricks)
2017-09-16 06:53:18 +00:00
2017-09-27 20:51:34 +00:00
## Icon Sets
2018-01-29 02:48:20 +00:00
Currently, there are two icon sets in the `dist/icons` directory:
2017-09-27 20:51:34 +00:00
* **Classic** - An expansion of the Redboot [free-file-icons](https://github.com/redbooth/free-file-icons) designs.
* **Vivid** - Inspired by [Erlen Masson](https://www.sketchappsources.com/svg-resource/1856-vector-file-type-icons-sketch-freebie-resource.html)
2018-06-12 13:32:49 +00:00
#### Demo: [View Icon Sets](https://danhendricks.com/demo/github/dmhendricks/file-icon-vectors/demo/) :eyes:
2017-09-28 12:54:42 +00:00
2017-09-27 15:27:29 +00:00
## Installation
2018-01-28 22:22:31 +00:00
To install with Bower:
```
bower install file-icon-vectors
```
To install with Composer:
2017-09-27 15:27:29 +00:00
```
composer require dmhendricks/file-icon-vectors
```
2017-09-23 07:18:06 +00:00
## Usage
2017-09-07 00:49:11 +00:00
2017-09-27 20:51:34 +00:00
To display a file icon, simply link to one or both of the icon set CSS files in the `css` directory:
2017-09-23 07:18:06 +00:00
```
2018-01-29 02:48:20 +00:00
<link rel="stylesheet" href="dist/file-icon-classic.min.css" />
<link rel="stylesheet" href="dist/file-icon-vivid.min.css" />
2017-09-23 07:18:06 +00:00
```
From there, you can use CSS classes to display the icons:
```
<span class="fiv-cla fiv-icon-ppt"></span>
<span class="fiv-cla fiv-icon-xls"></span>
<span class="fiv-viv fiv-icon-pdf"></span>
<span class="fiv-viv fiv-icon-wav"></span>
```
2017-09-24 05:21:03 +00:00
Notice that the classes contain either `flv-cla` for the Classic set or `flv-viv` for the Vivid set.
2017-09-23 07:18:06 +00:00
If you want to override the size of the icons, you can do so with CSS:
```
<style>
.fiv-cla, .fiv-viv { font-size: 3em; }
</style>
```
2017-09-24 05:21:03 +00:00
If you prefer, you may also use `.fiv-size-md`, `.fiv-size-lg` and `.fiv-size-xl` to modify the icon sizes:
2017-09-24 05:10:15 +00:00
```
<span class="fiv-viv fiv-icon-pdf fiv-size-lg"></span>
```
2018-01-28 21:15:46 +00:00
## TODO
2017-09-23 07:18:06 +00:00
2018-01-29 02:48:20 +00:00
* Fix inconsistent sizing in classic set
2018-06-12 11:00:03 +00:00
* Publish to NPM
2017-09-23 07:18:06 +00:00
* Add additional libraries, such as square icons, et al
2017-09-16 05:26:09 +00:00
2017-09-24 04:48:27 +00:00
## Legal Stuff
2017-09-27 20:51:34 +00:00
All icons used in the creation of this library were licensed MIT or purchased royalty-free, with exceptions noted below.
If you feel that you have a copyright issue, please feel free to [post it](https://github.com/dmhendricks/file-icon-vectors/issues).
### Attribution
2017-09-24 04:35:18 +00:00
* [Android icon](https://www.flaticon.com/free-icon/android-logo_61120) made by [Google](https://www.flaticon.com/authors/google) via [flaticon.com](https://www.flaticon.com/)
2017-09-27 20:51:34 +00:00
* [BitTorrent icon](http://www.icons101.com/icon/id_73504/setid_2388/Minimalist_Black_Icons__WIP_by_noshery/bittorrent) made by [noshery](http://www.icons101.com/artist/id_2388/noshery) from [icons101.com](http://www.icons101.com/)
* [GIMP Icon](https://icons8.com/icon/39867/gimp#filled) provided by [Icons8 LLC](https://icons8.com/)
* Vivid set [Folder Icon](https://www.iconfinder.com/icons/173016/close_folder_icon) made by [Snip Master](https://www.iconfinder.com/snipicons) from [Iconfinder](https://www.iconfinder.com)
2018-06-12 13:32:49 +00:00
## Screenshot
2018-06-12 13:46:48 +00:00
![Icons Preview](https://unpkg.com/file-icon-vectors@0.8.0/screenshot.png "Icons Preview")