# @pongo-ui/react-icon

> A collection of Icons to provide user's clarity on an action.

Latest version **0.1.13** (published 2022-03-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install @pongo-ui/react-icon
pnpm add @pongo-ui/react-icon
yarn add @pongo-ui/react-icon
bun add @pongo-ui/react-icon
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.1.13 |
| Published | 2022-03-25 |
| First published | 2022-03-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 2.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Maintainers | pongobuild, czearing |

## Links

- npm: https://www.npmjs.com/package/@pongo-ui/react-icon
- Repository: https://github.com/PongoAI/pongo-ui
- Homepage: https://github.com/PongoAI/pongo-ui#readme
- Issues: https://github.com/PongoAI/pongo-ui/issues
- npm.io page: https://npm.io/package/@pongo-ui/react-icon

## Dependencies (4)

- [@griffel/react](https://npm.io/package/@griffel/react.md) ^1.0.0
- [@pongo-ui/react-theme](https://npm.io/package/@pongo-ui/react-theme.md) ^0.0.13
- [@fluentui/react-tabster](https://npm.io/package/@fluentui/react-tabster.md) ^9.0.0-rc.5
- [@fluentui/react-utilities](https://npm.io/package/@fluentui/react-utilities.md) ^9.0.0-rc.5

## Recent versions

- 0.1.13 (latest) — 2022-03-25
- 0.1.12 — 2022-03-24
- 0.1.11 — 2022-03-20
- 0.1.10 — 2022-03-19
- 0.1.9 — 2022-03-18
- 0.1.8 — 2022-03-17
- 0.1.7 — 2022-03-15
- 0.1.6 — 2022-03-15
- 0.1.5 — 2022-03-14
- 0.1.4 — 2022-03-13
- 0.1.3 — 2022-03-12
- 0.1.2 — 2022-03-12
- 0.1.1 — 2022-03-12
- 0.1.0 — 2022-03-11
- 0.0.2 — 2022-03-11
- … 1 more at https://npm.io/package/@pongo-ui/react-icon/versions

## README

# Icon

Icons help provide user's clarity on an action. They are especially helpful in Buttons, Menus, and other controls to further convey a text based definition.

## Use

1. Install the @pongo-ui/react-icon component.

Using NPM

```
npm install @pongo-ui/react-icon
```

Using Yarn

```
yarn add @pongo-ui/react-icon
```

2. Install the @pongo-ui/react-provider and our theme tokens from @pongo-ui/react-theme

3. Set up the provider in your app:

```jsx
import { Provider } from '@pongo-ui/react-provider'
import { webLightTheme } from '@pongo-ui/react-theme'

const MyApp = () => {
  return (
    <Provider theme={webLightTheme}>
    <Provider>
  )
}
```

4. Integrate a Icon component.

```jsx
import { Provider } from '@pongo-ui/react-provider'
import { webLightTheme } from '@pongo-ui/react-theme'
import { Icon } from '@pongo-ui/react-icon'

const MyApp = () => {
  return (
    <Provider theme={webLightTheme}>
      <Icon />
    <Provider>
  )
}
```

## API

To learn more about the Icon API take a look at the [Icon Interface](src/components/Icon/Icon.types.ts) file.

---
_Source: https://npm.io/package/@pongo-ui/react-icon · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._