Socket
Socket
Sign inDemoInstall

react-awesome-button

Package Overview
Dependencies
6
Maintainers
1
Versions
57
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    react-awesome-button

Performant, extendable, highly customisable, production ready React Component that renders an animated basic set of UI buttons


Version published
Weekly downloads
1.2K
increased by63.41%
Maintainers
1
Install size
4.00 MB
Created
Weekly downloads
 

Readme

Source

<AwesomeButton />

Travis NPM

react-awesome-button is a performant, extendable, highly customisable, production ready React Component that renders an animated set of 3D UI buttons.

react-awesome-button demo

Live demo

Checkout the CSS customizer at my portfolio

Examples

With react-awesome-button and plain CSS

  import { AwesomeButton } from 'react-awesome-button';
  import 'react-awesome-button/dist/styles.css';

  function Button() {
    return (
      <AwesomeButton type="facebook">Button</AwesomeButton>
    );
  }

With react-awesome-button CSS Modules

  import { AwesomeButton } from 'react-awesome-button';
  import AwesomeButtonStyles from 'react-awesome-button/src/styles/styles.scss'

  function Button() {
    return (
      <AwesomeButton
        cssModule={AwesomeButtonStyles}
        type="twitter"
      >
        Share
      </AwesomeButton>
    );
  }

Key Features

  • Look and feel customisable and extendable via SASS variables and lists (scss config file)
  • Use it with CSSModules or Plain CSS (NO inline-styles)
  • Render any tag as the component's child (text, icon, img, svg)
  • Animated progress button
  • OnClick bubble animation
AttributesTypeDefaultDescription
actionfunctionnullDefault click function
bubblesboolfalseShould render the bubbles onClick animation
disabledboolfalseShould render a disabled button
typestringprimaryRender a specific button type, styled by the .scss type list
sizestringautoRender a specific button size, styled by the .scss size list
elementnodenullOverwrites the default container element renderer, useful for using it with react-router Link container.
hrefstringnullForces the button to be rendered on an anchor container and sets the href to the specified value
targetstringnullRender an anchor with a specific target attribute
progressboolfalseShould render a progress button
loadingLabelstringWait ..Progress button loading label text
errorLabelstringErrorProgress button error label text
successLabelstringSuccessProgress button success label text
visiblebooltrueShould the button be visible

Author

Rafael Caferati

License

MIT. Copyright (c) 2017 Rafael Caferati.

Keywords

FAQs

Last updated on 22 Mar 2018

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc