Documentation for using the YouTube Widget

Brief Information

The YouTube Widget has been implemented using an iFrame with a certain YouTube embed pattern. More information regarding this embed pattern can be found on the YouTube Developers API page. This widget is capable of serving any public YouTube video (via its link).

Requirements

There are no other prerequisites for this widget other than the basic project prerequisites.

Design Justification

The YouTube widget was specifically designed to be modular, portable and easy to extend. This was our reasoning to choose an iFrame, embed design pattern. By not using any API keys or other prerequisites the widget is lightweight and can easily be moved to another project as a React Component. We also wanted a minimal footprint on the journal and therefore we chose to implement a small textbox (for the youtube links) with the iFrame that can be easily resized to meet the users' needs.

Future Work

Currently, the default has been set to a live music channel and can easily be extended to include user-specific default options.