npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-twitter-widgets

v1.11.0

Published

Twitter widgets as React components

Downloads

116,753

Readme

react-twitter-widgets

npm version npm downloads GitHub issues

Quick and easy Twitter widgets for React.

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

See below for usage.

Demo

Storybook / Live Demo

Installation

npm install --save react-twitter-widgets

Example

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

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

// Timeline (with options)
<Timeline
  dataSource={{
    sourceType: 'profile',
    screenName: 'TwitterDev'
  }}
  options={{
    height: '400'
  }}
/>

Usage

🔗 Official Twitter Documentation

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

Timeline requires a dataSource object prop. The source type can be profile, list, or url. They each require their own co-fields; see Twitter documentation. NOTE that collection, likes, and moments will be deprecated on June 23, 2021.

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'

Common Props

All widgets accept these props.

  • options (object)
    • To learn more about the available options, refer to the Twitter documentation. There are four options that are common to all widgets (lang, dnt, related, and via). There are further options for button widgets, tweet buttons, Timeline, and Tweet.
  • onLoad (function)
    • Called every time the widget is loaded. A widget will reload if its props change.
  • renderError (function)
    • Render prop. Rendered if widget cannot be loaded (no internet connection, screenName not found, bad props, etc).
    • Example: renderError={(_err) => <p>Could not load timeline</p>}

Lazy vs. Eager Loading

By default, the remote Twitter library will be lazy-loaded when the first widget renders. To instead load it eagerly, call eagerLoadTwitterLibrary.

import { eagerLoadTwitterLibrary } from "react-twitter-widgets";
eagerLoadTwitterLibrary();

Further Information

  • This library loads the remote Twitter for Websites library.
  • Twitter widgets are only loaded in the browser. A blank div will be rendered during SSR.

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