Building a site

How to make a project with Visual Framework components.

Section Header github location npm version

For use in labeling a section of content, often containers.


Variants


Projects

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",
  "section_title": "Projects"
}
 %}
{% include "../path_to/vf-section-header/vf-section-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-section-header', {
  "component-type": "block",
  "section_title": "Projects"
} %}
                
HTML
<div class="vf-section-header">
  <h2 class="vf-section-header__heading">Projects</h2>
</div>
              
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",
  "section_title": "Projects",
  "id": "section-link",
  "href": "JavaScript:Void(0);"
}
 %}
{% include "../path_to/vf-section-header/vf-section-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-section-header', {
  "component-type": "block",
  "section_title": "Projects",
  "id": "section-link",
  "href": "JavaScript:Void(0);"
} %}
                
HTML
<div class="vf-section-header"><a class="vf-section-header__heading vf-section-header__heading--is-link" href="JavaScript:Void(0);" id="section-link">Projects <svg aria-hidden="true" class="vf-section-header__icon | vf-icon vf-icon-arrow--inline-end" width="1em" height="1em" xmlns="http://www.w3.org/2000/svg">
      <path d="M0 12c0 6.627 5.373 12 12 12s12-5.373 12-12S18.627 0 12 0C5.376.008.008 5.376 0 12zm13.707-5.209l4.5 4.5a1 1 0 010 1.414l-4.5 4.5a1 1 0 01-1.414-1.414l2.366-2.367a.25.25 0 00-.177-.424H6a1 1 0 010-2h8.482a.25.25 0 00.177-.427l-2.366-2.368a1 1 0 011.414-1.414z" fill="" fill-rule="nonzero"></path>
    </svg></a></div>
              

Projects

News from EMBL’s six sites

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",
  "section_title": "Projects",
  "id": "section-sub-heading",
  "section__subheading": "News from EMBL’s six sites"
}
 %}
{% include "../path_to/vf-section-header/vf-section-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-section-header', {
  "component-type": "block",
  "section_title": "Projects",
  "id": "section-sub-heading",
  "section__subheading": "News from EMBL’s six sites"
} %}
                
HTML
<div class="vf-section-header">
  <h2 class="vf-section-header__heading" id="section-sub-heading">Projects</h2>
  <p class="vf-section-header__subheading">News from EMBL’s six sites</p>
</div>
              
Projects

News from EMBL’s six sites

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",
  "section_title": "Projects",
  "href": "JavaScript:Void(0);",
  "id": "section-sub-heading-link",
  "section__subheading": "News from EMBL’s six sites"
}
 %}
{% include "../path_to/vf-section-header/vf-section-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-section-header', {
  "component-type": "block",
  "section_title": "Projects",
  "href": "JavaScript:Void(0);",
  "id": "section-sub-heading-link",
  "section__subheading": "News from EMBL’s six sites"
} %}
                
HTML
<div class="vf-section-header"><a class="vf-section-header__heading vf-section-header__heading--is-link" href="JavaScript:Void(0);" id="section-sub-heading-link">Projects <svg aria-hidden="true" class="vf-section-header__icon | vf-icon vf-icon-arrow--inline-end" width="1em" height="1em" xmlns="http://www.w3.org/2000/svg">
      <path d="M0 12c0 6.627 5.373 12 12 12s12-5.373 12-12S18.627 0 12 0C5.376.008.008 5.376 0 12zm13.707-5.209l4.5 4.5a1 1 0 010 1.414l-4.5 4.5a1 1 0 01-1.414-1.414l2.366-2.367a.25.25 0 00-.177-.424H6a1 1 0 010-2h8.482a.25.25 0 00.177-.427l-2.366-2.368a1 1 0 011.414-1.414z" fill="" fill-rule="nonzero"></path>
    </svg></a>
  <p class="vf-section-header__subheading">News from EMBL’s six sites</p>
</div>
              
Projects

News from EMBL’s six sites

Hello everyone who are doing?

Buy Pizza.

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",
  "section_title": "Projects",
  "href": "JavaScript:Void(0);",
  "id": "section-sub-heading-link-text",
  "section__subheading": "News from EMBL’s six sites",
  "vf_section__content": [
    "Hello everyone who are doing?",
    "Buy <a href=\"#\">Pizza</a>."
  ]
}
 %}
{% include "../path_to/vf-section-header/vf-section-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-section-header', {
  "component-type": "block",
  "section_title": "Projects",
  "href": "JavaScript:Void(0);",
  "id": "section-sub-heading-link-text",
  "section__subheading": "News from EMBL’s six sites",
  "vf_section__content": [
    "Hello everyone who are doing?",
    "Buy <a href=\"#\">Pizza</a>."
  ]
} %}
                
