1 | <p align="center">
|
2 | <img src="https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/simpleicons.svg" alt="Simple Icons" width=70>
|
3 | <h3 align="center">Simple Icons</h3>
|
4 | <p align="center">
|
5 | Over 2300 Free SVG icons for popular brands. See them all on one page at <a href="https://simpleicons.org">SimpleIcons.org</a>. Contributions, corrections & requests can be made on GitHub.</p>
|
6 | </p>
|
7 |
|
8 | <p align="center">
|
9 | <a href="https://github.com/simple-icons/simple-icons/actions?query=workflow%3AVerify+branch%3Adevelop"><img src="https://img.shields.io/github/workflow/status/simple-icons/simple-icons/Verify/develop?logo=github&label=tests" alt="Build status"/></a>
|
10 | <a href="https://www.npmjs.com/package/simple-icons"><img src="https://img.shields.io/npm/v/simple-icons.svg?logo=npm" alt="NPM version"/></a>
|
11 | <a href="https://packagist.org/packages/simple-icons/simple-icons"><img src="https://img.shields.io/packagist/v/simple-icons/simple-icons?logo=packagist&logoColor=white" alt="Build status"/></a>
|
12 | </p>
|
13 | <p align="center">
|
14 | <a href="https://simpleicons.org"><img src="https://img.shields.io/badge/dynamic/json?color=informational&label=icons&prefix=%20&logo=simpleicons&query=%24.icons.length&url=https%3A%2F%2Fraw.githubusercontent.com%2Fsimple-icons%2Fsimple-icons%2Fdevelop%2F_data%2Fsimple-icons.json" alt="Number of icons currently in the library"/></a>
|
15 | <a href="https://opencollective.com/simple-icons"><img src="https://img.shields.io/opencollective/all/simple-icons?logo=opencollective" alt="Backers and sponsors on Open Collective"/></a>
|
16 | </p>
|
17 |
|
18 | ## Usage
|
19 |
|
20 | > :information_source: We ask that all users read our [legal disclaimer](./DISCLAIMER.md) before using icons from Simple Icons.
|
21 |
|
22 | ### General Usage
|
23 |
|
24 | Icons can be downloaded as SVGs directly from [our website](https://simpleicons.org/) - simply click the icon you want, and the download should start automatically.
|
25 |
|
26 | ### CDN Usage
|
27 |
|
28 | Icons can be served from a CDN such as [JSDelivr](https://www.jsdelivr.com/package/npm/simple-icons) or [Unpkg](https://unpkg.com/browse/simple-icons/). Simply use the `simple-icons` npm package and specify a version in the URL like the following:
|
29 |
|
30 | ```html
|
31 | <img height="32" width="32" src="https://cdn.jsdelivr.net/npm/simple-icons@v7/icons/[ICON SLUG].svg" />
|
32 | <img height="32" width="32" src="https://unpkg.com/simple-icons@v7/icons/[ICON SLUG].svg" />
|
33 | ```
|
34 |
|
35 | Where `[ICON SLUG]` is replaced by the [slug] of the icon you want to use, for example:
|
36 |
|
37 | ```html
|
38 | <img height="32" width="32" src="https://cdn.jsdelivr.net/npm/simple-icons@v7/icons/simpleicons.svg" />
|
39 | <img height="32" width="32" src="https://unpkg.com/simple-icons@v7/icons/simpleicons.svg" />
|
40 | ```
|
41 |
|
42 | These examples use the latest major version. This means you won't receive any updates following the next major release. You can use `@latest` instead to receive updates indefinitely. However, this will result in a `404` error if the icon is removed.
|
43 |
|
44 | ### Node Usage <img src="https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/nodedotjs.svg" alt="Node" align=left width=24>
|
45 |
|
46 | The icons are also available through our npm package. To install, simply run:
|
47 |
|
48 | ```shell
|
49 | npm install simple-icons
|
50 | ```
|
51 |
|
52 | All icons are imported from a single file, where `[ICON SLUG]` is replaced by a capitalized [slug]. We highly recommend using a bundler that can tree shake such as [webpack](https://webpack.js.org/) to remove the unused icon code:
|
53 | ```javascript
|
54 | // Import a specific icon by its slug as:
|
55 | // import { si[ICON SLUG] } from 'simple-icons/icons'
|
56 |
|
57 | // For example:
|
58 | // use import/esm to allow tree shaking
|
59 | import { siSimpleicons } from 'simple-icons/icons';
|
60 | // or with require/cjs
|
61 | const { siSimpleicons } = require('simple-icons/icons');
|
62 | ```
|
63 |
|
64 | It will return an icon object:
|
65 |
|
66 | ```javascript
|
67 | console.log(siSimpleicons);
|
68 |
|
69 | /*
|
70 | {
|
71 | title: 'Simple Icons',
|
72 | slug: 'simpleicons',
|
73 | hex: '111111',
|
74 | source: 'https://simpleicons.org/',
|
75 | svg: '<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">...</svg>',
|
76 | path: 'M12 12v-1.5c-2.484 ...',
|
77 | guidelines: 'https://simpleicons.org/styleguide',
|
78 | license: {
|
79 | type: '...',
|
80 | url: 'https://example.com/'
|
81 | }
|
82 | }
|
83 |
|
84 | NOTE: the `guidelines` entry will be `undefined` if we do not yet have guidelines for the icon.
|
85 | NOTE: the `license` entry will be `undefined` if we do not yet have license data for the icon.
|
86 | */
|
87 | ```
|
88 |
|
89 | #### TypeScript Usage <img src="https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/typescript.svg" alt="Typescript" align=left width=19 height=19>
|
90 |
|
91 | Type definitions are bundled with the package.
|
92 |
|
93 | ### PHP Usage <img src="https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/php.svg" alt="Php" align=left width=24 height=24>
|
94 |
|
95 | The icons are also available through our Packagist package. To install, simply run:
|
96 |
|
97 | ```shell
|
98 | composer require simple-icons/simple-icons
|
99 | ```
|
100 |
|
101 | The package can then be used as follows, where `[ICON SLUG]` is replaced by a [slug]:
|
102 |
|
103 | ```php
|
104 | <?php
|
105 | // Import a specific icon by its slug as:
|
106 | echo file_get_contents('path/to/package/icons/[ICON SLUG].svg');
|
107 |
|
108 | // For example:
|
109 | echo file_get_contents('path/to/package/icons/simpleicons.svg');
|
110 |
|
111 | // <svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">...</svg>
|
112 | ?>
|
113 | ```
|
114 |
|
115 | ## Third-Party Extensions
|
116 |
|
117 | | Extension | Author |
|
118 | | :-- | :-- |
|
119 | | <img src="https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/angular.svg" alt="Angular" align=left width=24 height=24> [Angular Module](https://github.com/avmaisak/ngx-simple-icons) | [@avmaisak](https://github.com/avmaisak) |
|
120 | | <img src="https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/blender.svg" alt="Blender" align=left width=24 height=24> [Blender add-on](https://github.com/mondeja/simple-icons-blender) | [@mondeja](https://github.com/mondeja) |
|
121 | | <img src="https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/diagramsdotnet.svg" alt="Drawio" align=left width=24 height=24> [Drawio library](https://github.com/mondeja/simple-icons-drawio) | [@mondeja](https://github.com/mondeja) |
|
122 | | <img src="https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/drupal.svg" alt="Drupal" align=left width=24 height=24> [Drupal module](https://www.drupal.org/project/simple_icons) | [Phil Wolstenholme](https://www.drupal.org/u/phil-wolstenholme) |
|
123 | | <img src="https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/flutter.svg" alt="Flutter" align=left width=24 height=24> [Flutter package](https://pub.dev/packages/simple_icons) | [@jlnrrg](https://jlnrrg.github.io/) |
|
124 | | <img src="https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/hexo.svg" alt="Hexo" align=left width=24 height=24> [Hexo plugin](https://github.com/nidbCN/hexo-simpleIcons) | [@nidbCN](https://github.com/nidbCN/) |
|
125 | | <img src="https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/homeassistant.svg" alt="Home Assistant" align=left width=24 height=24> [Home Assistant plugin](https://github.com/vigonotion/hass-simpleicons) | [@vigonotion](https://github.com/vigonotion/) |
|
126 | | <img src="https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/hugo.svg" alt="Hugo" align=left width=24 height=24> [Hugo module](https://github.com/foo-dogsquared/hugo-mod-simple-icons) | [@foo-dogsquared](https://github.com/foo-dogsquared) |
|
127 | | <img src="https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/openjdk.svg" alt="OpenJDK" align=left width=24 height=24> [Java library](https://github.com/silentsoft/simpleicons4j) | [@silentsoft](https://github.com/silentsoft) |
|
128 | | <img src="https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/jetpackcompose.svg" alt="Jetpack Compose" align=left width=24 height=24> [Jetpack Compose library](https://github.com/DevSrSouza/compose-icons) | [@devsrsouza](https://github.com/devsrsouza/) |
|
129 | | <img src="https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/kirby.svg" alt="Kirby" align=left width=24 height=24> [Kirby plugin](https://github.com/runxel/kirby3-simpleicons) | [@runxel](https://github.com/runxel) |
|
130 | | <img src="https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/latex.svg" alt="LaTeX" align=left width=24 height=24> [LaTeX package](https://github.com/ineshbose/simple-icons-latex) | [@ineshbose](https://github.com/ineshbose) |
|
131 | | <img src="https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/laravel.svg" alt="Laravel" align=left width=24 height=24> [Laravel Package](https://github.com/ublabs/blade-simple-icons) | [@adrian-ub](https://github.com/adrian-ub) |
|
132 | | <img src="https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/python.svg" alt="Python" align=left width=24 height=24> [Python package](https://github.com/sachinraja/simple-icons-py) | [@sachinraja](https://github.com/sachinraja) |
|
133 | | <img src="https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/react.svg" alt="React" align=left width=24 height=24> [React package](https://github.com/icons-pack/react-simple-icons) | [@wootsbot](https://github.com/wootsbot) |
|
134 | | <img src="https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/simpleicons.svg" alt="Simple Icons" align=left width=24 height=24> [Stream Deck icon pack](https://github.com/mackenly/simple-icons-stream-deck) | [@mackenly](https://github.com/mackenly) |
|
135 | | <img src="https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/svelte.svg" alt="Svelte" align=left width=24 height=24> [Svelte package](https://github.com/icons-pack/svelte-simple-icons) | [@wootsbot](https://github.com/wootsbot) |
|
136 | | <img src="https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/vuedotjs.svg" alt="Vue" align=left width=24 height=24> [Vue 3 package](https://github.com/wyatt-herkamp/vue3-simple-icons) | [@wyatt-herkamp](https://github.com/wyatt-herkamp) |
|
137 | | <img src="https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/vuedotjs.svg" alt="Vue" align=left width=24 height=24> [Vue package](https://github.com/mainvest/vue-simple-icons) | [@noahlitvin](https://github.com/noahlitvin) |
|
138 | | <img src="https://raw.githubusercontent.com/simple-icons/simple-icons/develop/icons/wordpress.svg" alt="Wordpress" align=left width=24 height=24> [WordPress plugin](https://wordpress.org/plugins/simple-icons/) | [@tjtaylo](https://github.com/tjtaylo) |
|
139 |
|
140 |
|
141 | [slug]: ./slugs.md
|
142 |
|
143 | ## Contribute
|
144 |
|
145 | [![Good first issues open](https://img.shields.io/github/issues/simple-icons/simple-icons/good%20first%20issue?label=good%20first%20issues&logo=git&logoColor=white)](https://github.com/simple-icons/simple-icons/labels/good%20first%20issue)
|
146 |
|
147 | Information describing how to contribute can be found here:
|
148 |
|
149 | https://github.com/simple-icons/simple-icons/blob/develop/CONTRIBUTING.md
|