# @availity/mui-icon

> Availity MUI Icon component to be used with @availity/element design system.

[![Version](https://img.shields.io/npm/v/@availity/mui-icon.svg?style=for-the-badge)](https://www.npmjs.com/package/@availity/mui-icon)
[![NPM Downloads](https://img.shields.io/npm/dt/@availity/mui-icon.svg?style=for-the-badge)](https://www.npmjs.com/package/@availity/mui-icon)
[![Dependency Status](https://img.shields.io/librariesio/release/npm/@availity/mui-icon?style=for-the-badge)](https://github.com/Availity/element/blob/main/packages/icon/package.json)

## Documentation

This package extends the MUI SvgIcon component([MUI Icon Docs](https://mui.com/components/icons/)) to wrap UX Approved Font Awesome Icons.

Live demo and documentation in our [Storybook](https://availity.github.io/element/?path=/docs/components-icon-introduction--docs)

Availity standards for design and usage can be found in the [Availity Design Guide](https://design.availity.com/2e36e50c7)

## Installation

### Import Through @availity/element (Recommended)

#### NPM

```bash
npm install @availity/element
```

#### Yarn

```bash
yarn add @availity/element
```

### Direct Import

#### NPM

```bash
npm install @availity/mui-icon
```

#### Yarn

```bash
yarn add @availity/mui-icon
```

### Usage

#### Import through @availity/element

```tsx
import { HomeIcon } from '@availity/element';
```

#### Direct import

```tsx
import { HomeIcon } from '@availity/mui-icon';
```