Follow Button JavaScript Factory Function

Twitter’s widget JavaScript library supports dynamic insertion of a follow button using the twttr.widgets.createFollowButton function. Pass Twitter username, target parent element, and any custom options.

The code snippets on this page assume Twitter’s widgets.js has successfully loaded on your page. Include an asynchronous script loader on your page while initializing window.twttr as described in our JavaScript loader documentation. All JavaScript code depending on widgets.js should execute on or after twttr.ready.

Arguments

Parameter Description Example value
username A Twitter username 'TwitterDev'
targetEl DOM node of the desired parent element document.getElementById('container')
options Override default widget options { size: 'large' }

Example

An element with a DOM ID of container exists on the page.

<div id="container"></div>

The code snippet below will create a new follow button for the Twitter username “TwitterDev” inserted into a page inside an element with a unique ID of container.

twttr.widgets.createFollowButton(
  'TwitterDev',
  document.getElementById('container'),
  {
    size: 'large'
  }
);

Promises

The twttr.widgets.createFollowButton function returns a Promise. You can execute code after a widget has been inserted onto your page by passing a callback to the resulting promise’s then function.

twttr.widgets.createFollowButton(...)
.then( function( el ) {
  console.log('Follow button added.');
});