Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/icons8/webicon
Icon library
https://github.com/icons8/webicon
icons svg
Last synced: 24 days ago
JSON representation
Icon library
- Host: GitHub
- URL: https://github.com/icons8/webicon
- Owner: icons8
- License: mit
- Created: 2015-03-17T13:06:59.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-07-05T07:23:17.000Z (over 6 years ago)
- Last Synced: 2024-11-04T02:32:47.153Z (about 1 month ago)
- Topics: icons, svg
- Language: JavaScript
- Homepage: https://icons8.com/articles/webicon-svg-sets-icons/
- Size: 453 KB
- Stars: 193
- Watchers: 17
- Forks: 34
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-starred - icons8/webicon - Icon library (others)
README
# Icon library
**Insert the icons in 30 seconds using the new Icon Sets technology.**
## Installing webicon
You can install this package locally either with `npm`, `bower`, or `jspm`.
### npm
```shell
npm install webicon
```
Now you can use `require('webicon/angular-webicon')` or `require('webicon/jquery-webicon')` when installing with npm or jsmp and using Browserify or Webpack.
### bower
```shell
# To get the latest stable version, use bower from the command line.
bower install webicon
# To get the most recent, last committed-to-master version use:
bower install webicon#master
# To save the bower settings for future use:
bower install webicon --save
# Later, you can use easily update with:
bower update
```
> Please note that webicon requires **AngularJS 1.1.x** or higher for use as Angular module.
> Please note that webicon requires **jQuery 1.8.x** or higher for use as jQuery plugin.
## Using the webicon library
Simply include the scripts and stylesheet in your main HTML file in the order shown in the example below. Note that npm will install the files under `/node_modules/webicon/` and bower will install them under `/bower_components/webicon/`.
### Simple demo for AngularJS version
```html
angular
.module('app', ['webicon'])
.config(function($webiconProvider) {
$webiconProvider
.svgSet('flat-color-icons', '//cdn.rawgit.com/icons8/flat-color-icons/v1.0.2/icon-set/icons.svg')
.alias('flat-color-icons', 'fci')
.icon('clock', '//cdn.rawgit.com/icons8/flat-color-icons/v1.0.2/svg/clock.svg')
});
```
### Simple demo for jQuery version
```html
$(function() {
$(document).webicons({
svgSet: {
"flat-color-icons": '//cdn.rawgit.com/icons8/flat-color-icons/v1.0.2/icon-set/icons.svg'
},
alias: {
fci: 'flat-color-icons'
},
icon: {
clock: '//cdn.rawgit.com/icons8/flat-color-icons/v1.0.2/svg/clock.svg'
}
});
});
```
More demo [here](https://icons8.github.io/webicon/)
## Features
- Available all Icons8 [open source icons](https://github.com/icons8/flat-color-icons) via our api as default source.
- The icons are stored on our CDN server (which is free forever).
- You insert the icons right into your code.