lloydwatkin / react-share

Easy social media share buttons and share counts

react-share

Easy social media share buttons and share counts.

Features

• no external script loading, i.e. no dependencies on SDKs
• opens a popup share-window
• share buttons for:
  • Facebook
  • Twitter
  • Telegram
  • Google+
  • Whatsapp
  • LinkedIn
  • Pinterest
  • VK
  • Odnoklassniki
  • Reddit
  • Tumblr
  • Mail.Ru
  • LiveJournal
  • email
• share counts for
  • Facebook
  • Google+
  • Linkedin
  • Pinterest
  • VK
  • Odnoklassniki
  • Reddit
  • Tumblr
• social media icons included in the library
• supports also custom icons

Demo

To run demos: clone repo and run npm install && npm run run-demos and open http://localhost:8080/demo0/.

Install

npm install react-share --save

Browser

ShareButtons work on all browsers.

ShareCounts works on all browsers, with the exception of Goolge Plus share count working only on IE11 and newer (XHR CORS problem).

Compatibility

Compatible with React versions 0.13.x, 0.14.x and 15.x.x.

API

import {
  ShareButtons,
  ShareCounts,
  generateShareIcon
} from 'react-share';

Share buttons

const {
  FacebookShareButton,
  GooglePlusShareButton,
  LinkedinShareButton,
  TwitterShareButton,
  TelegramShareButton,
  WhatsappShareButton,
  PinterestShareButton,
  VKShareButton,
  OKShareButton,
  RedditShareButton,
  TumblrShareButton,
  LivejournalShareButton,
  EmailShareButton,
} = ShareButtons;

Share button props

	Required props	Optional props
All	children: A React node (e.g. string or element) url: URL of the shared page (string)	disabled: Disables click action and adds disabled class (bool) disabledStyle: Style when button is disabled (object, default = { opacity: 0.6 }) windowWidth, windowHeight: opened window dimensions (int, different defaults for all share buttons) beforeOnClick: Takes a function that returns a Promise to be fulfilled before calling onClick. If you do not return promise, onClick is called immediately. onShareWindowClose: Takes a function to be called after closing share dialog. additionalProps: An object to pass any additional properties, such as aria-* attributes.
FacebookShareButton	-	quote: A quote to be shared along with the link. (string) hashtag: A hashtag specified by the developer to be added to the shared content. People will still have the opportunity to remove this hashtag in the dialog. The hashtag should include the hash symbol. (string)
GooglePlusShareButton	-	-
LinkedinShareButton	-	title: Title of the shared page (string) description: Description of the shared page (string)
TwitterShareButton	-	title: Title of the shared page (string) via: (string) hashtags: (array)
TelegramShareButton	-	title: Title of the shared page (string)
WhatsappShareButton	-	title: Title of the shared page (string) separator: Separates title from the url, default: " " (string)
PinterestShareButton	media: An absolute link to the image that will be pinned (string)	description: Description for the shared media.
VKShareButton	-	title: Title of the shared page (string) description: Description of the shared page (string) image: An absolute link to the image that will be shared (string)
OKShareButton	-	title: Title of the shared page (string) description: Description of the shared page (string) image: An absolute link to the image that will be shared (string)
RedditShareButton	-	title: Title of the shared page (string)
TumblrShareButton	-	title: Title of the shared page (string) tags: (array) caption: Description of the shared page (string)
LivejournalShareButton	-	title: Title of the shared page (string) description: Description of the shared page (string)
MailruShareButton	-	title: Title of the shared page (string) description: Description of the shared page (string) image: An absolute link to the image that will be shared (string)
EmailShareButton	-	subject: Title of the shared page (string) body: Body of the email (string), defaults to shared url.

Share counts

const {
  FacebookShareCount,
  GooglePlusShareCount,
  LinkedinShareCount,
  PinterestShareCount,
  VKShareCount,
  OKShareCount,
  RedditShareCount,
  TumblrShareCount,
} = ShareCounts;

All share count components take in only one mandatory prop: url, which is the URL you are sharing. className prop is optional.

Example:

<FacebookShareCount url={shareUrl} />

If you want to render anything else but the count, you can provide a function as a child element that takes in shareCount as an argument and returns an element:

<FacebookShareCount url={shareUrl}>
  {shareCount => (
    <span className="myShareCountWrapper">{shareCount}</span>
  )}
</FacebookShareCount>

Icons

const FacebookIcon = generateShareIcon('facebook');
const TwitterIcon = generateShareIcon('twitter');
const TelegramIcon = generateShareIcon('telegram');
const WhatsappIcon = generateShareIcon('whatsapp');
const GooglePlusIcon = generateShareIcon('google');
const LinkedinIcon = generateShareIcon('linkedin');
const PinterestIcon = generateShareIcon('pinterest');
const VKIcon = generateShareIcon('vk');
const OKIcon = generateShareIcon('ok');
const RedditIcon = generateShareIcon('reddit');
const TumblrIcon = generateShareIcon('tumblr');
const LivejournalIcon = generateShareIcon('livejournal');
const MailruIcon = generateShareIcon('mailru');
const EmailIcon = generateShareIcon('email');

Props:

• size: Icon size in pixels (number)

• round: Whether to show round or rect icons (bool)

• iconBgStyle: customize background style, e.g. fill (object)

• logoFillColor: customize logo's fill color (string, default = 'white')

Example:

<TwitterIcon size={32} round={true} />

About semantic versioning

This library uses the standard semver convention. However, the share buttons and and counts are prone to lots of changes that are not in control of this library. For example: if Facebook decides to change or deprecate it's API in a major way, this library will not get a major version bump just because of that. Keep this in mind when you are planning the maintenance of your application.

License

MIT

Icons

Icon paths provided by: react-social-icons.