spaceout/site/frontend/node_modules/@material-ui/icons/README.md

34 lines
903 B
Markdown

# @material-ui/icons
This package provides the Google [Material icons](https://material.io/tools/icons/) packaged as a set of [React](https://facebook.github.io/react/) components.
## Installation
Install the package in your project directory with:
```sh
// with npm
npm install @material-ui/icons
// with yarn
yarn add @material-ui/icons
```
These components use the Material-UI [SvgIcon](https://material-ui.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
// with npm
npm install @material-ui/core
// with yarn
yarn add @material-ui/core
```
## Documentation
- [The documentation](https://material-ui.com/components/icons/#svg-material-icons)
- [The icons search](https://material-ui.com/components/material-icons/)