react-ionicons
Version:
A React SVG ionicon component
51 lines (37 loc) • 1.55 kB
Markdown
# A React Ionicon Component
<p align="center">
<img src="https://raw.githubusercontent.com/zamarrowski/react-ionicons/master/ionicons-logo.png">
</p>
View page: https://zamarrowski.github.io/react-ionicons/
## Install
```sh
$ npm install --save react-ionicons
```
## Usage
```js
import React from 'react'
import { render } from 'react-dom'
import LogoNodejs from 'react-ionicons/lib/LogoNodejs'
render(
<LogoNodejs onClick={() => alert('Hi!')} fontSize="60px" color="#43853d" />
, document.getElementById('container'))
```
### Browserify
[`browserify`](https://npmjs.com/packages/browserify) is supported, but you have to install [`browserify-css@^0.12.0`](https://npmjs.com/packages/browserify-css) manually.
## Features
* No dependencies, just React.
* SVG Icons.
* Simple API.
* Animations.
* Customizable.
* Support to Create React App.
## API:
| Param | Type | Description | Example |
| --- | --- | --- | --- |
| `className` | `String` | Name of a CSS class | `className="myClass"` |
| `fontSize` | `String` | Icon size. Allow all units (px, em, %, pt...). | `fontSize="35px"` |
| `color` | `String` | Icon color. Allow string (blue, red, cyan...), rgb, rgba and hexadecimal colors. | `color="#C9C9C9"` |
| `rotate` | `Boolean` | Apply rotate animation to icon | `rotate={true}` |
| `shake` | `Boolean` | Apply shake animation to icon | `shake={true}` |
| `beat` | `Boolean` | Apply beat animation to icon | `beat={true}` |
| `onClick` | `Function` | Pass a function to execute onClick | `onClick={() => console.log('Hi!')}` |