0.1.7 • Published 6 years ago

react-awesome-social v0.1.7

Weekly downloads
8
License
MIT
Repository
github
Last release
6 years ago

<AwesomeSocial />

Travis NPM

react-awesome-social is a performant, extendable, highly customisable, production ready React Component that renders a set of multi-purpose social and share animated buttons. Social SVG icons included.

Live demo

  • On my portfolio
  • Live code at Webpackbin

Examples

With react-awesome-button and plain CSS

  import AwesomeSocial from 'react-awesome-social';
  import 'react-awesome-button/dist/styles.css';

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

With react-awesome-button CSS Modules

  import AwesomeSocial from 'react-awesome-social';
  import AwesomeButtonStyles from 'react-awesome-button/src/styles.scss'

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

Key Features

  • Built in share methods for facebook, messenger, twitter, google plus, reddit, pinterest, whatsapp and vk
  • All SVG social icons included
  • Look and feel customisable and extendable via SASS variables and lists (scss config file)
  • Use it with CSSModules or Plain CSS (NO inline-styles)
  • OnClick bubble animation
AttributesTypeDefaultDescription
actionfunctionnullDefault click function; Overwrites the custom share behaviour
bubblesboolfalseShould render the bubbles animation onMouseUp
disabledboolfalseShould render a disabled button
typestringrequiredSpecify the social button type; oneOf (facebook, twitter, instagram, reddit, vk, pinterest, whatsapp, messenger)
sizestring"auto"Render a specific button size, styled by the .scss size list
elementnodenullOverwrites the AwesomeButton as default container element. Use it to customise with your own buttons
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
visiblebooltrueShould the button be visible

License

MIT. Copyright (c) 2017 Rafael Caferati.