# material-ui-apollo-icons

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

Latest version **1.0.0-alpha.4** (published 2018-05-19) · UNLICENSED license · 0 weekly downloads

## Install

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

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0-alpha.4 |
| Published | 2018-05-19 |
| First published | 2017-10-11 |
| Weekly downloads | 0 |
| License | UNLICENSED |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 827.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | qi-do-apollo-owner |

## Links

- npm: https://www.npmjs.com/package/material-ui-apollo-icons
- Repository: https://gitlab.ims.io/apollo/material-ui-apollo-icons
- npm.io page: https://npm.io/package/material-ui-apollo-icons

## Dependencies (1)

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

## Recent versions

- 1.0.0-alpha.4 (latest) — 2018-05-19
- 1.0.0-alpha.3 — 2018-05-19
- 1.0.0-alpha.2 — 2018-05-18
- 1.0.0-alpha.1 — 2017-10-11

## README

# material-ui-apollo-icons

This package provides the Quintiles IMS [Apollo Icons](https://apollo.ims.io/scaffolding/icons.html) packaged as a set of [React](https://facebook.github.io/react/) components.

## Installation

Install the package in your project directory with:

```
yarn add material-ui-apollo-icons
```

These components use the Material-UI [SvgIcon](http://material-ui.com/#/style/icons) 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:

```
yarn add @material-ui/core
```

## Usage

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

For example to use the 'account' icon component, import `material-ui-apollo-icons/Account`.

### Examples

- If your environment doesn't support tree-shaking, the **recommended** way to import the icons is the following:
```jsx
import AccountIcon from 'material-ui-apollo-icons/Account';
import AirplaneIcon from 'material-ui-apollo-icons/Airplane';
```

- If your environment support tree-shaking you can also import the icons that way:
```jsx
import { Account, Airplane } from 'material-ui-apollo-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/).

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