Really enjoyed reading this post, thank you.
Really enjoyed reading this post, thank you.
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": "block",
"number": 3,
"text": "comments on 'EMBL's graphic design history'",
"discussions": [
{
"name": "Title If Relevant",
"date": "15th February 2018",
"imageUrl": "/assets/vf-summary/assets/vf-summary--profile-img.png",
"content": "<p>Really enjoyed reading this post, thank you.</p> <p>For me, any communications strategy should be deeply rooted in the organisational strategy. And yet, your closing question reminded me how the discussions we lead about communications can often result in much broader discussions on organisational goals, ambitions and approaches.</p>",
"button_text": "Reply"
},
{
"name": "Title If Relevant",
"date": "15th February 2018",
"imageUrl": "/assets/vf-summary/assets/vf-summary--profile-img.png",
"content": "<p>Really enjoyed reading this post, thank you.</p>",
"button_text": "Reply",
"secondary_button": "Optional action",
"vf_discussion_href": "JavaScript:Void(0);",
"nested": [
{
"name": "Mr. Nested",
"date": "16th Febraury 2018",
"imageUrl": "/assets/vf-summary/assets/vf-summary--profile-img.png",
"content": "<p>Really enjoyed reading this post, thank you.</p>",
"button_text": "Reply"
}
]
}
]
}
%}
{% include "../path_to/vf-discussion/vf-discussion.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-discussion', {
"component-type": "block",
"number": 3,
"text": "comments on 'EMBL's graphic design history'",
"discussions": [
{
"name": "Title If Relevant",
"date": "15th February 2018",
"imageUrl": "/assets/vf-summary/assets/vf-summary--profile-img.png",
"content": "<p>Really enjoyed reading this post, thank you.</p> <p>For me, any communications strategy should be deeply rooted in the organisational strategy. And yet, your closing question reminded me how the discussions we lead about communications can often result in much broader discussions on organisational goals, ambitions and approaches.</p>",
"button_text": "Reply"
},
{
"name": "Title If Relevant",
"date": "15th February 2018",
"imageUrl": "/assets/vf-summary/assets/vf-summary--profile-img.png",
"content": "<p>Really enjoyed reading this post, thank you.</p>",
"button_text": "Reply",
"secondary_button": "Optional action",
"vf_discussion_href": "JavaScript:Void(0);",
"nested": [
{
"name": "Mr. Nested",
"date": "16th Febraury 2018",
"imageUrl": "/assets/vf-summary/assets/vf-summary--profile-img.png",
"content": "<p>Really enjoyed reading this post, thank you.</p>",
"button_text": "Reply"
}
]
}
]
} %}
<section class="vf-discussion">
<h3 class="vf-discussion__title"><span>3</span> comments on 'EMBL's graphic design history'</h3>
<ol class="vf-discussion__list | vf-list">
<li class="vf-discussion__item">
<div class="vf-discussion__meta">
<img class="vf-discussion__author-avatar" src="./assets/vf-summary/assets/vf-summary--profile-img.png" alt="" loading="lazy">
<cite class="vf-discussion__author">Title If Relevant</cite><span> says:</span>
<p class="vf-discussion__date">15th February 2018</p>
</div>
<div class="vf-discussion__comment | vf-content">
<p>Really enjoyed reading this post, thank you.</p>
<p>For me, any communications strategy should be deeply rooted in the organisational strategy. And yet, your closing question reminded me how the discussions we lead about communications can often result in much broader discussions on organisational goals, ambitions and approaches.</p>
</div>
<button class="vf-button vf-button--outline vf-button--primary | vf-discussion__reply">Reply</button>
</li>
<li class="vf-discussion__item">
<div class="vf-discussion__meta">
<img class="vf-discussion__author-avatar" src="./assets/vf-summary/assets/vf-summary--profile-img.png" alt="" loading="lazy">
<cite class="vf-discussion__author">Title If Relevant</cite><span> says:</span>
<p class="vf-discussion__date">15th February 2018</p>
</div>
<div class="vf-discussion__comment | vf-content">
<p>Really enjoyed reading this post, thank you.</p>
</div>
<button class="vf-button vf-button--outline vf-button--primary | vf-discussion__reply">Reply</button>
<a href="JavaScript:Void(0);" class="vf-button vf-button--outline vf-button--tertiary | vf-discussion__action">Optional action</a>
<ol class="vf-discussion__list | vf-list">
<li class="vf-discussion__item">
<div class="vf-discussion__meta">
<img class="vf-discussion__author-avatar" src="./assets/vf-summary/assets/vf-summary--profile-img.png" alt="" loading="lazy">
<cite class="vf-discussion__author">Mr. Nested</cite><span> says:</span>
<p class="vf-discussion__date">16th Febraury 2018</p>
</div>
<div class="vf-discussion__comment | vf-content">
<p>Really enjoyed reading this post, thank you.</p>
</div>
<button class="vf-button vf-button--outline vf-button--primary | vf-discussion__reply">Reply</button>
</li>
</ol>
</li>
</ol>
</section>
This repository is distributed with npm. After installing npm and yarn, you can install with this command.
$ yarn add --dev @visual-framework/vf-discussion
The style files included are written in Sass. If you're using a VF-core project, you can import it like this:
@import "@visual-framework/vf-discussion/index.scss";
Make sure you import Sass requirements along with the modules. You can use a project boilerplate or the vf-sass-starter
set-
style functions to cleaner version
File system location: components/vf-discussion
Find an issue on this page? Propose a change or discuss it.
Really enjoyed reading this post, thank you.
For me, any communications strategy should be deeply rooted in the organisational strategy. And yet, your closing question reminded me how the discussions we lead about communications can often result in much broader discussions on organisational goals, ambitions and approaches.