Next.js

Installation

Next.js 13.2.1 or higher is required in order to use react-tweet.

Follow the installation docs in the Introduction.

Usage

In any component, import Tweet from react-tweet and use it like so:

import { Tweet } from 'react-tweet'
 
export default function Page() {
  return <Tweet id="1628832338187636740" />
}

Tweet works differently depending on where it's used. If it's used in the App Router it will fetch the tweet in the server. If it's used in the pages directory it will fetch the tweet in the client with SWR (opens in a new tab).

You can learn more about Tweet in the Twitter theme docs. And you can learn more about the usage in Running the test app.

Troubleshooting

If you see an error saying that CSS can't be imported from node_modules in the pages directory. Add the following config to next.config.js:

transpilePackages: ['react-tweet']

The error won't happen if the App Router is enabled, where Next.js supports CSS imports from node_modules (opens in a new tab).

Advanced usage

Manual data fetching

You can use the getTweet function from react-tweet/api to fetch the tweet manually. This is useful for SSG pages and for other Next.js data fetching methods (opens in a new tab) in the pages directory.

For example, using getStaticProps in pages/[tweet].tsx to fetch the tweet and send it as props to the page component:

import { useRouter } from 'next/router'
import { getTweet, type Tweet } from 'react-tweet/api'
import { EmbeddedTweet, TweetSkeleton } from 'react-tweet'
 
export async function getStaticProps({
  params,
}: {
  params: { tweet: string }
}) {
  const tweetId = params.tweet
 
  try {
    const tweet = await getTweet(tweetId)
    return tweet ? { props: { tweet } } : { notFound: true }
  } catch (error) {
    return { notFound: true }
  }
}
 
export async function getStaticPaths() {
  return { paths: [], fallback: true }
}
 
export default function Page({ tweet }: { tweet: Tweet }) {
  const { isFallback } = useRouter()
  return isFallback ? <TweetSkeleton /> : <EmbeddedTweet tweet={tweet} />
}

Adding `next/image`

Add the domain URLs from Twitter to images.remotePatterns (opens in a new tab) in next.config.js:

/** @type {import('next').NextConfig} */
const nextConfig = {
  images: {
    remotePatterns: [
      { protocol: 'https', hostname: 'pbs.twimg.com' },
      { protocol: 'https', hostname: 'abs.twimg.com' },
    ],
  },
}

In tweet-components.tsx or elsewhere, import the Image component from next/image and use it to define custom image components for the tweet:

import Image from 'next/image'
import type { TwitterComponents } from 'react-tweet'
 
export const components: TwitterComponents = {
  AvatarImg: (props) => <Image {...props} />,
  MediaImg: (props) => <Image {...props} fill unoptimized />,
}

Then pass the components prop to Tweet:

import { Tweet } from 'react-tweet'
import { components } from './tweet-components'
 
export default function Page() {
  return <Tweet id="1628832338187636740" components={components} />
}

Running the test app

Clone the react-tweet (opens in a new tab) repository and then run the following command:

pnpm install && pnpm dev --filter=next-app...

The app will be up and running at http://localhost:3001 (opens in a new tab) for the Next.js app example (opens in a new tab).

The app shows the usage of react-tweet in different scenarios:

localhost:3001/light/1629307668568633344 (opens in a new tab) renders the tweet in the app router.
localhost:3001/dark/1629307668568633344 (opens in a new tab) renders the tweet using SSG in the pages directory.
localhost:3001/light/mdx (opens in a new tab) rendes the tweet in MDX (with the experimental mdxRs config enabled).
localhost:3001/light/suspense/1629307668568633344 (opens in a new tab) renders the tweet with a custom Suspense wrapper.
localhost:3001/dark/swr/1629307668568633344 (opens in a new tab) uses apiUrl to change the API endpoint from which the tweet is fetched in SWR mode.

The source code for react-tweet is imported from packages/react-tweet (opens in a new tab) and any changes you make to it will be reflected in the app immediately.

Introduction Vite