Skip to content

timneutkens/identicons

 
 

Repository files navigation

Introducing Identicons

An Open Source icon system for Identity language by Auth0. A royalty-free, free-to-use icons and clipart representing fundamental identity concepts. Use them in presentations, specifications and documentation. For more details, read the announcement blog post.

How to Use Them?

You can download the whole set of icons or just the icons that you need from the identicons.dev site.

Do You Want to Contribute with Icons?

Awesome! To contribute you have to make a pull request with the following data:

  1. Add an icon in two versions, dark and light. In turn, have an SVG and PNG for each version, using the .svg and .png extensions respectively. Each version of the icon has to be in its own corresponding folder: ./static/icons/dark or ./static/icons/light. When building the icons, you must consider the following specifications:
  • Icon colors.
    • You can use two colors per icon for each version.
      • Light: #000000 and #eb5424.
      • Dark: #ffffff and #eb5424.
  • All icons must have a transparent background.
  • The .png icons size has to be 400x400 pixels.
  • The filename must be the same for all versions.
  1. Once you add the icons, create a new key in the ./base/iconSet.js file. The key looks like this:
icon#: {
  image: "icon-name",
  name: "Icon Name"
}

So you have to:

  • Check the key number of the last icon listed and add yours right below it with the corresponding next key number, icon#.
  • Add the image file name (without the file extension) as the value of the image property.
  • Lastly, add the icon name that you think appropriately expresses what the icon represents as the value of the name property.

This is an example of what an icon key looks like:

icon27: {
  image: "icon-user-db",
  name: "User Data Base"
}

Thanks for contributing!

About

Visual language for Identity

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%