# material-ui-icons

> Material Design Svg Icons converted to Material-UI React components.

Latest version **1.0.0-beta.36** (published 2018-03-05) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install material-ui-icons
pnpm add material-ui-icons
yarn add material-ui-icons
bun add material-ui-icons
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.0-beta.36 |
| Published | 2018-03-05 |
| First published | 2017-03-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=6.11.0 |
| Dependencies | 1 |
| Unpacked size | 1.9 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 99039 |
| Author | Material-UI Team |
| Maintainers | hai-cea, mbrookes, oliviertassinari |
| Keywords | react, react-component, material design, material-ui, icons |

## Links

- npm: https://www.npmjs.com/package/material-ui-icons
- Repository: https://github.com/mui-org/material-ui
- Homepage: https://github.com/mui-org/material-ui/tree/v1-beta/packages/material-ui-icons
- Issues: https://github.com/mui-org/material-ui/issues
- npm.io page: https://npm.io/package/material-ui-icons

## Dependencies (1)

- [recompose](https://npm.io/package/recompose.md) ^0.26.0

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

- 1.0.0-beta.36 (latest) — 2018-03-05
- 1.0.0-beta.35 — 2018-02-25
- 1.0.0-beta.17 — 2017-10-15
- 1.0.0-beta.15 — 2017-10-04
- 1.0.0-beta.14 — 2017-10-01
- 1.0.0-beta.10 — 2017-09-14
- 1.0.0-beta.5 — 2017-08-18
- 1.0.0-beta.4 — 2017-08-18
- 1.0.0-alpha.19 — 2017-06-23
- 1.0.0-alpha.3 — 2017-04-25
- 1.0.0-alpha.2 — 2017-03-19
- 1.0.0-alpha.1 — 2017-03-13

## README

# material-ui-icons

This package provides the Google [Material icons](https://material.io/icons/) packaged as a set of [React](https://facebook.github.io/react/) components.

## Installation

Install the package in your project directory with:

```sh
npm install --save material-ui-icons
```

These components use the Material-UI [SvgIcon](https://material-ui-next.com/api/svg-icon/) component to
render the SVG path for each icon, and so a have a peer-dependency on the `next` release of Material-UI.

If you are not already using Material-UI in your project, you can add it with:

```sh
npm install --save material-ui@next
```

## Usage

The import path for each Material icon component includes the icon name in PascalCase.

For example to use the 'access alarm' icon component, import `material-ui-icons/AccessAlarm`.

Note: One exception is '3d rotation', which is named `ThreeDRotation`.

### Examples

- If your environment doesn't support tree-shaking, the **recommended** way to import the icons is the following:
```jsx
import AccessAlarmIcon from 'material-ui-icons/AccessAlarm';
import ThreeDRotation from 'material-ui-icons/ThreeDRotation';
```

- If your environment support tree-shaking you can also import the icons that way:
```jsx
import { AccessAlarm, ThreeDRotation } from 'material-ui-icons';
```

Note: Importing named exports in this way will result in the code for *every icon* being included in your project, so is not recommended unless you configure [tree-shaking](https://webpack.js.org/guides/tree-shaking/).

## Upgrading

If you are upgrading an existing project from Material-UI 0.x.x, you will need to revise the import paths
from `material-ui/svg-icons/<category>/<icon-name>` to `material-ui-icons/<IconName>`.

[Here](https://github.com/mui-org/material-ui/tree/v1-beta/packages/material-ui-codemod#svg-icon-imports)'s a `jscodeshift` [codemod](https://github.com/facebook/codemod) to help you upgrade.

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