Stack github location npm version

This can be used to set the flow of child components.

Variants


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 (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": "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>
              

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 (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": "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>
              

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 (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": "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>
              

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 (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": "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>
              

Usage

Some (and soon all) vf-core components will come without any margin spacing (this is to avoid adding margins where it is not needed).

You can add the vf-stack class name to existing containers (like vf-content) or containers you create yourself in your codebase.

Note: vf-grid (1.0.0) and embl-grid (2.0.1) now automaticaly add gaps to their child elements as needed. So you should not use vf-stack alongside these.

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 overriden by browsers that understand CSS custom properties.

variant name description
sm gives the vertical rhythm equal spacing of 1rem
md gives the vertical rhythm equal spacing of 1.5rem
lg gives the vertical rhythm equal spacing of 2rem

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