react-share
Advanced tools
The react-share npm package provides a collection of social media share buttons and share counts for React applications. It supports a wide range of social media platforms and allows for easy integration of sharing functionalities.
Facebook Share Button
This feature allows you to create a Facebook share button with a customizable icon. The button can be used to share a specified URL on Facebook.
import { FacebookShareButton, FacebookIcon } from 'react-share';
const FacebookShare = () => (
<FacebookShareButton url={'https://example.com'}>
<FacebookIcon size={32} round={true} />
</FacebookShareButton>
);Twitter Share Button
This feature allows you to create a Twitter share button with a customizable icon. The button can be used to share a specified URL and title on Twitter.
import { TwitterShareButton, TwitterIcon } from 'react-share';
const TwitterShare = () => (
<TwitterShareButton url={'https://example.com'} title={'Check this out!'}>
<TwitterIcon size={32} round={true} />
</TwitterShareButton>
);LinkedIn Share Button
This feature allows you to create a LinkedIn share button with a customizable icon. The button can be used to share a specified URL on LinkedIn.
import { LinkedinShareButton, LinkedinIcon } from 'react-share';
const LinkedinShare = () => (
<LinkedinShareButton url={'https://example.com'}>
<LinkedinIcon size={32} round={true} />
</LinkedinShareButton>
);Share Count
This feature allows you to display the share count for a specified URL on Facebook. Similar components are available for other social media platforms.
import { FacebookShareCount } from 'react-share';
const FacebookShareCountExample = () => (
<FacebookShareCount url={'https://example.com'} />
);The react-social-sharing package provides a set of social media sharing buttons for React applications. It supports fewer platforms compared to react-share but offers a simpler API and easier customization options.
The react-social-icons package offers a collection of social media icons that can be used for sharing purposes. It focuses more on providing a wide range of icons rather than the sharing functionality itself, making it a good complement to other sharing packages.
The react-share-buttons package provides a set of customizable share buttons for various social media platforms. It offers similar functionalities to react-share but with a different set of customization options and styling capabilities.
Social media share buttons and share counts for React.
Migrating from v2 to v3? Read changelog.
Migrating from v1 to v2? Read migration notes.
To run demo: clone repo and run npm install && npm run run-demos
and open http://localhost:8080.
npm install react-share --save
ShareButtons work on all browsers.
ShareCounts works on all browsers.
Version 1.x.x: compatible with React versions 0.13.x, 0.14.x and 15.x.x.
Version 2.x.x: compatiblity is tested with React 15 and 16.
Version 3.x.x: compatiblity is tested with React 15 and 16.
Version 3.0.1: compatible with React ^16.3.
Version 4.x.x: compatible with React >=16.3.
import {
EmailShareButton
FacebookShareButton,
InstapaperShareButton,
LineShareButton,
LinkedinShareButton,
LivejournalShareButton,
MailruShareButton,
OKShareButton,
PinterestShareButton,
PocketShareButton,
RedditShareButton,
TelegramShareButton,
TumblrShareButton,
TwitterShareButton,
ViberShareButton,
VKShareButton,
WhatsappShareButton,
WorkplaceShareButton,
} from "react-share";
| 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 trueonShareWindowClose (() => 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 wan't to customize the button style. |
| 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. |
| 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): Hashtags |
| 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. |
import {
FacebookShareCount,
OKShareCount,
PinterestShareCount,
RedditShareCount,
TumblrShareCount
VKShareCount,
} from "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>
import {
EmailIcon,
FacebookIcon,
InstapaperIcon,
LineIcon,
LinkedinIcon,
LivejournalIcon,
MailruIcon,
OKIcon,
PinterestIcon,
PocketIcon,
RedditIcon,
TelegramIcon,
TumblrIcon,
TwitterIcon,
ViberIcon,
VKIcon,
WeiboIcon
WhatsappIcon,
WorkplaceIcon,
} from "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} />
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.
MIT
Icon paths provided by: react-social-icons.
4.0.0 (January 4, 2020)
FacebookMessengerShareButton and FacebookMessengerShareCountWeiboIconVKShareButtonLinkedinShareButtonMailruShareButtonTumblrShareCountFacebookShareCountclassNames have been changed{ ...rest } props are spread to the root element for share buttons and share countsspan element instead of divsvg as root element instead of diviconBgStyle -> bgStyle, logoFillColor -> iconFillColorFAQs
Social media share buttons and share counts for React.
The npm package react-share receives a total of 146,266 weekly downloads. As such, react-share popularity was classified as popular.
We found that react-share demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
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.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.