Giter Club home page Giter Club logo

tweetable's Introduction

Tweetable - A jQuery plugin for displaying twitter feeds

GitHub : https://github.com/philipbeel/Tweetable
Demo : http://plugins.theodin.co.uk/tweetable/demo/
Website : http://theodin.co.uk
Email : [email protected]
Twitter : @philipbeel

Description

Tweetable is a lightweight jQuery plugin that enables you to display your twitter feed on your site quickly and easily. More than just displaying the feeds you can highlight @replys as well as links being dynamically generated for ease of use.

IE Usage

Please note that IE is no longer supported by this plugin.

Usage

Call in the jQuery framework and jquery.tweetable.js in your webpage

<script type="text/javascript" src="jquery.tweetable.js"></script>

Create an element on your page that you want to call your twitter feed into.

<div id="tweets"></div>

Initiate tweetable on your selected element, pass in the twitter username.

$('#tweets').tweetable({username: 'philipbeel'});

TimeAgo plugin support

Tweetable also supports timeago. for displaying how long ago a tweet was posted. This can be achieved like so:

$('#tweets').tweetable({
	html5: true,
	onComplete:function($ul){
		$('time').timeago();
	}
});

Plugin parameters

limit: {Integer},           	// Number of tweets to show
username: {String},     		// @username tweets to display
time: {Boolean},            	// Display date
retweets: {Boolean},        	// Discount retweets false
replies: {Boolean},         	// Filter out @replies if true
failed: {String}				// Text to display when API returns no results
rotate: {Boolean}				// Displays only one tweet at a time
speed: {Integer}		     	// Speed in milliseconds to display each tweet if rotating
append: {String}				// Appended position
loading: {String}				// Loading tweets text
HTML5: {Boolean}				// Confirm if HTML5 is supported (timeago support)
cacheInMilliseconds {Integer}	// Time to keep the most recent tweets in cache before requesting new ones
onComplete: {Object}			// Function callback after event triggered

Changelog

2.1

  • Added caching for improved performance
  • Made code more moduler

2.0

  • Added suppot for jQuery 1.8 getJSON promise interface
  • Depreciated IE support
  • Added loading message support

1.7.1

  • Changed endpoint to use getmytweets.co.uk

1.7.0

  • Added Qunit test coverage
  • Refactored plugin architecture
  • Added override for plugin defaults object

1.6.0

  • Added Qunit test coverage
  • Added timeago plugin support
  • Optimized variable declarations

tweetable's People

Contributors

bedfordlam avatar crazy4groovy avatar onepixelcitizen avatar peterson avatar philipbeel avatar philipjbeel avatar verygreenboi avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.