The vf-heading
component leverages the design token typography sizes.
This component provides a utility-like functionality and you'll rarely need to directly use this component. When coding a component's Sass, it will typically be better to use the mixins (@include set-type(text-heading--1);
) than these vf-heading
classes.
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" : "element",
"type" : 1,
"heading" : "This heading size is extra large and inverted",
"style" : "invert",
"tags" : "h1",
}
%}
{% include "../path_to/vf-heading/vf-heading.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-heading', {
"component-type" : "element",
"type" : 1,
"heading" : "This heading size is extra large and inverted",
"style" : "invert",
"tags" : "h1",}
%}
<h1 class="vf-text vf-text-heading--1 vf-text--invert">This heading size is extra large and inverted</h1>
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" : "element",
"type" : 2,
"heading" : "This heading size is extra large",
"tags" : "h1",
}
%}
{% include "../path_to/vf-heading/vf-heading.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-heading', {
"component-type" : "element",
"type" : 2,
"heading" : "This heading size is extra large",
"tags" : "h1",}
%}
<h1 class="vf-text vf-text-heading--2">This heading size is extra large</h1>
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" : "element",
"type" : 3,
"heading" : "This heading size is large",
"tags" : "h2",
}
%}
{% include "../path_to/vf-heading/vf-heading.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-heading', {
"component-type" : "element",
"type" : 3,
"heading" : "This heading size is large",
"tags" : "h2",}
%}
<h2 class="vf-text vf-text-heading--3">This heading size is large</h2>
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" : "element",
"type" : 4,
"heading" : "This heading size is regular",
"tags" : "h3",
}
%}
{% include "../path_to/vf-heading/vf-heading.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-heading', {
"component-type" : "element",
"type" : 4,
"heading" : "This heading size is regular",
"tags" : "h3",}
%}
<h3 class="vf-text vf-text-heading--4">This heading size is regular</h3>
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" : "element",
"type" : 5,
"heading" : "This heading size is small",
"tags" : "h4",
}
%}
{% include "../path_to/vf-heading/vf-heading.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-heading', {
"component-type" : "element",
"type" : 5,
"heading" : "This heading size is small",
"tags" : "h4",}
%}
<h4 class="vf-text vf-text-heading--5">This heading size is small</h4>
This component is distributed with npm. After installing npm, you can install the vf-heading
with this command.
$ yarn add --dev @visual-framework/vf-heading
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-heading/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-heading
Find an issue on this page? Propose a change or discuss it.