Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@anthotsang/react-twitter-widgets

1.7.1 • Public • Published

react-twitter-widgets

Alleviates the need for Twitter's default 2008-style widget snippets.

Available widgets: Timeline, Share, Follow, Hashtag, Mention, Tweet.

See below for usage.

Installation

npm install --save react-twitter-widgets

Example

Click here for a preview of all available widgets with example code.

import { Timeline } from 'react-twitter-widgets'
// var Timeline = require('react-twitter-widgets').Timeline
 
ReactDOM.render((
  <Timeline
    dataSource={{
      sourceType: 'profile',
      screenName: 'twitterdev'
    }}
    options={{
      username: 'TwitterDev',
      height: '400'
    }}
    onLoad={() => console.log('Timeline is loaded!')}
  />
), document.getElementById('root'))

Usage

Available widgets: Timeline, Share, Follow, Hashtag, Mention, Tweet

All widgets take an optional options object prop. To learn more about the available options (height, width, align, count, etc), see this link.

Timeline requires a dataSource object prop, see here for info. The source type can be profile, likes, list, collection, URL, or legacy widget configuration.

Share requires a url prop.

Follow and Mention require a username prop.

Hashtag requires a hashtag prop.

Tweet requires a tweetId prop. Ex. '511181794914627584'

All widgets accept an optional onLoad callback, which is called every time the widget is loaded/reloaded (both on inital load and updates).

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request

Credits

License

MIT

Install

npm i @anthotsang/react-twitter-widgets

DownloadsWeekly Downloads

6

Version

1.7.1

License

MIT

Unpacked Size

1.61 MB

Total Files

37

Last publish

Collaborators

  • avatar