c6a9346985
* Add URL friendy/slug/file name as property to package icon objects * Test new property * Build index from template * Add .get function to index.js export * Test new .get function in index.js export * Use Uglify-JS to minify the code in the package's index.js * Update API in README.md * Renaem test using "slug" instead of "name" |
||
|---|---|---|
| _data | ||
| .github | ||
| icons | ||
| images | ||
| scripts | ||
| tests | ||
| .editorconfig | ||
| .gitignore | ||
| .gitpod.yml | ||
| .jsonlintschema | ||
| .npmignore | ||
| .svglintrc.js | ||
| .travis.yml | ||
| CNAME | ||
| CONTRIBUTING.md | ||
| index.html | ||
| LICENSE.md | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| site_script.js | ||
| stylesheet.css | ||
Simple Icons
Free SVG icons for popular brands. See them all on one page at SimpleIcons.org. Contributions, corrections & requests can be made on GitHub. Started by Dan Leech.
Usage
General Usage
Icons can be downloaded as SVGs directly from our website - simply click the icon you want, and the download should start automatically.
CDN Usage
Icons can be served from a CDN such as JSDelivr or Unpkg. Simply use the simple-icons npm package and specify a version in the URL like the following:
<img height="32" width="32" src="https://cdn.jsdelivr.net/npm/simple-icons@latest/icons/[ICON NAME].svg" />
<img height="32" width="32" src="https://unpkg.com/simple-icons@latest/icons/[ICON NAME].svg" />
Where [ICON NAME] is replaced by the icon name, for example:
<img height="32" width="32" src="https://cdn.jsdelivr.net/npm/simple-icons@latest/icons/simpleicons.svg" />
<img height="32" width="32" src="https://unpkg.com/simple-icons@latest/icons/simpleicons.svg" />
Node Usage
The icons are also available through our npm package. To install, simply run:
$ npm install simple-icons
The API can then be used as follows:
const simpleIcons = require('simple-icons');
console.log(simpleIcons.get('Simple Icons'));
/*
{
title: 'Simple Icons',
slug: 'simpleicons',
hex: '111111',
source: 'https://simpleicons.org/',
svg: '<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">...</svg>',
path: 'M12 12v-1.5c-2.484 ...'
}
*/
Alternatively you can import the needed icons individually. This is useful if you are e.g. compiling your code with webpack and therefore have to be mindful of your package size:
const icon = require('simple-icons/icons/simpleicons');
console.log(icon);
/*
{
title: 'Simple Icons',
slug: 'simpleicons',
hex: '111111',
source: 'https://simpleicons.org/',
svg: '<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">...</svg>',
path: 'M12 12v-1.5c-2.484 ...'
}
*/
Third Party Extensions
WordPress
Icons are also available on WordPress through a simple plugin created by @tjtaylo, which you can find here.
Status
