Visual Framework
Visual Framework
If you're using the VF Nunjucks environment, you can utilise the {% codeblock 'html' -%}{% endcodeblock %} tag to assist generating pre-formatted content.
<pre class="vf-code-example__pre">
<code class="vf-code-example">
<your special code here>
Maybe some html tags?
<link rel="stylesheet" href="https://aurl">
<script src="https://aurl"></script>
</code>
</pre>
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.
includeYou'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",
}
%}
{% include "../path_to/vf-code-example/vf-code-example.njk" %}
renderThis 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-code-example', {
"component-type" : "block",}
%}
<pre class="vf-code-example__pre"><code class="Code Code--lang-html vf-code-example"><span class="hljs-tag"><<span class="hljs-name">pre</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"vf-code-example__pre"</span>></span>
<span class="hljs-tag"><<span class="hljs-name">code</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"vf-code-example"</span>></span>
<span class="hljs-tag"><<span class="hljs-name">your</span> <span class="hljs-attr">special</span> <span class="hljs-attr">code</span> <span class="hljs-attr">here</span>></span>
Maybe some html tags?
<span class="hljs-tag"><<span class="hljs-name">link</span> <span class="hljs-attr">rel</span>=<span class="hljs-string">"stylesheet"</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"https://aurl"</span>></span>
<span class="hljs-tag"><<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://aurl"</span>></span><span class="hljs-tag"></<span class="hljs-name">script</span>></span>
<span class="hljs-tag"></<span class="hljs-name">code</span>></span>
<span class="hljs-tag"></<span class="hljs-name">pre</span>></span>
</code></pre>
This component is distributed with npm. After installing npm, you can install the vf-code-example with this command.
$ yarn add --dev @visual-framework/vf-code-example
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-code-example/index.scss";
Make sure you import Sass requirements along with the modules. You can use a project boilerplate or the vf-sass-starter
@visual-framework@vf-sass-config@2.6.1vf-code-example__preset- style functions to cleaner versionvf-content pre and vf-code-example__pre to:
File system location: components/vf-code-example
Find an issue on this page? Propose a change or discuss it.