Videos are a powerful tool for communicating with your end-users. Now you can create a fully-functional, responsive library for your YouTube videos without having to write any code. Simply add the IDs of your chosen videos in the Promoted video IDs theme setting and the videos will appear on the Home page of your help center.
Three ready-made templates are available out-of-the-box:
Videos can be played inline or within lightboxes.
The Video Library will inherit the overall style of the theme as defined in your theme settings. Additional control is provided through extension options and you can even create your own fully custom templates.
Creating video libraries
The Video Library extension is bundled into all of our themes by default, so you can start using it straight away through the “Promoted video IDs” theme setting. The source code can be found within the
extension-video-library.(min.)js file in the theme’s Assets folder.
If you do not use the “Promoted video IDs” theme setting but wish to create a Video Library instance elsewhere in the help center, add a reference to it in your theme’s
|ids|| || ||A comma-separated list of YouTube video IDs.|
|layout|| || ||The layout to use ( |
|showTitle|| || ||True if a title should be shown for each video.|
|showDuration|| || ||True if a description should be shown for each video.|
|playsInline|| || ||True if videos should play inline, as opposed to in a lightbox.|
|useLoader|| || ||True if placeholders should be used while the videos are loading.|
|template|| || ||The name of the micro-template to use.|
|templateData|| || ||Additional data to expose to the templating function.|
In order for videos to play in a lightbox, you must enable the
playsInline option and ensure that lightboxes are enabled in your theme settings.
Video metadata is loaded after the main extension template has been rendered. The following data-attributes can be used on elements in your custom templates to automatically replace their content with video metadata:
data-title="<%= id %>"for the video title
data-description="<%= id %>"for the video description
data-duration="<%= id %>"for the formatted video duration
data-url="<%= id %>"for the video URL
| ||Fires when the article list has been rendered.|
| ||Fires when an individual player is ready.|
| ||Fires when all players are ready and the Video Library has been rendered.|