0.1.0 • Published 5 years ago

@paraboly/react-icon-button v0.1.0

Weekly downloads
1
License
-
Repository
-
Last release
5 years ago

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

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

Install

npm i @paraboly/react-icon-button

Usage

Please check the storybook's example to get the usage of the library. You can simply 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} />;

Configuration - Props

PropertyTypeDefaultDescription
imageSourceimageundefineduse this to set your own image
onPressfunctionnullset the onPress function
textstringnulluse this to change the text
textDisablebooleanfalseuse this to disable the text part if you do not want to use text
hoverColorcolorrgba(255, 255, 255, 0.08)change button's hovered background color
iconStylestyledefaultset your own style for the icon (image)
textStylestyledefaultset your own style for the text
textContainerStylestyledefaultset your own style for the text's container
buttonStylestyledefaultset your own style for the button itself
iconAltstringundefinedset 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.