sushmac

parovinay

archanaatparo

saisagar

bari-paro

reginald.ross

kbajzek

aai-riyaj

paroadmin

andybustmante

jesslombera

german-paro

nihal-paro

@paro.io/base-icons

# base-icons

> Base Icons for react applications

[![NPM](https://img.shields.io/npm/v/base-ui.svg)](https://www.npmjs.com/package/base-ui) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Install

```bash
yarn add @paro.io/base-icons
```


## Development
### Run locally
```
npm install
```

### Importing as local package into a project
Under the base-icons directory run
```
npm build or yarn build
```
then 

```
npm pack or yarn pack
```
Under the consumer project import the TAR file generated by `npm pack`
```
yarn add base-icons/file.tgz
```

### Publishing to npm
```
npm publish
```

## Usage
- Use icon size medium for primary navigation, marketing sections, icon-only buttons. Rendered at 24x24.
- Use icon size small for buttons, form elements, and to support text. Rendered at 20x20.

```tsx
import {IconMail} from @paro.io/base-icons
...
const ExampleComponent = () => (
  <IconMail size="md"/>
  <IconMail size="sm" />
)
```

## Documentation
[https://paroadmin.github.io/base-ui/#/assets/icons ](https://paroadmin.github.io/base-ui/#/assets/icons)

### Other
Icons are developed as an extension of https://heroicons.com/.
