A collection of components to embed Twitch.
For more information, visit the Embedding Twitch documentation page.
Make sure to check out the Demo and Documentation page for more information on the usage of the components, alongside a description on all the supported props for each component.
npm install react-twitch-embed
A Note on Typings
This package includes some typings for the
Player constructors that are downloaded automatically
into the browser's
window object. These are unofficial typings that I made empirically, some of them might not be accurate.
The documentation on Twitch's official page is incomplete in various aspects, and a lot of the functionality included in this package was found by arbitrarily and through trial and error.
If you find any inconsistency with the typings provided by this package, feel free to open a Pull Request.
A Note on the
Twitch requires that any embeds include the URL of the parent site that embeds their content. These components will get this
parent URL through
window.location.hostname for non-interactive components (those components that are essentially just an
while the interactive ones get the parent automatically (possible through the same property) by their respective constructor.
As such, you shouldn't need to specify this prop for any of the components, unless you run a particular setup with multiple domains.
TwitchPlayerNonInteractive, which component should I choose?
Out of these components,
TwitchPlayerare both interactive components, meaning that they expose the internal instance through their respective events. Both of these components support streams, VODs and collections, and they both react efficiently when their
collectionprops change by using the internal API instead of recreating the embed when they change. The key difference is that
TwitchEmbedcan include the live chat on streams. At the end of the day, it depends on which one you prefer.
TwitchPlayerNonInteractive, this component can embed streams, VODs and collections too, but it does not include an internal API. This means that channel, video or collection switching is not "smooth" and will recreate the embed. However, this component does not download anything extra, it does not create any additional nodes on the body document, so it is probably less resource heavy.
- Why are there
TwitchClipwill only work for clips whereas
TwitchPlayerwill work for VODs, collections and streams.
- I'm using multiple embeds simultaneously, why are they sticking next to each other?
In the case of
TwitchPlayer, these components need an
idprop to work because the internal API mounts its respective
divqueried by its
id. These components will use a default
idif it's not provided in their props. If you're displaying multiple embeds simultaneously then you should provide a static
id. Try not to use the name of the channel as an
idbecause in the case that this prop changes, the embed will be recreated and the internal API won't be used for the channel switching.
- What does smooth switching mean?
TwitchPlayercomponents, when updating their
collectionprops, the player will not be recreated and instead the internal API will be used to update this data.
You can run the tests for this package by running:
Or leave the watcher running with:
npm run test:watch
When developing, you can use Storybook as a way to check the components and test them. You can run the Storybook server with:
npm run storybook:serve
Also, make sure that your code is linter properly with:
npm run lint
This component package was made by moonstar-x.