There’s a cool new component in the Angular world 🌎! It makes it easier than ever before to add YouTube videos to your Angular applications. Install it today and try it out:
npm i @angular/youtube-player
To find out more details about it, and learn about the full API, read on! 📚
One of the big exciting recent changes to Angular (other than Ivy), is the rename of the
angular/material repository to
angular/component ✨. This rename is meant to capture the fact that the repository is for so much more than only the Angular Material library! The Angular Components repository already also contains the Angular Component Dev Kit, and it is going to be the place where new, high-quality Angular components are built and shared with the community. With the release of the first release candidate of Angular v9, we get our first look at these new components!
One of these brand new components is the
@angular/youtube-player. This component is a thin wrapper around the embed Youtube player API. Let’s check out what it looks like:
Documentation is a bit thin on the ground right now, so let’s dig into the code and see how this thing works! First, we need to import and include
This gives us access to the
Unfortunately documentation for the full API hasn’t written yet. Luckily, we can check out the source code for the component and see what we find…
[videoId]: string— YouTube Video ID to render. It’s the little hash at the end of the YouTube URL. For example, if your video is found at https://www.youtube.com/watch?v=moSFlvxnbgk, then your videoId is moSFlvxnbgk.
[height]: number— height of video player
[width]: number— width of video player
[startSeconds]: number— the moment when the player is supposed to start playing
[endSeconds]: number— the moment when the player is supposed to stop playing
[suggestedQuality]: SuggestedQuality— the suggested quality of the player. This can take the values
[showBeforeIframeApiLoads]: boolean— whether the
iframewill attempt to load regardless of the status of the API on the page. Set this to true if you don’t want the
onYouTubeIframeAPIReadyfield to be set on the global
Each output maps to the events fired from the YouTube JS API.
(ready): PlayerEvent— fires whenever a player has finished loading and is ready to begin receiving API calls.
(stateChange): OnStateChangeEvent— fires whenever the player’s state changes
(error): OnErrorEvent— fires if an error occurs in the player
(apiChange): PlayerEvent— fires to indicate that the player has loaded (or unloaded) a module with exposed API methods
(playbackQualityChange): OnPlaybackQualityChangeEvent— fires whenever the video playback quality changes
(playbackRateChange): OnPlaybackRateChangeEvent— fires whenever the video playback rate changes
Here’s a slightly more complete code snippet for rendering and playing a video with the
And that’s it! It’s great to see cool new components coming from the Angular team. This one provides a really clear API around a pretty common use-case. I’m sure you’ll all come up with awesome ways to use it. Check it out, file any bugs against the Angular Components repository, and let me know what you’re building!