Vue Socials

💬 Social media share buttons and counts for Vue.js.

Explore website »

Key Features •
Installation •
Documentation •
Browsers support •
License •
Support the project •
Contributing

Key Features ✨

* 50+ reusable components
* Small ~1.3KB component average size (minified and gzipped)
* Fully tree-shakeable
* No dependencies
* No SDK
* Don't track the user
* Completely unstyled
* Built with a11y in mind
* Support Vue 2 & Vue 3
* Support SSR
* Each component exposing a single slot that gives you complete control over what should actually be rendered

Installation 🚀

npm
``shell

`Vue 2`


npm install vue-socials@1
Vue 3

npm install vue-socials

yarn`shell

`Vue 2`


yarn add vue-socials@1
Vue 3

yarn add vue-socials


Import all components (not recommended)

`js /** * Vue 2 */ import Vue from 'vue' import VueSocials from 'vue-socials';

Vue.use(VueSocials)

/** * Vue 3 */ import { createApp } from 'vue' import VueSocials from 'vue-socials'; import App from './App.vue'

const app = createApp(App) app.use(VueSocials)`

Import only specific component`js /** * Vue 2 */ import Vue from 'vue' import { SGithub } from 'vue-socials';

Vue.component('SGithub', SGithub)

/** * Vue 3 */ import { createApp } from 'vue' import { SGithub } from 'vue-socials'; import App from './App.vue'

const app = createApp(App) app.component('SGithub', SGithub)`

`Documentation 🤗`

Browse online documentation here

`K`

* Kakao Story

`L`

* Line

* Line counter

* Linkedin

* LiveJournal

`M`

* MailRu

* Mastodon

* Microsoft Teams

`O`

* Odnoklassniki

* Odnoklassniki counter

`P`

* Pinterest

* Pinterest counter

* Pocket

`Q`

* Qzone

`R`

* Reddit

* Reddit counter

* Renren

`S`

* Skype

* Sms

`T`

* Telegram

* Threema

* Trello

* Tumblr

* Tumblr counter

* Twitter

`V`

* Viber

* Vkontakte

* Vkontakte counter

`W`

* Weibo

* Whatsapp

* Wordpress

`X`

* Xing

`Y`

* Yahoo

* Yammer

---

`$3`

Usage

`vue

Props

Events

| Event name | Usage | | ------ | ------ |popup-open | window.open()has been opened |popup-close | window.open()has been closed |popup-block | window.open()has been blocked |popup-focus | window.open() has been focused |

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

| Prop | Type | Description | Default value | | ------ | ------ | ------ | ------ |shareOptions | object| Your share link parameters: mail – e-mail recipient address subject – subject of e-mail cc – carbon copy e-mail address bcc – blind carbon copy e-mail address body – body of e-mail |{}

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

| Prop | Type | Description | Default value | | ------ | ------ | ------ | ------ |shareOptions | object| Your share link parameters: id – the URL you want to share accessToken – your facebook access token fields – a comma-separated list of fields you want to request. |{}tag | string | Dynamic HTML tag or component | span

Events

| Event name | Usage | | ------ | ------ |load| the request has finished successfully |error| the request has finished with error |loading | the request has started |

⚠️ Warning

This component uses JSONP so the content won't be available during SSR.

---

`$3`

Usage