HTML
<div class="vf-section-header"><a class="vf-section-header__heading vf-section-header__heading--is-link" href="JavaScript:Void(0);" id="section-sub-heading-link-text">Projects <svg aria-hidden="true" class="vf-section-header__icon | vf-icon vf-icon-arrow--inline-end" width="1em" height="1em" xmlns="http://www.w3.org/2000/svg">
      <path d="M0 12c0 6.627 5.373 12 12 12s12-5.373 12-12S18.627 0 12 0C5.376.008.008 5.376 0 12zm13.707-5.209l4.5 4.5a1 1 0 010 1.414l-4.5 4.5a1 1 0 01-1.414-1.414l2.366-2.367a.25.25 0 00-.177-.424H6a1 1 0 010-2h8.482a.25.25 0 00.177-.427l-2.366-2.368a1 1 0 011.414-1.414z" fill="" fill-rule="nonzero"></path>
    </svg></a>
  <p class="vf-section-header__subheading">News from EMBL’s six sites</p>
  <p class="vf-section-header__text">Hello everyone who are doing?</p>
  <p class="vf-section-header__text">Buy <a href="#">Pizza</a>.</p>
</div>
              
Projects

Hello everyone who are doing?

Pizza

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",
  "section_title": "Projects",
  "href": "JavaScript:Void(0);",
  "id": "section-link-text",
  "vf_section__content": [
    "Hello everyone who are doing?",
    "Pizza"
  ]
}
 %}
{% include "../path_to/vf-section-header/vf-section-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-section-header', {
  "component-type": "block",
  "section_title": "Projects",
  "href": "JavaScript:Void(0);",
  "id": "section-link-text",
  "vf_section__content": [
    "Hello everyone who are doing?",
    "Pizza"
  ]
} %}
                
HTML
<div class="vf-section-header"><a class="vf-section-header__heading vf-section-header__heading--is-link" href="JavaScript:Void(0);" id="section-link-text">Projects <svg aria-hidden="true" class="vf-section-header__icon | vf-icon vf-icon-arrow--inline-end" width="1em" height="1em" xmlns="http://www.w3.org/2000/svg">
      <path d="M0 12c0 6.627 5.373 12 12 12s12-5.373 12-12S18.627 0 12 0C5.376.008.008 5.376 0 12zm13.707-5.209l4.5 4.5a1 1 0 010 1.414l-4.5 4.5a1 1 0 01-1.414-1.414l2.366-2.367a.25.25 0 00-.177-.424H6a1 1 0 010-2h8.482a.25.25 0 00.177-.427l-2.366-2.368a1 1 0 011.414-1.414z" fill="" fill-rule="nonzero"></path>
    </svg></a>
  <p class="vf-section-header__text">Hello everyone who are doing?</p>
  <p class="vf-section-header__text">Pizza</p>
</div>
              

Projects

Hello everyone who are doing?

Pizza

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",
  "section_title": "Projects",
  "id": "section-text",
  "vf_section__content": [
    "Hello everyone who are doing?",
    "Pizza"
  ]
}
 %}
{% include "../path_to/vf-section-header/vf-section-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-section-header', {
  "component-type": "block",
  "section_title": "Projects",
  "id": "section-text",
  "vf_section__content": [
    "Hello everyone who are doing?",
    "Pizza"
  ]
} %}
                
HTML
<div class="vf-section-header">
  <h2 class="vf-section-header__heading" id="section-text">Projects</h2>
  <p class="vf-section-header__text">Hello everyone who are doing?</p>
  <p class="vf-section-header__text">Pizza</p>
</div>
              
Installation info

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

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

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-section-header/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.1.12

  • Update milestones and roadmap.

1.1.11

  • Add ELIXIR banner to example EMBL-EBI page.
  • https://stable.visual-framework.dev/patterns/boilerplate-generic-embl-ebi/
  • https://github.com/visual-framework/vf-core/pull/1615

1.1.7

  • Fixed issue of overlapping menu on VF components site
  • https://github.com/visual-framework/vf-core/issues/1518

1.1.6

  • dependency bump

1.1.2

  • Implements updated vf-search markup.
  • Changes a few pages on how it works with nunjucks and markdown.

1.1.0

  • updates Design Tokens homepage.
  • adds neutral colour tokens
  • adds 'status banners' for components in the documentation page.
  • Adds the form options as their own set of components in the list.
  • https://github.com/visual-framework/vf-core/pull/1390/files
  • Updates to use 11ty 0.12.1
  • https://github.com/visual-framework/vf-core/pull/1435

1.0.24

  • changes the vf-intro so it's a white background, removes the padding.
  • changes the links in vf-intro to be the 'correct' buttons.

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-section-header

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