1.0.0 • Published 6 years ago

socialise v1.0.0

Weekly downloads
4
License
ISC
Repository
github
Last release
6 years ago

#Shape Share http://twitter.com/madebyshape

##Description

jQuery plugin that allows simple and quick implementation of Twitter, Facebook, Pinterest & Google+ sharing. There are no styles included which makes it work with custom styling a lot easier, by simply applying a class and data attribute.

##Usage

Note: This requires jQuery 1.10.x to work correctly. This is not included in the repo but can be downloaded from http://jquery.com or from a Google CDN - https://developers.google.com/speed/libraries/#jquery

###Installing

The content is pulled from "Open Graph" tags. This means that if someone shares your page not via this add-on content is still pulled through in to the social network. So it's important that these tags are added.

<meta property="og:site_name" content="">
<meta property="og:title" content="">
<meta property="og:description" content="">
<meta property="og:type" content="">
<meta property="og:image" content="">
<meta property="og:url" content="">
<script>
	$(document).ready(function(){
		$('.social-share').shapeShare();
	});
</script>

##Options

General

Shorten URL

You can make the plugin shorten the URL that is being shared (Particularly useful for share options that have a character count). It uses Bitly (https://bitly.com) to shorten the URL's.

Example:

<script>
	$(document).ready(function(){
		$('.social-share')
			.shapeShare(
				{
					shortenUrl: {
						enable: true,
					}
				}
			);
	});
</script>

Popup Size

Example:

<script>
	$(document).ready(function(){
		$('.social-share')
			.shapeShare(
				{
					popupSize: {
			        	width: '600',
			        	height: '500'
					}
				}
			);
	});
</script>

Twitter

If having a share option for Twitter it's important to fill out these options.

Example:

<script>
	$(document).ready(function(){
		$('.social-share')
			.shapeShare(
				{
					twitter: {
						account: 'madebyshape',
						content: 'title'
					}
				}
			);
	});
</script>

##Roadmap

1.0.0

6 years ago