Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
svg
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

collecticons-banner

Collecticons Library

We at Development Seed use iconography in a lot of projects. Some of the icons were designed/built on top of libraries like icoMoon by Keyamoon and others were made in house. This evergrowing collection is a set of the icons we've been using so far and are now available for free under the The MIT License and the Creative Commons Attribution License 4.0.

If you feel like contributing to this library checkout the guidelines below:

Contributing

  • The icons in this package are designed on a 16px grid and look best at sizes that are multiples of that value (E.g. 16px, 32px, 48px, etc).
  • Download the template file. You'll see a transparent 16px square (named icon-bound) being used as a wrapper. This should not be deleted and your artwork must be contained within its limits.
  • The icons should look minimalist, geometric yet functional. Use a 2px stroke for general lines and 1px for details. Round corners should be avoided if their only purpose is decoration.
  • It's of no use designing finely-detailed icons that don't work at lower resolutions. Do readability tests to ensure that your designs work at different sizes.
  • Convert strokes to fills. Unite/combine your fills.
  • Instead of using color white for making holes, subtract the foreground shape from the background shape.
  • Adding a bitmap image (PNG, JPEG, etc.) to a SVG image does not make it vector. Don't use bitmap images embedded in SVGs.

Name conventions

The name of the SVG file should follow the pattern:

[object]-[classifier]-[index]--[small-modifier].svg
  • object: Avoid using actions in the object part. Always go with real-world object names, except when there's no real-world counterpart or when the icon describes a specific/ubiquitous UI action, like share or download.
  • classifier: Additional descriptor, can be simple like open or complex like down-left.
  • index: Index for an alternative icon version.
  • small-modifier: Alternative smaller version of an existing icon.

Examples:

tick.svg
lock-open.svg
lock-open-2.svg
chevron-down--small.svg

Groups

It is possible to group icons based on specific criteria, such as if the icon represents an existing brand or if it's formally contained within a wrapper. These should be placed before the name.

[brand]-[name].svg
-- or --
[wrapper]-[name].svg
  • brand: Brand only applies when the icon represents an existing brand (E.g. Facebook, Twitter, etc).
  • wrapper: Wrapper can be circle, disc, sign, etc.

Note that brand and wrapper are mutually exclusive. There can't be a branded icon with a wrapper since brands follow the rules disciplined by their brand guides.

Examples:

brand-instagram.svg
circle-xmark.svg

Optical size

Some icons are better expressed at smaller sizes, especially when they are presented alongside text. This means that their design doesn't need to occupy the whole grid. Try to use 80% or less of the grid space instead. Example: sort.

Versions

Collecticons operates similarly to Semver with the following version convention:

  • Major: Breaking changes — removed icons, icon redesigns, name changes
  • Minor: Non-breaking changes — new icons, minor icon changes
  • Patch: Unnoticeable tweaks — slight visual changes, other updates

When the version changes the version number in the package.json file must be updated as well. Before merging to master compile the font with the collecticons processor:

collecticons compile svg --style-formats css --style-dest dist/styles --preview-dest dist/

Once the merge is done a new release should be created using the version number in the package.json.

Add Collecticons to your project

The compiled version of Collecticons is located inside the collecticons/ folder.

You can also use your usual package manager:

NPM

  1. Install collecticons.
npm install --save collecticons-lib
  1. Link to the icons.css stylesheet in the <head> of your <html> page:
<link rel="stylesheet" href="node_modules/collecticons-lib/dist/styles/icons.css">
  1. Simply use an icon in your HTML page:
<span class="collecticon collecticon-devseed"></span>

Webfont

If you are interested in generating a custom webfont and the accompanying css/sass files from the icons we've got you covered! We created a command line util specifically for this purpose.

Check the collecticons processor repo for usage instructions.

You can’t perform that action at this time.