beta This component version is ready to be used but is still in active development.

Video block

Add a video with this component.

github location npm version


Nunjucks syntax

Depending on your environment you'll want to use render or include. As a rule of thumb: server-side use include, precompiled browser use render. If you're using vf-eleventy you should use include.

Using include

You'll need to pass a context object from your code or Yaml file (example), as well as the path to the Nunjucks template. Nunjucks' include is an abstraction of render and provides some additional portability.

{% set context fromYourYamlFile %}
- or -
{% set context = { 
"component-type" : "block",
"video_href" : "",
{% include "../path_to/vf-video/vf-video.njk" %}

Using render

This approach is best for bare-bones Nunjucks environments, such as precompiled templates with the Nunjucks slim runtime where include is not be available.

{% render '@vf-video', {
  "component-type" : "block",
  "video_href" : "",}
<div class="vf-video">
  <iframe width="560" height="315" src="" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>


Installation info

This component is distributed with npm. After installing npm, you can install the vf-video with this command.

$ yarn add --dev @visual-framework/vf-video


The source files included are written in Sass(scss). You can point your Sass include-path at your node_modules directory and import it like this.

@import "@visual-framework/vf-video/index.scss";

Make sure you import Sass requirements along with the modules. You can use a project boilerplate or the vf-sass-starter






  • Readme cleanup


  • Version bump only for package @visual-framework/vf-video


  • Version bump only for package @visual-framework/vf-video


File system location: components/vf-video

Find an issue on this page? Propose a change or discuss it.