# material-design-icons-iconfont

> Material Design Icons DX

Latest version **6.7.0** (published 2022-04-23) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install material-design-icons-iconfont
pnpm add material-design-icons-iconfont
yarn add material-design-icons-iconfont
bun add material-design-icons-iconfont
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 6.7.0 |
| Published | 2022-04-23 |
| First published | 2015-07-13 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.4 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 459 |
| Author | Material Design Authors, Jossef Harush |
| Maintainers | jossef |
| Keywords | icons, material, material-design, material-design-icons, material-design-icons-build, material-design-icons-release, material-design-icons-dist, material-design-icons-iconfont, mdidx, google, nuxt |

## Links

- npm: https://www.npmjs.com/package/material-design-icons-iconfont
- Repository: https://github.com/jossef/material-design-icons-iconfont
- Homepage: https://jossef.github.io/material-design-icons-iconfont/
- Issues: https://github.com/jossef/material-design-icons-iconfont/issues
- npm.io page: https://npm.io/package/material-design-icons-iconfont

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads

## Recent versions

- 6.7.0 (latest) — 2022-04-23
- 6.6.0 — 2022-04-06
- 6.5.0 — 2022-03-13
- 6.4.2 — 2022-02-23
- 6.4.1 — 2022-02-19
- 6.4.0 — 2022-02-19
- 6.3.0 — 2022-02-19
- 6.2.0 — 2022-02-19
- 6.1.1 — 2021-11-01
- 6.1.0 — 2020-09-06
- 6.0.2 — 2020-09-03
- 1.0.0 — 2020-09-03
- 6.0.1 — 2020-08-30
- 5.0.1 — 2019-05-07
- 4.0.5 — 2019-02-16
- … 14 more at https://npm.io/package/material-design-icons-iconfont/versions

## README

![banner-01](https://user-images.githubusercontent.com/1287098/47606030-f76c3680-da16-11e8-8508-92b26b68f3f8.png)


[Project's Demo Page](https://jossef.github.io/material-design-icons-iconfont)


## MDI**DX** - Same Material Design icons, Better DX 


MDI**DX** (this repository) is a ~*fork* (+ fixes) of Google's [Material Design icons](https://github.com/google/material-design-icons) repository. 
Sadly, Google allocates **low maintenance and low support** for issues reported by software developers having trouble using the Material Design icons library.
 

MDI**DX** helps modern **web developers** to use and include the (awesome) Material Design icons library in their project.
 


### Installation

using npm
```
npm install material-design-icons-iconfont --save
```


### Usage - Check out the [Demo Page](https://jossef.github.io/material-design-icons-iconfont)


- Using `scss`

  Import fonts and variables in your project
 
  ```scss
  $material-design-icons-font-directory-path: '~material-design-icons-iconfont/dist/fonts/';

  @import '~material-design-icons-iconfont/src/material-design-icons';
  ```

  **Customize your own classes**

  access material variable with Sass mixins:

  ```scss
  .my-face {
    @include material-icon('face');
  }
  # or
  .my-face:before {
    content: material-icons-content('face');
  }
  ```



### What's the difference? Why forking?


- **Performance** - 
    When you checkout Google's [original repository](https://github.com/google/material-design-icons)  ( via git, npm and bower) you experience an unwanted delay. This **checkout delay** is caused by **thousands** of separate source graphic `svg,png,...` files. 
    
    Needless to say that these file are **irrelevant** for the average developer's purposes and **cause build congestion** (especially when using in CI systems)
   
    In this fork all irrelevant files have been **removed** while keeping only the required files. 


- **SCSS Support** - Modern developers need support for `scss`. You can customize the referenced font's files filename and path 


- **Maintenance** - The original repository's release has **missing icons** that should be included according to [https://material.io/tools/icons](https://material.io/tools/icons)


### [Demo Page](https://jossef.github.io/material-design-icons-iconfont)

![image](https://user-images.githubusercontent.com/1287098/47608007-44a8d200-da30-11e8-8750-694fb2fb26e4.png)

### How to contribute to this project

**Configure environment**

Install nodejs on your environemt (> 7.6 for async await)

**running build**
```
npm install
npm run build
```

---
_Source: https://npm.io/package/material-design-icons-iconfont · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._