Get unlimited public & private packages + team-based management with npm Teams.Learn more »

vendor-icons

1.0.0 • Public • Published

vendor-icons

NPM version Bower version Packagist version Nuget version

Dependency Status Build Status

About

Icons and logos from various vendors of the coding community. While the project is opened to new icons, its author admits the project is kind of orientated towards JavaScript / Web & HTML5 / HybridApps.

This project just provides icons from various projects. All icons are made available through the following dimensions (in pixels):

  • 16x16
  • 32x32
  • 48x48
  • 64x64
  • 96x96
  • 128x128
  • 256x256

CSS spritesheets

You can insert the icons directly into your HTML with a common IMG tag:

<img alt="Github logo" src="dist/32x32/github.png" width="32" height="32">

In addition to the icons by themselves, this project also ships a CSS spritesheet for the icon-pack. This spritesheet allows to load the entire icon-pack in just 1 image, and thus reduce HTTP calls.

This is what it actually looks:

Spritesheet Spritesheet

All the positioning of the icons inside this alone image is made through CSS, which allows you to just add block-type tags with the proper class and get the same result:

<div class="vendor-icons github"></div>

Just remember to add the CSS stylesheet to the HEAD of your HTML page!

Install

Get the package with NPM

npm install vendor-icons

Get the package with Bower

bower install vendor-icons

Get the package with Composer / Packagist

composer require legacy-icons/vendor-icons

Get the package with NuGet

Install-Package vendor-icons

Build the whole project or your custom project

We use Gulp to build the project, so if you want to re-build or customize this project, you'll need Gulp.

After gulp is installed, and your CLI is pointed to your work directory, first install the dependencies:

with NPM 2.x.x

npm install

with NPM 3.x.x (resolve dependencies for node-spritesheet before this module's ones)

npm install grunt grunt-contrib-coffee grunt-contrib-clean

npm install

then be sure that you have ImageMagick installed for building spritesheet.

then, you can run the gulp build task to build the project:

gulp build

What the build task does?

First, it takes PNG files from the src folder, and pastes them to the dist folder.

Then it creates a spritesheet from the PNG images located in the src folder, and thus creates the sprite folder in dist.

If, for example you just want css3 and html5 icons in a spritesheet, you just have to fork this project, point your CLI to the working directory, empty the src directory, except css3 and html5 icons in PNG format, and then run the gulp build task.

You'll get the proper spritesheet and copies of the icons directly in the dist folder.

License

Each icon in this project belong to its original author, and for most of them, they are copyrighted. Some of these icons may not match their project's official icon/logo.

Actually, this icon set is quite opinionated, but is definitely open to improvements, or critics.

Please note that the project "vendor-icons" does not consider these icons as free-to-use by default: if you want to use these icons in your project, you may|shall|should|must check with the rightful owners that your use of the icon is OK.

This project is meant to follow any kind of "upstream-design". Let's say NPM creates a Github repository to host SVG/EPS/AI for the NPM logo, then vendor-icons's vocation would be to create a workflow to take the repository as a source for the NPM icon. Each project and/or company handles graphic assets in different manners, and then, vendor-icons can not give general guidelines for use or licensing, since each icon may have its own guidelines/policy/license.

Please refer the rightful owners in case you don't know whether your use of any icon is legit or not.

The icons are borrowed from the following projects:

About the rest (all this repository but the icons)

All the content of this repository (excepted the icon pack) is licensed under the MIT license.

Though, it is just composed a few trivial json files and a Readme.

Install

npm i vendor-icons

DownloadsWeekly Downloads

2

Version

1.0.0

License

MIT

Last publish

Collaborators

  • avatar