# @icon/material-icons

> Material Design Iconic Font and CSS toolkit

Latest version **2.2.0-alpha.3** (published 2020-02-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install @icon/material-icons
pnpm add @icon/material-icons
yarn add @icon/material-icons
bun add @icon/material-icons
```

## 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 | 2.2.0-alpha.3 |
| Published | 2020-02-13 |
| First published | 2018-02-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 860.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 25 |
| Author | Sergey Kupletsky |
| Maintainers | kaptinlin, thecreation |
| Keywords | icons, icon |

## Links

- npm: https://www.npmjs.com/package/@icon/material-icons
- Repository: https://github.com/thecreation/standard-icons/tree/master/modules/material-icons
- Homepage: https://zavoloklom.github.io/material-design-iconic-font/
- Issues: https://github.com/thecreation/standard-icons/issues
- npm.io page: https://npm.io/package/@icon/material-icons

## 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

- 2.2.0-alpha.3 (latest) — 2020-02-13
- 2.2.0 — 2019-05-23
- 2.2.0-alpha.2 — 2018-12-04
- 2.2.0-alpha.1 — 2018-11-29
- 2.2.0-alpha.0 — 2018-11-23
- 2.2.0-2 — 2018-05-17
- 2.2.0-1 — 2018-05-10
- 2.2.3 — 2018-05-08
- 2.2.2 — 2018-05-07
- 2.2.1 — 2018-04-03
- 2.2.1-0 — 2018-03-05
- 2.2.0-0 — 2018-02-28

## README

# @icon/material-icons

[![npm version](https://img.shields.io/npm/v/@icon/material-icons.svg)](https://www.npmjs.org/package/@icon/material-icons)

This repository is a module of the full [standard-icons][standard-icons] repository.

## Install

This repository is distributed with [npm]. After [installing npm][install-npm], you can install `@icon/material-icons` with this command.

```bash
npm install --save @icon/material-icons
```

## Usage

There are many ways/formats of how to use material-icons. The fastest and recommended way is via SVG directly. Or use the webfont version if you want to include all icons at once:

### SVG icons -- when you need just a few icons in your project

1 . If you want to use just a few icons. Find the icons you need in "icons" folder. Then use them as regular images:

```
<img height="32" width="32" src="@icon/material-icons/icons/airplane.svg" />
```

2 . Icons can be served from a CDN such as [Unpkg][Unpkg]. Simply use the `@icon/material-icons` npm package in the URL like the following:

```
<img height="32" width="32" src="https://unpkg.com/@icon/material-icons/icons/airplane.svg" />
```

### Icons font -- ideal when you want to include all icons at once

1 . Install `@icon/material-icons` with this command. In the `<head>` of your html, reference the location to your `material-icons.css`.

```
<head>
...
<link rel="stylesheet" href="@icon/material-icons/material-icons.css">
...
</head>
```

2 . Use [unpkg.com][Unpkg] to load directly material-icons without installing anything:

```
<head>
...
<link rel="stylesheet" href="https://unpkg.com/@icon/material-icons/material-icons.css">
...
</head>
```

> Place material-icons with `<i>` tag in your html like this. Icon class names are to be used with the `zmdi` class prefix.

```
<i class="zmdi zmdi-airplane"></i>
```


## Bugs, Ideas, Pull Requests

If you have any ideas or found bugs, please send me Pull Requests or let me know with [GitHub Issues][github issues].

## License

Material-icons is copyright by Sergey Kupletsky, font is licensed under the [SIL OFL 1.1][SIL], code is licensed under the [MIT License][MIT].

[MIT]: https://opensource.org/licenses/MIT
[SIL]: http://scripts.sil.org/OFL
[standard-icons]: https://github.com/thecreation/standard-icons
[npm]: https://www.npmjs.com/
[install-npm]: https://docs.npmjs.com/getting-started/installing-node
[sass]: http://sass-lang.com/
[github issues]: https://github.com/thecreation/standard-icons/issues
[Unpkg]: https://unpkg.com

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