Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/avdeev/vanilla-sharing
Small (1.5 KB) simple tool for sharing url, title, description and image to VK, Facebook (Feed, Dialog, Button, Messenger), Reddit, Pinterest, Tumblr, Twitter, VK, OK, Mail.ru, LinkedIn, Whatsapp, Viber, Telegram, Line
https://github.com/avdeev/vanilla-sharing
facebook linkedin mailru messenger odnoklassniki reddit sharing social-buttons social-network telegram tumblr twitter vanilla-sharing vkontakte whatsapp whatsapp-sharing
Last synced: 22 days ago
JSON representation
Small (1.5 KB) simple tool for sharing url, title, description and image to VK, Facebook (Feed, Dialog, Button, Messenger), Reddit, Pinterest, Tumblr, Twitter, VK, OK, Mail.ru, LinkedIn, Whatsapp, Viber, Telegram, Line
- Host: GitHub
- URL: https://github.com/avdeev/vanilla-sharing
- Owner: avdeev
- License: mit
- Created: 2017-02-16T16:09:13.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-06T14:07:42.000Z (6 months ago)
- Last Synced: 2024-05-06T15:37:55.363Z (6 months ago)
- Topics: facebook, linkedin, mailru, messenger, odnoklassniki, reddit, sharing, social-buttons, social-network, telegram, tumblr, twitter, vanilla-sharing, vkontakte, whatsapp, whatsapp-sharing
- Language: JavaScript
- Homepage: https://alexey-avdeev.com/vanilla-sharing/
- Size: 5.98 MB
- Stars: 114
- Watchers: 5
- Forks: 22
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# vanilla-sharing
Small (1.5 KB) simple tool for sharing url, title, description and image to VK, Facebook (Feed, Dialog, Button, Messenger), Twitter, Reddit, Pinterest, Tumblr, VK, OK, Mail.ru, LinkedIn, Whatsapp, Viber, Telegram, Line.
[DEMO](https://avdeev.github.io/vanilla-sharing/demo)
[](https://github.com/avdeev/vanilla-sharing/actions?query=workflow%3A%22Node+CI%22)
[](https://bundlephobia.com/result?p=vanilla-sharing)
[](https://coveralls.io/github/avdeev/vanilla-sharing?branch=master)
[](https://www.npmjs.com/package/vanilla-sharing)
[](https://www.npmjs.com/package/vanilla-sharing)
# Motivation
Adding sharings to a project is digging in the documentation of the corresponding social networks. With this set of small functions, we have already done everything for you. Just take them and use!
# Installation
## From NPM
```sh
npm install --save vanilla-sharing
```
## From unpkg CDN (you can use other)
```html
```
# Usage
## From NPM
```js
import { fbButton } from 'vanilla-sharing';
fbButton({
url: 'https://alexey-avdeev.com/vanilla-sharing/',
});
```
## From CDN
```js
VanillaSharing.fbButton({
url: 'https://alexey-avdeev.com/vanilla-sharing/',
});
```
# API
### `fbFeed(options)`
Share on facebook.com via the Feed dialog
Documentation: https://developers.facebook.com/docs/sharing/reference/feed-dialog
```js
fbFeed({
url: string,
redirectUri: string,
fbAppId: string,
})
```
You can use `getFbFeedUrl(options)` for getting URL.
### `fbShare(options)`
Share on facebook.com via the Share dialog
Documentation: https://developers.facebook.com/docs/sharing/reference/share-dialog
```js
fbShare({
url: string,
redirectUri: string,
hashtag: string,
fbAppId: string,
quote: string,
})
```
You can use `getFbShareUrl(options)` for getting URL.
### `fbButton(options)`
Share on facebook.com using facebook share button
```js
fbButton({
url: string,
})
```
You can use `getFbButtonUrl(options)` for getting URL.
### `messenger(options)`
Share via Facebook Messenger
Share method from [Sharing for Messenger](https://developers.facebook.com/docs/sharing/messenger).
```js
messenger({
url: string,
fbAppId: string,
})
```
### `tw(options)`
Share on Twitter
```js
tw({
url: string,
title: string,
hashtags: array,
})
```
You can use `getTwUrl(options)` for getting URL.
### `reddit(options)`
Share on Reddit
```js
reddit({
url: string,
title: string,
})
```
### `pinterest(options)`
[Share on Pinterest](https://developers.pinterest.com/docs/widgets/save/?)
```js
pinterest({
url: string,
description: string,
media: image url string,
})
```
### `tumblr(options)`
[Share on Tumblr](https://www.tumblr.com/docs/en/share_button)
```js
tumblr({
url: string,
title: string,
caption: string,
tags: array,
})
```
### `vk(options)`
Share on vk.com
```js
vk({
url: string,
title: string,
description: string,
image: string,
isVkParse: boolean,
})
```
You can use `getVkUrl(options)` for getting URL.
### `ok(options)`
Share on ok.ru
[Like/Share button](https://apiok.ru/en/ext/like)
```js
ok({
url: string,
title: string,
image: string,
})
```
You can use `getOkUrl(options)` for getting URL.
### `mail(options)`
Share on Mail.ru
```js
mail({
url: string,
title: string,
description: string,
image: string,
})
```
### `email(options)`
Share via user's email
```js
email({
to: string,
url: string,
title: string,
description: string,
subject: string,
})
```
You can use `getEmailUrl(options)` for getting URL.
### `linkedin(options)`
Share on LinkedIn
Share method from [Share on LinkedIn](https://developer.linkedin.com/docs/share-on-linkedin#).
```js
linkedin({
url: string,
title: string,
description: string,
})
```
### `whatsapp(options)`
Share via Whatsapp
[WhatsApp FAQ - Using Click to Chat](https://faq.whatsapp.com/en/android/26000030/).
```js
whatsapp({
url: string,
title: string,
phone: string,
})
```
You can use `getWhatsappUrl(options)` for getting URL.
### `viber(options)`
Share via Viber
[Viber Share Button docs](https://developers.viber.com/docs/tools/share-button/).
```js
viber({
url: string,
title: string,
})
```
You can use `getViberUrl(options)` for getting URL.
### `telegram(options)`
Share via Telegram
```js
telegram({
url: string,
title: string,
})
```
You can use `getTelegramUrl(options)` for getting URL.
### `line(options)`
Share via Line
```js
line({
url: string,
title: string,
})
```