mirror of https://github.com/iconify/iconify.git synced 2024-11-16 17:45:09 +00:00

emoji glyph-fonts icons svg svg-framework vector-icons

Go to file

cyberalien 4b21ac37c7 Do not store dist files on github		2017-03-18 10:54:03 +02:00
build	Build plugins	2017-03-16 11:20:43 +02:00
dist	Do not store dist files on github	2017-03-18 10:54:03 +02:00
samples	Version 0.0.1	2017-02-22 17:25:57 +02:00
src	Do not force https for default CDN	2017-03-18 10:46:28 +02:00
tests	Replace maximum number of icons per request with maximum URL length	2017-03-16 16:41:25 +02:00
.gitignore	Do not store dist files on github	2017-03-18 10:54:03 +02:00
.npmignore	Version 0.0.1	2017-02-22 17:25:57 +02:00
composer.json	PHP script to locate build directory. See simple-svg-cdn package	2017-03-14 12:23:13 +02:00
license.txt	Version 0.0.1	2017-02-22 17:25:57 +02:00
package.json	Do not store dist files on github	2017-03-18 10:54:03 +02:00
README.md	Version 0.0.1	2017-02-22 17:25:57 +02:00
tests.html	Remove temporary code from tests.html	2017-02-24 11:27:09 +02:00

README.md

Simple SVG

This is a preview version. Description will be here later.

It is basically like FontAwesome, but instead of using web font, it uses SVG.

There are over 20,000 icons to choose from, including icons from popular web fonts, such as Font Awesome, Material Design and multiple emoji libraries: Emoji One, Firefox OS Emoji, Noto Emoji and few other libraries.

You can use this library to load emoji from 4 different libraries, rendering them identically in all browsers on all operating systems. You can use this library to render custom SVG icons set.

Search tool with full index of available icons will be published later.

Loading all those icons?

Do not worry, Simple SVG loads only icons that are found on page. This is not a web font.

CDN with all icons will be available later. For now icons are loaded from artodia.com server using RESTful API.

Usage examples

This will load home icon from FontAwesome library

<i class="simple-svg" data-icon="fa-home"></i>

This will load home icon from Material Design icons:

<i class="simple-svg" data-icon="mdi-home"></i>

There are over 20,000 icons to choose from.

To set width and/or height use width and height attributes:

<i class="simple-svg" data-icon="noto-gift" height="32px"></i>
<i class="simple-svg" data-icon="emoji-gift" height="32px"></i>

If you set only 1 dimension, other dimension will be automatically calculated using icon's width/height ratio. If no dimensions are specified, height is automatically set to 1em.

To change color use "color" in css:

<i class="simple-svg" data-icon="fa-home" style="color: red;"></i>

More details will be posted later. See HTML files in directory "samples".

Custom icons

This library can be used with custom icon sets.

Tools for making custom packages will be published later.

Browser support

Library supports all modern browsers.

Old browsers that are supported:

IE 9+
iOS Safari for iOS 8+

IE 9, 10 and iOS 8 Safari do not support some modern functions that library relies on. SimpleSVG will automatically load polyfills for those browsers. All newer browsers do not require those polyfills.

License

Library is released with MIT license.

This license does not apply to icons. Icons are released under different licenses, see each icons set for details. Icons available by default are all licensed under some kind of open source or free license.