Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/ayda-tech/react-share-kit

React-Share-Kit is an easy-to-use library that adds social media share buttons to React and Next apps for popular platforms like Facebook, Twitter, and LinkedIn.
https://github.com/ayda-tech/react-share-kit
nextjs npm-package preact react-share-components reactjs social social-media
Last synced: about 2 months ago
JSON representation
React-Share-Kit is an easy-to-use library that adds social media share buttons to React and Next apps for popular platforms like Facebook, Twitter, and LinkedIn.
Host: GitHub
URL: https://github.com/ayda-tech/react-share-kit
Owner: ayda-tech
License: mit
Created: 2023-11-17T04:18:20.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-03-15T08:09:32.000Z (10 months ago)
Last Synced: 2024-03-15T09:27:34.525Z (10 months ago)
Topics: nextjs, npm-package, preact, react-share-components, reactjs, social, social-media
Language: TypeScript
Homepage: https://react-share-kit.vercel.app/
Size: 362 KB
Stars: 7
Watchers: 0
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

        
# React-Share-Kit 

React-Share-Kit is a simple and easy-to-use library for adding social media share buttons to your React & Next applications. With React-Share-Kit, you can quickly integrate share buttons for popular social media platforms such as Facebook, Twitter, LinkedIn, and more.

If package size is mater and you don't need use share count functionality instead of your React.js, Next.js and PReact project build with Javascript and Typescript. [React-share-lite](https://www.npmjs.com/package/react-share-lite) is the solution to enhance your application performance.

****

