README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

# Material Design

This repo contains all the planning for current and work-in-progress Material Design Icons.

[Getting Started](http://materialdesignicons.com/getting-started)

[![npm](https://img.shields.io/npm/v/@mdi/font.svg)](https://www.npmjs.com/package/@mdi/svg) [![GitHub issues](https://img.shields.io/github/issues/Templarian/MaterialDesign.svg)](https://github.com/Templarian/MaterialDesign/issues)

## Icons

View at [Material Design Icons](http://materialdesignicons.com/). This repo also contains converted icons from [Google's official icon set](https://github.com/google/material-design-icons).

|                 | NPM                   | Dist Repo |   |
|-----------------|-----------------------|-----------|---|
| Webfont / SCSS  | `npm install @mdi/font`     | [MaterialDesign-Webfont](https://github.com/Templarian/MaterialDesign-Webfont) | [![npm](https://img.shields.io/npm/dm/@mdi/font.svg)](https://github.com/Templarian/MaterialDesign-Webfont) |
| JavaScript / TypeScript  | `npm install @mdi/js`     | [MaterialDesign-JS](https://github.com/Templarian/MaterialDesign-JS) | [![npm](https://img.shields.io/npm/dm/@mdi/js.svg)](https://github.com/Templarian/MaterialDesign-JS) |
| ReactJS  | `npm install @mdi/react`     | [MaterialDesign-React](https://github.com/Templarian/MaterialDesign-React) | [![npm](https://img.shields.io/npm/dm/@mdi/react.svg)](https://github.com/Templarian/MaterialDesign-React) |
| SVG / Meta.json | `npm install @mdi/svg` | [MaterialDesign-SVG](https://github.com/Templarian/MaterialDesign-SVG)     | [![npm](https://img.shields.io/npm/dm/@mdi/svg.svg)](https://github.com/Templarian/MaterialDesign-SVG) |
| Desktop Font | n/a | [MaterialDesign-Font](https://github.com/Templarian/MaterialDesign-Font)     |

[Upgrade Guide](https://dev.materialdesignicons.com/upgrade) | [Changelog Guide](https://dev.materialdesignicons.com/changelog)

[![Icons](http://i.imgur.com/zKuXEkR.png)](https://materialdesignicons.com/)

**Warning (Cordova only):** _You will need to manually edit the css file to remove the version query string. [Read More](https://github.com/Templarian/MaterialDesign/issues/760)._

## Contribute

Please do not make pull requests against this repositiory. All icons are managed through the Material Design Icons site by the various contributors and synced instantly. If you want to become a contributor [read more](http://materialdesignicons.com/contribute).

### Icon Suggestions

Submit icon suggestions through the issue tab. Please include examples.

### Third Party (Plugins / Extensions / etc)

- [Third Party Guide](http://dev.materialdesignicons.com/contribute/third-party)
- [First Party Guide](http://dev.materialdesignicons.com/contribute/first-party)

## License

[View the License](https://github.com/Templarian/MaterialDesign/blob/master/LICENSE)

## Code of Conduct

[View and submit violations](https://materialdesignicons.com/code-of-conduct).