Skip to content

azamatsmith/react-social-bar

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build Status codecov

react-social-bar

Configurable Social Media Sharing Bar


react-social-demo

Install

Yarn: yarn add react-social-bar

Npm: npm install react-social-bar

Get Started

This project was bootstrapped using create-react-app and react-storybook

The easiest way to get started is to clone this repo and run yarn start

Adding react-social-bar to your app

Once react-social-bar is installed. Import it into your file
`import SocialBar from 'react-social-bar';

  return (
    <SocialBar config={ configObj } />
  );

Configuration Options

Options

  const configObj = {
    description: string (required),
    domain: string (required),
    handleClick: function (required),
    hideBelowWidth: number (optional),
    mediaUrl: string (optional),
    productName: string (required),
    twitterHandle: string (optional)
  }

Example Options

  const configObj = {
    description: 'NameSquash: An easy way to name your next side project or business',
    domain: 'https://namesquash.com',
    handleClick: (social) => console.log('clicked:', social),
    hideBelowWidth: 1038,
    mediaUrl: 'https://namesquash.com/images/namesquashapp.png',
    productName: 'NameSquash',
    twitterHandle: 'namesquash'
  }