beta This component version is ready to be used but is still in active development.

Stack layout

This sets the vertical spacing of child components.

github location npm version

Usage

Most vf-core components come without any margin spacing to avoid adding margins where not needed. Instead vertical spacing is controlled by vf-stack.

Where vertical spacing is required withing a component, the vf-stack class name to existing containers (like vf-hero) or containers you create yourself in your codebase.

Variants

We use CSS custom properties to control this vertical rhythm. For browsers that do not support CSS custom properties (IE 11) we provide a default value of 1rem so that child components get some spacing. This value is overridden by browsers that understand CSS custom properties.

variant name description
200 gives the vertical rhythm equal spacing of .5rem
400 gives the vertical rhythm equal spacing of 1rem
500 gives the vertical rhythm equal spacing of 1.25rem
600 gives the vertical rhythm equal spacing of 1.5rem
800 gives the vertical rhythm equal spacing of 2rem
1200 gives the vertical rhythm equal spacing of 3rem
1600 gives the vertical rhythm equal spacing of 4rem

Even though the vf-stack layout has a default spacing design token applied as a CSS custom property fallback it is good practice in the system to declare the vf-stack spacing class name in your projects.

❌ <div class="vf-stack">...</div>

✅ <div class="vf-stack vf-stack--400">...</div>

As we are using CSS custom properties we can also use a custom value by creating the custom property --vf-stack-margin--custom either in your stylesheet, or in your HTML.

<div class="vf-stack vf-stack--custom" style="--vf-stack-margin--custom: 3em;">
  <div class="vf-box vf-box--normal vf-box-theme--primary">...</div>
  <div class="vf-box vf-box--normal vf-box-theme--primary">...</div>
  <div class="vf-box vf-box--normal vf-box-theme--primary">...</div>
</div>

Variants

Spacing (200) variant

Did you know?

This is some more content that would be in the box.

Did you know?

This is some more content that would be in the box.

Did you know?

This is some more content that would be in the box.

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": "layout",
  "stack__spacing": 200
}
 %}
{% include "../path_to/vf-stack/vf-stack.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-stack', {
  "component-type": "layout",
  "stack__spacing": 200
} %}
HTML 
<div class="vf-stack vf-stack--200">


  <div class="vf-box vf-box-theme--primary vf-box--normal">

    <h3 class="vf-box__heading">Did you know?</h3>
    <p class="vf-box__text">This is some more content that would be in the box.</p>
  </div>

  <div class="vf-box vf-box-theme--primary vf-box--normal">

    <h3 class="vf-box__heading">Did you know?</h3>
    <p class="vf-box__text">This is some more content that would be in the box.</p>
  </div>

  <div class="vf-box vf-box-theme--primary vf-box--normal">

    <h3 class="vf-box__heading">Did you know?</h3>
    <p class="vf-box__text">This is some more content that would be in the box.</p>
  </div>

</div>

Spacing (400) variant

Did you know?

This is some more content that would be in the box.

Did you know?

This is some more content that would be in the box.

Did you know?

This is some more content that would be in the box.

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": "layout",
  "stack__spacing": 400
}
 %}
{% include "../path_to/vf-stack/vf-stack.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-stack', {
  "component-type": "layout",
  "stack__spacing": 400
} %}
HTML 
<div class="vf-stack vf-stack--400">


  <div class="vf-box vf-box-theme--primary vf-box--normal">

    <h3 class="vf-box__heading">Did you know?</h3>
    <p class="vf-box__text">This is some more content that would be in the box.</p>
  </div>

  <div class="vf-box vf-box-theme--primary vf-box--normal">

    <h3 class="vf-box__heading">Did you know?</h3>
    <p class="vf-box__text">This is some more content that would be in the box.</p>
  </div>

  <div class="vf-box vf-box-theme--primary vf-box--normal">

    <h3 class="vf-box__heading">Did you know?</h3>
    <p class="vf-box__text">This is some more content that would be in the box.</p>
  </div>

</div>

Spacing (500) variant

Did you know?

This is some more content that would be in the box.

Did you know?

This is some more content that would be in the box.

Did you know?

This is some more content that would be in the box.

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": "layout",
  "stack__spacing": 500
}
 %}
{% include "../path_to/vf-stack/vf-stack.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-stack', {
  "component-type": "layout",
  "stack__spacing": 500
} %}
HTML 
<div class="vf-stack vf-stack--500">


  <div class="vf-box vf-box-theme--primary vf-box--normal">

    <h3 class="vf-box__heading">Did you know?</h3>
    <p class="vf-box__text">This is some more content that would be in the box.</p>
  </div>

  <div class="vf-box vf-box-theme--primary vf-box--normal">

    <h3 class="vf-box__heading">Did you know?</h3>
    <p class="vf-box__text">This is some more content that would be in the box.</p>
  </div>

  <div class="vf-box vf-box-theme--primary vf-box--normal">

    <h3 class="vf-box__heading">Did you know?</h3>
    <p class="vf-box__text">This is some more content that would be in the box.</p>
  </div>

</div>

Spacing (600) variant

Did you know?

This is some more content that would be in the box.

Did you know?

This is some more content that would be in the box.

Did you know?

This is some more content that would be in the box.

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": "layout",
  "stack__spacing": 600
}
 %}
{% include "../path_to/vf-stack/vf-stack.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-stack', {
  "component-type": "layout",
  "stack__spacing": 600
} %}
HTML 
<div class="vf-stack vf-stack--600">


  <div class="vf-box vf-box-theme--primary vf-box--normal">

    <h3 class="vf-box__heading">Did you know?</h3>
    <p class="vf-box__text">This is some more content that would be in the box.</p>
  </div>

  <div class="vf-box vf-box-theme--primary vf-box--normal">

    <h3 class="vf-box__heading">Did you know?</h3>
    <p class="vf-box__text">This is some more content that would be in the box.</p>
  </div>

  <div class="vf-box vf-box-theme--primary vf-box--normal">

    <h3 class="vf-box__heading">Did you know?</h3>
    <p class="vf-box__text">This is some more content that would be in the box.</p>
  </div>

