mdp.icons
v0.0.5
Published
Convert Material Design Svg Icons to Material-UI React components.
Downloads
9
Maintainers
Readme
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 --save 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:
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:
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:
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.
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>
.