https://github.com/paraboly/react-icon-button

Fully customizable, Plug & Play Icon Button Component for React by Paraboly
https://github.com/paraboly/react-icon-button

Last synced: about 1 year ago
JSON representation

Fully customizable, Plug & Play Icon Button Component for React by Paraboly

• Host: GitHub
• URL: https://github.com/paraboly/react-icon-button
• Owner: Paraboly
• Created: 2020-06-26T10:50:30.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-06-26T15:43:39.000Z (almost 6 years ago)
• Last Synced: 2025-04-09T23:43:02.974Z (about 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 362 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          


[![Fully customizable, Plug & Play Icon Button Component for React by Paraboly](https://img.shields.io/badge/-Fully%20customizable%2C%20Plug%20%26%20Play%20Icon%20Button%20Component%20for%20React%20by%20Paraboly-lightgrey?style=for-the-badge)](https://github.com/Paraboly/react-icon-button)

[![npm version](https://img.shields.io/npm/v/@paraboly/react-icon-button.svg?style=for-the-badge)](https://www.npmjs.com/package/@paraboly/react-icon-button)

[![npm](https://img.shields.io/npm/dt/@paraboly/react-icon-button.svg?style=for-the-badge)](https://www.npmjs.com/package/@paraboly/react-icon-button)

![Platform - Web](https://img.shields.io/badge/platform-web-blue.svg?style=for-the-badge)

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier)



  



# Install

```sh

npm i @paraboly/react-icon-button

```

# Usage

Please check the storybook's example to get the usage of the library.

You can clone the project and `npm i && npm start` to check the how to use the library with alive example.

```js

import IconButton from "@paraboly/react-icon-button";

 {}} />;

```

### Configuration - Props

| Property           |   Type   |          Default          | Description                                                      |

| ------------------ | :------: | :-----------------------: | ---------------------------------------------------------------- |

| imageSource        |  image   |         undefined         | use this to set your own image                                   |

| onPress            | function |           null            | set the onPress function                                         |

| text               |  string  |           null            | use this to change the text                                      |

| textDisable        | boolean  |           false           | use this to disable the text part if you do not want to use text |

| hoverColor         |  color   | rgba(255, 255, 255, 0.08) | change button's hovered background color                         |

| iconStyle          |  style   |          default          | set your own style for the icon (image)                          |

| textStyle          |  style   |          default          | set your own style for the text                                  |

| textContainerStyle |  style   |          default          | set your own style for the text's container                      |

| buttonStyle        |  style   |          default          | set your own style for the button itself                         |

| iconAlt            |  string  |         undefined         | set your own alt naming for the icon (image)                     |

## Credits

Thank you so much for the filter icon [Flaticon](https://www.flaticon.com/free-icon/filter_872173?term=filter&page=1&position=95)

## Author

FreakyCoder, kurayogun@gmail.com

## License

React Icon Button is available under the MIT license. See the LICENSE file for more info.