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
.
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" : "container",
"section-title" : "Video",
}
%}
{% include "../path_to/vf-video-container/vf-video-container.njk" %}
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-container', {
"component-type" : "container",
"section-title" : "Video",}
%}
<section class="vf-video-container | embl-grid embl-grid--has-sidebar">
<div class="vf-section-header">
<h2 class="vf-section-header__heading"> Projects</h2>
</div>
<div class="vf-video">
<iframe width="560" height="315" src="https://www.youtube.com/embed/nGNvYjYQaaQ?rel=0" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
</div>
<div class="vf-video-teaser | vf-stack vf-stack--400">
<h3 class="vf-video-teaser__title">More on our YouTube channel</h3>
<article class="vf-video-teaser__item | vf-stack vf-stack--400">
<img class="vf-video-teaser__image" src="https://acxngcvroo.cloudimg.io/v7/https://www.embl.org/files/wp-content/uploads/2020/04/SEMINARS_1102_lecture_vision2020_hd_retouched_500px.jpg" alt="" loading="lazy">
<a href="JavaScript:Void(0);" class="vf-video-teaser__link vf-link">A presentation on something to do with Life Sciences.</a>
</article>
<article class="vf-video-teaser__item | vf-stack vf-stack--400">
<img class="vf-video-teaser__image" src="https://acxngcvroo.cloudimg.io/v7/https://www.embl.org/files/wp-content/uploads/2020/04/CONFERENCES_NonCodingSymp_7804_Retouched_500px.jpg" alt="" loading="lazy">
<a href="JavaScript:Void(0);" class="vf-video-teaser__link vf-link">Take a look at the fancy Helix building</a>
</article>
</div>
</section>
This component is distributed with npm. After installing npm, you can install thevf-video-container` with this command.
$ yarn add --dev @visual-frameworvf-video-container
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-frameworvf-video-container/index.scss";
Make sure you import Sass requirements along with the modules. You can use a project boilerplate or the vf-sass-starter
File system location: components/vf-video-container
Find an issue on this page? Propose a change or discuss it.