react-share

Social media share buttons and share counts for React.

Features

• no external script loading, i.e. no dependencies on SDKs
• opens a popup share-window
• share buttons for:
  • Facebook
  • Facebook Messenger
  • Twitter
  • Telegram
  • Whatsapp
  • LinkedIn
  • Pinterest
  • VK
  • Odnoklassniki
  • Reddit
  • Tumblr
  • Mail.Ru
  • LiveJournal
  • Viber
  • Workplace
  • Line
  • Weibo
  • Pocket
  • Instapaper
  • Hatena
  • E-mail
  • Copy Link
• share counts for
  • Facebook
  • Pinterest
  • VK
  • Odnoklassniki
  • Reddit
  • Tumblr
  • Hatena
• social media icons included in the library
• supports also custom icons

Demo

View demo

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

Install

npm install @nicolasepiscopo/react-share --save

Or with Yarn:

yarn add @nicolasepiscopo/react-share

Compatibility

Compatible with React >= 16.3

API

Share buttons

import {
  CopyLinkButton,
  EmailShareButton,
  FacebookShareButton,
  HatenaShareButton,
  InstapaperShareButton,
  LineShareButton,
  LinkedinShareButton,
  LivejournalShareButton,
  MailruShareButton,
  OKShareButton,
  PinterestShareButton,
  PocketShareButton,
  RedditShareButton,
  TelegramShareButton,
  TumblrShareButton,
  TwitterShareButton,
  ViberShareButton,
  VKShareButton,
  WhatsappShareButton,
  WorkplaceShareButton
} from "react-share";

Share button props

| | Required props | Optional props | | ---------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | All | children (string/element): React nodeurl (string): URL of the shared page | disabled (bool): Disables click action and adds "disabled" classdisabledStyle (object, default={ opacity: 0.6 }): Disabled stylewindowWidth, windowHeight (number, different default for all share buttons): opened window dimensionsbeforeOnClick (() => Promise/() => void): Takes a function that returns a Promise to be fulfilled before calling onClick. If you do not return promise, onClick is called immediately.openShareDialogOnClick (boolean): Open dialog on click. Defaults to true except on EmailShareButtononShareWindowClose (() => void): Takes a function to be called after closing share dialog.resetButtonStyle (boolean, default=true): Reset button element style. Preferred to be set to false if you want to customize the button style. | | CopyLinkButton | - | url (string): Link to be sharedonCopySuccess (() => void): called when the link has been successfully copied. | | EmailShareButton | - | subject (string): Title of the shared pagebody (string): Email, will be prepended to the url.separator (string, default=" "): Separates body from the url | | FacebookShareButton | - | quote (string): A quote to be shared along with the link.hashtag (string): 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. | | FacebookMessengerShareButton | appId (string): Facebook application id | redirectUri (string): The URL to redirect to after sharing (default: the shared url).to (string): A user ID of a recipient. Once the dialog comes up, the sender can specify additional people as recipients. | | HatenaShareButton | - | title (string): Title of the shared page | | InstapaperShareButton | - | title (string): Title of the shared pagedescription (string): Description of the shared page | | LinkedinShareButton | - | title (string): Title of the shared pagesummary (string): Description of the shared pagesource (string): Source of the content (e.g. your website or application name) | | LineShareButton | - | title (string): Title of the shared page | | LivejournalShareButton | - | title (string): Title of the shared pagedescription (string): Description of the shared page | | MailruShareButton | - | title (string): Title of the shared pagedescription (string): Description of the shared pageimageUrl (string): An absolute link to the image that will be shared | | OKShareButton | - | title (string): Title of the shared pagedescription (string): Description of the shared pageimage (string): An absolute link to the image that will be shared | | PinterestShareButton | media (string): An absolute link to the image that will be pinned | description (string): Description for the shared media. | | PocketShareButton | - | title (string): Title of the shared page. Note that if Pocket detects a title tag on the page being saved, this parameter will be ignored and the title tag of the saved page will be used instead. | | RedditShareButton | - | title (string): Title of the shared page | | TelegramShareButton | - | title (string): Title of the shared page | | TumblrShareButton | - | title (string): Title of the shared pagetags: (Array<string>)caption (string): Description of the shared pageposttype (string, default=link) | | TwitterShareButton | - | title (string): Title of the shared pagevia: (string)hashtags (array): Hashtagsrelated (array): Accounts to recommend following | | ViberShareButton | - | title (string): Title of the shared pageseparator (string), default=" ": Separates title from the url | | VKShareButton | - | title (string): Title of the shared pageimage (string): An absolute link to the image that will be sharednoParse (boolean): If true is passed, VK will not retrieve URL informationnoVkLinks (boolean): If true is passed, there will be no links to the user's profile in the open window. Only for mobile devices | | WeiboShareButton | - | title (string): Title of the shared pageimage (string): An absolute link to the image that will be shared | | WhatsappShareButton | - | title (string): Title of the shared pageseparator (string, default=" "): Separates title from the url | | WorkplaceShareButton | - | quote (string): A quote to be shared along with the link.hashtag (string): 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. |

Custom Share Buttons

You can create custom share buttons by doing:

import { createShareButton } from '@nicolasepiscopo/react-share';

type Options = {
  // Here your custom options.
  myOption: string;
};

function link = (url: string, options: Options) => url;

const CustomShareButton = createShareButton<Options>(
  'custom-share-button',
  link,
  ({ myOption }) => ({ myOption }),
  {
    openShareDialogOnClick: false,
    onClick: async (_, link: string, options: Options) => {
      // do something
      console.log(options.myOption);
    },
  },
);

export default CustomShareButton;

Share counts

import {
  FacebookShareCount,
  HatenaShareCount,
  OKShareCount,
  PinterestShareCount,
  RedditShareCount,
  TumblrShareCount,
  VKShareCount
} from "@nicolasepiscopo/react-share";

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>

Custom Share Counts

You can create custom share counts by doing:

import { createShareCount } from '@nicolasepiscopo/react-share';

const CustomShareCount = createShareCount((shareUrl, callback) => {
  jsonp(process.env.CUSTOM_COUNT_ENDPOINT, (err, data) => {
    callback(
      !err && data?.count
        ? data.count
        : undefined,
    );
  });
});

export default CustomShareCount;

Icons

import {
  CopyLinkIcon,
  EmailIcon,
  FacebookIcon,
  FacebookMessengerIcon,
  HatenaIcon,
  InstapaperIcon,
  LineIcon,
  LinkedinIcon,
  LivejournalIcon,
  MailruIcon,
  OKIcon,
  PinterestIcon,
  PocketIcon,
  RedditIcon,
  TelegramIcon,
  TumblrIcon,
  TwitterIcon,
  ViberIcon,
  VKIcon,
  WeiboIcon,
  WhatsappIcon,
  WorkplaceIcon
} from "@nicolasepiscopo/react-share";

Props:

• size: Icon size in pixels (number)

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

• borderRadius: Allow rounded corners if using rect icons (number)

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

• iconFillColor: customize icon fill color (string, default = 'white')

Example:

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

Custom Icons

You can create custom icons by doing:

import { createIcon } from '@nicolasepiscopo/react-share';

const CustomIcon = createIcon({
  color: '#fff',
  networkName: 'custom-icon',
  path: 'svg-path-here',
});

export default CustomIcon;

This repo uses semantic-release

Every push to master branch would end up in a new version of the package and will be published instantly.

License

MIT

Icons

Icon paths provided by: react-social-icons.