`vue

Props

| Prop | Type | Description | Default value | | ------ | ------ | ------ | ------ |windowFeatures | object | Pass options to window.open(). Requested features of the new window. | { width: 685, height: 600, }shareOptions | object| Your share link parameters: url – the URL you want to share redirectUri – The URL to redirect to after a person clicks a button on the dialog. appId – Your app's unique identifier. to – A user ID of a recipient. Once the dialog comes up, the sender can specify additional people as recipients. |{}useNativeBehavior | boolean | Use native link behavior instead of window.open() or not | false

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

| Prop | Type | Description | Default value | | ------ | ------ | ------ | ------ |shareOptions | object| Your share link parameters: username – your GitHub username type – share link type (follow) |{}tag | string | Dynamic HTML tag or component | span

Events

| Event name | Usage | | ------ | ------ |load| the request has finished successfully |error| the request has finished with error |loading | the request has started |

⚠️ Warning

This component uses JSONP so the content won't be available during SSR.

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

| Prop | Type | Description | Default value | | ------ | ------ | ------ | ------ |shareOptions | object| Your share link parameters: gistId – your gist id type – share link type (fork) |{}tag | string | Dynamic HTML tag or component | span

Events

| Event name | Usage | | ------ | ------ |load| the request has finished successfully |error| the request has finished with error |loading | the request has started |

⚠️ Warning

This component uses JSONP so the content won't be available during SSR.

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

| Prop | Type | Description | Default value | | ------ | ------ | ------ | ------ |shareOptions | object| Your share link parameters: username – your github username repository – your github repository type – share link type (watch, type, fork, issues) |{}tag | string | Dynamic HTML tag or component | span

Events

| Event name | Usage | | ------ | ------ |load| the request has finished successfully |error| the request has finished with error |loading | the request has started |

⚠️ Warning

This component uses JSONP so the content won't be available during SSR.

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

| Prop | Type | Description | Default value | | ------ | ------ | ------ | ------ |shareOptions | object| Your share link parameters: url – the URL you want to share |{}tag | string | Dynamic HTML tag or component | span

Events

| Event name | Usage | | ------ | ------ |load| the request has finished successfully |error| the request has finished with error |loading | the request has started |

⚠️ Warning

This component uses JSONP so the content won't be available during SSR.

---

`$3`

Usage

`vue

Props

| Prop | Type | Description | Default value | | ------ | ------ | ------ | ------ |windowFeatures | object | Pass options to window.open(). Requested features of the new window. | { width: 1100, height: 700, }shareOptions | object| Your share link parameters: url – Canonical URL of your product. If you already have products listed in Houzz, make sure the URLs match exactly to prevent duplicate listings and maintain accuracy of the Ideabook count. id – A unique identifier that verifies you own this web page. image – URL of hi-res product image. title – Title of the product. category – Keywords to help categorize the product. (ie. 'Wall Sconces') |{}useNativeBehavior | boolean | Use native link behavior instead of window.open() or not | false

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

| Event name | Usage | | ------ | ------ |load| the request has finished successfully |error| the request has finished with error |loading | the request has started |

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

| Prop | Type | Description | Default value | | ------ | ------ |--------------------------------------------------------------------------------------------------------------------------------------------------------| ------ |windowFeatures | object | Pass options to window.open(). Requested features of the new window. | { width: 600, height: 700, }shareOptions | object| Your share link parameters: domain – the mastodon domain url – the URL you want to share text – your text |{}useNativeBehavior | boolean | Use native link behavior instead of window.open() or not | false

Events

---

`$3`

Usage

`vue

Props

| Prop | Type | Description | Default value | | ------ | ------ | ------ | ------ |windowFeatures | object | Pass options to window.open(). Requested features of the new window. | { width: 600, height: 540, }shareOptions | object| Your share link parameters: url – the URL you want to share title – Default Text to be inserted in the assignments "Title" field (50 character limit) text – Default Text to be inserted before the link in the message compose box (200 character limit) preview – Whether or not to show a preview of the content to share. instruction – Default Text to be inserted in the assignments "Instructions" field (200 character limit) |{}useNativeBehavior | boolean | Use native link behavior instead of window.open() or not | false

Events

---

`$3`

Usage

`vue

Props

Vue Socials

💬 Social media share buttons and counts for Vue.js.

Explore website »

Key Features •
Installation •
Documentation •
Browsers support •
License •
Support the project •
Contributing

Key Features ✨

Installation 🚀

npm
``shell

`Vue 2`


npm install vue-socials@1
Vue 3

npm install vue-socials

yarn`shell

`Vue 2`


yarn add vue-socials@1
Vue 3

yarn add vue-socials


Import all components (not recommended)

`js /** * Vue 2 */ import Vue from 'vue' import VueSocials from 'vue-socials';

Vue.use(VueSocials)

/** * Vue 3 */ import { createApp } from 'vue' import VueSocials from 'vue-socials'; import App from './App.vue'

