Page Header block

A simple combination of a heading and subheading for pages.

github location npm version


Strategy & Communications

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",
"heading" : "Strategy &amp Communications",
"subheading" : "Blog",
{% include "../path_to/vf-page-header/vf-page-header.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-page-header', {
  "component-type" : "block",
  "heading" : "Strategy &amp Communications",
  "subheading" : "Blog",}
<header class="vf-page-header">
  <h1 class="vf-page-header__heading">Strategy &amp Communications</h1>
  <span class="vf-page-header__sub-heading">Blog</span>


Installation info

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

$ yarn add --dev @visual-framework/vf-page-header


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-page-header/index.scss";

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




  • changes any set- style functions to cleaner version


  • Resolve issue of missing import in index.scss


  • updates spacing design tokens
  • requires v2.0.0 of the vf-design-tokens package or newer


  • Initial stable release


File system location: components/vf-page-header

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