JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 14244
  • Score
    100M100P100Q137717F
  • License MIT

Twitter widgets as React components

Package Exports

  • react-twitter-widgets

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-twitter-widgets) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

react-twitter-widgets

Quick and easy Twitter widgets for React.

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

See below for usage.

Installation

npm install --save react-twitter-widgets

Example

import { Timeline } from 'react-twitter-widgets'

// Timeline (with options)
<Timeline
  dataSource={{
    sourceType: 'profile',
    screenName: 'TwitterDev'
  }}
  options={{
    height: '400'
  }}
  // Optional
  // onLoad={() => console.log('Timeline is loaded!')}
/>

// Tweet (without options)
<Tweet tweetId="841418541026877441" />

Usage

Official Twitter Documentation

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

Timeline requires a dataSource object prop. The source type can be profile, likes, list, collection, or url. They each require their own co-fields; see Twitter documentation.

Share requires a url prop.

Follow and Mention require a username prop. NOTE that the Twitter documentation now refers to this as screenName.

Hashtag requires a hashtag prop.

Tweet requires a tweetId prop. Ex. '511181794914627584'

All widgets accept an optional options object prop. To learn more about the available options (height, width, align, count, etc), see the Twitter documentation.

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

Further Information

  • This library loads the remote Twitter for Websites script.
  • Twitter widgets are only loaded in the browser. A blank div will be rendered during SSR.
  • Unfortunately, widget errors cannot be handled by this library. Twitter catches and logs any errors before they can bubble up. Therefore, if the remote library can't be loaded or if a supplied screen name does not exist, the widget will render as a blank div.

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