loading...
Cover image for The new Angular YouTube Player component!

The new Angular YouTube Player component!

phenomnominal profile image Craig ☠️💀👻 ・3 min read

Easily embed YouTube videos in your Angular applications!

TL;DR; —

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! 📚


The Angular YouTube Player component 🎉:

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 YouTubePlayerModule:

This gives us access to the <youtube-player> component!

Pretty straightforward!

The Angular YouTube Player API:

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…

⚠️ Warning! ⚠️

The YouTube Player component is still pre-release, so this API could change!

Inputs:

  • [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 'default' , 'small', 'medium', 'large', 'hd720', 'hd1080', and 'highres'
  • [showBeforeIframeApiLoads]: boolean — whether the iframe will attempt to load regardless of the status of the API on the page. Set this to true if you don’t want the onYouTubeIframeAPIReady field to be set on the global window

Outputs:

Each output maps to the events fired from the YouTube JS API.

  • (ready): PlayerEventfires whenever a player has finished loading and is ready to begin receiving API calls.
  • (stateChange): OnStateChangeEventfires whenever the player’s state changes
  • (error): OnErrorEventfires 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): OnPlaybackQualityChangeEventfires whenever the video playback quality changes
  • (playbackRateChange): OnPlaybackRateChangeEventfires whenever the video playback rate changes

Here’s a slightly more complete code snippet for rendering and playing a video with the <youtube-player> component:

The end! 📼 🎈

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!
🦄

Discussion

pic
Editor guide
Collapse
splaktar profile image
Michael Prentice

Thanks for the write up!

I just made some changes to show how you can have the video resize to fit its container space: github.com/angular/components/pull...

Here's that demo on StackBlitz: stackblitz.com/edit/youtube-player...

Collapse
wsadqe1234 profile image
WSADQE1234

Dude THANK YOU!!!! U are AWESOME!!!

Collapse
phenomnominal profile image
Craig ☠️💀👻 Author

Awesome! Thank you!

Collapse
lalish99 profile image
Eduardo Rojas

Great post!

One question, I've added a video correctly but I am wondering if I need to pay attention to the following warnings, apparently they start appearing after I use the Youtube Api directly or with this new component. Thanks in advance

Collapse
oleksandr profile image
Collapse
arcticjuggernaut profile image
Chris Johnston

You bastard you had to use a baby shark video didn't you?!

Collapse
phenomnominal profile image
Craig ☠️💀👻 Author

🦈🦈🦈🦈🦈

Collapse
lisacopeland profile image
Lisa Copeland

Thanks! That was super simple to use! I was also able to use breakpoint observer to make it responsive!

Collapse
cook_n_pop profile image
Cooknpop

You can use also use to make it responsive the bootstrap embed-responsive class

Collapse
toshminosh profile image
Toshminosh

Does startSeconds work yet?

I can't seem to get it working though height and width work fine.

Collapse
phenomnominal profile image
Craig ☠️💀👻 Author

I've actually had the same issue! I started debugging it, but didn't get very far! You should raise an issue on the repo, or even make a PR!

Collapse
lautarojgarcia177 profile image
Lautaro Garcia

Does anyone know how yo hide the player's controls?