Giter VIP home page Giter VIP logo

twitterfetch's Introduction

twitterFetch

Fetches your latest tweets

twitterFetch shows your latest tweets on your website.

⚠️ Warning: Twitter switched to iframes to embed Twitter widgets and disabled fetching the feed from JavaScript. This means twitterFetch is no longer working! This repository is only for informational purposes. ⚠️

Twitter already offers two options to show your tweets on your website:

  1. Using a Twitter widget
  2. Using the Twitter REST API

They are fully supported by Twitter and might be the best solution for you.

Disadvantages are:

  1. Limited layout possibilities (widget).
  2. Cookies are send to Twitter, which, without warning, might be illegal in your jurisdiction (widget).
  3. Page load (widget).
  4. Needs server side scripting (api).

TwitterFetch provides a solution without these disadvantages. It fetches the Twitter widget (without sending cookies) and makes the tweets available in JavaScript, to be placed on a webpage the way you want. Less than 2kB, twitterFetch is also very lightweight.

TwitterFetch uses unsupported Twitter functionality, so there's no guarantee of continuity.

Quickstart

Start by downloading twitterfetch.js to you server and including it in your web page.

<script src="twitterfetch.js">

In your HTML, make sure you have a place to show the tweets:

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

Now, use twitterFetch to fetch the tweets and show the first one:

twitterFetch.fetch('345615146724495360', {}, function (tweets) {
	if (!tweets || tweets.length == 0) {
		return;
	}
	document.getElementById('tweets').innerHTML = tweets[0];
});

But don't use the widget id 345615146724495360, that belongs to my @edwinmdev Twitter account.

How to make your own widget id?

Create a Twitter widget and look at the generated code. You'll find data-widget-id="..." with the number you can use.

API

The twitterFetch fetch function takes three parameters:

twitterFetch.fetch(widgetId, options, callbackFunction);

widgetId

The widget id you get when creating a widget, see above.

options

An object literal with several options:

images (boolean): when false, prevents loading images that are not needed (default: false).

plaintext (boolean): when false, encodes some entities to make the text safe for HTML (default: false).

hyperlinks (boolean): when true, turns urls and Twitter @usernames into hyperlinks (default: true).

Example:

{
	images: false,
	plaintext: true
}

callbackFunction

The function that is called back with one argument containing an array with tweets.

License

TwitterFetch is copyright 2016 Edwin Martin and MIT licensed.

twitterfetch's People

Contributors

edwinm avatar

Watchers

 avatar  avatar  avatar

Forkers

scottyzen

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.