@vitali-zaneuski/react-share
v1.15.0
Published
Easy social media share buttons and share counts.
Downloads
3
Maintainers
Readme
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:
- Telegram
- Google+
- VK
- Odnoklassniki
- share counts for
- Google+
- VK
- Odnoklassniki
- 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,
} = 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.|
|FacebookShareButton|-|title
: Title of the shared page (string)description
: Description of the shared page (string)picture
: An absolute link to the image that will be shared (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)|
Share counts
const {
FacebookShareCount,
GooglePlusShareCount,
LinkedinShareCount,
PinterestShareCount,
VKShareCount,
OKShareCount,
RedditShareCount,
} = 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');
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} />
License
MIT
Icons
Icon paths provided by: react-social-icons.