Headings github location npm version

Variants


This heading size is extra large and inverted

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 (exampe), 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" %}
                

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-heading', {
  "component-type": "element",
  "type": 1,
  "heading": "This heading size is extra large and inverted",
  "style": "invert",
  "tags": "h1"
} %}
                
HTML
 <h1 class="vf-text vf-text-heading--1 vf-text--invert">This heading size is extra large and inverted</h1>
              

This heading size is extra large

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 (exampe), 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" %}
                

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-heading', {
  "component-type": "element",
  "type": 2,
  "heading": "This heading size is extra large",
  "tags": "h1"
} %}
                
HTML
 <h1 class="vf-text vf-text-heading--2">This heading size is extra large</h1>
              

This heading size is large

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 (exampe), 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" %}
                

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-heading', {
  "component-type": "element",
  "type": 3,
  "heading": "This heading size is large",
  "tags": "h2"
} %}
                
HTML
 <h2 class="vf-text vf-text-heading--3">This heading size is large</h2>
              

This heading size is regular

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 (exampe), 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" %}
                

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-heading', {
  "component-type": "element",
  "type": 4,
  "heading": "This heading size is regular",
  "tags": "h3"
} %}
                
HTML
 <h3 class="vf-text vf-text-heading--4">This heading size is regular</h3>
              

This heading size is small

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 (exampe), 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" %}
                

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-heading', {
  "component-type": "element",
  "type": 5,
  "heading": "This heading size is small",
  "tags": "h4"
} %}
                
HTML
 <h4 class="vf-text vf-text-heading--5">This heading size is small</h4>
              
Installation info

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

Sass/CSS

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

Changelog

Changelog

1.0.23

  • small change to cards on homepage

1.0.18

  • dependency bump

1.0.17

  • dependency bump

1.0.16

  • dependency bump

1.0.13

  • dependency bump
  • adds roamap and consultation docs

1.0.12

  • design token documenation now lives in the component libary

1.0.7

  • adds updates blog

1.0.6

  • begin to make more pattern/boilerplate guidance
  • minor templating updates

1.0.5

  • dependency bump

1.0.4

  • uses vf-favicon
  • adds meta attributes

1.0.3

  • run vf-component-assets:everything on local dev
  • remove reference to removed /css/app.css

1.0.2

  • Add 404
  • Fix component CSS generation

1.0.1

  • Also generate per-component CSS with vf-css:generate-component-css

1.0.0

  • Initial release to be used with vf-core 2.2.0

Assets



File system location: components/vf-heading

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