# social-sharing > social share button add-on Latest version **0.2.2** (published 2017-06-30) · MIT license · 0 weekly downloads ## Install ```sh npm install social-sharing pnpm add social-sharing yarn add social-sharing bun add social-sharing ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.2.2 | | Published | 2017-06-30 | | First published | 2016-12-17 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 1 | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Author | Caliber Interactive | | Maintainers | caliberi | | Keywords | social, share, buttons | ## Links - npm: https://www.npmjs.com/package/social-sharing - Repository: https://github.com/caliberi/social-sharing - Homepage: https://github.com/caliberi/social-sharing#readme - Issues: https://github.com/caliberi/social-sharing/issues - npm.io page: https://npm.io/package/social-sharing ## Dependencies (1) - [pure-masonry-js](https://npm.io/package/pure-masonry-js.md) ^0.2.5 ## Recent versions - 0.2.2 (latest) — 2017-06-30 - 0.2.1 — 2017-06-30 - 0.1.5 — 2017-06-27 - 0.1.4 — 2017-06-27 - 0.1.3 — 2017-06-27 - 0.1.2 — 2017-06-26 - 0.1.1 — 2017-06-26 - 0.0.2 — 2016-12-19 - 0.0.1-security — 2016-12-17 ## README # Social Buttons **Installation** ```bash npm install --save-dev social-sharing ``` **Usage** **1.** Add .css and .js files of socialSharing. ```html ... ... ``` **2.** Initialise app and pass a configuration object to it: ```html ``` **Or** Using webpack ```javascript let SocialSharing = require('social-sharing'); SocialSharing.init(); ``` **Table of options (High level)**
Option Default value Comments
orientation right (String) 2 values currently possible, left or right
googleAPIKey none (String) Get you own google api shortner. https://developers.google.com/url-shortener/v1/getting_started you can get your own key here (scroll down and find a button (GET A KEY)). This will be used to shorten your url for twitter
distanceFromTop 30 (String) this would be 30vh from the top
buttonMobileSize 20 (Integer) size of the button for Mobiles in pixels ( height: 20px, width: 20px)
buttonDesktopSize 25 (Integer) size of the button for Desktop in pixels ( height: 20px, width: 20px)
buttonRoundness 0 (Integer) border radius on top and bottom
buttonGreyscale false (Boolean) Grayscale buttons?
closeBtn false (Boolean) Add a button that has an ability to hide social buttons (animate them away from the view)
--- **List of social settings** (part of `socials object`) For example ```javascript var options = { socials: { facebook: { enabled: true, url: 'https://example.com' } twitter { enabled: true } } } ``` Whole list of social networks all social netowork have at least 2 params, its `enabled: true or false` and `url: 'someurl.com'` Facebooks and twitter have more than two and below is example of both. ```javascript var options = { socials: { facebook: { enabled: true, url: 'https://caliberi.com', name: 'Social Sharing Plugin Add-on', caption: 'This is a caption text', description: 'This is a description text' }, twitter: { enabled: true, text: 'Social Sharing Plugin Add-on', url: 'https://caliberi.com', screenName: 'Caliberi', hashtag: 'SocialShare' } } } ``` **Examples** In order to view how the output looks like, open `examples/example-1.html` in your browser. --- _Source: https://npm.io/package/social-sharing · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._