[![downloads](https://img.shields.io/npm/dm/react-share-kit.svg?label=monthly%20downloads)](https://www.npmjs.com/package/react-share-kit) [![downloads](https://img.shields.io/npm/dt/react-share-kit.svg?label=total%20downloads)](https://www.npmjs.com/package/react-share-kit)

[![NPM](https://img.shields.io/npm/v/react-share-kit.svg)](https://www.npmjs.com/package/react-share-kit) ![npm bundle size](https://img.shields.io/bundlephobia/min/react-share-kit) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

![Share buttons screenshot](https://github.com/ayda-tech/react-share-lite/blob/main/react-share-lite.png?raw=true)

---

### Table of Contents

- [React-Share-Kit](#react-share-kit)

    - [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)

  - [📕 Share Count global props](#-share-count-global-props)

  - [💡 Usage of ShareCount](#-usage-of-sharecount)

    - [Facebook Count](#facebook-count)

    - [Hatena Count](#hatena-count)

    - [OK Count](#ok-count)

    - [Pinterest Count](#pinterest-count)

    - [Tumblr Count](#tumblr-count)

    - [VK Count](#vk-count)

  - [License](#license)

## Installation

To install React-Share-Kit, simply run:

```bash

npm install react-share-kit

```

or

```bash

yarn add react-share-kit

```

## 📕 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, FacebookCount } from 'react-share-kit';

const ShareButtons = () => {

  const shareUrl = 'https://github.com/ayda-tech/react-share-kit';

  const title = 'Check out this awesome website!';

  return (

      <>

        

        

        

          {shareCount => {shareCount}}

        

      >

  );

};

```

## 💡 Usage of ShareButtons

### Facebook Share

👨‍💻 Example 

```js

import { FacebookShare } from 'react-share-kit'

```

📕 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-kit'

```

📕 Props: Supports only on Twitter

| Props | Type | Default | Description | Required |

| :--- | :--- | :--- | :--- | :--- |

| via | string |  |  | FALSE |

| hashtags | array |  |  | FALSE |

| related | array |  |  | FALSE |

###  Linkedin Share

👨‍💻 Example 

```js

import { LinkedinShare } from 'react-share-kit'

```

###  Whatsapp Share

👨‍💻 Example 

```js

import { WhatsappShare } from 'react-share-kit'

```

📕 Props: Supports only on WhatsApp

| Props | Type | Default | Description | Required |

| :--- | :--- | :--- | :--- | :--- |

| separator | string |  |  | FALSE |

###  Telegram Share

👨‍💻 Example 

```js

import { TelegramShare } from 'react-share-kit'

```

###  FacebookMessenger Share

👨‍💻 Example 

```js

import { FacebookMessengerShare } from 'react-share-kit'

```

📕 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 'react-share-kit'

```

📕 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 |  |  | FALSE |

| body | string |  |  | FALSE |

| separator | string |  |  | 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-kit'

```

📕 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-kit'

```

📕 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-kit'

```

###  Line Share

👨‍💻 Example 

```js

import { LineShare } from 'react-share-kit'

```

###  Tumblr Share

👨‍💻 Example 

```js

import { TumblrShare } from 'react-share-kit'

```

📕 Props: Supports only on Tumblr

| Props | Type | Default | Description | Required |

| :--- | :--- | :--- | :--- | :--- |

| tags | Array<string> |  |  | FALSE |

| caption | string |  | The description of the shared page. | FALSE |

| posttype | string | link |  | FALSE |

###  Viber Share

👨‍💻 Example 

```js

import { ViberShare } from 'react-share-kit'

```

📕 Props: Supports only on Viber

| Props | Type | Default | Description | Required |

| :--- | :--- | :--- | :--- | :--- |

| separator | string |  |  | FALSE |

###  Weibo Share

👨‍💻 Example 

```js

import { WeiboShare } from 'react-share-kit'

```

📕 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-kit'

```

📕 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-kit'

```

📕 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-kit'

```

📕 Props: Supports only on Workspace

| Props | Type | Default | Description | Required |

| :--- | :--- | :--- | :--- | :--- |

| quote | string |  |  | FALSE |

| hashtag | string |  |  | FALSE |

###  Pocket Share

👨‍💻 Example 

```js

import {

  PocketShare

} from 'react-share-kit'

```

###  Instapaper Share

👨‍💻 Example 

```js

import { InstapaperShare } from 'react-share-kit'

```

📕 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-kit'

```

###  Gab Share

👨‍💻 Example 

```js

import { GabShare } from 'react-share-kit'

```

## 📕 Share Count global props

| Props | Type | Default | Description | Required |

| :--- | :--- | :--- | :--- | :--- |

| url | string |  | The URL of the shared page. | TRUE |

| children | node |  | React component, HTML element or string. | FALSE |

| appId | string |  | Facebook application id. | TRUE |

| appSecret | string |  | Facebook application secret. | TRUE |

## 💡 Usage of ShareCount

###  Facebook Count

👨‍💻 Example 

```js

import { FacebookCount } from 'react-share-kit'

  {shareCount => {shareCount}}

```

📕 Props: Supports only on Facebook count

| Props | Type | Default | Description | Required |

| :--- | :--- | :--- | :--- | :--- |

| appId | string |  | Facebook application id. | TRUE |

| appSecret | string |  | Facebook application secret. | TRUE |

###  Hatena Count

👨‍💻 Example 

```js

import { HatenaCount } from 'react-share-kit'

  {shareCount => {shareCount}}

```

###  OK Count

👨‍💻 Example 

```js

import { OKCount } from 'react-share-kit'

  {shareCount => {shareCount}}

```

###  Pinterest Count

👨‍💻 Example 

```js

import { PinterestShareCount } from 'react-share-kit'

  {shareCount => {shareCount}}

```

###  Tumblr Count

👨‍💻 Example 

```js

import { TumblrCount } from 'react-share-kit'

  {shareCount => {shareCount}}

```

###  VK Count

👨‍💻 Example 

```js

import { VKCount } from 'react-share-kit'

  {shareCount => {shareCount}}

```

## License

React-Share-Kit is licensed under the MIT License. See the [LICENSE](https://github.com/ayda-tech/react-share-kit/blob/main/LICENSE) file for more details.