Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/iconify/icon-sets

150+ open source icon sets. Icons are validated, cleaned up, optimised, ready to render as SVG. Updated automatically 3 times a week.
https://github.com/iconify/icon-sets

Last synced: 3 days ago
JSON representation

150+ open source icon sets. Icons are validated, cleaned up, optimised, ready to render as SVG. Updated automatically 3 times a week.

Awesome Lists containing this project

README 

        
# Iconify icon sets in JSON format



This is a big collection of open source vector icons, all validated, cleaned up and converted to the same easy to use format.



Even though all icon sets are open source, some icon sets require attribution.



See [collections.md](./collections.md) for list of icon sets and their licenses.



## Validation and clean up



All icons have been processed with [Iconify Tools](https://iconify.design/docs/libraries/tools/) to clean them up.



Icon parsing process includes:



- Very strict validation and clean up. Icons do not contain scripts, even listeners, fonts, raster images, external resources and unknown elements.

- Colors for monotone icons have been replaced with `currentColor`, making it easy to change icon color by changing text color.

- Icon content has been optimised to reduce its size.



## Maintenance



This repository is automatically updated several times a week, so it always contains the latest icons for all icon sets.



## Format



Icon sets are stored in `IconifyJSON` format. TypeScript definition is available in `@iconify/types` package. Documentation is [available on Iconify Documentation website](https://iconify.design/docs/types/iconify-json.html).



To work with icon sets, use [Iconify Utils](https://iconify.design/docs/libraries/utils/). Utils package works in any JavaScript environment: Node.js, Deno, browsers, isolated JavaScript environments.



## Usage



These icons can be used with many tools, plugins and components. They can also be exported as individual SVG files.



See [Iconify documentation](https://iconify.design/docs/usage/) for more details.



## How to get this repository



Instructions below are for Node.js and PHP projects.



### Node.js



Run this command to add icons to your project:



```bash

npm install --save @iconify/json

```



Icons will be available in node_modules/@iconify/json



To resolve filename for any json file, use this if you are using CommonJS syntax:



```js

import { locate } from '@iconify/json';



// returns location of mdi-light.json

const mdiLightFilename = locate('mdi-light');

```



### PHP



Install and initialize Composer project. See documentation at [https://getcomposer.org](https://getcomposer.org)



Then open composer.json and add following code:



```json

"require": {

    "php": ">=5.6",

    "iconify/json": "*"

}

```



then run:



```bash

composer install

```



Icons will be available in vendor/iconify/json/



If you don't use Composer, clone GitHub repository and add necessary autoload code.



To resolve filename for any json file, use this:



```php

// Returns location of mdi-light.json

$mdiLightLocation = \Iconify\IconsJSON\Finder::locate('mdi-light');

```



## Data format



Icons used by Iconify are in directory json, in Iconify JSON format.



Why JSON instead of SVG? There are several reasons for that:



- Easy to store images in bulk.

- Contains only content of icon without `` element, making it easy to manipulate content without doing complex parsing. It also makes it easier to create components, such as React icon component, allowing to use framework native SVG element.

- Data can contain additional content: aliases for icons, icon set information, categories/tags/themes.



Why not XML?



- JSON is much easier to parse without additional tools. All languages support it.



Format of json file is very simple:



```json

{

  "prefix": "mdi-light",

  "icons": {

    "icon-name": {

      "body": "",

      "width": 24,

      "height": 24

    }

  },

  "aliases": {

    "icon-alias": {

      "parent": "icon-name"

    }

  }

}

```



"icons" object contains list of all icons.



Each icon has following properties:



- body: icon body.

- left, top: left and top coordinates of viewBox, default is 0.

- width, height: dimensions of viewBox, default is 16.

- rotate: rotation. Default = 0. Values: 0 = 0deg, 1 = 90deg, 2 = 180deg, 3 = 270deg.

- hFlip: horizontal flip. Boolean value, default = false.

- vFlip: vertical flip. Boolean value, default = false.

- hidden: if set to true, icon is hidden. That means icon was removed from collection for some reason, but it is kept in JSON file to prevent applications that rely on old icon from breaking.



Optional "aliases" object contains list of aliases for icons. Format is similar to "icons" object, but without "body" property and with additional property "parent" that points to parent icon. Transformation properties (rotate, hFlip, vFlip) are merged with parent icon's properties. Any other properties overwrite properties of parent icon.



When multiple icons have the same value, it is moved to root object to reduce duplication:



```json

{

  "prefix": "mdi-light",

  "icons": {

    "icon1": {

      "body": ""

    },

    "icon2": {

      "body": ""

    },

    "icon-20": {

      "body": "",

      "width": 20,

      "height": 20

    }

  },

  "width": 24,

  "height": 24

}

```



In example above, "icon1" and "icon2" are 24x24, "icon-20" is 20x20.



For more information see developer documentation on [https://iconify.design/docs/types/iconify-json.html](https://docs.iconify.design/types/iconify-json.html)



## Extracting individual SVG icons



You can use [Iconify Utils](https://iconify.design/docs/libraries/utils/) for simple export process or [Iconify Tools](https://iconify.design/docs/libraries/tools/) for more options.



Example using Iconify Utils (TypeScript):



```ts

import { promises as fs } from 'fs';



// Function to locate JSON file

import { locate } from '@iconify/json';



// Various functions from Iconify Utils

import { parseIconSet } from '@iconify/utils/lib/icon-set/parse';

import { iconToSVG } from '@iconify/utils/lib/svg/build';

import { defaults } from '@iconify/utils/lib/customisations';



(async () => {

  // Locate icons

  const filename = locate('mdi');



  // Load icon set

  const icons = JSON.parse(await fs.readFile(filename, 'utf8'));



  // Parse all icons

  const exportedSVG: Record = Object.create(null);

  parseIconSet(icons, (iconName, iconData) => {

    if (!iconData) {

      // Invalid icon

      console.error(`Error parsing icon ${iconName}`);

      return;

    }



    // Render icon

    const renderData = iconToSVG(iconData, {

      ...defaults,

      height: 'auto',

    });



    // Generate attributes for SVG element

    const svgAttributes: Record = {

      'xmlns': 'http://www.w3.org/2000/svg',

      'xmlns:xlink': 'http://www.w3.org/1999/xlink',

      ...renderData.attributes,

    };

    const svgAttributesStr = Object.keys(svgAttributes)

      .map(

        (attr) =>

          // No need to check attributes for special characters, such as quotes,

          // they cannot contain anything that needs escaping.

          `${attr}="${svgAttributes[attr as keyof typeof svgAttributes]}"`

      )

      .join(' ');



    // Generate SVG

    const svg = `${renderData.body}`;

    exportedSVG[iconName] = svg;

  });



  // Output directory

  const outputDir = 'mdi-export';

  try {

    await fs.mkdir(outputDir, {

      recursive: true,

    });

  } catch (err) {

    //

  }



  // Save all files

  const filenames = Object.keys(exportedSVG);

  for (let i = 0; i < filenames.length; i++) {

    const filename = filenames[i];

    const svg = exportedSVG[filename];

    await fs.writeFile(outputDir + '/' + filename + '.svg', svg, 'utf8');

  }

})();

```



Same example using Iconify Tools:



```ts

import { readFile, writeFile, mkdir } from 'fs';

import { SVG } from '@iconify/tools';



const outputDir = 'mdi-export';



// Create target directory

try {

  await mkdir(outputDir, {

    recursive: true,

  });

} catch (err) {

  //

}



// Locate icons

const filename = locate('mdi');



// Load icon set

const data = JSON.parse(await fs.readFile(filename, 'utf8'));



// Create IconSet instance

const iconSet = new IconSet(data);



// Export all icons

await iconSet.forEach(async (name) => {

  const svg = iconSet.toString(name);

  if (!svg) {

    return;

  }



  // Save to file

  await writeFile(`${outputDir}/${name}.svg`, svg, 'utf8');

  console.log(`Saved ${outputDir}/${name}.svg (${svg.length} bytes)`);

});

```



See [Iconify Tools documentation](https://iconify.design/docs/libraries/tools/export/) for more export options.



## License



This is collection of icon sets created by various authors.



See [collections.md](./collections.md) for list of icon sets and their licenses.