Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 

README.md

jquery.tweetable.js

A simple li'l plugin that lets you make site content easily tweetable.

Inspired (and by inspired I mean I stole this) from a recent New York Times article doing the exact same thing.

You can see a demo of the plugin in action here.

Usage

Dependencies

I mean, jquery is in the name and everything ...

The Basics

Using the plugin is super duper easy:

$('[data-tweetable]').tweetable();

That will grab all elements with the data-tweetable attribute and create clickable links out of them. If the attribute in question has a value (e.g. data-tweetable='I love lamp'), the tweet's text will be set to that value; otherwise, it is set to whatever text is within the given element.

(If you're using a selector which is not an attribute, then be sure to set dataAttr so it knows where to pick up the text.)

The links are unstyled by default, but those links also are created with a given class (by default tweetable) so you can style them to your heart's content.

Options

Options are pretty simple, and you can pass them as so:

$('.awesome-text').tweetable({
	via: 'justinmduke'
});

The defaults:

// Defaults
{
	dataAttr: 'data-tweetable',
	linkClass: 'tweetable',
	via: null,
	related: null,
	url: window.location.pathname
}

The first two should be fairly obvious: via, related, and url all correspond to what you're passing to Twitter in terms of data.

About

Make sentences and snippets easily tweetable for your users.

Resources

You can’t perform that action at this time.