README
📰 React Social Media Embed
Easily embed social media posts from Facebook, Instagram, LinkedIn, TikTok, Twitter, and YouTube in React.
Documentation
Read the official documentation.
Donate
This project is the result of 100s of hours of work and I really hope it saves you hours of your own precious time.
If you would like to join others in showing support for the development of this project, then please feel free to buy me a coffee.
Overview
Easily embed content from several popular social media platforms in React.
All embeds only require a URL to the post. No API token is needed.
Currently supporting: Facebook, Instagram, LinkedIn, TikTok, Twitter, and YouTube.
Features include:
- 🚀 Quick and easy
- Embed content quickly and easily for the most popular social media platforms. Just provide a URL!
- 💁 Live demos
- Give the embeds a try and play with their props using live examples.
- ⚙️ Customizable
- Each embed supports all div props and provides additional options, such as a placeholder.
- 💪 Resilient
- If embedding fails, it automatically retries using a configurable retry delay.
Table of Contents
- Documentation
- Donate
- Overview
- Table of Contents
- Installation
- Usage
- How It Works
- TypeScript
- Icon Attribution
- Contributing
- ⭐ Found It Helpful? Star It!
- License
Installation
npm i react-social-media-embed
Usage
import { FacebookEmbed } from 'react-social-media-embed';
<div style={{ display: 'flex', justifyContent: 'center' }}>
<FacebookEmbed url="https://www.facebook.com/andrewismusic/posts/451971596293956" width={550} />
</div>
This will display the Facebook embed centered with a width of 550.
For a live example and more options, read the full documentation for FacebookEmbed.
import { InstagramEmbed } from 'react-social-media-embed';
<div style={{ display: 'flex', justifyContent: 'center' }}>
<InstagramEmbed url="https://www.instagram.com/p/CUbHfhpswxt/" width={328} />
</div>
This will display the Instagram embed centered with a width of 328.
For a live example and more options, read the full documentation for InstagramEmbed.
import { LinkedInEmbed } from 'react-social-media-embed';
<div style={{ display: 'flex', justifyContent: 'center' }}>
<LinkedInEmbed
url="https://www.linkedin.com/embed/feed/update/urn:li:share:6898694772484112384"
postUrl="https://www.linkedin.com/posts/peterdiamandis_5-discoveries-the-james-webb-telescope-will-activity-6898694773406875648-z-D7"
width={325}
height={570}
/>
</div>
This will display the LinkedIn embed centered with a width of 325 and height of 570.
The url must be be retrieved from the "Embed this post" option for the desired post. Use the src attribute of the iframe:
<iframe src="https://www.linkedin.com/embed/feed/update/urn:li:share:6898694772484112384" height="570" width="325" frameborder="0" allowfullscreen="" title="Embedded post"></iframe>
It is recommended that you specify the width and height of the post. These have been pre-calculated in the iframe embed code as well.
You can also specify a postUrl which will be used in the placeholder to link to the regular, non-embed version of the post.
For a live example and more options, read the full documentation for LinkedInEmbed.
TikTok
import { TikTokEmbed } from 'react-social-media-embed';
<div style={{ display: 'flex', justifyContent: 'center' }}>
<TikTokEmbed url="https://www.tiktok.com/@epicgardening/video/7055411162212633903" width={325} />
</div>
This will display the TikTok embed centered with a width of 325.
The URL must contain the video ID, in the format https://www.tiktok.com/@username/video/1234567890123456789. Short links are not supported.
For a live example and more options, read the full documentation for TikTokEmbed.
import { TwitterEmbed } from 'react-social-media-embed';
<div style={{ display: 'flex', justifyContent: 'center' }}>
<TwitterEmbed url="https://twitter.com/PixelAndBracket/status/1356633038717923333" width={325} />
</div>
This will display the Twitter embed centered with a width of 325.
The URL must contain the tweet ID, in the format https://twitter.com/username/status/1234567890123456789. Short links are not supported.
This component uses the react-twitter-embed package to embed content. You can specify props for the internal TwitterTweetEmbed component via the twitterTweetEmbedProps prop.
For a live example and more options, read the full documentation for TwitterEmbed.
YouTube
import { YouTubeEmbed } from 'react-social-media-embed';
<div style={{ display: 'flex', justifyContent: 'center' }}>
<YouTubeEmbed url="https://www.youtube.com/watch?v=HpVOs5imUN0" width={325} height={220} />
</div>
This will display the YouTube embed centered with a width of 325 and height of 220.
This component uses the react-youtube package to embed content. You can specify props for the internal YouTube component via the youTubeProps prop.
For a live example and more options, read the full documentation for YouTubeEmbed.
Placeholder
import { PlaceholderEmbed } from 'react-social-media-embed';
A placeholder is shown while loading. If you do not specify a placeholder via the embedPlaceholder prop, a default PlaceholderEmbed placeholder component will be used. You can disable the placeholder with the placeholderDisabled prop.
The default placeholder will size itself according to the width and/or height you specify for the embed. If none are specified, it will fall back to a default size appropriate for the given social media platform. You can pass custom props (such as style) to the default placeholder via placeholderProps to override any default behavior.
If you'd like, you can specify the placeholderImageUrl prop to any of the embeds to show a placeholder with the provided image.
See the PlaceholderEmbed docs for examples and more.
How It Works
Each embed has a slightly different implementation. I've tried my best to standardize the embed experience for each from a developer standpoint so you don't have to think about how it performs the embed.
If you're curious how the embeds happen, read on!
We use the Facebook JavaScript SDK to embed content.
This loads a script which initializes the Facebook embedder to window.FB.XFBML.
A Facebook post uses the following form:
<div class="fb-post" data-href="{your-post-url}"></div>
We then use the FB.XFBML.parse() function to manually initialize the embed HTML.
We use the Instagram embed.js JavaScript library to embed content. In the documentation, you can refer to the section titled "Embed JS" for details.
This loads a script which initializes the Instagram embedder to window.instgrm.Embeds.
An Instagram post uses the following form:
<blockquote class="instagram-media"
data-instgrm-permalink="{your-post-url}"
data-instgrm-version="14">
<div>Placeholder</div>
</blockquote>
We then use the instgrm.Embeds.process() function to manually initialize the embed HTML.
LinkedIn does not have an embed JS library, unfortunately. So we use a simple iframe with the embed URL from LinkedIn's embed option, which is accessed via the menu next to any given post that has embedding allowed. If a post does not have embedding allowed, this option will not appear.
LinkedIn provides you with an iframe with an src attribute and the calculated width and height. Use these attributes for your embed.
TikTok
We use the TikTok embed.js JavaScript library to embed content.
This loads a script which initializes the TikTok embedder to window.tiktokEmbed.
A TikTok post uses the following form:
<blockquote class="tiktok-embed" cite="{your-post-url}" data-video-id="{video-id}">
<div>Placeholder</div>
</blockquote>
Unfortunately, unlike Facebook and Instagram, there is no documented or obvious way to manually initialize the embed HTML. If you know how to do this, please open a GitHub issue with the info!
So, in order to initialize the embed HTML, we must load the embed script from TikTok every time we render the TikTok embed. To do this, we use time-based query param cache busting and replace the embed.js script element in the head node. This forces the browser to load the script anew each time, which then performs the embed.
For example, here's the script element with t as the current time:
<script src="https://www.tiktok.com/embed.js?t=1645275849920" id="tiktok-embed-script"></script>
Again, if there's a way to manually initialize the embed HTML through the already-loaded script, please open an issue so this can be improved. For now, this gets the job done!
We use the react-twitter-embed package to embed Twitter tweets. This completely amazing package does all the heavy lifting. Please consider supporting the project.
You can specify props for the internal TwitterTweetEmbed component via the twitterTweetEmbedProps prop.
YouTube
We use the react-youtube package to embed YouTube videos. This incredibly awesome package does all the heavy lifting. Please consider supporting the project.
You can specify props for the internal YouTube component via the youTubeProps prop.
TypeScript
Type definitions have been included for TypeScript support.
Icon Attribution
Icon by Twemoji.
Contributing
Open source software is awesome and so are you. 😎
Feel free to submit a pull request for bugs or additions, and make sure to update tests as appropriate. If you find a mistake in the docs, send a PR! Even the smallest changes help.
For major changes, open an issue first to discuss what you'd like to change.
⭐ Found It Helpful? Star It!
If you found this project helpful, let the community know by giving it a star: 👉⭐
License
See LICENSE.md.