@material-ui/icons

This package provides the Google Material icons packaged as a set of React components.

Installation

Install the package in your project directory with:

npm install @material-ui/icons

These components use the Material-UI SvgIcon 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:

// with npm
npm install @weareroam/cake-ui-v1

// with yarn
yarn add @weareroam/cake-ui-v1

Usage

You can use material.io/tools/icons to find a specific icon. When importing an icon, keep in mind that the names of the icons are PascalCase, for instance:

• delete is exposed as @material-ui/icons/Delete
• delete forever is exposed as @material-ui/icons/DeleteForever

For "themed" icons, append the theme name to the icon name. For instance with the

• The Outlined delete icon is exposed as @material-ui/icons/DeleteOutlined
• The Rounded delete icon is exposed as @material-ui/icons/DeleteRounded
• The Two Tone delete icon is exposed as @material-ui/icons/DeleteTwoTone
• The Sharp delete icon is exposed as @material-ui/icons/DeleteSharp

There are three exceptions to this rule:

• 3d_rotation is exposed as @material-ui/icons/ThreeDRotation
• 4k is exposed as @material-ui/icons/FourK
• 360 is exposed as @material-ui/icons/ThreeSixty

Imports

• If your environment doesn't support tree-shaking, the recommended way to import the icons is the following:

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 this way:

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. It may also impact Hot Module Reload performance.

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's a jscodeshift codemod to help you upgrade.