Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ayda-tech/react-share-lite
react-share-lite is a simple and easy-to-use library for adding social media share buttons to your React & Next applications. With react-share-lite, you can quickly integrate share buttons for popular social media platforms such as Facebook, Twitter, LinkedIn, and more.
https://github.com/ayda-tech/react-share-lite
nextjs npm-package preact react-share-lite reactjs socia-media-widget social-media
Last synced: 3 months ago
JSON representation
react-share-lite is a simple and easy-to-use library for adding social media share buttons to your React & Next applications. With react-share-lite, you can quickly integrate share buttons for popular social media platforms such as Facebook, Twitter, LinkedIn, and more.
- Host: GitHub
- URL: https://github.com/ayda-tech/react-share-lite
- Owner: ayda-tech
- License: mit
- Created: 2023-12-03T17:51:44.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-04T11:23:14.000Z (about 1 year ago)
- Last Synced: 2024-06-28T10:19:21.893Z (7 months ago)
- Topics: nextjs, npm-package, preact, react-share-lite, reactjs, socia-media-widget, social-media
- Language: TypeScript
- Homepage: https://react-share-lite.vercel.app/
- Size: 272 KB
- Stars: 13
- Watchers: 0
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## React-Share-Lite
react-share-lite is a simple and easy-to-use library for adding social media share buttons to your React, Next and Preact applications. With react-share-lite, you can quickly integrate share buttons for popular social media platforms such as Facebook, Twitter, LinkedIn, and more.
If you want to add share count functionality to your share buttons in your React, Next.js, or Preact projects built with JavaScript and TypeScript, [react-share-kit](https://www.npmjs.com/package/react-share-kit) is the solution. It seamlessly enhances your applications, allowing users to easily track the popularity of your content.
[](https://www.npmjs.com/package/react-share-lite) [](https://www.npmjs.com/package/react-share-lite)
[](https://www.npmjs.com/package/react-share-lite)  [](https://standardjs.com)
---
### Table of Contents
- [React-Share-Lite](#react-share-lite)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [📕 Share Button Global Props](#-share-button-global-props)
- [💡 Usage of ShareButtons](#-usage-of-sharebuttons)
- [Facebook Share](#facebook-share)
- [Twitter Share](#twitter-share)
- [Linkedin Share](#linkedin-share)
- [Whatsapp Share](#whatsapp-share)
- [Telegram Share](#telegram-share)
- [FacebookMessenger Share](#facebookmessenger-share)
- [Email Share](#email-share)
- [VK Share](#vk-share)
- [Pinterest Share](#pinterest-share)
- [Reddit Share](#reddit-share)
- [Line Share](#line-share)
- [Tumblr Share](#tumblr-share)
- [Viber Share](#viber-share)
- [Weibo Share](#weibo-share)
- [Mailru Share](#mailru-share)
- [LiveJournal Share](#livejournal-share)
- [Workplace Share](#workplace-share)
- [Pocket Share](#pocket-share)
- [Instapaper Share](#instapaper-share)
- [Hatena Share](#hatena-share)
- [Gab Share](#gab-share)
- [License](#license)
## Installation
To install react-share-lite, simply run:
```bash
npm install react-share-lite
```
or
```bash
yarn add react-share-lite
```
## 📕 Share Button Global Props
Each button supports a set of global props that are consistent across all buttons. However, in addition to these global props, each button also possesses its own unique set of specific properties. These specific properties are tailored to the individual functionality and customization options of each button.
| Props | Type | Default | Description | Required |
| :----------- | :------ | :------------ | :------------------------------------------------------------------------------------------------ | :------- |
| url | string | | The URL of the shared page. | TRUE |
| title | string | | The title of the shared page. | FALSE |
| windowWidth | number | 550 | Opened window width. | FALSE |
| windowHeight | number | 400 | Opened window height. | FALSE |
| blankTarget | boolean | false | Open share window in a new tab if set to `true`. | FALSE |
| bgColor | string | related color | Icon background color. | FALSE |
| round | boolean | false | The "round" attribute creates a fully circular button shape, giving it a 100% rounded appearance. | FALSE |
| borderRadius | number | 0px | Custom round share. | FALSE |
| size | number | 64px | The button size. | FALSE |
| buttonTitle | string | | The title of button used instead of icon. | FALSE |
👨💻 Example
```jsx
import React from 'react'
import { FacebookShare } from 'react-share-lite'
const ShareButtons = () => {
const shareUrl = 'https://github.com/ayda-tech/react-share-lite'
const title = 'Check out this awesome website!'
return
}
```
## 💡 Usage of ShareButtons
### Facebook Share
👨💻 Example
```js
import { FacebookShare } from 'react-share-lite';
```
📕 Props: Supports only on Facebook
| Props | Type | Default | Description | Required |
| :------ | :----- | :------ | :-------------------- | :------- |
| quote | string | | A quote to be shared. | FALSE |
| hashtag | string | | Hashtag to be shared. | FALSE |
### Twitter Share
👨💻 Example
```js
import {
TwitterShare
} from 'react-share-lite'
```
📕 Props: Supports only on Twitter
| Props | Type | Default | Description | Required |
| :------- | :----- | :------ | :---------- | :------- |
| via | string | | A screen name to associate with the Tweet. | FALSE |
| hashtags | array | | A comma-separated list of hashtags to be appended to default Tweet text. | FALSE |
| related | array | | A comma-separated list of accounts related to the content of the shared URI. | FALSE |
### Linkedin Share
👨💻 Example
```js
import { LinkedinShare } from 'react-share-lite'
```
### Whatsapp Share
👨💻 Example
```js
import { WhatsappShare } from 'react-share-lite'
```
📕 Props: Supports only on WhatsApp
| Props | Type | Default | Description | Required |
| :-------- | :----- | :------ | :---------- | :------- |
| separator | string | | | FALSE |
### Telegram Share
👨💻 Example
```js
import { TelegramShare } from 'react-share-lite'
```
### FacebookMessenger Share
👨💻 Example
```js
import { FacebookMessengerShareButton } from 'react-share-lite'
```
📕 Props: Supports only on Facebook Messenger
| Props | Type | Default | Description | Required |
| :---------- | :----- | :------ | :---------------------------------------------------------------------------------------------------------- | :------- |
| appId | string | | Facebook application id. | TRUE |
| redirectUri | string | | The URL to redirect to after sharing (default: the shared url). | FALSE |
| to | string | | A user ID of a recipient. Once the dialog comes up, the sender can specify additional people as recipients. | FALSE |
### Email Share
👨💻 Example
```js
import { EmailShare } from 'next-share'
```
📕 Props: Supports only on Email
| Props | Type | Default | Description | Required |
| :---------- | :------ | :------ | :----------------------------------------------- | :------- |
| children | node | | React component, HTML element or string. | TRUE |
| url | string | | The URL of the shared page. | TRUE |
| subject | string | | The subject of the email. | FALSE |
| body | string | | The body of the email. | FALSE |
| separator | string | | A separator to be shared. | FALSE |
| blankTarget | boolean | false | Open share window in a new tab if set to `true`. | FALSE |
### VK Share
👨💻 Example
```js
import { VKShare } from 'react-share-lite'
```
📕 Props: Supports only on VK
| Props | Type | Default | Description | Required |
| :-------- | :------ | :------ | :----------------------------------------------------------------------------------------------------------- | :------- |
| image | string | | An absolute link to the image that will be shared. | FALSE |
| noParse | boolean | | If true is passed, VK will not retrieve URL information. | FALSE |
| noVkLinks | boolean | | If true is passed, there will be no links to the user's profile in the open window. Only for mobile devices. | FALSE |
### Pinterest Share
👨💻 Example
```js
import { PinterestShare } from 'react-share-lite'
```
📕 Props: Supports only on Pinterest
| Props | Type | Default | Description | Required |
| :---------- | :----- | :------ | :----------------------------------- | :------- |
| media | string | | The image URL that will be pinned. | TRUE |
| description | string | | The description of the shared media. | FALSE |
### Reddit Share
👨💻 Example
```js
import { RedditShare } from 'react-share-lite'
```
### Line Share
👨💻 Example
```js
import { LineShare } from 'react-share-lite'
```
### Tumblr Share
👨💻 Example
```js
import { TumblrShare } from 'react-share-lite'
```
📕 Props: Supports only on Tumblr
| Props | Type | Default | Description | Required |
| :------- | :------------------------------- | :---------------- | :---------------------------------- | :------- |
| tags | Array<string> | | An array of tags to be shared. | FALSE |
| caption | string | | The description of the shared page. | FALSE |
| posttype | string | link | The type of the post. | FALSE |
### Viber Share
👨💻 Example
```js
import { ViberShare } from 'react-share-lite'
```
📕 Props: Supports only on Viber
| Props | Type | Default | Description | Required |
| :-------- | :----- | :------ | :---------- | :------- |
| separator | string | | | FALSE |
### Weibo Share
👨💻 Example
```js
import { WeiboShare } from 'react-share-lite'
```
📕 Props: Supports only on Weibo
| Props | Type | Default | Description | Required |
| :---- | :----- | :------ | :--------------------------------- | :------- |
| image | string | | The image URL that will be shared. | FALSE |
### Mailru Share
👨💻 Example
```js
import { MailruShare } from 'react-share-lite'
```
📕 Props: Supports only on Mail-Ru
| Props | Type | Default | Description | Required |
| :---------- | :----- | :------ | :------------------------------ | :------- |
| description | string | | Description of the shared page. | FALSE |
| imageUrl | string | | Image url of the shared page. | FALSE |
### LiveJournal Share
👨💻 Example
```js
import { LiveJournalShare } from 'react-share-lite'
```
📕 Props: Supports only on Live Journal
| Props | Type | Default | Description | Required |
| :---------- | :----- | :------ | :------------------------------ | :------- |
| description | string | | Description of the shared page. | FALSE |
### Workplace Share
👨💻 Example
```js
import { WorkplaceShare } from 'react-share-lite'
```
📕 Props: Supports only on Workspace
| Props | Type | Default | Description | Required |
| :------ | :----- | :------ | :---------- | :------- |
| quote | string | | A quote to be shared. | FALSE |
| hashtag | string | | Hashtags to be shared. | FALSE |
### Pocket Share
👨💻 Example
```js
import {
PocketShare
} from 'react-share-lite'
```
### Instapaper Share
👨💻 Example
```js
import { InstapaperShare } from 'react-share-lite'
```
📕 Props: Supports only on Instapaper
| Props | Type | Default | Description | Required |
| :---------- | :----- | :------ | :------------------------------ | :------- |
| description | string | | Description of the shared page. | FALSE |
### Hatena Share
👨💻 Example
```js
import {
HatenaShare
} from 'react-share-lite'
```
### Gab Share
👨💻 Example
```js
import { GabShare } from 'react-share-lite'
```
## License
react-share-lite is licensed under the MIT License. See the [LICENSE](https://github.com/ayda-tech/react-share-lite/blob/main/LICENSE) file for more details.