Skip to content

Paraboly/react-icon-button

Repository files navigation

React Icon Button

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

npm version npm Platform - Web License: MIT styled with prettier

React Icon Button

Install

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.

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

<IconButton text="Filter" imageSource={filterIcon} onPress={() => {}} />;

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

Author

FreakyCoder, kurayogun@gmail.com

License

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

About

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

Resources

Stars

Watchers

Forks

Packages

No packages published