</div>

Spacing (800) variant

Did you know?

This is some more content that would be in the box.

Did you know?

This is some more content that would be in the box.

Did you know?

This is some more content that would be in the box.

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": "layout",
  "stack__spacing": 800
}
 %}
{% include "../path_to/vf-stack/vf-stack.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-stack', {
  "component-type": "layout",
  "stack__spacing": 800
} %}
HTML 
<div class="vf-stack vf-stack--800">


  <div class="vf-box vf-box-theme--primary vf-box--normal">

    <h3 class="vf-box__heading">Did you know?</h3>
    <p class="vf-box__text">This is some more content that would be in the box.</p>
  </div>

  <div class="vf-box vf-box-theme--primary vf-box--normal">

    <h3 class="vf-box__heading">Did you know?</h3>
    <p class="vf-box__text">This is some more content that would be in the box.</p>
  </div>

  <div class="vf-box vf-box-theme--primary vf-box--normal">

    <h3 class="vf-box__heading">Did you know?</h3>
    <p class="vf-box__text">This is some more content that would be in the box.</p>
  </div>

</div>

Spacing (1200) variant

Did you know?

This is some more content that would be in the box.

Did you know?

This is some more content that would be in the box.

Did you know?

This is some more content that would be in the box.

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": "layout",
  "stack__spacing": 1200
}
 %}
{% include "../path_to/vf-stack/vf-stack.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-stack', {
  "component-type": "layout",
  "stack__spacing": 1200
} %}
HTML 
<div class="vf-stack vf-stack--1200">


  <div class="vf-box vf-box-theme--primary vf-box--normal">

    <h3 class="vf-box__heading">Did you know?</h3>
    <p class="vf-box__text">This is some more content that would be in the box.</p>
  </div>

  <div class="vf-box vf-box-theme--primary vf-box--normal">

    <h3 class="vf-box__heading">Did you know?</h3>
    <p class="vf-box__text">This is some more content that would be in the box.</p>
  </div>

  <div class="vf-box vf-box-theme--primary vf-box--normal">

    <h3 class="vf-box__heading">Did you know?</h3>
    <p class="vf-box__text">This is some more content that would be in the box.</p>
  </div>

</div>

Spacing (1600) variant

Did you know?

This is some more content that would be in the box.

Did you know?

This is some more content that would be in the box.

Did you know?

This is some more content that would be in the box.

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": "layout",
  "stack__spacing": 1600
}
 %}
{% include "../path_to/vf-stack/vf-stack.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-stack', {
  "component-type": "layout",
  "stack__spacing": 1600
} %}
HTML 
<div class="vf-stack vf-stack--1600">


  <div class="vf-box vf-box-theme--primary vf-box--normal">

    <h3 class="vf-box__heading">Did you know?</h3>
    <p class="vf-box__text">This is some more content that would be in the box.</p>
  </div>

  <div class="vf-box vf-box-theme--primary vf-box--normal">

    <h3 class="vf-box__heading">Did you know?</h3>
    <p class="vf-box__text">This is some more content that would be in the box.</p>
  </div>

  <div class="vf-box vf-box-theme--primary vf-box--normal">

    <h3 class="vf-box__heading">Did you know?</h3>
    <p class="vf-box__text">This is some more content that would be in the box.</p>
  </div>

</div>

Spacing (custom) variant

Did you know?

This is some more content that would be in the box.

Did you know?

This is some more content that would be in the box.

Did you know?

This is some more content that would be in the box.

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": "layout",
  "stack__spacing__custom": "4rem",
  "stack__spacing": "custom"
}
 %}
{% include "../path_to/vf-stack/vf-stack.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-stack', {
  "component-type": "layout",
  "stack__spacing__custom": "4rem",
  "stack__spacing": "custom"
} %}
HTML 
<div class="vf-stack vf-stack--custom" style="--vf-stack-margin--custom: 4rem;">


  <div class="vf-box vf-box-theme--primary vf-box--normal">

    <h3 class="vf-box__heading">Did you know?</h3>
    <p class="vf-box__text">This is some more content that would be in the box.</p>
  </div>

  <div class="vf-box vf-box-theme--primary vf-box--normal">

    <h3 class="vf-box__heading">Did you know?</h3>
    <p class="vf-box__text">This is some more content that would be in the box.</p>
  </div>

  <div class="vf-box vf-box-theme--primary vf-box--normal">

    <h3 class="vf-box__heading">Did you know?</h3>
    <p class="vf-box__text">This is some more content that would be in the box.</p>
  </div>

</div>

Examples

Installation info

This repository is distributed with [npm][https://www.npmjs.com/]. After [installing npm][https://www.npmjs.com/get-npm] and yarn, you can install vf-stack with this command.

$ yarn add --dev @visual-framework/vf-stack

Sass/CSS

If your component uses Sass:

The source files included are written in Sass (scss) You can simply point your sass include-path at your node_modules directory and import it like this.

@import "@visual-framework/vf-stack/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.2.3

  • Updated changelog

1.2.2

  • Documentation upgrade

1.2.1

  • New release

1.2.0

  • Update node-html-parser to 5.1.0
  • Use eleventy v1.0.0-beta.8
  • https://github.com/visual-framework/vf-core/pull/1257

1.1.16

  • Utilise new vf-navigation--on-this-page.
  • Update project boilerplate links at https://stable.visual-framework.dev/building/

1.1.13

  • Documentation updates
  • New release

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-stack

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