const app = createApp(App) app.use(VueSocials)`

Import only specific component`js /** * Vue 2 */ import Vue from 'vue' import { SGithub } from 'vue-socials';

Vue.component('SGithub', SGithub)

/** * Vue 3 */ import { createApp } from 'vue' import { SGithub } from 'vue-socials'; import App from './App.vue'

const app = createApp(App) app.component('SGithub', SGithub)`

`Documentation 🤗`

Browse online documentation here

`$3`

* Blogger

`$3`

* DevTo

* Diaspora

* Douban

`$3`

* Email

* Evernote

`$3`

* Facebook * Facebook counter

* Facebook Messenger

* Facebook Workplace

* Flipboard

`$3`

* Github

* Github counter

* Github gist

* Github gist counter

* Github repository

* Github repository counter

* Gmail

* Google Bookmarks

`$3`

* Hacker News

* Hatena

* Hatena counter

* Houzz

`$3`

* Instapaper

`K`

* Kakao Story

`L`

* Line

* Line counter

* Linkedin

* LiveJournal

`M`

* MailRu

* Mastodon

* Microsoft Teams

`O`

* Odnoklassniki

* Odnoklassniki counter

`P`

* Pinterest

* Pinterest counter

* Pocket

`Q`

* Qzone

`R`

* Reddit

* Reddit counter

* Renren

`S`

* Skype

* Sms

`T`

* Telegram

* Threema

* Trello

* Tumblr

* Tumblr counter

* Twitter

`V`

* Viber

* Vkontakte

* Vkontakte counter

`W`

* Weibo

* Whatsapp

* Wordpress

`X`

* Xing

`Y`

* Yahoo

* Yammer

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

| Event name | Usage | | ------ | ------ |load| the request has finished successfully |error| the request has finished with error |loading | the request has started |

⚠️ Warning

This component uses JSONP so the content won't be available during SSR.

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

| Event name | Usage | | ------ | ------ |load| the request has finished successfully |error| the request has finished with error |loading | the request has started |

⚠️ Warning

This component uses JSONP so the content won't be available during SSR.

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

| Event name | Usage | | ------ | ------ |load| the request has finished successfully |error| the request has finished with error |loading | the request has started |

⚠️ Warning

This component uses JSONP so the content won't be available during SSR.

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

| Event name | Usage | | ------ | ------ |load| the request has finished successfully |error| the request has finished with error |loading | the request has started |

⚠️ Warning

This component uses JSONP so the content won't be available during SSR.

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

| Event name | Usage | | ------ | ------ |load| the request has finished successfully |error| the request has finished with error |loading | the request has started |

⚠️ Warning

This component uses JSONP so the content won't be available during SSR.

---

`$3`

Usage

`vue

Props

| Prop | Type | Description | Default value | | ------ | ------ | ------ | ------ |windowFeatures | object | Pass options to window.open(). Requested features of the new window. | { width: 1100, height: 700, }shareOptions | object| Your share link parameters: url – Canonical URL of your product. If you already have products listed in Houzz, make sure the URLs match exactly to prevent duplicate listings and maintain accuracy of the Ideabook count. id – A unique identifier that verifies you own this web page. image – URL of hi-res product image. title – Title of the product. category – Keywords to help categorize the product. (ie. 'Wall Sconces') |{}useNativeBehavior | boolean | Use native link behavior instead of window.open() or not | false

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

| Event name | Usage | | ------ | ------ |load| the request has finished successfully |error| the request has finished with error |loading | the request has started |

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

Events

---

`$3`

Usage

`vue

Props

| Prop | Type | Description | Default value | | ------ | ------ | ------ | ------ |windowFeatures | object | Pass options to window.open(). Requested features of the new window. | { width: 600, height: 540, }shareOptions | object| Your share link parameters: url – the URL you want to share title – Default Text to be inserted in the assignments "Title" field (50 character limit) text – Default Text to be inserted before the link in the message compose box (200 character limit) preview – Whether or not to show a preview of the content to share. instruction – Default Text to be inserted in the assignments "Instructions" field (200 character limit) |{}useNativeBehavior | boolean | Use native link behavior instead of window.open() or not | false

Events

---

`$3`

Usage

`vue

Props